ReferenceAlias Script

Extends: Alias Script

Script for the manipulation of reference aliases.

Definition

ScriptName ReferenceAlias extends Alias

Properties

None

Global Functions

None

Member Functions

Function AddInventoryEventFilter(Form akFilter)

• Adds an inventory event filter to this alias.

Function Clear()

• Clears this alias from pointing at anything.

bool Function ForceRefIfEmpty(ObjectReference akNewRef)

• Tries to force a reference into the alias, but only if it's already empty.

Function ForceRefTo(ObjectReference akNewRef)

• Forces this alias to use the specified ObjectReference

Actor Function GetActorRef()

• Alias for GetActorReference().

Actor Function GetActorReference()

• Retrieves the alias's ObjectReference cast as an Actor.

ObjectReference Function GetRef()

• Alias for GetReference().

ObjectReference Function GetReference()

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

Function RemoveAllInventoryEventFilters()

• Remove all inventory event filters on this alias.

Function RemoveInventoryEventFilter(Form akFilter)

• Remove a specific inventory event filter.

bool Function TryToAddToFaction(Faction FactionToAddTo)

• Attempts to add the reference this alias points to to a faction

bool Function TryToClear()

• Attempts to clear this alias

bool Function TryToDisable()

• Attempts to disable the reference this alias points at

bool Function TryToDisableNoWait()

• Attempts to disable the reference this alias points at (the no-wait version)

bool Function TryToEnable()

• Attempts to enable the reference this alias points at

bool Function TryToEnableNoWait()

• Attempts to enable the reference this alias points at (no-wait version)

bool Function TryToEvaluatePackage()

• Attempts to get the actor this alias points at to re-evaluate his package stack

bool Function TryToKill()

• Attempts to kill the actor this alias points at

bool Function TryToMoveTo(ObjectReference RefToMoveTo)

• Attempts to move the reference this alias points to to the target reference

bool Function TryToRemoveFromFaction(Faction FactionToRemoveFrom)

• Attempts to remove the reference this alias points to from a faction

bool Function TryToReset()

• Attempts to reset the reference this alias points at

bool Function TryToStopCombat()

• Attempts to remove the actor this alias points at from combat

Events

ReferenceAliases receive events from the ObjectReference they are pointing at.

ReferenceAliases may also receive additional events if they are pointing at an Actor.