GetRefsLinkedToMe - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Gets an array of all instantiated ObjectReferences that are linked to this reference, using a LinkedRef with the specified keyword. Can optionally specify a keyword for which they must NOT have a LinkedRef.

Syntax

ObjectReference[] Function GetRefsLinkedToMe(Keyword apLinkKeyword = None, Keyword apExcludeKeyword = None) native

Parameters

  • apLinkKeyword: In order to be added to this array, an ObjectReference 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 ObjectReference 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 ObjectReferences that are linked to this reference, using a LinkedRef with the specified keyword (and that meet the exclude keyword criteria, if one is provided).

Examples

;Get a list of all instantiated non-"lookout" ObjectReferences linked to the "turf" reference "Warehouse101Ref" via the "Turf" TurfKeyword
ObjectReference[] warehouseRefs = Warehouse101Ref.GetRefsLinkedToMe( TurfKeyword, LookoutKeyword )

See Also