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.
tupoy-ya a1fb2ae6d8
feat(Lua)!: New Lua bindings (#3563)
* feat(Lua): Make independent imgui independent.
feat(Lua): Add a `pointer:set_address` binding.
feat(Lua): Added `menu_event.Wndproc` event.
fix(Lua): Fix `ImGui.SliderFloat3` binding.
fix(Lua Docs): Partially fixed auto generated documentation.
* fix(gui.cpp): include `lua_manager.hpp`.
* fix(lua_manager.hpp): Added `draw_less_dependent_gui` function.
* chore(Lua): Rename `add_independent_imgui` to `add_always_draw_imgui`.
* docs(menu_event): Added docs for Wndporc event.
* docs: Fixed a few more errors.
* add reasoning and use native underlying format

Co-authored-by: tupoy-ya <tupoy-ya@users.noreply.github.com>
Co-authored-by: xiaoxiao921 <837334+xiaoxiao921@users.noreply.github.com>
2024-08-14 08:40:09 +02:00

3.3 KiB

Class: tab

Class for representing a tab within the GUI.

Functions (12)

is_selected()

  • Returns:
    • boolean: Returns true if this tab is the one currently selected in the GUI.

Example Usage:

boolean = tab:is_selected()

clear()

Clear the tab of all its custom lua content that you own.

Example Usage:

tab:clear()

add_tab(tab_name)

Add a sub tab to this tab.

  • 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 = tab:add_tab(tab_name)

add_button(name, callback)

Add a button to the gui tab.

  • Parameters:
    • name (string): Text written inside the button.
    • callback (function): function that will be called when the button is clicked.

Example Usage:

tab:add_button(name, callback)

add_text(name)

Add text to the gui tab.

  • Parameters:

    • name (string): Text that will be written.
  • Returns:

    • text: The text object instance.

Example Usage:

text = tab:add_text(name)

add_checkbox(name)

Add a checkbox widget to the gui tab.

  • Parameters:

    • name (string): Text that will be written next to the checkbox.
  • Returns:

    • checkbox: The checkbox object instance.

Example Usage:

checkbox = tab:add_checkbox(name)

add_sameline()

Add a ImGui::SameLine.

  • Returns:
    • sameline: The sameline object instance.

Example Usage:

sameline = tab:add_sameline()

add_separator()

Add a ImGui::Separator.

  • Returns:
    • separator: The separator object instance.

Example Usage:

separator = tab:add_separator()

add_input_int(name)

Add a ImGui::InputInt.

  • Parameters:

    • name (string): Text that will be written next to the input field.
  • Returns:

    • input_int: The input_int object instance.

Example Usage:

input_int = tab:add_input_int(name)

add_input_float(name)

Add a ImGui::InputFloat.

  • Parameters:

    • name (string): Text that will be written next to the input field.
  • Returns:

    • input_float: The input_float object instance.

Example Usage:

input_float = tab:add_input_float(name)

add_input_string(name)

Add a ImGui::InputText.

  • Parameters:

    • name (string): Text that will be written next to the input field.
  • Returns:

    • input_string: The input_string object instance.

Example Usage:

input_string = tab:add_input_string(name)

add_imgui(imgui_rendering)

Registers a function that will be called every rendering frame, you can call ImGui functions in it, please check the ImGui.md documentation file for more info. Example Usage:

tab:add_imgui(function()
   if ImGui.Begin("My Custom Window") then
       if ImGui.Button("Label") then
         script.run_in_fiber(function(script)
           -- call natives in there
         end)
       end

       ImGui.End()
   end
end)
  • Parameters:
    • imgui_rendering (function): Function that will be called every rendering frame, you can call ImGui functions in it, please check the ImGui.md documentation file for more info.

Example Usage:

tab:add_imgui(imgui_rendering)