Editing ReferenceAlias Script

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]

'''Extends:''' [[Alias Script]]

Script for the manipulation of reference aliases.

== Definition ==
<syntaxhighlight lang="papyrus">
ScriptName ReferenceAlias extends Alias
</syntaxhighlight>

== Properties ==
None

== Global Functions ==
None

== Member Functions ==

:'''[[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form ''akFilter'')'''
:*Adds an inventory event filter to this alias.

:'''[[Clear - ReferenceAlias|Clear]]()'''
:*Clears this alias from pointing at anything.

:'''Bool [[ForceRefIfEmpty - ReferenceAlias|ForceRefIfEmpty]](ObjectReference ''akNewRef'')'''
:*Tries to force a reference into the alias, but only if it's already empty.

:'''[[ForceRefTo - ReferenceAlias|ForceRefTo]](ObjectReference ''akNewRef'')'''
:*Forces this alias to use the specified [[ObjectReference Script|ObjectReference]]

:'''Actor [[GetActorReference - ReferenceAlias|GetActorRef]]()'''
:*Shorthand for GetActorReference().

:'''Actor [[GetActorReference - ReferenceAlias|GetActorReference]]()'''
:*Shorthand for GetReference() as [[Actor Script|Actor]].

:'''ObjectReference [[GetReference - ReferenceAlias|GetRef]]()'''
:*Shorthand for GetReference().

:'''ObjectReference [[GetReference - ReferenceAlias|GetReference]]()'''
:*Attempts to retrieve the [[ObjectReference Script|ObjectReference]] that this alias is pointing at

:'''[[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]()'''
:*Remove all inventory event filters on this alias.

:'''[[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form ''akFilter'')'''
:*Remove a specific inventory event filter.

:'''Bool [[TryToAddToFaction - ReferenceAlias|TryToAddToFaction]](Faction ''FactionToAddTo'')'''
:*Attempts to add the reference this alias points to to a faction

:'''Bool [[TryToClear - ReferenceAlias|TryToClear]]()'''
:*Attempts to clear this alias

:'''Bool [[TryToDisable - ReferenceAlias|TryToDisable]]()'''
:*Attempts to disable the reference this alias points at

:'''Bool [[TryToDisableNoWait - ReferenceAlias|TryToDisableNoWait]]()'''
:*Attempts to disable the reference this alias points at (the no-wait version)

:'''Bool [[TryToEnable - ReferenceAlias|TryToEnable]]()'''
:*Attempts to enable the reference this alias points at

:'''Bool [[TryToEnableNoWait - ReferenceAlias|TryToEnableNoWait]]()'''
:*Attempts to enable the reference this alias points at (no-wait version)

:'''Bool [[TryToEvaluatePackage - ReferenceAlias|TryToEvaluatePackage]]()'''
:*Attempts to get the actor this alias points at to re-evaluate his package stack

:'''Bool [[TryToKill - ReferenceAlias|TryToKill]]()'''
:*Attempts to kill the actor this alias points at

:'''Bool [[TryToMoveTo - ReferenceAlias|TryToMoveTo]](ObjectReference ''RefToMoveTo'')'''
:*Attempts to move the reference this alias points to to the target reference

:'''Bool [[TryToRemoveFromFaction - ReferenceAlias|TryToRemoveFromFaction]](Faction ''FactionToRemoveFrom'')'''
:*Attempts to remove the reference this alias points to from a faction

:'''Bool [[TryToReset - ReferenceAlias|TryToReset]]()'''
:*Attempts to reset the reference this alias points at

:'''Bool [[TryToStopCombat - ReferenceAlias|TryToStopCombat]]()'''
:*Attempts to remove the actor this alias points at from combat

== Events ==

* ReferenceAliases receive [[ObjectReference Script#Events|events]] from the [[ObjectReference Script|ObjectReference]] they are pointing at.
* ReferenceAliases may also receive [[Actor Script#Events|additional events]] if they are pointing at an [[Actor Script|Actor]].
* ReferenceAliases do not inherit events registered to their internal objects, only the mirrored registration functions available from the [[Alias Script]]
* aliases do not necessarily inherit all events from their contained objects or actors - IE OnTranslationComplete() will not work

== Special Edition Exclusive Events ==

'''[[OnLycanthropyStateChanged - ReferenceAlias|OnLycanthropyStateChanged]](Bool ''abIsWerewolf'')'''
*Event received when the lycanthropy state of this actor changes

'''[[OnPlayerFastTravelEnd - ReferenceAlias|OnPlayerFastTravelEnd]](Float ''afTravelGameTimeHours'')'''
*Event received when the player finishes fast travel.

'''[[OnVampirismStateChanged - ReferenceAlias|OnVampirismStateChanged]](bool ''abIsVampire'')'''
*Event received when the vampirism state of this actor changes

'''[[OnVampireFeed - ReferenceAlias|OnVampireFeed]](Actor ''akTarget'')'''
*Event received when this actor feeds on another, as a vampire