IsInMenuMode function - Utility script | Fallout 4

Found in:

Vanilla
F4SE

boolfunctionIsInMenuMode()NativeGlobal

Description

Wiki Description

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

Documentation Comment

Returns whether the game is currently in menu mode or not

Caveats

CK Wiki - Notes

Dialogue, because the game isn't paused, will not put the game into "menu mode".

Examples

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

Auto-Generated Example

bool returnedValue = Utility.IsInMenuMode()

Utility

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki