The Location Script

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

No properties found.

• Found in:
  • Vanilla

  eventOnLocationExplored()

  Event sent to location when its explored

• Found in:
  • Vanilla

  eventOnLocationLoaded()

  Event called when the Location is loaded.

• Found in:
  • Vanilla

  voidfunctionAddKeyword(KeywordakKeyword)Native

  Adds the specified keyword to the location

• Found in:
  • Vanilla

  voidfunctionAddLinkedLocation(LocationakLoc, KeywordakKeyword)Native

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

• Found in:
  • Vanilla

  intfunctionCountActors(KeywordapRequiredLinkedRefKeyword=NONE, KeywordapExcludeLinkedRefKeyword=NONE)Native

  Get the count of all instantiated Actors (across all process levels) who belong to this location.
  Can optionally specify a keyword for a linkedref that they must have (apRequiredLinkedRefKeyword), and/or a linkedref keyword they must NOT have (apExcludeLinkedRefKeyword).
  (Presence or absence of the keywordless linkedref cannot be checked.)
  (NOTE: if you're also necessarily going to call GetActors, just do that and check its size, instead of calling this.)

• Found in:
  • Vanilla

  boolfunctionDisableSpaceTravelToAllExcept(QuestakQuest, boolabAddLocation=true)Native

  Disables player space travel to all locations except the specified location. Can call on multiple locations.

• Found in:
  • Vanilla

  boolfunctionEnableSpaceTravel(QuestakQuest, boolabEnable=true)Native

  Enables player space travel to the specified location.

• Found in:
  • Vanilla

  Actor[]functionGetActors(KeywordapRequiredLinkedRefKeyword=NONE, KeywordapExcludeLinkedRefKeyword=NONE)Native

  Get an array of all instantiated Actors (across all process levels) who belong to this location.
  Can optionally specify a keyword for a linkedref that they must have (apRequiredLinkedRefKeyword), and/or a linkedref keyword they must NOT have (apExcludeLinkedRefKeyword).
  (Presence or absence of the keywordless linkedref cannot be checked.)

• Found in:
  • Vanilla

  Location[]functionGetAllLinkedLocations(KeywordakKeyword)Native

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

• Found in:
  • Vanilla

  PlanetfunctionGetCurrentPlanet()Native

  Returns this location's planet

• Found in:
  • Vanilla

  floatfunctionGetKeywordData(KeywordakKeyword)Native

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

• Found in:
  • Vanilla

  intfunctionGetMinLevel()Native

  Gets this location's minimum level

• Found in:
  • Vanilla

  intfunctionGetMaxLevel()Native

  Gets this location's maximum level

• Found in:
  • Vanilla

  Location[]functionGetParentLocations(KeywordapKeyword=NONE)Native

  Gets this location's parent locations
  Can optionally specify a keyword that the parent location must have

• Found in:
  • Vanilla

  intfunctionGetRefTypeAliveCount(LocationRefTypeakRefType)Native

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

• Found in:
  • Vanilla

  intfunctionGetRefTypeDeadCount(LocationRefTypeakRefType)Native

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

• Found in:
  • Vanilla

  floatfunctionGetValue(ActorValueakActorValue)Native

  Gets an actor value on location

• Found in:
  • Vanilla

  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

  boolfunctionHasEverBeenExplored()Native

  Returns if this location has ever been explored

• Found in:
  • Vanilla

  boolfunctionHasRefType(LocationRefTypeakRefType)Native

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

• Found in:
  • Vanilla

  boolfunctionIsExplored()Native

  Returns whether this location is flagged as "explored" or not

• Found in:
  • Vanilla

  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

  boolfunctionIsLinkedLocation(LocationakLocation, KeywordakKeyword)Native

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

• Found in:
  • Vanilla

  boolfunctionIsLoaded()Native

  Returns if this location is loaded or not.

• Found in:
  • Vanilla

  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

  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

  voidfunctionRemoveKeyword(KeywordakKeyword)Native

  Removed the specified keyword from the location

• Found in:
  • Vanilla

  voidfunctionRemoveLinkedLocation(LocationakLoc, KeywordakKeyword)Native

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

• Found in:
  • Vanilla

  voidfunctionReset()Native

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

• Found in:
  • Vanilla

  voidfunctionSetKeywordData(KeywordakKeyword, floatafData)Native

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

• Found in:
  • Vanilla

  voidfunctionSetExplored(boolabExplored=true)Native

  Sets this location as explored or not

• Found in:
  • Vanilla

  voidfunctionSetFactionOwner(FactionakFaction)Native

  Set the given faction as the faction owner for this location

• Found in:
  • Vanilla

  voidfunctionSetMinLevel(intaiMinLevel)Native

  Sets this encounter zone's minimum level

• Found in:
  • Vanilla

  voidfunctionSetMaxLevel(intaiMaxLevel)Native

  Sets this encounter zone's maximum level

• Found in:
  • Vanilla

  voidfunctionSetNeverResets(boolabFlag=true)Native

  Forces the value of the never reset flag on this location

• Found in:
  • Vanilla

  voidfunctionSetValue(ActorValueakActorValue, floatafValue)Native

  Sets an actor value on location

• Found in:
  • Vanilla

  voidfunctionModValue(ActorValueakActorValue, floatafAmount)