GetActorsLinkedToMe - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Gets an array of instantiated Actors (across all process levels) who are linked to this reference, using a LinkedRef with the specified keyword. Skips over dead, disabled, or deleted actors. Can optionally specify a keyword for which they must NOT have a LinkedRef .

Syntax

Actor[] Function GetActorsLinkedToMe ( apLinkKeyword = None, apExcludeKeyword = None ) native

Parameters

  • apLinkKeyword: In order to be added to this array, an actor must link to this ref with a LinkedRef using this Keyword. Can be None.
    • Default: None
  • apExcludeKeyword: In order to be added to this array, an actor must NOT have a keyworded LinkedRef that uses this Keyword. (If None, don't exclude on the basis of any keyword.)
    • Default: None

Return Value

An array of all instantiated Actors (across all process levels) who are linked to this reference, using a LinkedRef with the specified keyword (and who meet the exclude keyword criteria, if one is provided).

Examples

;Get a list of all instantiated (across all process levels) non-"lookout" Actors linked to the "turf" reference "Warehouse101Ref" via the "Turf" TurfKeyword
Actor[] warehouseActors = Warehouse101Ref.GetActorsLinkedToMe( TurfKeyword, LookoutKeyword )

See Also