Disable - ObjectReference: Difference between revisions
Jump to navigation
Jump to search
imported>Chesko |
m (Convert source tags to syntaxhighlight) |
||
| Line 7: | Line 7: | ||
== Syntax == | == Syntax == | ||
< | <syntaxhighlight lang="papyrus"> | ||
Function Disable(bool abFadeOut = False) native | Function Disable(bool abFadeOut = False) native | ||
</ | </syntaxhighlight> | ||
== Parameters == | == Parameters == | ||
| Line 19: | Line 19: | ||
== Examples == | == Examples == | ||
< | <syntaxhighlight lang="papyrus"> | ||
; Disables the reference, popping it out | ; Disables the reference, popping it out | ||
TempReference.Disable() | TempReference.Disable() | ||
</ | </syntaxhighlight> | ||
<br/> | <br/> | ||
< | <syntaxhighlight lang="papyrus"> | ||
; Disables the reference, fading it out | ; Disables the reference, fading it out | ||
TempReference.Disable(true) | TempReference.Disable(true) | ||
</ | </syntaxhighlight> | ||
== Notes == | == Notes == | ||
Latest revision as of 19:56, 5 September 2026
Member of: ObjectReference Script
Disables this reference, fading it out if necessary. This function is latent and will wait for the fade out and/or disable to happen.
Syntax[edit | edit source]
Function Disable(bool abFadeOut = False) nativeParameters[edit | edit source]
- abFadeOut: Whether to fade the item out or not. If this is an enable parent the children will not be faded.
- Default: False
Return Value[edit | edit source]
None.
Examples[edit | edit source]
; Disables the reference, popping it out
TempReference.Disable()
; Disables the reference, fading it out
TempReference.Disable(true)Notes[edit | edit source]
- Small objects will never fade.
- Children of an enable parent will not fade and will simply pop out of existence when the parent object has finished fading.