Difference between revisions of "Location Script"
Jump to navigation
Jump to search
imported>Jlundin |
(Added GetParent SKSE function) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
Line 19: | Line 15: | ||
== Member Functions == | == Member Functions == | ||
:'''Float [[GetKeywordData - Location|GetKeywordData]](Keyword ''akKeyword'')''' | |||
:*Returns the float value associated with the specified keyword attached to this location. | |||
:'''Int [[GetRefTypeAliveCount - Location|GetRefTypeAliveCount]](LocationRefType ''akRefType'')''' | |||
:*Returns the number of alive enabled references matching the specified [[LocationRefType Script|LocationRefType]]. | |||
:'''Int [[GetRefTypeDeadCount - Location|GetRefTypeDeadCount]](LocationRefType ''akRefType'')''' | |||
:*Returns the number of dead enabled references matching the specified [[LocationRefType Script|LocationRefType]]. | |||
:'''Bool [[HasCommonParent - Location|HasCommonParent]](Location ''akOther'', Keyword ''akFilter'')''' | |||
:*Returns if the two locations have a common parent, filtered with the [[Keyword Script|Keyword]]. | |||
:'''Bool [[HasRefType - Location|HasRefType]](LocationRefType ''akRefType'')''' | |||
:*Returns if this location has the specified [[LocationRefType Script|LocationRefType]] | |||
:'''Bool [[IsCleared - Location|IsCleared]]()''' | |||
:*Gets whether this location is flagged as "cleared" or not. | |||
:'''Bool [[IsChild - Location|IsChild]](Location ''akOther'')''' | |||
:*Checks to see if the other location is a child of this one. | |||
:'''Bool [[IsLoaded - Location|IsLoaded]]()''' | |||
:*Is this location currently loaded? | |||
:'''Bool [[IsSameLocation - Location|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. | |||
== SKSE Member Functions == | |||
:'''Location [[GetParent - Location|GetParent]]() | |||
:*Gets the parent Location of this Location (inferred from name). | |||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] |
Latest revision as of 03:32, 3 December 2021
Extends: Form Script
Script for the manipulation of location base objects.
Definition[edit | edit source]
ScriptName Location extends Form
Properties[edit | edit source]
None
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- 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.
SKSE Member Functions[edit | edit source]
- Location GetParent()
- Gets the parent Location of this Location (inferred from name).
Events[edit | edit source]
None