Difference between revisions of "LocationAlias Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Rhavlovick
m (1 revision: Clobber re-import by Henning)
 
imported>Jog
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
*Function [[Clear - LocationAlias|Clear]]()
'''Function [[Clear - LocationAlias|Clear]]()'''
**Clears this alias from pointing at anything.
*Clears this alias from pointing at anything.
*Location Function [[GetLocation - LocationAlias|GetLocation]]()
 
**Attempts to retrieve the [[Location Script|Location]] that this alias is pointing at
'''Location Function [[GetLocation - LocationAlias|GetLocation]]()'''
*Function [[ForceLocationTo - LocationAlias|ForceLocationTo]](Location akNewLocation)
*Attempts to retrieve the [[Location Script|Location]] that this alias is pointing at
**Forces this alias to point at the specified [[Location Script|Location]].
 
'''Function [[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.

Revision as of 12:52, 20 February 2012


Extends: Alias Script (Papyrus)

Script for the manipulation of location aliases.

Definition

ScriptName LocationAlias extends Alias

Properties

None

Global Functions

None

Member Functions

Function Clear()

  • Clears this alias from pointing at anything.

Location Function GetLocation()

  • Attempts to retrieve the Location that this alias is pointing at

Function ForceLocationTo(Location akNewLocation)

  • Forces this alias to point at the specified Location.

Events

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