UI Visibility

Controls visibility of the CEF and ImGui UI layers.

Overview

ui_visibility provides a simple API to show/hide the two UI layers: CEF (web-based UI) and ImGui (debug/developer UI). Both can be toggled independently or together.

Extension path: lua/ge/extensions/ui/visibility.lua

Exports (M)

State (M.state)

Internals

CEF Visibility Change

When setCef changes state, it fires:

1. guihooks.trigger('onCefVisibilityChanged', visible) - notifies CEF UI
2. extensions.hook('onCefVisibilityChanged', visible) - notifies other extensions

ImGui Visibility Change

setImgui calls Engine.imgui.setEnabled(visible) directly.

Combined Controls

set(visible) calls both setCef and setImgui. get() returns only CEF state. toggle() toggles based on get().

How It Works

1. Game code or keybinds call toggle() to hide/show the UI.
2. CEF visibility controls the web-based HUD, menus, and apps.
3. ImGui visibility controls all developer debug windows.
4. Extensions can listen for onCefVisibilityChanged to react (e.g., pause rendering).

Lua Examples

-- Hide all UI
extensions.ui_visibility.set(false)

-- Toggle UI visibility (common keybind action)
extensions.ui_visibility.toggle()

-- Hide only ImGui, keep CEF
extensions.ui_visibility.setImgui(false)

-- Check if CEF is visible
if extensions.ui_visibility.getCef() then
  print("UI is visible")
end

Hooks

Additional Exports

The following exports are available but not yet documented in detail:

• M.get
• M.getCef
• M.getImgui
• M.set
• M.setCef
• M.setImgui
• M.toggle
• M.toggleCef