GetLinkedRefChildren - ObjectReference

Revision as of 06:11, 7 February 2021 by imported>Scrivener07 (Just clarifying what Linked Ref Children is actually referring to.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ObjectReference Script

This function returns an array of objectreferences representing the "linked ref children" of the reference it is called on, using only those linked with the specified keyword.


SyntaxEdit

ObjectReference[] Function GetLinkedRefChildren( keyword apKeyword ) native

ParametersEdit

  • apKeyword: Keyword to check ref link against (see GetLinkedRef.)

Return ValueEdit

An array of ObjectReferences representing the references are directly linked as children to this object using the specified keyword.

ExamplesEdit

; Get all of the terminal link children of this object reference.
ObjectReference[] LinkedRefs = GetLinkedRefChildren(TerminalLinkKeyword)


; Enable the "terminal link" children refs of this object reference.
ObjectReference[] LinkedRefs = GetLinkedRefChildren(TerminalLinkKeyword)
int i = 0
while (i < LinkedRefs.length)
	LinkedRefs[i].enable()
	i += 1
endwhile

NotesEdit

  • For the uninitiated, LinkedRef "Children" means the references that appear in the Linked From area of the Object's Reference window.

See AlsoEdit