LynxMods
  • Overview
  • Using Lua Scripts
    • Using lua scripts
  • DEVELOPERS
    • Writing Lua Scripts
      • Getting Started
      • Examples
        • Basic UI Examples
        • Basic Auto Reply
      • Events
      • API Documentation
        • client
        • ui
Powered by GitBook
On this page
  • Functions:
  • ui.Modal
  • ui.Checkbox

Was this helpful?

  1. DEVELOPERS
  2. Writing Lua Scripts
  3. API Documentation

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.

Previousclient

Last updated 4 years ago

Was this helpful?