Background for Fallout 4
Member of the EncounterZone script
Actor[]functionGetActors(KeywordapRequiredLinkedRefKeyword=NONE, KeywordapExcludeLinkedRefKeyword=NONE)Native

Description

Wiki Description

Gets an array of instantiated Actors (across all process levels) who belong to this encounter zone. Skips over dead, disabled, or deleted actors. Can optionally specify a keyword they MUST have, and/or a keyword they must NOT have.

Documentation Comment

Get an array of all instantiated Actors (across all process levels) who belong to this encounter zone.
Can optionally specify a keyword for a linkedref that they must have (apRequiredLinkedRefKeyword), and/or a linkedref keyword they must NOT have (apExcludeLinkedRefKeyword).
(Presence or absence of the keywordless linkedref cannot be checked.)


Parameters

  1. KeywordapRequiredLinkedRefKeyword=NONE

    CK Wiki Description

    Keyword that actors MUST have, in order to be added to this array. If None, don't require any keyword.

    • Default:None
  2. KeywordapExcludeLinkedRefKeyword=NONE

    CK Wiki Description

    Keyword that actors must NOT have, in order to be added to this array. If None, don't exclude on the basis of any keyword.

    • Default:None

Examples

;Get a list of all instantiated Actors (across all process levels) non-"lookout" actors in the encounter zone "Warehouse101"
Actor[] warehouseActors = Warehouse101Zone.GetActors( None, LookoutKeyword )

Auto-Generated Example

Keyword myKeyword__apRequiredLinkedRefKeyword
Keyword myKeyword__apExcludeLinkedRefKeyword

Actor[] returnedValue = myEncounterZone__toCallFunctionOn.GetActors(myKeyword__apRequiredLinkedRefKeyword, myKeyword__apExcludeLinkedRefKeyword)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

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