Mod:Creation Kit/Location Script

Extends: Mod:Creation Kit/Form Script  Editor: Mod:Creation Kit/Location

Script for the manipulation of location base objects.

Definition
ScriptName Location extends Form Native Hidden

Properties
None

Global Functions
None

Member Functions

 * Function AddLinkedLocation(Location akLoc, Keyword akKeyword)
 * Links the given location to this one under the given keyword
 * Location[] Function GetAllLinkedLocations(Keyword akKeyword)
 * Returns an array of all locations linked to this one under the given keyword
 * 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 HasEverBeenCleared
 * Returns if this location has ever been cleared.
 * 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 IsLinkedLocation(Location akLoc, Keyword akKeyword)
 * Is this location linked to the given one under the given keyword?
 * 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 ModifyKeywordData(Keyword akKeyword, float afData)
 * Modifies the keyword's data on this location
 * Function RemoveLinkedLocation(Location akLoc, Keyword akKeyword)
 * Removes any link between this location and the given one under the given keyword
 * Function Reset
 * Flags all encounter zones and interior cells tagged to this location for forced reset.
 * 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.

F4SE Member Functions

 * EncounterZone Function GetEncounterZone(bool abRecursive = False)
 * Returns this location's encounter zone.


 * Location Function GetParent
 * Returns this location's parent.


 * Function SetEncounterZone(EncounterZone akEncounterZone)
 * Set this location's encounter zone.


 * Function SetParent(Location akLocation)
 * Set this location's parent.

Events

 * Event OnLocationCleared
 * Event received when this location is cleared, either through script or death of the last boss.
 * Event OnLocationLoaded
 * Event received when this location is loaded.