The Location Script

The Papyrus Index is still under construction. Structs have not been implemented yet.

No properties found.

• Found in:
  • Vanilla
  • F4SE

  eventOnLocationCleared()

  Event called when the Location is cleared.

• Found in:
  • Vanilla
  • F4SE

  eventOnLocationLoaded()

  Event called when the Location is loaded.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionAddLinkedLocation(LocationakLoc, KeywordakKeyword)Native

  Adds a link between this location and the given one under the given keyword.

• Found in:
  • Vanilla
  • F4SE

  Location[]functionGetAllLinkedLocations(KeywordakKeyword)Native

  Returns an array of all locations linked to this one under the given keyword.

• Found in:
  • Vanilla
  • F4SE

  floatfunctionGetKeywordData(KeywordakKeyword)Native

  Obtains the data attached to the specified keyword on this location.

• Found in:
  • Vanilla
  • F4SE

  intfunctionGetRefTypeAliveCount(LocationRefTypeakRefType)Native

  Obtains the number of alive enabled references matching the specified reference type in this location.

• Found in:
  • Vanilla
  • F4SE

  intfunctionGetRefTypeDeadCount(LocationRefTypeakRefType)Native

  Obtains the number of dead enabled references matching the specified reference type in this location.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionHasCommonParent(LocationakOther, KeywordakFilter=NONE)Native

  Returns if this location and the other have a common parent (filtering with a keyword, if provided). If the locations are identical, the function will return false.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionHasEverBeenCleared()Native

  Returns if this location has ever been cleared.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionHasRefType(LocationRefTypeakRefType)Native

  Returns if this location has any unreserved refs with the specified LocationRefType.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionIsCleared()Native

  Returns if this location is flagged as cleared or not.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionIsChild(LocationakOther)Native

  Returns true if the other location is a child of this one. If they are the same location, the function returns false.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionIsLinkedLocation(LocationakLocation, KeywordakKeyword)Native

  Checks for a link between this location and the given one under the given keyword.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionIsLoaded()Native

  Returns if this location is loaded or not.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionIsSameLocation(LocationakOtherLocation, KeywordakKeyword=NONE)

  Returns true if the calling location is the same as the supplied location. Or, if an optional keyword is supplied it also returns true if the locations share a parent with that keyword, or one of the locations has the keyword and is a parent of the other.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionModifyKeywordData(KeywordakKeyword, floatafData)

  Modifies the data attached to the specified keyword on this location by adding the passed-in data to the current value, but as a single function call so it is thread-safe.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionRemoveLinkedLocation(LocationakLoc, KeywordakKeyword)Native

  Removes the link between this location and the given one under the given keyword.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionReset()Native

  Flags all encounter zones and interior cells associated with this location for forced reset.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionSetKeywordData(KeywordakKeyword, floatafData)Native

  Sets the data attached to the specified keyword on this location.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionSetCleared(boolabCleared=true)Native

  Flags or unflags this location as cleared.

• Found in:
  • F4SE

  LocationfunctionGetParent()Native

  Returns the parent location

• Found in:
  • F4SE

  voidfunctionSetParent(LocationakLocation)Native
• Found in:
  • F4SE

  EncounterZonefunctionGetEncounterZone(boolrecursive=false)Native

  Returns the locations EncounterZone, if recursive it goes up a parent until it finds an EncounterZone

• Found in:
  • F4SE

  voidfunctionSetEncounterZone(EncounterZoneez)Native

  Sets this locations encounter zone