Difference between revisions of "Location Script"

!style="text-align:left;"|Function

|[[GetKeywordData - Location|Float '''GetKeywordData'''(Keyword ''akKeyword'')]]

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

|[[GetRefTypeAliveCount - Location|Int '''GetRefTypeAliveCount'''(LocationRefType ''akRefType'')]]

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

|[[GetRefTypeDeadCount - Location|Int '''GetRefTypeDeadCount'''(LocationRefType ''akRefType'')]]

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

|[[HasCommonParent - Location|Bool '''HasCommonParent'''(Location ''akOther'', Keyword ''akFilter'')]]

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

|[[HasRefType - Location|Bool '''HasRefType'''(LocationRefType ''akRefType'')]]

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

|[[IsCleared - Location|Bool '''IsCleared'''()]]

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

|[[IsChild - Location|Bool '''IsChild'''(Location ''akOther'')]]

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

|[[IsLoaded - Location|Bool '''IsLoaded'''()]]

|Is this location currently loaded?

|[[IsSameLocation - Location|Bool '''IsSameLocation'''(Location ''akOtherLocation'', Keyword ''akKeyword'')]]

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

|[[SetCleared - Location|'''SetCleared'''(Bool ''abCleared'')]]

|Flags this location as cleared (or not).

|[[SetKeywordData - Location|'''SetKeywordData'''(Keyword ''akKeyword'', Float ''afData'')]]

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