GetPlayerControlsDisabledAlt
A function added by the New Vegas Script Extender version 6.3.2.
Contents
Description
Returns true (1) if any of the specified player controls are currently disabled, and false (0) otherwise.
Disabling and enabling is stored on a per-mod basis, so if two mods disable a control at some point, it will be disabled until both of them re-enable it, or until the save is reloaded.
The disabledHow arg can be used to check how the controls were disabled. Here are its possible values and uses:
If 0, check if controls are disabled by calling mod (DisablePlayerControls*Alt/AltEx* only) If 1, ... disabled by any mod (DisablePlayerControls*Alt/AltEx* only) If 2, ... disabled by any mod OR disabled by vanilla DisablePlayerControls
Default (no parameters) is equivalent to having disabledHow at 0, and *all* the Flag arguments at 1, meaning it will check if any of the flags are disabled by the calling mod.
Syntax
(bool) GetPlayerControlsDisabledAlt disabledHow:int{0} MovementFlag (0/1), PipboyFlag (0/1), FightingFlag (0/1), POVFlag (0/1), LookingFlag (0/1), RolloverTextFlag (0/1), SneakingFlag (0/1)
Example
GetPlayerControlsDisabledAlt
Returns 1 if any of the player's controls are currently disabled by the calling mod.
GetPlayerControlsDisabledAlt 0 1 0 0 0
Returns 1 if the player's Pip-Boy flag or if any flags starting from RolloverTextFlag are disabled by the calling mod. If you want to get really specific without having to specify a bunch of filler args, consider using GetPlayerControlsDisabledAltEx.
DisablePlayerControlsAlt 0 1 0 1 0 ; will disable pipboy and POV switch. GetPlayerControlsDisabledAlt 0 1 0 0 0 ; returns 1 GetPlayerControlsDisabledAlt 0 0 0 1 0 ; returns 1 GetPlayerControlsDisabledAlt 0 1 0 1 0 ; returns 1 GetPlayerControlsDisabledAlt 1 1 1 1 1 ; returns 1 GetPlayerControlsDisabledAlt 0 0 0 0 0 ; returns 0 GetPlayerControlsDisabledAlt 1 0 1 0 1 ; returns 0
Notes
- See DisablePlayerControlsAlt for flag definitions.
See Also
- GetPlayerControlsDisabledAltEx - Same as this but takes a single Bitmask argument instead.
- GetPlayerControlsDisabled
- EnablePlayerControls / EnablePlayerControlsAlt / EnablePlayerControlsAltEx
- DisablePlayerControls / DisablePlayerControlsAlt / DisablePlayerControlsAltEx
- DisableControl
- ToggleVanityWheel
