RefCollectionAlias

Found in:

Vanilla

Inheritance Tree

No indexed scripts extend this script.

Structs

Properties

Events

Functions

Found in:

Vanilla

voidfunctionAddToFaction(FactionakFaction)

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

Found in:

Vanilla

voidfunctionBlockActivation(boolabBlocked=true, boolabHideActivateText=false)

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

Found in:

Vanilla

ActorfunctionGetActorAt(intaiIndex)

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

Found in:

Vanilla

SpaceshipReferencefunctionGetShipAt(intaiIndex)

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

Found in:

Vanilla

ObjectReferencefunctionGetRandom()

jduvall
convenience function
return a random reference

Found in:

Vanilla

ObjectReference[]functionGetRandomObjects(intaiNumberToGet=0)

joshua.mcqueary
Gets a random number of things from the collection

Found in:

Vanilla

ObjectReferencefunctionGetFirstOwnedObject(ActoractorOwner)

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

Found in:

Vanilla

voidfunctionEnableAll(boolbFadeIn=false)

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

Found in:

Vanilla

voidfunctionDisableAll(boolbFadeOut=false)

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

Found in:

Vanilla

voidfunctionEvaluateAll()

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

Found in:

Vanilla

voidfunctionMoveAllTo(ObjectReferenceakTarget)

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

Found in:

Vanilla

voidfunctionMoveAllToPackageLocation()

sc
Move all actors to packages locations.

Found in:

Vanilla

boolfunctionIsOwnedObjectInList(ActoractorOwner)

Returns true if actorOwner owns anything in the collection

Found in:

Vanilla

boolfunctionIsDetectedBy(ActordetectionTarget)

kmk
return true if detectionTarget is detected by any actor in the collection

Found in:

Vanilla

boolfunctionHasDetectionLOS(ActoractorTarget)

kmk
return true if any actor in the collection has detection LOS on actorTarget

Found in:

Vanilla

voidfunctionSetOpen(boolabOpen=true)

sc
Open or close all refs.

Found in:

Vanilla

voidfunctionLock(boolabLock=true, boolabAsOwner=false, boolabTraverseLinkedLockables=true)

kmk
lock/unlock all refs

Found in:

Vanilla

voidfunctionKillAll(ObjectReferenceakKiller=NONE)

Kills all the actors in this collection

Found in:

Vanilla

voidfunctionStartCombatAll(ObjectReferenceakCombatTarget)

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

Found in:

Vanilla

voidfunctionRemoveFromFaction(FactionakFaction)

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

Found in:

Vanilla

voidfunctionRemoveFromAllFactions()

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

Found in:

Vanilla

voidfunctionResetAll()

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

Found in:

Vanilla

voidfunctionSetGhost(boolbSetGhost=true)

wjs
convenenience function - set ghost on everyone

Found in:

Vanilla

voidfunctionSetProtected(boolbSetProtected=true)

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

Found in:

Vanilla

voidfunctionSetEssential(boolbSetEssential=true)

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

Found in:

Vanilla

voidfunctionStopCombat()

bsn
convenience function - stops combat on everyone

Found in:

Vanilla

voidfunctionStopCombatAlarm()

convenience function - stop combat alarm on everyone

Found in:

Vanilla

voidfunctionAddRefCollection(RefCollectionAliasrefCollectionAliasToAdd)

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

Found in:

Vanilla

voidfunctionRemoveRefCollection(RefCollectionAliasrefCollectionAliasToRemove)

Found in:

Vanilla

voidfunctionAddArray(ObjectReference[]refArrayToAdd)

Adds the contents of the array to this collection.

Found in:

Vanilla

intfunctionGetCountDead()

jduvall
Get count of dead actors in Collection

Found in:

Vanilla

intfunctionGetCountDeadOr3DUnloaded()

jduvall
Get count of dead actors and/or unloaded refs in Collection

Found in:

Vanilla

intfunctionGetCountAliveAnd3DLoaded()

jduvall
Get count of dead actors and unloaded refs in Collection

Found in:

Vanilla

intfunctionGetCountDisabled()

kmk
Get count of disabled refs in Collection

Found in:

Vanilla

intfunctionRemoveDisabled()

kmk
remove disabled refs in Collection
returns number of refs removed

Found in:

Vanilla

voidfunctionSetValue(ActorValueakActorValue, floatfValue)

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

Found in:

Vanilla

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.

Found in:

Vanilla

voidfunctionSetUnconscious(boolabUnconscious=true)

lvc Set the conscious/unconscious state of a ref collection

Found in:

Vanilla

voidfunctionAddRef(ObjectReferenceakNewRef)Native

Adds the given ref to this collection

Found in:

Vanilla

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)

Found in:

Vanilla

ObjectReference[]functionGetArray()Native

Gets an array of all refs in the collection

Found in:

Vanilla

Actor[]functionGetActorArray()Native

Gets an array of all actors in the collection

Found in:

Vanilla

ObjectReferencefunctionGetAt(intaiIndex)Native

Gets the ref at the given index in this collection

Found in:

Vanilla

intfunctionGetCount()Native

Gets the number of refs in this collection

Found in:

Vanilla

voidfunctionRemoveAll()Native

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

Found in:

Vanilla

voidfunctionRemoveRef(ObjectReferenceakRemoveRef)Native

Removes the given reference from this collection