Difference between revisions of "GetPlayerControlsDisabled"
Jump to navigation
Jump to search
imported>Yukichigai (Clarify this is an or, not an and) |
imported>Odessa (typo in last example + tidied up a little) |
||
| Line 2: | Line 2: | ||
|CSWikiPage = GetPlayerControlsDisabled | |CSWikiPage = GetPlayerControlsDisabled | ||
|origin = GECK1 | |origin = GECK1 | ||
|summary = [[GetPlayerControlsDisabled]] returns 1 if any of the specified player controls are currently disabled, and 0 otherwise. | |summary = [[GetPlayerControlsDisabled]] returns true (1) if any of the specified player controls are currently disabled, and false (0) otherwise. | ||
|returnType = bool | |||
|arguments = {{FunctionArgument | |arguments = {{FunctionArgument | ||
|Name = MovementFlag | |Name = MovementFlag | ||
|Type = | |Type = bool | ||
|Optional = true | |Optional = true | ||
}}{{FunctionArgument | |||
|Name = PipboyFlag | |Name = PipboyFlag | ||
|Type = | |Type = bool | ||
|Optional = true | |Optional = true | ||
}}{{FunctionArgument | |||
|Name = FightingFlag | |Name = FightingFlag | ||
|Type = | |Type = bool | ||
|Optional = true | |Optional = true | ||
}}{{FunctionArgument | |||
|Name = POVFlag | |Name = POVFlag | ||
|Type = | |Type = bool | ||
|Optional = true | |Optional = true | ||
}}{{FunctionArgument | |||
|Name = LookingFlag | |Name = LookingFlag | ||
|Type = | |Type = bool | ||
|Optional = true | |Optional = true | ||
}}{{FunctionArgument | |||
|Name = RolloverTextFlag | |Name = RolloverTextFlag | ||
|Type = | |Type = bool | ||
|Optional = true | |Optional = true | ||
}}{{FunctionArgument | |||
|Name = SneakingFlag | |Name = SneakingFlag | ||
|Type = | |Type = bool | ||
|Optional = true | |Optional = true | ||
}} | |||
|example = | |example = | ||
GetPlayerControlsDisabled | GetPlayerControlsDisabled | ||
| Line 50: | Line 51: | ||
<ul> | <ul> | ||
<li>Default (no parameters) is equivalent to: | <li>Default (no parameters) is equivalent to: | ||
<pre> | <pre>GetPlayerControlsDisabled 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> | </li> | ||
| Line 58: | Line 59: | ||
*[[EnablePlayerControls]] | *[[EnablePlayerControls]] | ||
*[[DisablePlayerControls]] | *[[DisablePlayerControls]] | ||
*[[GetRestrained]] | |||
*[[GetTFC]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
Revision as of 11:45, 28 July 2014
< [[::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 true (1) if any of the specified player controls are currently disabled, and false (0) otherwise.
Syntax
(bool) GetPlayerControlsDisabled MovementFlag:bool PipboyFlag:bool FightingFlag:bool POVFlag:bool LookingFlag:bool RolloverTextFlag:bool SneakingFlag:bool
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:
GetPlayerControlsDisabled 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).