DisablePlayerControls

From GECK

Revision as of 19:36, 12 December 2008 by Quetzilla (Talk | contribs)

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

Note: This function replaces ForcePlayerTo1stPerson.

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:

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

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. If it is currently up when this flag is set, the pip-boy will be put away.
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.

Examples

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
GetPlayerControlsDisabled

Personal tools