Disable - ObjectReference

From the CreationKit Wiki
Revision as of 20:57, 26 February 2015 by imported>Chesko (Undo revision 44203 by Chesko (talk))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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) native

Parameters[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.

See Also[edit | edit source]