Difference between revisions of "Enable"

From GECK

(removed incomplete tag and link to TES Wiki)
(Updated to function template, added Enable Parent to "See Also")
Line 1: Line 1:
'''Syntax:'''
+
{{Function
  Enable ''[FadeIn]''(1 by default)
+
  |CSWikiPage = Enable
 
+
|origin = GECK1
Enables the calling object if it was previously disabled with [[Disable]].
+
|summary = Enables the calling reference if it was previously disabled. Enabled references are rendered, and enabled actors will process their AI.
Objects are enabled by default, which means they are rendered in the game, and if they are actors, will process their AI.
+
|arguments = {{FunctionArgument
 +
  |Name = FadeIn
 +
  |Type = Int
 +
  |Optional = Optional
 +
}}
 +
|example = TerminalRef.Enable
 +
TerminalRef, if previously disabled, will be enabled.  Because the ''[FadeIn]'' parameter was not set, TerminalRef will fade in by default.
 +
}}
  
 
==Notes==
 
==Notes==
*When applied to an enable parent the ''[FadeIn]'' will not get passed to the children.  The "Enable" command will just get called on them, which fades in by default (''[FadeIn]'' set to 1).
+
*If multiple references should share an enable state, [[Reference#Enable_Parent|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.
**In order for the children to Pop In (Instead of fade in which is the default for the Enable command) you must go to each child and, under the enable parent tab, check the "Pop In" checkbox.
+
*If [[Enable]] is called on a reference with an [[Reference#Enable_Parent|Enable Parent]], it will have no effect.
*If "Enable" is called on a reference with an "Enable Parent", it will have no effect.
+
*When applied to an enable parent the ''[FadeIn]'' parameter will not be passed to the children.  [[Enable]] will be called on them, which fades in by default (''[FadeIn]'' set to 1).
 +
**In order for the children to Pop In (Instead of fade in which is the default for [[Enable]]) you must go to each child and, under the enable parent tab, check the "Pop In" checkbox.
  
=='''See Also'''==
+
==See Also==
[[Disable]]<br>
+
*[[Disable]]
[[GetDisabled]]
+
*[[GetDisabled]]
 +
*[[Reference#Enable_Parent|Enable Parent]]
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Miscellaneous Functions]]
 
[[Category:Miscellaneous Functions]]

Revision as of 23:17, 14 May 2009

Link to TES4 Construction Set Wiki: Enable.

A function included in the GECK version 1.1.0.36.

Description

Enables the calling reference if it was previously disabled. Enabled references are rendered, and enabled actors will process their AI.

Syntax

Enable FadeIn:Int

Example

TerminalRef.Enable

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

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 Enable is called on a reference with an Enable Parent, it will have no effect.
  • When applied to an enable parent the [FadeIn] parameter will not be passed to the children. Enable will be called on them, which fades in by default ([FadeIn] set to 1).
    • In order for the children to Pop In (Instead of fade in which is the default for Enable) you must go to each child and, under the enable parent tab, check the "Pop In" checkbox.

See Also

Personal tools