Difference between revisions of "Location Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
'''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)'''
{|class="wikitable" width =100%
*Returns the number of alive enabled references matching the specified [[LocationRefType Script|LocationRefType]].
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetKeywordData - Location|Float '''GetKeywordData'''(Keyword ''akKeyword'')]]
|Returns the float value associated with the specified keyword attached to this location.
|-


'''int Function [[GetRefTypeDeadCount - Location|GetRefTypeDeadCount]](LocationRefType akRefType)'''
|[[GetRefTypeAliveCount - Location|Int '''GetRefTypeAliveCount'''(LocationRefType ''akRefType'')]]
*Returns the number of dead enabled references matching the specified [[LocationRefType Script|LocationRefType]].
|Returns the number of alive enabled references matching the specified [[LocationRefType Script|LocationRefType]].
|-


'''bool Function [[HasCommonParent - Location|HasCommonParent]](Location akOther, Keyword akFilter)'''
|[[GetRefTypeDeadCount - Location|Int '''GetRefTypeDeadCount'''(LocationRefType ''akRefType'')]]
*Returns if the two locations have a common parent, filtered with the [[Keyword Script|Keyword]].
|Returns the number of dead enabled references matching the specified [[LocationRefType Script|LocationRefType]].
|-


'''bool Function [[HasRefType - Location|HasRefType]](LocationRefType akRefType)'''
|[[HasCommonParent - Location|Bool '''HasCommonParent'''(Location ''akOther'', Keyword ''akFilter'')]]
*Returns if this location has the specified [[LocationRefType Script|LocationRefType]]
|Returns if the two locations have a common parent, filtered with the [[Keyword Script|Keyword]].
|-


'''bool Function [[IsCleared - Location|IsCleared]]()'''
|[[HasRefType - Location|Bool '''HasRefType'''(LocationRefType ''akRefType'')]]
*Gets whether this location is flagged as "cleared" or not.
|Returns if this location has the specified [[LocationRefType Script|LocationRefType]]
|-


'''bool Function [[IsChild - Location|IsChild]](Location akOther)'''
|[[IsCleared - Location|Bool '''IsCleared'''()]]
*Checks to see if the other location is a child of this one.
|Gets whether this location is flagged as "cleared" or not.
|-


'''bool Function [[IsLoaded - Location|IsLoaded]]()'''
|[[IsChild - Location|Bool '''IsChild'''(Location ''akOther'')]]
*Is this location currently loaded?
|Checks to see if the other location is a child of this one.
|-


'''bool Function [[IsSameLocation - Location|IsSameLocation]](Location akOtherLocation, Keyword akKeyword)'''
|[[IsLoaded - Location|Bool '''IsLoaded'''()]]
*Returns true if this location is the same as the supplied location
|Is this location currently loaded?
|-


'''Function [[SetCleared - Location|SetCleared]](bool abCleared)'''
|[[IsSameLocation - Location|Bool '''IsSameLocation'''(Location ''akOtherLocation'', Keyword ''akKeyword'')]]
*Flags this location as cleared (or not).
|Returns true if this location is the same as the supplied location
|-


'''Function [[SetKeywordData - Location|SetKeywordData]](Keyword akKeyword, float afData)'''
|[[SetCleared - Location|'''SetCleared'''(Bool ''abCleared'')]]
*Sets the specified [[Keyword Script|Keyword]]'s data on this location.
|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.
|-
 
|}


== Events ==
== Events ==
None
None

Revision as of 04:10, 24 October 2013


Extends: Form Script

Script for the manipulation of location base objects.

Definition

ScriptName Location extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
Float GetKeywordData(Keyword akKeyword) Returns the float value associated with the specified keyword attached to this location.
Int GetRefTypeAliveCount(LocationRefType akRefType) Returns the number of alive enabled references matching the specified LocationRefType.
Int GetRefTypeDeadCount(LocationRefType akRefType) Returns the number of dead enabled references matching the specified LocationRefType.
Bool HasCommonParent(Location akOther, Keyword akFilter) Returns if the two locations have a common parent, filtered with the Keyword.
Bool HasRefType(LocationRefType akRefType) Returns if this location has the specified LocationRefType
Bool IsCleared() Gets whether this location is flagged as "cleared" or not.
Bool IsChild(Location akOther) Checks to see if the other location is a child of this one.
Bool IsLoaded() Is this location currently loaded?
Bool IsSameLocation(Location akOtherLocation, Keyword akKeyword) Returns true if this location is the same as the supplied location
SetCleared(Bool abCleared) Flags this location as cleared (or not).
SetKeywordData(Keyword akKeyword, Float afData) Sets the specified Keyword's data on this location.

Events

None

Retrieved from "https://ck.uesp.net/w/index.php?title=Location_Script&oldid=12856"