IsInMenuMode - Utility

From Creation Kit
Jump to: navigation, search

Member of: Utility Script

Obtains whether the game is currently in "menu mode" or not. Menu mode is basically defined as whenever the game is paused, usually because some menu is showing. Dialogue does not pause the game, and so does not put the game into "menu mode".

Syntax

bool Function IsInMenuMode() native

Parameters

None.

Return Value

Whether the game is currently in "menu mode" or not.

Examples

if (!Utility.IsInMenuMode())
  ; do game stuff! we aren't in a menu
endIf

Notes

  • Dialogue, because the game isn't paused, will not put the game into "menu mode". This state appears to be undetectable by any simple means, but possibly may be worked around with things like IsTalking, IsInDialogueWithPlayer, etc.
  • Crafting happens in game mode, use IsFurnitureInUse - ObjectReference to determine if the player is currently in a crafting menu.

See Also