ui
Functions for interfacing with the lynx settings screen
Functions:
ui.Modal
ui.Modal(name: string, summary: string, callback: function)
Argument
Type
Description
name
string
Name of the modal to be added to the menu
summary
string
Brief summary of what the modal does, can be empty
callback
function
The lua function that will be called when the modal is clicked
Creates a modal button to be clicked inside the settings
ui.Checkbox
ui.Checkbox(name: string, summary: string, key: string, default: boolean) : userdata (checkbox)
Argument
Type
Description
name
string
Name of the checkbox to be added to the menu
summary
string
Brief summary of what the checkbox does, can be empty
key
string
Unique key of the check, should be unique to your lua, other luas can modify this value
default
boolean
default value of the checkbox, can be null
Returns a userdata of Checkbox, where you can call setValue
or getValue, refer to examples.
Last updated
Was this helpful?