Difference between revisions of "GetOpenState"

Latest revision as of 05:24, 17 August 2014

< [[::Category:Functions|Category:Functions]]

Link to TES4 Construction Set Wiki: GetOpenState.

A function included in the GECK version 1.1.0.36.

Gets the open state of an animating door

(0, 1, 2, 3, 4:int) [Door].GetOpenState

ShackDoor.GetOpenState

Will return the state of the shack door

GetOpenState will return relevant values for some objects which have Open and Closed animation states, including Radios and some Containers.
The following correspond to the state of the door:

    0 = none (has no open/closed states) 
    1 = open 
    2 = opening 
    3 = closed 
    4 = closing

@@ Line 1: / Line 1: @@
-{{Incomplete}}
+{{Function
+ |CSWikiPage = GetOpenState
+ |origin = GECK1
+ |summary = Gets the open state of an animating door
+ |name = GetOpenState
+ |returnVal = 0, 1, 2, 3, 4
+ |returnType = int
+ |referenceType = [Door]
+ |example = <pre>ShackDoor.GetOpenState</pre>
+Will return the state of the shack door
+}}
-Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/GetOpenState GetOpenState]
+==Notes==
+*GetOpenState will return relevant values for some objects which have Open and Closed animation states, including Radios and some Containers.
+*The following correspond to the state of the door:
+<pre>
+= none (has no open/closed states)
+= open
+= opening
+= closed
+= closing
+</pre>
+*Note that these states do NOT correspond to those of [[SetOpenState]]
+==See Also==
+*[[SetOpenState]]
 [[Category:Functions]]
+[[Category:Functions (GECK 1.1)]]