# Gui {% hint style="info" %} If you need to get a container ID or an existing control ID, enable **`LUA>GENERAL>`**![](/files/7vG3Dwxa1qz04XAxGVF0)**`Debug mode`** and hover on a groupbox or any element. {% endhint %} {% hint style="info" %} You can stack most control in line with other controls. To do that, pass the ID of a control that already exists into the `container_id` argument of the function. {% endhint %} ## Enums

Hotkey modes

* hotkey\_toggle * hotkey\_hold

Dialog buttons

* dialog\_buttons\_ok\_cancel * dialog\_buttons\_yes\_no * dialog\_buttons\_yes\_no\_cancel

Dialog result

* dialog\_result\_affirmative * dialog\_result\_negative


Parameter	Datatype	Description	Default value
id	string	new id	❌
container_id	string	container id	❌
label	string	label	❌
min	number	minimum slider value	❌
max	number	maximum slider value	❌
format	string	format string	'%.0f'
step	number	step value	1.0


Parameter	Datatype	Description	Default value
id	string	new id	❌
container_id	string	container id	❌
label	string	label	❌
is_mult	boolean	true if list should enable multiselect	❌
height	number	element height	120


Parameter	Datatype	Description	Default value
id	string	new id	❌
container_id	string	container id	❌
label	string	label	❌
default	render.color	default color	❌
allow_alpha	boolean	true if alpha modification is allowed	true

#### Returns: | [Value](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | | :---------------------------------------: | :------------------------------------------: | | list | [list](/documentation/datatypes/list.md) | ### get\_colorpicker ```lua local item = gui.get_colorpicker('lua>elements a>test') ``` | [Parameter](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | [Description](/documentation/namespaces/gui.md) | | :-------------------------------------------: | :------------------------------------------: | :---------------------------------------------: | | id | string | control id | #### Returns: | [Value](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | | :---------------------------------------: | :-------------------------------------------------------: | | color\_picker | [color\_picker](/documentation/datatypes/color_picker.md) | ## Misc ### is\_menu\_open ```lua gui.is_menu_open() ``` #### Returns: | [Value](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | | :---------------------------------------: | :------------------------------------------: | | menu's visibility state | boolean | ### get\_menu\_rect ```lua gui.get_menu_rect() ``` #### Returns: | [Value](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | | :---------------------------------------: | :------------------------------------------: | | x1 | number | | y1 | number | | x2 | number | | y2 | number | ### show\_message ```lua gui.show_message('my_message', 'Hello!', 'Click OK to close this message.') ``` | [Parameter](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | [Description](/documentation/namespaces/gui.md) | | :-------------------------------------------: | :------------------------------------------: | :---------------------------------------------: | | id | string | messagebox id | | title | string | title | | message | string | message | ### show\_dialog ```lua gui.show_dialog('my_dialog', 'Hello!', 'Do you like balls?', gui.dialog_buttons_yes_no, function (res) if res == gui.dialog_result_affirmative then gui.show_message('my_message', 'Hey!', 'Me too'); else gui.show_message('my_message', ':(', 'Ligma'); end end); ``` | [Parameter](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | [Description](/documentation/namespaces/gui.md) | | :-------------------------------------------: | :------------------------------------------: | :---------------------------------------------: | | id | string | dialog id | | title | string | title | | message | string | message | | button | [Enum](#dialog-buttons) | dialog box buttons | | callback | function([Enum](#dialog-result)) | result callback | ### add\_notification ```lua gui.add_notification('Hello', 'This lua was loaded!') ``` | [Parameter](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | [Description](/documentation/namespaces/gui.md) | | :-------------------------------------------: | :------------------------------------------: | :---------------------------------------------: | | title | string | title | | message | string | message | ### for\_each\_hotkey ```lua gui.for_each_hotkey(function (name, key, mode, is_active) print('Hotkey ' .. name .. ':'); print('\tkey = ' .. tostring(key)); print('\tmode = ' .. tostring(mode)); print('\tis_active = ' .. tostring(is_active)); end); ``` | [Parameter](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | [Description](/documentation/namespaces/gui.md) | | :-------------------------------------------: | :------------------------------------------: | :---------------------------------------------: | | fn | function(string, number, number, bool) | callback function | #### Callback parameters: | [Parameter](/documentation/namespaces/gui.md) | [Datatype](/documentation/namespaces/gui.md) | [Description](/documentation/namespaces/gui.md) | | :-------------------------------------------: | :------------------------------------------: | :------------------------------------------------------------------------------------------------: | | name | string | item name | | key | number | active key ([keycode](https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes)) | | mode | [Enum](#hotkey-modes) | hotkey mode | | is\_active | boolean | true if currently active | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://golua.fatality.win/documentation/namespaces/gui.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.