Class Location

Namespace

TaleWorlds.CampaignSystem.Settlements.Locations

Assembly

TaleWorlds.CampaignSystem.dll

public class Location

Inheritance

object

Location

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Location(string, TextObject, TextObject, int, bool, bool, string, string, string, string, string[], LocationComplex)

public Location(string stringId, TextObject name, TextObject doorName, int prosperityMax, bool isIndoor, bool canBeReserved, string playerCanEnter, string playerCanSee, string aiCanExit, string aiCanEnter, string[] sceneNames, LocationComplex locationComplex)

Parameters

stringId string

name TextObject

doorName TextObject

prosperityMax int

isIndoor bool

canBeReserved bool

playerCanEnter string

playerCanSee string

aiCanExit string

aiCanEnter string

sceneNames string[]

locationComplex LocationComplex

Location(Location, LocationComplex)

public Location(Location location, LocationComplex locationComplex)

Parameters

location Location

locationComplex LocationComplex

Fields

ProsperityMax

public int ProsperityMax

Field Value

int

Properties

CanBeReserved

public bool CanBeReserved { get; }

Property Value

bool

CharacterCount

public int CharacterCount { get; }

Property Value

int

DoorName

public TextObject DoorName { get; }

Property Value

TextObject

IsIndoor

public bool IsIndoor { get; }

Property Value

bool

IsInitialized

[CachedData]
public bool IsInitialized { get; }

Property Value

bool

IsReserved

[SaveableProperty(30)]
public bool IsReserved { get; }

Property Value

bool

LocationsOfPassages

public List<Location> LocationsOfPassages { get; }

Property Value

List<Location>

Name

public TextObject Name { get; }

Property Value

TextObject

SpecialItems

[SaveableProperty(20)]
public List<ItemObject> SpecialItems { get; }

Property Value

List<ItemObject>

StringId

[SaveableProperty(10)]
public string StringId { get; }

Property Value

string

Methods

AddCharacter(LocationCharacter)

public void AddCharacter(LocationCharacter locationCharacter)

Parameters

locationCharacter LocationCharacter

AddLocationCharacters(CreateLocationCharacterDelegate, CultureObject, CharacterRelations, int)

public void AddLocationCharacters(CreateLocationCharacterDelegate createDelegate, CultureObject culture, LocationCharacter.CharacterRelations relation, int count)

Parameters

createDelegate CreateLocationCharacterDelegate

culture CultureObject

relation LocationCharacter.CharacterRelations

count int

AddPassageToLocation(Location)

public void AddPassageToLocation(Location passageToLocation)

Parameters

passageToLocation Location

AddSpecialItem(ItemObject)

public void AddSpecialItem(ItemObject itemObject)

Parameters

itemObject ItemObject

AutoGeneratedInstanceCollectObjects(List<object>)

protected virtual void AutoGeneratedInstanceCollectObjects(List<object> collectedObjects)

Parameters

collectedObjects List<object>

CanAIEnter(LocationCharacter)

public bool CanAIEnter(LocationCharacter character)

Parameters

character LocationCharacter

Returns

bool

CanAIExit(LocationCharacter)

public bool CanAIExit(LocationCharacter character)

Parameters

character LocationCharacter

Returns

bool

CanPlayerEnter()

public bool CanPlayerEnter()

Returns

bool

CanPlayerSee()

public bool CanPlayerSee()

Returns

bool

ContainsCharacter(Hero)

public bool ContainsCharacter(Hero hero)

Parameters

hero Hero

Returns

bool

ContainsCharacter(LocationCharacter)

public bool ContainsCharacter(LocationCharacter locationCharacter)

Parameters

locationCharacter LocationCharacter

Returns

bool

GetCharacterList()

public IEnumerable<LocationCharacter> GetCharacterList()

Returns

IEnumerable<LocationCharacter>

GetLocationCharacter(Hero)

public LocationCharacter GetLocationCharacter(Hero hero)

Parameters

hero Hero

Returns

LocationCharacter

GetLocationCharacter(IAgentOriginBase)

public LocationCharacter GetLocationCharacter(IAgentOriginBase agentOrigin)

Parameters

agentOrigin IAgentOriginBase

Returns

LocationCharacter

GetPassageToLocation(string)

public Location GetPassageToLocation(string locationId)

Parameters

locationId string

Returns

Location

GetSceneCount()

public int GetSceneCount()

Returns

int

GetSceneName(int)

public string GetSceneName(int upgradeLevel)

Parameters

upgradeLevel int

Returns

string

Initialize(Location, LocationComplex)

public void Initialize(Location locationTemplate, LocationComplex ownerComplex)

Parameters

locationTemplate Location

ownerComplex LocationComplex

OnAIChangeLocation(Location)

public void OnAIChangeLocation(Location previousLocation)

Parameters

previousLocation Location

RemoveAllCharacters()

public void RemoveAllCharacters()

RemoveAllCharacters(Predicate<LocationCharacter>)

public void RemoveAllCharacters(Predicate<LocationCharacter> predicate)

Parameters

predicate Predicate<LocationCharacter>

RemoveAllHeroCharactersFromPrison()

public void RemoveAllHeroCharactersFromPrison()

RemoveCharacter(Hero)

public void RemoveCharacter(Hero hero)

Parameters

hero Hero

RemoveLocationCharacter(LocationCharacter)

public void RemoveLocationCharacter(LocationCharacter locationCharacter)

Parameters

locationCharacter LocationCharacter

RemoveReservation()

public void RemoveReservation()

ReserveLocation(TextObject, TextObject)

public void ReserveLocation(TextObject locationName, TextObject doorName)

Parameters

locationName TextObject

doorName TextObject

SetOwnerComplex(LocationComplex)

public void SetOwnerComplex(LocationComplex locationComplex)

Parameters

locationComplex LocationComplex

SetSceneName(int, string)

public void SetSceneName(int upgradeLevel, string sceneName)

Parameters

upgradeLevel int

sceneName string

---

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).