Difference between revisions of "ReferenceAlias Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>Texashokies
(Added a Special Edition Exclusive section and added events relevant to the section.)
 
(5 intermediate revisions by 2 users not shown)
Line 19: Line 19:


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


'''Function [[Clear - ReferenceAlias|Clear]]()'''
:'''[[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form ''akFilter'')'''
*Clears this alias from pointing at anything.
:*Adds an inventory event filter to this alias.


'''bool Function [[ForceRefIfEmpty - ReferenceAlias|ForceRefIfEmpty]](ObjectReference akNewRef)'''
:'''[[Clear - ReferenceAlias|Clear]]()'''
*Tries to force a reference into the alias, but only if it's already empty.
:*Clears this alias from pointing at anything.


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


'''Actor Function [[GetActorReference - ReferenceAlias|GetActorRef]]()'''
:'''[[ForceRefTo - ReferenceAlias|ForceRefTo]](ObjectReference ''akNewRef'')'''
*Alias for GetActorReference().
:*Forces this alias to use the specified [[ObjectReference Script|ObjectReference]]


'''Actor Function [[GetActorReference - ReferenceAlias|GetActorReference]]()'''
:'''Actor [[GetActorReference - ReferenceAlias|GetActorRef]]()'''
*Retrieves the alias's [[ObjectReference Script|ObjectReference]] cast as an [[Actor Script|Actor]].
:*Shorthand for GetActorReference().


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


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


'''Function [[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]()'''
:'''ObjectReference [[GetReference - ReferenceAlias|GetReference]]()'''
*Remove all inventory event filters on this alias.
:*Attempts to retrieve the [[ObjectReference Script|ObjectReference]] that this alias is pointing at


'''Function [[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form akFilter)'''
:'''[[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]()'''
*Remove a specific inventory event filter.
:*Remove all inventory event filters on this alias.


'''bool Function [[TryToAddToFaction - ReferenceAlias|TryToAddToFaction]](Faction FactionToAddTo)'''
:'''[[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form ''akFilter'')'''
*Attempts to add the reference this alias points to to a faction
:*Remove a specific inventory event filter.


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


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


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


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


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


'''bool Function [[TryToEvaluatePackage - ReferenceAlias|TryToEvaluatePackage]]()'''
:'''Bool [[TryToEnableNoWait - ReferenceAlias|TryToEnableNoWait]]()'''
*Attempts to get the actor this alias points at to re-evaluate his package stack
:*Attempts to enable the reference this alias points at (no-wait version)


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


'''bool Function [[TryToMoveTo - ReferenceAlias|TryToMoveTo]](ObjectReference RefToMoveTo)'''
:'''Bool [[TryToKill - ReferenceAlias|TryToKill]]()'''
*Attempts to move the reference this alias points to to the target reference
:*Attempts to kill the actor this alias points at


'''bool Function [[TryToRemoveFromFaction - ReferenceAlias|TryToRemoveFromFaction]](Faction FactionToRemoveFrom)'''
:'''Bool [[TryToMoveTo - ReferenceAlias|TryToMoveTo]](ObjectReference ''RefToMoveTo'')'''
*Attempts to remove the reference this alias points to from a faction
:*Attempts to move the reference this alias points to to the target reference


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


'''bool Function [[TryToStopCombat - ReferenceAlias|TryToStopCombat]]()'''
:'''Bool [[TryToReset - ReferenceAlias|TryToReset]]()'''
*Attempts to remove the actor this alias points at from combat
:*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 ==
== Events ==
Line 89: Line 90:


ReferenceAliases may also receive [[Actor Script#Events|additional events]] if they are pointing at an [[Actor Script|Actor]].
ReferenceAliases may also receive [[Actor Script#Events|additional events]] if they are pointing at an [[Actor Script|Actor]].
== 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

Latest revision as of 20:11, 3 October 2017


Extends: Alias Script

Script for the manipulation of reference aliases.

Definition[edit | edit source]

ScriptName ReferenceAlias extends Alias

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

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)
Actor GetActorRef()
  • Shorthand for GetActorReference().
Actor GetActorReference()
  • Shorthand for GetReference() as Actor.
ObjectReference GetRef()
  • Shorthand for GetReference().
ObjectReference GetReference()
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[edit | edit source]

ReferenceAliases receive events from the ObjectReference they are pointing at.

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

Special Edition Exclusive Events[edit | edit source]

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
Retrieved from "https://ck.uesp.net/w/index.php?title=ReferenceAlias_Script&oldid=14745"