IsMenuOpen - UI

From the CreationKit Wiki
Revision as of 22:15, 12 October 2012 by imported>Chesko (Added all possible MenuName options as per the SKSE 1.06 documentation.)
Jump to navigation Jump to search

SKSE Member of: UI Script

Minimum required SKSE Version: 1.06.00

Returns if the menu is currently open.

Syntax

Bool Function IsMenuOpen(String MenuName) Global Native

Parameters

Potential values for MenuName are:

  • "InventoryMenu"
  • "Console"
  • "Dialogue Menu"
  • "HUD Menu"
  • "Main Menu"
  • "MessageBoxMenu"
  • "Cursor Menu"
  • "Fader Menu"
  • "MagicMenu"
  • "Top Menu"
  • "Overlay Menu"
  • "Overlay Interaction Menu"
  • "Loading Menu"
  • "TweenMenu"
  • "BarterMenu"
  • "GiftMenu"
  • "Debug Text Menu"
  • "MapMenu"
  • "Lockpicking Menu"
  • "Quantity Menu"
  • "StatsMenu"
  • "ContainerMenu"
  • "Sleep/Wait Menu"
  • "LevelUp Menu"
  • "Journal Menu"
  • "Book Menu"
  • "FavoritesMenu"
  • "RaceSex Menu"
  • "Crafting Menu"
  • "Training Menu"
  • "Mist Menu"
  • "Tutorial Menu"
  • "Credits Menu"
  • "TitleSequence Menu"
  • "Console Native UI Menu"
  • "Kinect Menu"

Return Value

Returns whether or not the specified menu is currently open as a bool.

Examples

Bool bIsInventoryMenuOpen = UI.IsMenuOpen("InventoryMenu")

Notes

None

See Also