DisableNoWait - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Disables this reference, fading it out if necessary. This function will not wait for the fade or the disable to happen before returning.

Syntax

Function DisableNoWait(bool abFadeOut = False) native

Parameters

  • 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

None.

Examples

; Disables the reference, popping it out
TempReference.DisableNoWait()


; Disables the reference, fading it out
TempReference.DisableNoWait(true)

Notes

  • 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.
  • Putting a DisableNoWait() in the same script call as an Enable or EnableNoWait can cause problems, because the DisableNoWait doesn't wait for the disable to finish before returning. That means your DisableNoWait call will be bashed by the Enable call.

See Also