Background for Skyrim SE

ReferenceAlias


Inheritance Tree
ScriptExtended By
Properties
Events
Functions
voidfunctionAddInventoryEventFilter(FormakFilter)Native

Add an inventory event filter to this alias. Item added/removed events matching the
specified form (or in the specified form list) will now be let through.

voidfunctionClear()Native

Clears any reference out of this alias. Will error if this alias is not optional.

Attempts to retrive the object reference this alias is pointing at. If it has not been resolved to a reference, it will return None.

voidfunctionForceRefTo(ObjectReferenceakNewRef)Native

Forces this alias to use the specified reference.

voidfunctionRemoveAllInventoryEventFilters()Native

Remove all inventory event filters from this alias - all item added/removed events will now be received

voidfunctionRemoveInventoryEventFilter(FormakFilter)Native

Remove an inventory event filter from this alias. Item added/removed events matching the
specified form (or in the specified form list) will no longer be let through.

boolfunctionForceRefIfEmpty(ObjectReferenceakNewRef)

Forces this alias to use the specified reference, but only if the alias is currently empty

Attempts to retrieve the actor this alias is pointing at. If it has not been resolved to a reference, or the reference is not an Actor, it will return None.

Attempts to retrive the object reference this alias is pointing at. If it has not been resolved to a reference, it will return None.

Attempts to retrieve the actor this alias is pointing at. If it has not been resolved to a reference, or the reference is not an Actor, it will return None.

boolfunctionTryToAddToFaction(FactionFactionToAddTo)

This is a convenient way to add an actor in an alias to a faction without calling ReferenceAlias.GetActorReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call Actor.AddToFaction(...) on them without having to test for a reference being present first.

boolfunctionTryToRemoveFromFaction(FactionFactionToRemoveFrom)

This is a convenient way to remove an actor in an alias from a faction without calling ReferenceAlias.GetActorReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call Actor.RemoveFromFaction(...) on them without having to test for a reference being present first.

boolfunctionTryToStopCombat()

This is a convenient way to have an actor in an alias stop combat without calling ReferenceAlias.GetActorReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call Actor.StopCombat() on them without having to test for an actor being present first.

boolfunctionTryToDisable()

This is a convenient way to disable a reference in an alias without calling ReferenceAlias.GetReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call ObjectReference.Disable(...) on them without having to test for a reference being present first.

boolfunctionTryToDisableNoWait()

This is a convenient way to disable a reference (without waiting for it to diable) in an alias without calling ReferenceAlias.GetReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call ObjectReference.DisableNoWait(...) on them without having to test for a reference being present first.

boolfunctionTryToEnable()

This is a convenient way to enable a reference in an alias without calling ReferenceAlias.GetReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call ObjectReference.Enable(...) on them without having to test for a reference being present first.

boolfunctionTryToEnableNoWait()

This is a convenient way to enable a reference (without waiting on it to finish enabling) in an alias without calling ReferenceAlias.GetReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call ObjectReference.EnableNoWait(...) on them without having to test for a reference being present first.

boolfunctionTryToEvaluatePackage()

This is a convenient way to tell an actor in an alias to reevaluate his package stack without calling ReferenceAlias.GetActorReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call Actor.EvaluatePackage() on them without having to test for an actor being present first.

boolfunctionTryToKill()

This is a convenient way to kill an actor in an alias without calling ReferenceAlias.GetActorReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call Actor.Kill(...) on them without having to test for an actor being present first.

boolfunctionTryToMoveTo(ObjectReferenceRefToMoveTo)

This is a convenient way to move a reference in an alias without calling ReferenceAlias.GetReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call ObjectReference.MoveTo(...) on them without having to test for a object reference being present first.

boolfunctionTryToReset()

This is a convenient way to reset a reference in an alias without calling ReferenceAlias.GetReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call ObjectReference.Reset(...) on them without having to test for a reference being present first.

boolfunctionTryToClear()

Clears this alias and returns whether anything was in it to begin with.

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.