ReferenceAlias Script

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search


Extends: Alias Script

Script for the manipulation of reference aliases.

Definition[edit | edit source]

ScriptName ReferenceAlias extends Alias Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

  • Function ApplyToRef(ObjectReference akRef)
    • Puts the data from this data alias onto the given ref without putting the ref into the alias on the quest.
  • Function Clear()
    • Clears this alias from pointing at anything.
  • bool Function ForceRefIfEmpty(ObjectReference akNewRef)
    • Tries to force a reference into the alias, but only if it's already empty.
  • Function ForceRefTo(ObjectReference akNewRef)
  • Actor Function GetActorRef()
    • Alias for GetActorReference().
  • Actor Function GetActorReference()
  • ObjectReference Function GetRef()
    • Alias for GetReference().
  • ObjectReference Function GetReference()
  • Function RemoveFromRef(ObjectReference akRef)
    • Removes the data from this data alias from the given ref if the ref is not in the alias on the quest.
  • bool Function TryToAddToFaction(Faction FactionToAddTo)
    • Attempts to add the reference this alias points to to a faction
  • bool Function TryToClear()
    • Attempts to clear this alias
  • bool Function TryToDisable()
    • Attempts to disable the reference this alias points at
  • bool Function TryToDisableNoWait()
    • Attempts to disable the reference this alias points at (the no-wait version)
  • bool Function TryToEnable()
    • Attempts to enable the reference this alias points at
  • bool Function TryToEnableNoWait()
    • Attempts to enable the reference this alias points at (no-wait version)
  • bool Function TryToEvaluatePackage()
    • Attempts to get the actor this alias points at to re-evaluate his package stack
  • float Function TryToGetValue(ActorValue ActorValueToGet)
    • Attempts to get the value of an actor value (only works on actors)
  • bool Function TryToKill()
    • Attempts to kill the actor this alias points at
  • bool Function TryToMoveTo(ObjectReference RefToMoveTo)
    • Attempts to move the reference this alias points to to the target reference
  • bool Function TryToRemoveFromFaction(Faction FactionToRemoveFrom)
    • Attempts to remove the reference this alias points to from a faction
  • bool Function TryToReset()
    • Attempts to reset the reference this alias points at
  • bool Function TryToSetValue(ActorValue akAV, float afValue)
    • Attempts to set the value of an actor value (only works on actors)
  • bool Function 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.