Location Script

Extends: Form Script

Script for the manipulation of location base objects.

Definition

ScriptName Location extends Form

Properties

None

Global Functions

None

Member Functions

float Function GetKeywordData(Keyword akKeyword)

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

int Function GetRefTypeAliveCount(LocationRefType akRefType)

• Returns the number of alive enabled references matching the specified LocationRefType.

int Function GetRefTypeDeadCount(LocationRefType akRefType)

• Returns the number of dead enabled references matching the specified LocationRefType.

bool Function HasCommonParent(Location akOther, Keyword akFilter)

• Returns if the two locations have a common parent, filtered with the Keyword.

bool Function HasRefType(LocationRefType akRefType)

• Returns if this location has the specified LocationRefType

bool Function IsCleared()

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

bool Function IsChild(Location akOther)

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

bool Function IsLoaded()

• Is this location currently loaded?

bool Function IsSameLocation(Location akOtherLocation, Keyword akKeyword)

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

Function SetCleared(bool abCleared)

• Flags this location as cleared (or not).

Function SetKeywordData(Keyword akKeyword, float afData)

• Sets the specified Keyword's data on this location.

Events

None