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.

Syntax

Function DisableLinkChain(Keyword apKeyword = None, bool abFadeOut = false)
	ObjectReference CurrentLink = GetLinkedRef(apKeyword)
	While CurrentLink
		CurrentLink.Disable(abFadeOut)
		CurrentLink = CurrentLink.GetLinkedRef(apKeyword)
	endWhile
endFunction

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