Difference between revisions of "ReferenceAlias Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>DayDreamer
m (→‎Member Functions: change Alias to Shorthand, as these are about aliases)
imported>CraftySentinel
m (→‎Member Functions: Reverted to List)
Line 20: Line 20:
== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''[[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form ''akFilter'')'''
!style="text-align:left;"|Function
:*Adds an inventory event filter to this alias.
!style="text-align:left;"|Description
|-
|[[AddInventoryEventFilter - ObjectReference|'''AddInventoryEventFilter'''(Form ''akFilter'')]]
|Adds an inventory event filter to this alias.
|-


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


== Events ==
== Events ==

Revision as of 22:57, 2 February 2014


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)
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

ReferenceAliases receive events from the ObjectReference they are pointing at.

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

Retrieved from "https://ck.uesp.net/w/index.php?title=ReferenceAlias_Script&oldid=14744"