CountActors - EncounterZone | Fallout 4

Found in:

Vanilla
F4SE

intfunctionCountActors(KeywordapRequiredLinkedRefKeyword=NONE, KeywordapExcludeLinkedRefKeyword=NONE)Native

Description

Wiki Description

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

Documentation Comment

Get the count 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.)
(NOTE: if you're also necessarily going to call GetActors, just do that and check its size, instead of calling this.)

[DEV SERVER] Loading description...

Caveats

Parameters

KeywordapRequiredLinkedRefKeyword=NONE

CK Wiki Description

If specified, Actors MUST have a LinkedRef using this Keyword, in order to be counted. If None, don't require any linkedref.

Default:None

KeywordapExcludeLinkedRefKeyword=NONE

CK Wiki Description

If specified, SKIP OVER Actors that have a LinkedRef using this Keyword when doing the count. If None, don't exclude on the basis of any linkedref.

Default:None

Examples

;Count the number of instantiated non-"lookout" Actors (across all process levels) in the encounter zone "Warehouse101"
int actorCount = Warehouse101Zone.CountActors( None, LookoutKeyword );Count the number of instantiated non-"lookout" Actors (across all process levels) in the encounter zone "Warehouse101"
int actorCount = Warehouse101Zone.CountActors( None, LookoutKeyword )

Auto-Generated Example

Keyword myKeyword__apRequiredLinkedRefKeyword
Keyword myKeyword__apExcludeLinkedRefKeyword

int returnedValue = myEncounterZone__toCallFunctionOn.CountActors(myKeyword__apRequiredLinkedRefKeyword, myKeyword__apExcludeLinkedRefKeyword)Keyword myKeyword__apRequiredLinkedRefKeyword
Keyword myKeyword__apExcludeLinkedRefKeyword

int returnedValue = myEncounterZone__toCallFunctionOn.CountActors(myKeyword__apRequiredLinkedRefKeyword, myKeyword__apExcludeLinkedRefKeyword)

EncounterZone
EncounterZone.GetActors(...)

Additional References

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

Description

Wiki Description

Documentation Comment

Caveats

Parameters

KeywordapRequiredLinkedRefKeyword=NONE

CK Wiki Description

KeywordapExcludeLinkedRefKeyword=NONE

CK Wiki Description

Examples

Auto-Generated Example

Related Pages

Additional References

Description

Wiki Description

Documentation Comment