Background for Fallout 4

RefCollectionAlias


Inheritance Tree

No indexed scripts extend this script.

Structs
Properties
Events
Functions
voidfunctionAddToFaction(FactionakFaction)

Calls Actor.AddToFaction(...) on all the actors in the collection

voidfunctionBlockActivation(boolabBlocked=true, boolabHideActivateText=false)

Calls ObjectReference.BlockActivation(...) on all the references in the collection

ActorfunctionGetActorAt(intaiIndex)

kmk
convenience function - casts the reference at aiIndex as an actor before returning it

Returns first reference in collection that is owned by the specified actor

voidfunctionEnableAll(boolbFadeIn=false)

Calls ObjectReference.EnableNoWait(...) on all the references in the collection.

voidfunctionDisableAll(boolbFadeOut=false)

Calls ObjectReference.DisableNoWait(...) on all the references in the collection.

voidfunctionEvaluateAll()

Calls Actor.EvaluatePackage(...) on all the actors in the collection.

voidfunctionMoveAllTo(ObjectReferenceakTarget)

Calls ObjectReference.MoveTo(...) on all the references in the collection.

boolfunctionIsOwnedObjectInList(ActoractorOwner)

Returns true if actorOwner owns anything in the collection

voidfunctionKillAll(ActorakKiller=NONE)

Kills all the actors in this collection

voidfunctionStartCombatAll(ActorakCombatTarget)

Calls Actor.StartCombat(...) on all the actors in the collection.

voidfunctionRemoveFromFaction(FactionakFaction)

Calls Actor.RemoveFromFaction(...) on all the actors in the collection

voidfunctionRemoveFromAllFactions()

Calls Actor.RemoveFromAllFactions() on all the actors in the collection.

voidfunctionResetAll()

Calls ObjectReference.Reset(...) on all the references in the collection.

voidfunctionSetProtected(boolbSetProtected=true)

Calls Actor.SetProtected(...) on all the actors in the collection.

voidfunctionSetEssential(boolbSetEssential=true)

Calls Actor.SetEssential(...) on all the actors in the collection.

voidfunctionAddRefCollection(RefCollectionAliasrefCollectionAliasToAdd)

Adds the contents of the passed-in collection alias to this one.

voidfunctionAddArray(ObjectReference[]refArrayToAdd)

Adds the contents of the array to this collection.

voidfunctionSetValue(ActorValueakActorValue, floatfValue)

Calls ObjectReference.SetValue(...) on all the actors in the collection.

boolfunctionLinkCollectionTo(RefCollectionAliasLinkedRefCollectionAlias, KeywordLinkKeyword=NONE, boolWrapLinks=false)

LinkRefs each index of the RefCollectionAlias to the same index of the target RefCollectionAlias using the keyword specified. Can be set to wrap to the top of the target RefCollectionAlias if it runs out of indexes before the colleciton this is called on.

voidfunctionAddRef(ObjectReferenceakNewRef)Native

Adds the given ref to this collection

intfunctionFind(ObjectReferenceakFindRef)Native

Searches for the specified form in the form list, returning its index (or a negative number if the form isn't found in the list)

ObjectReferencefunctionGetAt(intaiIndex)Native

Gets the ref at the given index in this collection

intfunctionGetCount()Native

Gets the number of refs in this collection

voidfunctionRemoveAll()Native

Clears all references out of this collection. Will error if this alias is not optional.

voidfunctionRemoveRef(ObjectReferenceakRemoveRef)Native

Removes the given reference from this collection

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.