Editing DisableLinkChain - ObjectReference

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Latent Functions]]
'''Member of:''' [[ObjectReference Script]]

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

== Syntax ==
<syntaxhighlight lang="papyrus">
Function DisableLinkChain(Keyword apKeyword = None, bool abFadeOut = false)
	ObjectReference CurrentLink = GetLinkedRef(apKeyword)
	While CurrentLink
		CurrentLink.Disable(abFadeOut)
		CurrentLink = CurrentLink.GetLinkedRef(apKeyword)
	endWhile
endFunction	
</syntaxhighlight>

== Parameters ==
*apKeyword: Keyword to check ref link against (see [[GetLinkedRef - ObjectReference|GetLinkedRef]].)
**'''Default''': None

== Return Value ==
None

== Examples ==
<syntaxhighlight lang="papyrus">
; Disable every ref linked to startRef in a chain
startRef.DisableLinkChain()
</syntaxhighlight>
<br>
<syntaxhighlight lang="papyrus">
; disable every ref linked to startRef using the special keyword
startRef.DisableLinkChain(SpecialKeyword)
</syntaxhighlight>

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

== See Also ==
*[[ObjectReference Script]]
*[[Disable - ObjectReference]]
*[[GetLinkedRef - ObjectReference]]