ReferenceAlias Script
Revision as of 05:24, 24 October 2013 by imported>CraftySentinel (→Member Functions: Formatting Change)
Extends: Alias Script
Script for the manipulation of reference aliases.
Definition
ScriptName ReferenceAlias extends AliasProperties
None
Global Functions
None
Member Functions
| Function | Description |
|---|---|
| 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 GetActorReference() | Alias for GetActorReference(). |
| Actor GetActorReference() | Retrieves the alias's ObjectReference cast as an Actor. |
| ObjectReference GetReference() | Alias 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.