Main

How to create an element? There are a ton of ways, and you'll know all of them

Creating a group

pui.group(tab, name*, align*) : pui_group

Common way

local group = pui.create("Visuals", "Indicators")
local switch = group:switch("Name")

Inline way

-- Name only
local switch = pui.switch("Indicators", "Name")

-- Tab and name
local switch = pui.switch({"Visuals", "Indicators"}, "Name")

Creating an element

pui.element(group, ..., arg1, arg2, argn) : pui_element

group:element(..., arg1, arg2, argn) : pui_element

You can use elements just like in neverlose. All arguments will be saved, and you will also be able to add more (but there are some exceptions)

Common example

local group = pui.create("Visuals", "Indicators")
local switch = group:switch("Name", true, function(gear)
    return {
        value = gear:slider("Value", 0, 10, 5)
    }
end, "Tooltip")

Exceptions for elements with list (combo, selectable, list, listable)

Due to their arguments style, you will have to modify them a bit in order to use pui features. You can still use them like they are if you don't need additional features.

group:combo("A", "Apple", "Banana", "Coconut")

-- place combo values in a table:
group:combo("B", {"Apple", "Banana", "Coconut"}, "Tooltip")

-- won't work: group:combo("C", "Apple", "Banana", "Coconut", "Tooltip")

What does a pui_element contain?

pui::element is a table of variables that you can use in some cases.

For example: switch.value returns the current switch value

Variable	Description
.value	Current value. Includes overridden one too.
.ref	Original neverlose reference.
.color	This table is a pui::element of your color picker. For example: .color.value, .color:set() d

Children elements

Children elements are those gears or color pickers near the main elements.

Gear

If you want to add a gear elements, see this:

group:element(..., tooltip, children)

Definition of children:

function children(gear, self)
    return elements, condition
end

Let's see.

Variable	Description
gear	The gear created when you want to add children
self	The table of a main element. Be careful when using it.
elements	A table of pui elements you want to pass to gear.
condition	A global condition, that will make your children visible or invisible depending on if it's met or not. See :depend method for more info.

Example

This example shows a switch. It contains children elements: bar and button. Also you can see, that you may operate them just like regular pui elements. These elements will be shown only if the main switch is enabled (true).

local switch = group:switch("Name", false, function(gear)
    local elements = {
        bar = gear:switch("Switch!", true, "Tooltip!")
        button = gear:button("Click!", function() print "Clicked!" end)
    }
    
    elements.bar:set_callback(function() print "Switched!" end)
    
    return elements, true
end)

Accesing children elements

print( switch.bar.value )
switch.button:set_callback()

Color picker

If you want to add a color picker, the second pui argument should be a color (it will be used as a default color)

Example:

local switch = group:switch("Name", false, color(255, 0, 0))

Accessing color

switch.color:set( color(255) ) -- behaves like pui::element
local col = switch.color.value -- its value