DisableLinkChain - ObjectReference

Revision as of 14:54, 11 November 2011 by imported>Scornett (Reverted edits by Scornett-Bot (talk) to last revision by Jlundin)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ObjectReference Script

This function disables all the linked refs, linked in a chain, from this reference.

Syntax

Function DisableLinkChain(Keyword apKeyword = None)

Parameters

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

Return Value

None

Examples

; Disable every ref linked to startRef in a chain
startRef.DisableLinkChain()


; disable every ref linked to startRef using the special keyword
startRef.DisableLinkChain(SpecialKeyword)

Notes

Do not use this on a link chain that is linked in a loop or it will cause an endless loop.

See Also