DisableLinkChain - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

This function disables all the linked refs, linked in a chain, from this reference (but not this reference). It does not wait for all of them to fade or disable before returning.

Syntax

Function DisableLinkChain(Keyword apKeyword = None, bool abFadeOut = false) native

Parameters

  • apKeyword: Keyword to check ref link against (see GetLinkedRef.)
    • Default: None
  • abFadeOut: If true, will fade out each ref, otherwise will pop them out
    • Default: False

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)

See Also