Difference between revisions of "Location Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
(Added GetParent SKSE function)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Line 20: Line 16:
== Member Functions ==
== Member Functions ==


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


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


|[[HasCommonParent - Location|Bool '''HasCommonParent'''(Location ''akOther'', Keyword ''akFilter'')]]
:'''Bool [[HasCommonParent - Location|HasCommonParent]](Location ''akOther'', Keyword ''akFilter'')'''
|Returns if the two locations have a common parent, filtered with the [[Keyword Script|Keyword]].
:*Returns if the two locations have a common parent, filtered with the [[Keyword Script|Keyword]].
|-


|[[HasRefType - Location|Bool '''HasRefType'''(LocationRefType ''akRefType'')]]
:'''Bool [[HasRefType - Location|HasRefType]](LocationRefType ''akRefType'')'''
|Returns if this location has the specified [[LocationRefType Script|LocationRefType]]
:*Returns if this location has the specified [[LocationRefType Script|LocationRefType]]
|-


|[[IsCleared - Location|Bool '''IsCleared'''()]]
:'''Bool [[IsCleared - Location|IsCleared]]()'''
|Gets whether this location is flagged as "cleared" or not.
:*Gets whether this location is flagged as "cleared" or not.
|-


|[[IsChild - Location|Bool '''IsChild'''(Location ''akOther'')]]
:'''Bool [[IsChild - Location|IsChild]](Location ''akOther'')'''
|Checks to see if the other location is a child of this one.
:*Checks to see if the other location is a child of this one.
|-


|[[IsLoaded - Location|Bool '''IsLoaded'''()]]
:'''Bool [[IsLoaded - Location|IsLoaded]]()'''
|Is this location currently loaded?
:*Is this location currently loaded?
|-


|[[IsSameLocation - Location|Bool '''IsSameLocation'''(Location ''akOtherLocation'', Keyword ''akKeyword'')]]
:'''Bool [[IsSameLocation - Location|IsSameLocation]](Location ''akOtherLocation'', Keyword ''akKeyword'')'''
|Returns true if this location is the same as the supplied location
:*Returns true if this location is the same as the supplied location
|-


|[[SetCleared - Location|'''SetCleared'''(Bool ''abCleared'')]]
:'''[[SetCleared - Location|SetCleared]](Bool ''abCleared'')'''
|Flags this location as cleared (or not).
:*Flags this location as cleared (or not).
|-


|[[SetKeywordData - Location|'''SetKeywordData'''(Keyword ''akKeyword'', Float ''afData'')]]
:'''[[SetKeywordData - Location|SetKeywordData]](Keyword ''akKeyword'', Float ''afData'')'''
|Sets the specified [[Keyword Script|Keyword]]'s data on this location.
:*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)
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

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