Disable - ObjectReference

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

Function Disable(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.Disable()

; Disables the reference, fading it out
TempReference.Disable(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.
• Flora objects will occasionally render even though they've been disabled, and IsDisabled returns true for their reference.

See Also

• ObjectReference Script
• DisableNoWait - ObjectReference
• Enable - ObjectReference
• IsDisabled - ObjectReference