DisableLinkChain - ObjectReference: Difference between revisions
Jump to navigation
Jump to search
imported>Thingy Person (→Syntax) |
m (Convert source tags to syntaxhighlight) |
||
| Line 7: | Line 7: | ||
== Syntax == | == Syntax == | ||
< | <syntaxhighlight lang="papyrus"> | ||
Function DisableLinkChain(Keyword apKeyword = None, bool abFadeOut = false) | Function DisableLinkChain(Keyword apKeyword = None, bool abFadeOut = false) | ||
ObjectReference CurrentLink = GetLinkedRef(apKeyword) | ObjectReference CurrentLink = GetLinkedRef(apKeyword) | ||
| Line 15: | Line 15: | ||
endWhile | endWhile | ||
endFunction | endFunction | ||
</ | </syntaxhighlight> | ||
== Parameters == | == Parameters == | ||
| Line 25: | Line 25: | ||
== Examples == | == Examples == | ||
< | <syntaxhighlight lang="papyrus"> | ||
; Disable every ref linked to startRef in a chain | ; Disable every ref linked to startRef in a chain | ||
startRef.DisableLinkChain() | startRef.DisableLinkChain() | ||
</ | </syntaxhighlight> | ||
<br> | <br> | ||
< | <syntaxhighlight lang="papyrus"> | ||
; disable every ref linked to startRef using the special keyword | ; disable every ref linked to startRef using the special keyword | ||
startRef.DisableLinkChain(SpecialKeyword) | startRef.DisableLinkChain(SpecialKeyword) | ||
</ | </syntaxhighlight> | ||
== Notes == | == Notes == | ||
Latest revision as of 20:56, 5 September 2026
Member of: ObjectReference Script
This function disables all the linked refs, linked in a chain, from this reference.
Syntax[edit | edit source]
Function DisableLinkChain(Keyword apKeyword = None, bool abFadeOut = false)
ObjectReference CurrentLink = GetLinkedRef(apKeyword)
While CurrentLink
CurrentLink.Disable(abFadeOut)
CurrentLink = CurrentLink.GetLinkedRef(apKeyword)
endWhile
endFunctionParameters[edit | edit source]
- apKeyword: Keyword to check ref link against (see GetLinkedRef.)
- Default: None
Return Value[edit | edit source]
None
Examples[edit | edit source]
; 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[edit | edit source]
Do not use this on a link chain that is linked in a loop or it will cause an endless loop.