Difference between revisions of "GetPlayerControlsDisabled"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Cipscis
(Converted to function template, fixed function name in examples)
imported>Yukichigai
(Clarify this is an or, not an and)
Line 2: Line 2:
  |CSWikiPage = GetPlayerControlsDisabled
  |CSWikiPage = GetPlayerControlsDisabled
  |origin = GECK1
  |origin = GECK1
  |summary = [[GetPlayerControlsDisabled]] returns 1 if the specified player controls are currently disabled, and 0 otherwise.
  |summary = [[GetPlayerControlsDisabled]] returns 1 if any of the specified player controls are currently disabled, and 0 otherwise.
  |arguments = {{FunctionArgument
  |arguments = {{FunctionArgument
   |Name = MovementFlag
   |Name = MovementFlag

Revision as of 03:22, 25 September 2013

< [[::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 any of the specified player controls are currently disabled, and 0 otherwise.

Syntax

[help]
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).

See Also