LocationAlias Script

From the CreationKit Wiki
Jump to navigation Jump to search


Extends: Alias Script (Papyrus)

Script for the manipulation of location aliases.

Definition[edit | edit source]

ScriptName LocationAlias extends Alias

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

Clear()
  • Clears this alias from pointing at anything.
Location GetLocation()
  • Attempts to retrieve the Location that this alias is pointing at
ForceLocationTo(Location akNewLocation)
  • Forces this alias to point at the specified Location.

Events[edit | edit source]

Will receive every event from the Location they are attached to.

  • a Misleading statement, locations have no events. Locations aliases can be set to FILL on location changes via alias settings - wherein most actual interaction with these sorts of aliases is handled.
  • the ONLY event these aliases will ever receive are those listed are those registered for via Alias Script, and most are inapplicable.
  • Location aliases, like reference aliases, do not receive updates registered to the forms contained within the alias.
  • Almost all interaction that is not handled in the quest alias data window is handled via external references to the contents of these alias
If (SomeQuest.GetAlias(3) as LocationAlias).GetLocation() == SomeLocation
;We're in the right location!
Endif