Difference between revisions of "GetPlayerControlsDisabled"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Odessa
(typo in last example + tidied up a little)
imported>Odessa
m (tidied)
 
Line 5: Line 5:
  |returnType = bool
  |returnType = bool
  |arguments = {{FunctionArgument
  |arguments = {{FunctionArgument
   |Name = MovementFlag
   |Name = Movement
   |Type = bool
   |Type = bool
   |Optional = true
   |Optional = true
}}{{FunctionArgument
}}{{FunctionArgument
   |Name = PipboyFlag
   |Name = Pipboy
   |Type = bool
   |Type = bool
   |Optional = true
   |Optional = true
}}{{FunctionArgument
}}{{FunctionArgument
   |Name = FightingFlag
   |Name = Fighting
   |Type = bool
   |Type = bool
   |Optional = true
   |Optional = true
}}{{FunctionArgument
}}{{FunctionArgument
   |Name = POVFlag
   |Name = POV
   |Type = bool
   |Type = bool
   |Optional = true
   |Optional = true
}}{{FunctionArgument
}}{{FunctionArgument
   |Name = LookingFlag
   |Name = Looking
   |Type = bool
   |Type = bool
   |Optional = true
   |Optional = true
}}{{FunctionArgument
}}{{FunctionArgument
   |Name = RolloverTextFlag
   |Name = RolloverText
   |Type = bool
   |Type = bool
   |Optional = true
   |Optional = true
}}{{FunctionArgument
}}{{FunctionArgument
   |Name = SneakingFlag
   |Name = Sneaking
   |Type = bool
   |Type = bool
   |Optional = true
   |Optional = true

Latest revision as of 11:48, 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

[help]
(bool) GetPlayerControlsDisabled Movement:bool Pipboy:bool Fighting:bool POV:bool Looking:bool RolloverText:bool Sneaking: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).

See Also