Difference between revisions of "Disable"

From GECK

m
m
Line 3: Line 3:
 
  |origin = GECK1
 
  |origin = GECK1
 
  |summary = Disabled the calling reference.  Disabled references are not rendered, and disabled actors will not process their AI.  Scripts ''will'' run on disabled references.
 
  |summary = Disabled the calling reference.  Disabled references are not rendered, and disabled actors will not process their AI.  Scripts ''will'' run on disabled references.
 +
|name = Disable
 
  |arguments = {{FunctionArgument
 
  |arguments = {{FunctionArgument
 
   |Name = FadeIn
 
   |Name = FadeIn

Revision as of 07:08, 15 January 2011

Link to TES4 Construction Set Wiki: Disable.

A function included in the GECK version 1.1.0.36.

Description

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

Syntax

Disable FadeIn:Int{Default = 0}

Example

TerminalRef.Disable

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

TerminalRef.Disable 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.
  • If Disable is called on a reference with an Enable Parent, it will have no effect.
  • The [FadeIn] parameter does not affect the children of an Enable Parent. The children will still pop out when disabled.
  • Disable does not remove references from the game, just stops them from rendering. Do not rely on Disable 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

Personal tools