This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
Quentin 89f57a9a4c
Lua: can make new tabs from lua scripts, doc generation for available tabs to use (#1593)
* lua api: add globals.get_uint and globals.set_uint

* lua doc: remove duplicate function check as we can overload so it doesn't make sense

* lua doc gen: add support for parsing the tabs enum

* gui: custom lua tabs don't have a `func` rendering function but can still have elements to draw

* lua doc: update generated doc

* chore: code style

* chore: minor spelling mistake

* chore: code style

* gui_service: add runtime removal of tabs

* refactor: make it so that it's less likely defining tabs and their translation key in a wrong way.

* lua api: ability to add custom tabs to the gui from lua
2023-07-05 00:30:57 +02:00

1.3 KiB

Table: gui

Table containing functions for modifying the menu GUI.

Functions (6)

get_tab(tab_name)

  • Parameters:

    • tab_name (string): Name of the tab to get.
  • Returns:

    • tab: A tab instance which corresponds to the tab in the GUI.

Example Usage:

tab = gui.get_tab(tab_name)

add_tab(tab_name)

  • Parameters:

    • tab_name (string): Name of the tab to add.
  • Returns:

    • tab: A tab instance which corresponds to the new tab in the GUI.

Example Usage:

tab = gui.add_tab(tab_name)

show_message(title, message)

Shows a message to the user with the given title and message.

  • Parameters:
    • title (string)
    • message (string)

Example Usage:

gui.show_message(title, message)

show_warning(title, message)

Shows a warning to the user with the given title and message.

  • Parameters:
    • title (string)
    • message (string)

Example Usage:

gui.show_warning(title, message)

show_error(title, message)

Shows an error to the user with the given title and message.

  • Parameters:
    • title (string)
    • message (string)

Example Usage:

gui.show_error(title, message)

is_open()

  • Returns:
    • bool: Returns true if the GUI is open.

Example Usage:

bool = gui.is_open()