Difference between revisions of "Location Script"

*float Function [[GetKeywordData - Location|GetKeywordData]](Keyword akKeyword)

**Returns the float value associated with the specified keyword attached to this location.

*int Function [[GetRefTypeAliveCount - Location|GetRefTypeAliveCount]](LocationRefType akRefType)

**Returns the number of alive enabled references matching the specified [[LocationRefType Script|LocationRefType]].

*int Function [[GetRefTypeDeadCount - Location|GetRefTypeDeadCount]](LocationRefType akRefType)

**Returns the number of dead enabled references matching the specified [[LocationRefType Script|LocationRefType]].

*bool Function [[HasCommonParent - Location|HasCommonParent]](Location akOther, Keyword akFilter)

**Returns if the two locations have a common parent, filtered with the [[Keyword Script|Keyword]].

*bool Function [[HasRefType - Location|HasRefType]](LocationRefType akRefType)

**Returns if this location has the specified [[LocationRefType Script|LocationRefType]]

*bool Function [[IsCleared - Location|IsCleared]]()

**Gets whether this location is flagged as "cleared" or not.

*bool Function [[IsChild - Location|IsChild]](Location akOther)

**Checks to see if the other location is a child of this one.

*bool Function [[IsLoaded - Location|IsLoaded]]()

**Is this location currently loaded?

*bool Function [[IsSameLocation - Location|IsSameLocation]](Location akOtherLocation, Keyword akKeyword)

**Returns true if this location is the same as the supplied location

*Function [[SetCleared - Location|SetCleared]](bool abCleared)

**Flags this location as cleared (or not).

*Function [[SetKeywordData - Location|SetKeywordData]](Keyword akKeyword, float afData)

**Sets the specified [[Keyword Script|Keyword]]'s data on this location.