Mod:Creation Kit/RefCollectionAlias Script

Extends: Mod:Creation Kit/Alias Script

Script for the manipulation of reference collection aliases.

Definition
ScriptName RefCollectionAlias extends Alias Native Hidden

Properties
None

Global Functions
None

Member Functions

 * Function AddArray(ObjectReference[] refArrayToAdd)
 * Adds every ref in the array to this collection.
 * Function AddRef(ObjectReference akNewRef)
 * Adds the given ref to this ref collection
 * Function AddRefCollection(RefCollectionAlias refCollectionAliasToAdd)
 * Adds every ref in the passed-in collection to this one.
 * Function AddToFaction(faction akFaction)
 * Calls AddToFaction on all the actors in the collection
 * Function BlockActivation(bool abBlocked, bool abHideActivateText)
 * Block/unblock activation on all refs in the collection
 * Function DisableAll(bool bFadeOut)
 * Disables all refs in the collection
 * Function EnableAll(bool bFadeIn)
 * Enables all refs in the collection
 * Function EvaluateAll
 * Evaluate packages on all actors in the collection
 * int Function Find(ObjectReference akFindRef)
 * Searches for the specified reference and returns its index in the collection alias.
 * ObjectReference Function GetAt(int aiIndex)
 * Gets the ref at the specified index in the collection
 * int Function GetCount
 * Gets the number of refs in the collection
 * ObjectReference Function GetFirstOwnedObject(Actor actorOwner)
 * return (first) owned object in collection
 * bool Function IsOwnedObjectInList(Actor actorOwner)
 * return true if actorOwner owns anything in the collection
 * Function KillAll(actor akKiller)
 * Calls Kill on all the actors in the collection
 * bool Function LinkCollectionTo(RefCollectionAlias LinkedRefCollectionAlias, Keyword LinkKeyword, bool WrapLinks)
 * Link this collection with the other with the specified keyword.
 * Function MoveAllTo(ObjectReference akTarget)
 * Move every reference in the collection to the target.
 * Function RemoveAll
 * Empties the collection of all refs it currently contains
 * Function RemoveFromAllFactions
 * Removes each actor from all factions
 * Function RemoveFromFaction(faction akFaction)
 * Calls RemoveFromFaction on all the actors in the collection
 * Function RemoveRef(ObjectReference akRefToRemove)
 * Removes the given ref from the collection
 * Function ResetAll
 * Resets each ref in the collection
 * Function SetEssential(bool bSetEssential)
 * Sets/clears each actor's essential status
 * Function SetProtected(bool bSetProtected)
 * Sets/clears each actor's protected status
 * Function SetValue(ActorValue akActorValue, float fValue)
 * Sets the actor value on each actor in the alias (does NOT set it on non-actors)
 * Function StartCombatAll(Actor akCombatTarget)
 * Starts combat between every actor in the collection and the target.

Events
ReferenceAliases receive events from the ObjectReference they are pointing at.

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

All of these events will have the ObjectReference sender as their first argument, before any other arguments the event receives. This allows you to figure out which reference in your collection sent the event.

Example: Event OnDeath(Actor akKiller) Becomes: Event OnDeath(ObjectReference akSenderRef, Actor akKiller)