Difference between revisions of "DisablePlayerControls"

From GECK

(Flag Definitions)
m (TESCK wiki link is worthless for this command)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''DisablePlayerControls''' disables some or all of the player's controls.
+
{{Function
 
+
|origin = GECK1
Note: This function replaces ForcePlayerTo1stPerson.
+
|summary = '''DisablePlayerControls''' disables some or all of the player's controls.
 
+
=='''Syntax'''==
+
 
+
DisablePlayerControls ''MovementFlag (0/1) (optional), PipboyFlag (0/1) (optional), FightingFlag (0/1) (optional), POVFlag (0/1) (optional), LookingFlag (0/1) (optional), RolloverTextFlag (0/1) (optional), SneakingFlag (0/1) (optional)''
+
  
 
Default (no parameters) is equivalent to:
 
Default (no parameters) is equivalent to:
 
   
 
   
 
  DisablePlayerControls 1 1 1 1 0 0 0  ; Looking, Rollover Text, and Sneaking are still enabled
 
  DisablePlayerControls 1 1 1 1 0 0 0  ; Looking, Rollover Text, and Sneaking are still enabled
 +
|name = DisablePlayerControls
 +
|returnType = void
 +
|arguments =
 +
  {{FunctionArgument
 +
  |Name = MovementFlag (0/1) (optional),
 +
  |Optional = y
 +
  }}{{FunctionArgument
 +
  |Name = PipboyFlag (0/1) (optional),
 +
  |Optional = y
 +
  }}{{FunctionArgument
 +
  |Name = FightingFlag (0/1) (optional),
 +
  |Optional = y
 +
  }}{{FunctionArgument
 +
  |Name = POVFlag (0/1) (optional),
 +
  |Optional = y
 +
  }}{{FunctionArgument
 +
  |Name = LookingFlag (0/1) (optional),
 +
  |Optional = y
 +
  }}{{FunctionArgument
 +
  |Name = RolloverTextFlag (0/1) (optional),
 +
  |Optional = y
 +
  }}{{FunctionArgument
 +
  |Name = SneakingFlag (0/1) (optional)
 +
  |Optional = y
 +
  }}
 +
|example = DisablePlayerControls
 +
Player's controls are disabled, except for Looking.
 +
 +
DisablePlayerControls 0 0 1 0 0
 +
Player's ability to equip or use a weapon is disabled; all other controls are unaffected.
 +
}}
  
 
===Flag Definitions===
 
===Flag Definitions===
Line 15: Line 42:
 
; MovementFlag : Player movement is disabled. Activation of world objects is disabled. HUD is partially disabled: Action Points, Health, Crosshair.
 
; MovementFlag : Player movement is disabled. Activation of world objects is disabled. HUD is partially disabled: Action Points, Health, Crosshair.
  
; PipBoyFlag : Player cannot bring up the pip-boy interface. If it is currently up when this flag is set, the pip-boy will be put away.  The "Wait" menu will also be disabled.
+
; PipBoyFlag : Player cannot bring up the pip-boy interface.  The "Wait" menu will also be disabled.
  
 
; FightingFlag : Player cannot bring up a weapon. If the player currently has a weapon out, the weapon will be holstered.
 
; FightingFlag : Player cannot bring up a weapon. If the player currently has a weapon out, the weapon will be holstered.
Line 27: Line 54:
 
; SneakingFlag : Player cannot go into sneak mode. If currently sneaking, forces you out of sneak mode.
 
; SneakingFlag : Player cannot go into sneak mode. If currently sneaking, forces you out of sneak mode.
  
=='''Examples'''==
+
==Notes==
 
+
*This function replaces ForcePlayerTo1stPerson.
DisablePlayerControls
+
Player's controls are disabled, except for Looking.
+
 
+
DisablePlayerControls 0 0 1 0 0
+
Player's ability to equip or use a weapon is disabled; all other controls are unaffected.
+
 
+
=='''Notes'''==
+
 
+
 
+
=='''See Also'''==
+
[[EnablePlayerControls]]<br>
+
[[GetPlayerControlsDisabled]]
+
 
+
<!--
+
=='''Reference'''==
+
None provided.
+
<!-- [[AddItemHealthPercent_Reference|List of functions that use AddItemHealthPercent]]  (wiki) -->
+
  
 +
==See Also==
 +
*[[EnablePlayerControls]]
 +
*[[GetPlayerControlsDisabled]]
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Functions (GECK 1.1)]]
 
[[Category:Player Functions]]
 
[[Category:Player Functions]]
 +
[[Category:Player Functions (GECK 1.1)]]
 
[[Category:Godsend Functions]]
 
[[Category:Godsend Functions]]
 +
[[Category:Godsend Functions (GECK 1.1)]]

Latest revision as of 22:20, 7 October 2012

A function included in the GECK version 1.1.0.36.

Description

DisablePlayerControls disables some or all of the player's controls.

Default (no parameters) is equivalent to:

DisablePlayerControls 1 1 1 1 0 0 0  ; Looking, Rollover Text, and Sneaking are still enabled

Syntax

DisablePlayerControls MovementFlag (0/1) (optional), PipboyFlag (0/1) (optional), FightingFlag (0/1) (optional), POVFlag (0/1) (optional), LookingFlag (0/1) (optional), RolloverTextFlag (0/1) (optional), SneakingFlag (0/1) (optional)

Example

DisablePlayerControls

Player's controls are disabled, except for Looking.

DisablePlayerControls 0 0 1 0 0

Player's ability to equip or use a weapon is disabled; all other controls are unaffected.

Flag Definitions

MovementFlag 
Player movement is disabled. Activation of world objects is disabled. HUD is partially disabled: Action Points, Health, Crosshair.
PipBoyFlag 
Player cannot bring up the pip-boy interface. The "Wait" menu will also be disabled.
FightingFlag 
Player cannot bring up a weapon. If the player currently has a weapon out, the weapon will be holstered.
POVFlag 
Player cannot go into 3rd person view. If currently in 3rd person, the view is forced into first person.
LookingFlag 
Player looking is disabled -- the player's view is locked into its current position.
RolloverTextFlag 
No rollover text on world objects.
SneakingFlag 
Player cannot go into sneak mode. If currently sneaking, forces you out of sneak mode.

Notes

  • This function replaces ForcePlayerTo1stPerson.

See Also

Personal tools