Difference between revisions of "GetPlayerControlsDisabled"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1))) |
imported>Cipscis (Converted to function template, fixed function name in examples) |
||
| Line 1: | Line 1: | ||
== | {{Function | ||
|CSWikiPage = GetPlayerControlsDisabled | |||
|origin = GECK1 | |||
|summary = [[GetPlayerControlsDisabled]] returns 1 if the specified player controls are currently disabled, and 0 otherwise. | |||
== | |arguments = {{FunctionArgument | ||
|Name = MovementFlag | |||
|Type = int | |||
|Optional = true | |||
|Value = 0, 1}}{{FunctionArgument | |||
|Name = PipboyFlag | |||
|Type = int | |||
|Optional = true | |||
|Value = 0, 1}}{{FunctionArgument | |||
|Name = FightingFlag | |||
|Type = int | |||
|Optional = true | |||
|Value = 0, 1}}{{FunctionArgument | |||
|Name = POVFlag | |||
|Type = int | |||
|Optional = true | |||
|Value = 0, 1}}{{FunctionArgument | |||
|Name = LookingFlag | |||
|Type = int | |||
|Optional = true | |||
|Value = 0, 1}}{{FunctionArgument | |||
|Name = RolloverTextFlag | |||
|Type = int | |||
|Optional = true | |||
|Value = 0, 1}}{{FunctionArgument | |||
|Name = SneakingFlag | |||
|Type = int | |||
|Optional = true | |||
|Value = 0, 1}} | |||
|example = | |||
GetPlayerControlsDisabled | |||
Returns 1 if any of the player's controls are currently disabled. | |||
GetPlayerControlsDisabled 0 1 0 0 0 | |||
Returns 1 if the player's Pip-Boy is currently disabled. | |||
DisablePlayerControls 0 1 0 1 0 ; will disable pipboy and POV switch. | |||
GetPlayerControlsDisabled 0 1 0 0 0 ; returns 1 | |||
GetPlayerControlsDisabled 0 0 0 1 0 ; returns 1 | |||
GetPlayerControlsDisabled 0 1 0 1 0 ; returns 1 | |||
GetPlayerControlsDisabled 1 1 1 1 1 ; returns 1 | |||
GetPlayerControlsDisabled 0 0 0 0 0 ; returns 0 | |||
GetPlayerControlsDisabled 1 0 1 0 1 ; returns 0 | |||
}} | |||
==Notes== | |||
<ul> | |||
<li>Default (no parameters) is equivalent to: | |||
<pre>GetControlsDisabled 1 1 1 1 1 1 1 ; Return true if any controls are currently disabled.</pre> | |||
The function returns true if ANY of the specified controls are currently disabled (see examples). | The function returns true if ANY of the specified controls are currently disabled (see examples). | ||
</li> | |||
</ul> | |||
==See Also== | |||
*[[EnablePlayerControls]] | |||
*[[DisablePlayerControls]] | |||
[[EnablePlayerControls]] | |||
[[DisablePlayerControls]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
Revision as of 10:14, 19 March 2010
< [[::Category:Functions|Category:Functions]]
Link to TES4 Construction Set Wiki: GetPlayerControlsDisabled.
A function included in the GECK version 1.1.0.36.
Description
GetPlayerControlsDisabled returns 1 if the specified player controls are currently disabled, and 0 otherwise.
Syntax
GetPlayerControlsDisabled MovementFlag:int{0, 1} PipboyFlag:int{0, 1} FightingFlag:int{0, 1} POVFlag:int{0, 1} LookingFlag:int{0, 1} RolloverTextFlag:int{0, 1} SneakingFlag:int{0, 1}
Example
GetPlayerControlsDisabled
Returns 1 if any of the player's controls are currently disabled.
GetPlayerControlsDisabled 0 1 0 0 0
Returns 1 if the player's Pip-Boy is currently disabled.
DisablePlayerControls 0 1 0 1 0 ; will disable pipboy and POV switch. GetPlayerControlsDisabled 0 1 0 0 0 ; returns 1 GetPlayerControlsDisabled 0 0 0 1 0 ; returns 1 GetPlayerControlsDisabled 0 1 0 1 0 ; returns 1 GetPlayerControlsDisabled 1 1 1 1 1 ; returns 1 GetPlayerControlsDisabled 0 0 0 0 0 ; returns 0 GetPlayerControlsDisabled 1 0 1 0 1 ; returns 0
Notes
- Default (no parameters) is equivalent to:
GetControlsDisabled 1 1 1 1 1 1 1 ; Return true if any controls are currently disabled.
The function returns true if ANY of the specified controls are currently disabled (see examples).