ReferenceAlias Script

Extends: Alias Script

Script for the manipulation of reference aliases.

Definition

ScriptName ReferenceAlias extends Alias

Properties

None

Global Functions

None

Member Functions

AddInventoryEventFilter(Form akFilter)

• Adds an inventory event filter to this alias.

Clear()

• Clears this alias from pointing at anything.

Bool ForceRefIfEmpty(ObjectReference akNewRef)

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

ForceRefTo(ObjectReference akNewRef)

• Forces this alias to use the specified ObjectReference

Actor GetActorRef()

• Shorthand for GetActorReference().

Actor GetActorReference()

• Shorthand for GetReference() as Actor.

ObjectReference GetRef()

• Shorthand for GetReference().

ObjectReference GetReference()

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

RemoveAllInventoryEventFilters()

• Remove all inventory event filters on this alias.

RemoveInventoryEventFilter(Form akFilter)

• Remove a specific inventory event filter.

Bool TryToAddToFaction(Faction FactionToAddTo)

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

Bool TryToClear()

• Attempts to clear this alias

Bool TryToDisable()

• Attempts to disable the reference this alias points at

Bool TryToDisableNoWait()

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

Bool TryToEnable()

• Attempts to enable the reference this alias points at

Bool TryToEnableNoWait()

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

Bool TryToEvaluatePackage()

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

Bool TryToKill()

• Attempts to kill the actor this alias points at

Bool TryToMoveTo(ObjectReference RefToMoveTo)

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

Bool TryToRemoveFromFaction(Faction FactionToRemoveFrom)

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

Bool TryToReset()

• Attempts to reset the reference this alias points at

Bool 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.
• ReferenceAliases do not inherit OnUpdate() events from their objectreferences, they must register separately.
• ReferenceAliases do not inherit ALL Events from either object, or actor. Registration events, TranslateToEvents, animation registrations etc do not work, or work infrequently. LOS registrations work fine, with their usual caveats taken into account.

Special Edition Exclusive Events

OnLycanthropyStateChanged(Bool abIsWerewolf)

• Event received when the lycanthropy state of this actor changes

OnPlayerFastTravelEnd(Float afTravelGameTimeHours)

• Event received when the player finishes fast travel.

OnVampirismStateChanged(bool abIsVampire)

• Event received when the vampirism state of this actor changes

OnVampireFeed(Actor akTarget)

• Event received when this actor feeds on another, as a vampire