DisablePlayerControls

From the CreationKit Wiki
Revision as of 16:11, 18 January 2013 by imported>HawkFest (→‎Syntax)
Jump to navigation Jump to search

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

Syntax

DisablePlayerControls([MovementFlag][, FightingFlag][, POVFlag][, LookingFlag][, SneakingFlag][, MenuFlag][, ActivateFlag])

Where each Flag is a boolean value (either 0 or False, either 1 or True). Default (no parameters) is equivalent to:

DisablePlayerControls(1, 1, 0, 0, 0, 1, 1)  ; POV, Looking, and Sneaking are still enabled
1 = Disabled - Will Disable the Flag.
0 = Enabled - Will keep the Flag enabled, so the player can use the Flag.

Flag Definitions

MovementFlag
Player movement is disabled. Activation of world objects is disabled. HUD is partially disabled: Action Points, Health, Crosshair.
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.
SneakingFlag
Player cannot go into sneak mode. If currently sneaking, forces you out of sneak mode.
MenuFlag
Player cannot use the four main menus.
ActivateFlag
Player cannot activate anything.

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


Papyrus Version

DisablePlayerControls - Game