GetPlayerControlsDisabled

From the CreationKit Wiki
Revision as of 15:09, 12 May 2024 by DavidJCobb (talk | contribs) (→‎Notes: Very basic testing in the CK, and brief RE in-game, suggests that using this ObScript function as a condition function is a bad idea.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

GetPlayerControlsDisabled returns a list of values for the following:

  • Movement
  • Fighting
  • POV Switch
  • Looking
  • Sneaking
  • Menu
  • Activate
  • PlayerControls::bDisablePOVChange[Script]
  • PlayerControls::bDisablePOVChange[Werewolf]
  • PlayerControls::bActivationDisabled
  • JournalMenu::bTabsDisabled

Syntax

GetPlayerControlsDisabled


Examples

GetPlayerControlsDisabled 1 0 0 0 0 0 0 0 0 0

Returns 1 if player's Movement is currently disabled.

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).

  • Attempting to use this as a condition function in the Skyrim LE Creation Kit will trigger an assertion failure (though the Creation Kit will not crash if you click "Retry"). The condition is programmed as having eight parameters, and the Creation Kit's UI supports no more than three. It is not known whether the Creation Kit can actually save this condition, or whether the resulting data would load properly.

See Also

EnablePlayerControls
DisablePlayerControls