Difference between revisions of "Enable"

← Older edit

Enable (edit)

Revision as of 08:31, 15 January 2011

676 bytes added , 08:31, 15 January 2011

m

no edit summary

Anonymous user

imported>Ez0n3

@@ Line 1: / Line 1: @@
-Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/Enable Enable].
+{{Function
+ |CSWikiPage = Enable
-'''Syntax:'''
+ |origin = GECK1
-  Enable ''[FadeIn]''(1 by default)
+ |summary = Enables the calling reference if it was previously disabled.  Enabled references are rendered, and enabled actors will process their AI.
+ |name = Enable
-Enables the calling object if it was previously disabled with [[Disable]].
+ |arguments = {{FunctionArgument
-Objects are enabled by default, which means they are rendered in the game, and if they are actors, will process their AI.
+  |Name = FadeIn
+  |Type = Int
+  |Optional = y
+  |Value = Default = 1
+ }}
+  |example = TerminalRef.Enable
+TerminalRef, if previously disabled, will be enabled.  Because the ''[FadeIn]'' parameter was not set, TerminalRef will fade in by default.
+}}
+ TerminalRef.Enable 0
+With the parameter set as '0', the object will not fade in.
 ==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.
+*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 (GECK 1.1)]]
 [[Category:Miscellaneous Functions]]
+[[Category:Miscellaneous Functions (GECK 1.1)]]