tModLoader v2024.11
A mod to make and play Terraria mods
IngameFancyUI Class Reference

Provides convenient access to the Main.InGameUI UserInterface class. Use this for in-game non-gameplay fullscreen user interfaces. User interfaces shown using IngameFancyUI hide all other UI. Some examples include the bestiary, emote menu, and settings menus. There can only be one active fullscreen user interface and the user can't play the game normally when active, so this is only useful for non-gameplay UI. Use OpenUIState to show a UIState and Close to close it. There is no need to manage a UserInterface or interface layers when using this approach, but it is more limited in flexibility. More...

Static Public Member Functions

static bool CanCover ()
 
static bool CanShowVirtualKeyboard (int context)
 
static void Close ()
 
static void CoverNextFrame ()
 
static bool Draw (SpriteBatch spriteBatch, GameTime gameTime)
 
static void MouseOver ()
 
static void OpenAchievements ()
 
static void OpenAchievementsAndGoto (Achievement achievement)
 
static void OpenKeybinds ()
 
static void OpenUIState (UIState uiState)
 Sets the current UIState for Main.InGameUI. Modders can use this to display a non-gameplay UI without managing and updating a UserInterface. More...
 
static void OpenVirtualKeyboard (int keyboardContext)
 

Detailed Description

Provides convenient access to the Main.InGameUI UserInterface class. Use this for in-game non-gameplay fullscreen user interfaces. User interfaces shown using IngameFancyUI hide all other UI. Some examples include the bestiary, emote menu, and settings menus. There can only be one active fullscreen user interface and the user can't play the game normally when active, so this is only useful for non-gameplay UI.

Use OpenUIState to show a UIState and Close to close it. There is no need to manage a UserInterface or interface layers when using this approach, but it is more limited in flexibility.

Member Function Documentation

◆ OpenUIState()

static void IngameFancyUI.OpenUIState ( UIState  uiState)
static

Sets the current UIState for Main.InGameUI. Modders can use this to display a non-gameplay UI without managing and updating a UserInterface.

Parameters
uiState