IsInMenuMode - Utility

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

See Also

• Utility Script
• IsTimePassing - Utility