DisableAlt

From GECK
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin version 1.17.

Description

Disabled the calling reference. Disabled references are not rendered, and disabled actors will not process their AI. Scripts will run on disabled references.

Ignores Disable's limitation of being unable to disable references that have an Enable Parent. Ignoring this limit has not been solidly tested, so some issues may pop up. Otherwise, the two functions are identical.

Syntax

[help]
reference.DisableAlt FadeOut:Int{Default = 0} 

Or:

reference.SnigOff FadeOut:Int{Default = 0}

Example

TerminalRef.DisableAlt

TerminalRef, if previously enabled, will be disabled. Because the [FadeOut] parameter was not set, TerminalRef will not fade out by default.

TerminalRef.DisableAlt 0

With the parameter set as '0', the object will not fade out.

Notes

  • If multiple references should share an enable state, Enable Parenting should be used so that Enable only needs to be called once in order to affect the enable state of all appropriate references.
  • The [FadeOut] parameter does not affect the children of an Enable Parent. The children will still pop out when disabled.
  • Disable/DisableAlt does not remove references from the game, just stops them from rendering. Do not rely on it to prevent savegame bloat by removing references. MarkForDelete should be used to remove references from the game.
  • Disabled actors cannot be forced to activate objects via Activate.
  • Disabling the object on which a spell is active during the ScriptEffectStart block causes unpredictable behavior in the later spell blocks.

See Also