Difference between revisions of "LocationAlias Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
m (→‎Member Functions: Reverted to List)
 
(One intermediate revision by the same user not shown)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
'''Function [[Clear - LocationAlias|Clear]]()'''
*Clears this alias from pointing at anything.


'''Location Function [[GetLocation - LocationAlias|GetLocation]]()'''
:'''[[Clear - LocationAlias|Clear]]()'''
*Attempts to retrieve the [[Location Script|Location]] that this alias is pointing at
:*Clears this alias from pointing at anything.


'''Function [[ForceLocationTo - LocationAlias|ForceLocationTo]](Location akNewLocation)'''
:'''Location [[GetLocation - LocationAlias|GetLocation]]()'''
*Forces this alias to point at the specified [[Location Script|Location]].
:*Attempts to retrieve the [[Location Script|Location]] that this alias is pointing at
 
:'''[[ForceLocationTo - LocationAlias|ForceLocationTo]](Location ''akNewLocation'')'''
:*Forces this alias to point at the specified [[Location Script|Location]].


== Events ==
== Events ==
Will receive every event from the [[Location Script (Papyrus)|Location]] they are attached to.
Will receive every event from the [[Location Script (Papyrus)|Location]] they are attached to.

Latest revision as of 19:26, 2 February 2014


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.