Difference between revisions of "LocationAlias Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
Line 19: Line 19:


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


'''Location Function [[GetLocation - LocationAlias|GetLocation]]()'''
{|class="wikitable" width =100%
*Attempts to retrieve the [[Location Script|Location]] that this alias is pointing at
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[Clear - LocationAlias|'''Clear'''()]]
|Clears this alias from pointing at anything.
|-


'''Function [[ForceLocationTo - LocationAlias|ForceLocationTo]](Location akNewLocation)'''
|[[GetLocation - LocationAlias|Location '''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.

Revision as of 04:10, 24 October 2013


Extends: Alias Script (Papyrus)

Script for the manipulation of location aliases.

Definition

ScriptName LocationAlias extends Alias

Properties

None

Global Functions

None

Member Functions

Function Description
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

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