Create entity from handle

Get entity handle

Check if entity is valid

Check if entity is a ped

Check if entity is a vehicle

Check if entity is an object

Check if entity is a player

Check if entity is a mission entity

Get entity model hash

Get entity position

Set entity position

Get entity rotation

Set entity rotation

Get entity velocity

Set entity velocity

Get entity heading

Set entity heading

Get entity speed

Set entity collision

Set entity frozen state

Delete entity

Check if entity is networked

Check if entity is remote

Check if we have control

Get network object ID

Prevent network migration

Force control of entity

Request control of entity

Check if entity is invincible

Set entity invincibility

Check if entity is dead

Kill entity

Get entity health

Set entity health

Get entity max health

Check if entity is visible

Set entity visibility

Get entity alpha

Set entity alpha

Reset entity alpha

Check if entity has interior

Get player name

Get Rockstar ID

Get host token

Check if player is valid

Check if player is host

Get player ped

Get network object ID

Get object owner

Create object from handle

Create new object

Create ped from handle

Create new ped

Get ped's current vehicle

Get ped's last vehicle

Get vehicle network object ID

Set ped in vehicle

Get ragdoll state

Set ragdoll state

Get bone position

Check if ped is enemy

Get ped accuracy

Set ped accuracy

Give weapon to ped

Remove weapon from ped

Get current weapon hash

Check if ped has weapon

Set infinite ammo

Set infinite clip

Set max ammo for weapon

Teleport ped to position

Get ped armour

Set ped armour

Set as group leader

Add to group

Remove from group

Check group membership

Randomize ped outfit

Start scenario

Set keep task

Clear ped damage

Set max time underwater

Set ped as cop

Create vehicle from handle

Create new vehicle

Get vehicle driver

Get passenger by seat

Set maximum speed

Set forward speed

Repair vehicle

Set doors locked

Set dirt level

Set on all wheels

Get vehicle mods

Set vehicle mod

Get primary color

Get secondary color

Set vehicle colors

Set custom primary RGB color

Set custom secondary RGB color

Yield execution for milliseconds

Log info message

Log warning message

Log error message

Show notification: notify.success(title, msg)

Get local player ped

Get local player

Get all peds in world

Get all vehicles in world

Get all objects in world

Get all network players

Invoke native function

Create new vector

X component

Y component

Z component

Get vector length

Normalize vector

Distance to another vector

Register a coroutine callback on the game script thread and return a cancellable handle. Long work must yield or call checkpoint periodically.

Cancel and release a callback by handle. Safe while callbacks are being processed.

Yield execution for ms (must be called inside run_in_callback). Zero or a negative value resumes on the next frame; very large values are clamped safely.

Yield for one frame only when the current guarded call is close to its time limit. Use inside long queued loops.

Milliseconds remaining in the active guarded Lua call; -1 outside a guarded host-to-Lua call.

Check if currently inside a script callback coroutine

Register a handler for a named event and return its removable handle.

Disable and release an event handler by handle. A handler removed during dispatch is not called again.

Register an isolated ImGui render callback and return its handle. Every Begin/Push must be paired in the same callback.

Disable and release a render callback by handle. Safe while callbacks are being processed.

Keep the script loaded after a runtime callback fails. The failing render/thread callback is stopped.

Return this script's Continue On Error setting.

Return the number of runtime errors reported by this script.

Register a cleanup function called before the script state closes.

Get current game time

Set game time

Set game date

Advance game time

Pause/unpause game clock

Get milliseconds per game minute

Set weather type

Set persistent weather

Transition weather over time

Get current weather type

Clear weather override

Set random weather

Get all weather type names

Set wind speed

Get wind speed

Set rain level

Get rain level

Set snow level

Get snow level

Force lightning

Set gravity level

Set blackout mode

Check if blackout is active

Get game timer (ms)

Get frame delta time

Get frame count

Themed toggle. Style names: "switch", "checkbox", "box", "radio", "text", "button_toggle"

Themed integer slider. Style names: "bar", "modern", "drag", "input", "stepper". opts.step sets the increment, opts.format the display text

Themed float slider. Same styles and opts as slider_int

Themed button. Style names: "plain", "accent", "danger", "link"

Themed dropdown. index is 1-based, like every other list in this API. Style names: "dropdown", "stepper", "radio", "buttons"

A list that holds NO selection - every entry is its own action. Returns the 1-based index clicked this frame, or nil. Style names: "dropdown", "buttons"

Every accepted style name, so a script can offer the user the same choices menu.set_style has

True only inside a render callback. Lets a script branch rather than silently drawing nothing

Add or update a row. Re-using the same key updates that row in place, so calling this every tick from a loop is the intended usage, not a leak. Colour is a packed ImU32 (ABGR) or 0 for the panel default; order sorts the row (built-in rows occupy 0-999, so the 1000 default puts yours after them). Capped at 64 rows per panel

Remove one of your rows by key

Remove every row your script added to a panel. Other scripts' rows are untouched

Every row currently registered on a panel, including other scripts', for a script drawing the panel itself

Hide one of the panel's OWN rows by its English label ("Health", "Armour", ...), matched case-insensitively. Pass false to show it again

Keep the panel's frame, title and image but drop every built-in row, leaving only script rows

false skips the entire native panel, for a script drawing its own from script.register_render. Pass true to restore it

Override the panel's title. "" or nil restores the panel's own

Override the panel's image with a texture id from texture.load / load_from_url. 0 or nil restores the panel's own

What the panel is showing right now, so a script can react to it: { hash, name, number }. `number` is the vehicle class for vehicle_preview or the selected player id for player_info

Every valid panel name

Pin an image to an edge of the menu window, free to overhang outside it - the "character peeking over the top of the menu" look. Re-using a key updates it in place. opts: width, height (0 = the texture's own size; setting only one derives the other from the aspect ratio so it is never stretched), along (0-1 down the edge, 0.5 centres), offset (extra pixels along the edge), overhang (pixels OUTSIDE the edge - match it to the height to sit fully outside), tint (packed ImU32), behind (draw under the window so it peeks out from behind instead of covering the chrome), visible, host ("both" | "clickui" | "listui"). Capped at 32 decals

Remove one of your decals by key

Remove every decal your script added

Load a texture from a file. A relative path resolves inside the lua folder. PNG, JPG, BMP, GIF and WebP (when the codec is installed)

Load a texture from raw image bytes, 1 byte to 64 MB. The string is read length-aware, so binary data with NULs is fine

Download an image and load it in one call - the direct way to use a web image in your GUI. This helper is synchronous, so it blocks the calling script's thread until the download finishes or http's timeouts fire: load during startup or from a script.run_in_callback loop, never from a render callback. For non-blocking downloads use http.get_async and then texture.load_from_memory in its callback. Obeys the user's Network capability and reports HTTP status and empty/oversized bodies as errors

Load an animated GIF. Drive it with update_animation and set_frame

Unload texture by ID

Unload all textures

Get texture dimensions

Check if texture ID is valid

Check if texture is a GIF

Get GIF frame count

Get all loaded texture IDs

Set GIF frame

Update GIF animation

Draw texture

Draw texture with UV coords

Draw texture with tint color

Draw texture as button

Draw a texture at a screen position on the FOREGROUND draw list - on top of everything, ignoring window clipping and scrolling. For an image inside your own window use draw_to_window instead

Draw a texture on the current window's draw list, so it is clipped and scrolled with the window. This is the one to build custom GUI elements with (icon rails, panel art, rounded avatars). Coordinates are absolute screen pixels: imgui.get_window_pos() plus imgui.get_cursor_pos() minus the scroll gives the current spot. A non-zero rounding uses the whole texture and ignores the UVs

Draw texture rotated (foreground draw list)

Hash string using joaat

Get model hash from name

Check if control is pressed

Check if control was just pressed

Check if control was just released

Disable a control input

Get 3D distance between two points

Get 2D distance between two points

Clamp value between min and max

Linear interpolation

Convert degrees to radians

Convert radians to degrees

Get random integer in range

Get random float in range

Random chance (0-100)

Get offset coordinates from entity

Get heading from one position to another

Convert world coords to screen coords

Get screen resolution

Get screen aspect ratio

Format number as money string

Format distance value

Call to mark script done

Member available through Scooby's native Lua API.

Member available through Scooby's native Lua API.

Returns true if script should exit

Member available through Scooby's native Lua API.

Member available through Scooby's native Lua API.

Get tunable as integer

Get tunable as float

Get tunable as boolean

Set tunable as integer

Set tunable as float

Set tunable as boolean

Create transaction

Add item to transaction

Send transaction

Check if in session

Get session type

Get player by name

Get session host

Get script host

Register event handler

Unregister event handler

Draw a line between two points

Draw a rectangle outline

Draw a filled rectangle

Draw a circle outline

Draw a filled circle

Draw text at position

Draw a triangle outline

Draw a filled triangle

Draw a quad outline

Draw a filled quad

Get screen dimensions

Calculate text dimensions

Convert 3D world position to screen coords

Clear all pending draw commands

Draw a filled rectangle (native GRAPHICS::DRAW_RECT). x,y is the CENTRE of the rect; w,h are its full size, all 0.0-1.0.

-- A real in-game native HUD panel, drawn by GTA itself.
-- Toggle with F6. Everything below is native (not an imgui overlay).
local ui = { open = true, running = true }

script.run_in_callback(function()
    while ui.running do
        if input.is_key_pressed(input.keys.F6) then ui.open = not ui.open end
        if ui.open then
            -- panel background (x,y = CENTRE, 0-1 normalised)
            drawing.rect(0.15, 0.30, 0.20, 0.28, 0, 0, 0, 180)
            -- accent header bar
            drawing.rect(0.15, 0.18, 0.20, 0.04, 30, 150, 220, 230)
            -- native title text (left-aligned, x,y = top-left)
            drawing.text("SCOOBY NATIVE UI", 0.06, 0.165, 0.40, 255, 255, 255, 255, 4)
            -- live native stat rows
            drawing.text("Health: " .. player.get_health(), 0.06, 0.22, 0.34, 200, 235, 200, 255, 0)
            drawing.text("Armour: " .. player.get_armour(), 0.06, 0.26, 0.34, 200, 220, 235, 255, 0)
            drawing.text("[F6] hide", 0.06, 0.40, 0.30, 150, 150, 150, 255, 0)
        end
        script.yield(0)
    end
end)

script.on_unload(function() ui.running = false end)

Draw a streamed texture (native GRAPHICS::DRAW_SPRITE). Auto-requests the texture dict. x,y = centre. Draws nothing on the first frame(s) while the dict streams in.

Like sprite, but requests the dict if not resident and returns true only if it actually drew this frame — use to preload/poll instead of drawing nothing.

Native pixel dimensions of a texture in a streamed dict (GET_TEXTURE_RESOLUTION). Requests the dict if needed; returns nil until it's resident. Use for aspect-correct sizing.

Draw native game text. x,y = top-left, 0-1 normalised. font: 0=Chalet, 1=Sign, 2=Cursive, 4=Condensed, 7=Pricedown.

Draw native text centred horizontally on x.

Draw native text at a 3D world position (billboards toward the camera).

Measure native text width in normalised 0-1 units.

Draw a 3D world marker (native GRAPHICS::DRAW_MARKER).

Draw a 3D world-space line (native GRAPHICS::DRAW_LINE).

Draw a 3D world-space box.

Draw a 3D world-space sphere.

Stream a texture dictionary for use with drawing.sprite; returns true once it's loaded (poll across frames: repeat until drawing.request_texture_dict(d)).

Check whether a streamed texture dict is ready.

Release a streamed texture dict.

Send an HTTP GET. URL queries are preserved and the body is returned length-aware, so binary responses (images, archives) survive intact. Responses are capped at 64 MB to keep a bad endpoint from exhausting the host

Same request as get, with the byte count returned explicitly. Hand the body straight to texture.load_from_memory or buffer.from_string

GET and decode the response as JSON. Invalid JSON comes back as nil plus a parse error instead of throwing, so a flaky endpoint cannot kill the script

Start a non-blocking GET and return a request ID. The callback runs on the Lua/game thread as callback(body, status, error_or_nil), and is discarded safely if the script unloads. The same 64 MB response cap applies.

Start a non-blocking POST and return a request ID. At most 32 async requests may be outstanding globally.

Start a non-blocking custom request and return a request ID. Completion delivery is bounded per frame.

Cancel callback delivery for a request owned by this script. The underlying WinHTTP operation is allowed to finish in the background.

Check whether this script still owns a pending request ID.

Return this script's number of outstanding asynchronous requests.

Per-stage timeouts in milliseconds. These bound synchronous calls and background request workers. Omitted stages keep their current value; each is clamped to 1000-120000. Raise the receive timeout before fetching something large

Read the current per-stage timeouts

Restore the default timeouts (5s resolve, 8s connect, 8s send, 15s receive)

Send HTTP POST request

Send HTTP PUT request

Send HTTP DELETE request

Send custom HTTP request

URL encode a string

URL decode a string

Download file from URL to lua folder

Open URL in default browser

HTTP request with custom headers

GET request with Bearer token

POST request with Bearer token

GET request with Basic auth

POST request with Basic auth

Check if key was just pressed this frame

Check if key is held down

-- Move a Lua-drawn window/actor with WASD, independent of the
-- game's own movement — call this from script.register_render.
if input.is_key_down(input.keys.W) then player_y = player_y - speed end
if input.is_key_down(input.keys.S) then player_y = player_y + speed end
if input.is_key_down(input.keys.A) then player_angle = player_angle - turn_speed end
if input.is_key_down(input.keys.D) then player_angle = player_angle + turn_speed end

Check if key was just released this frame

Get mouse position

Get mouse movement since last frame

Get vertical scroll delta this frame

Check if mouse button was just clicked

Check if mouse button held

Check if mouse button released

Check if mouse button was double-clicked

Check if a gamepad (XInput slot 0) is connected

Check if a gamepad button is held

Check if a gamepad button was just pressed this frame

if input.is_gamepad_connected() then
    if input.is_gamepad_button_pressed(input.gamepad.A) then
        notification.info("A pressed", 1000)
    end
    local lx = input.get_gamepad_axis(input.gamepad_axis.LEFT_X)
    local ly = input.get_gamepad_axis(input.gamepad_axis.LEFT_Y)
    -- lx/ly are -1..1; deadzone before using them for movement
    if math.abs(lx) > 0.2 or math.abs(ly) > 0.2 then
        move(lx, ly)
    end
end

Read a gamepad analog axis

Check if a GTA control was just pressed

Check if a GTA control is held

Check if a GTA control was just released

Disable a single GTA control this frame (must be called every frame to stay disabled)

Re-enable a previously disabled GTA control

Disable every GTA control in an input group this frame

Convenience: disable ALL foot + vehicle controls this frame. Call every frame (e.g. from script.register_render) while your UI should have exclusive input.

script.register_render(function()
    if my_window_open then
        input.block_game_input(true)
        -- ... draw your imgui window ...
    end
end)

Override an analog control's value for the next frame

Read an analog control's normalized value

Check a just-pressed control even while disabled

Check a held control even while disabled

Read byte from address

Read short from address

Read int from address

Read long from address

Read float from address

Read double from address

Read string from address

Read pointer from address

Write byte to address

Write short to address

Write int to address

Write long to address

Write float to address

Write double to address

Add offset to address

Resolve RIP-relative address

Check if address is valid

Get module base address

Scan a module or explicit address range for the first IDA-style signature match.

Return up to 4096 matches for an IDA-style signature.

Cherax-compatible scan that checkpoints near the watchdog limit inside a queued callback.

Scan an ordered array of patterns and yield between bounded batches inside a queued callback.

Get current time in milliseconds

Get current time in seconds (float)

Get elapsed time since start

Get game tick count

Get delta time since last frame

Get current FPS

Get system time as table

Format current time

Get unix timestamp

Create reusable timer object

Get elapsed time since start/reset

Reset timer to current time

Check if interval has passed

Check if ready and auto-reset if true

Set new interval

Get current interval

Read file contents

Write content to file

Append content to file

Check if file/folder exists

Delete file or folder

Create directory

List directory contents

Check if path is directory

Get file size in bytes

Copy file to destination

Move/rename file

Get absolute path to lua folder

Open folder in Windows Explorer

Extract ZIP archive to destination

Parse JSON string to table

Convert table to JSON string

Check if string is valid JSON

Get value at path (dot notation)

Set value at path (dot notation)

Merge two tables

Get array of keys

Get array of values

Get number of elements

Compute MD5 hash

Compute SHA1 hash

Compute SHA256 hash

Compute SHA512 hash

Encode to Base64

Decode from Base64

Encode to hex string

Decode from hex string

Compute CRC32 checksum

Compute JOAAT hash (GTA hash)

Generate random bytes

Generate random hex string

Generate UUID string

Get current game time

Set game time

Get game date

Set game date

Pause/unpause game clock

Set weather type

Set rain level (0-1)

Get rain level

Set wind speed

Get wind speed

Toggle city blackout

Create explosion

Start a fire

Remove fire by ID

Extinguish all fires

Get ground height at coords

Cast ray between points

Get street name at coords

Clear peds/vehicles/objects

Begin a window. Always call end_() once, even when visible is false.

Begin a persistent closable window. Always call end_() once; use visible only to skip contents.

End the Lua-owned window. Extra calls are rejected before touching host UI state.

Begin child region

End child region

Display text

Display colored text

Display wrapped text

Create button

Create checkbox with storage

Create checkbox with value

Integer slider whose value lives in imgui's own id-keyed storage. Prefer slider_int_value when your script already owns the number

Float slider whose value lives in imgui's own id-keyed storage. Prefer slider_float_value when your script already owns the number

A colour swatch that opens a picker when clicked. Components are 0-1. Value in, value out - color_button only DISPLAYS a colour, this is the one that changes it, which any ESP/chams/theme section needs

The full inline picker (wheel or square plus sliders) rather than a popup swatch. Same value-in/value-out shape as color_edit

Clip subsequent draw-list output to a rectangle. Needed for a scroll region you draw yourself - without it hand-drawn content spills past the panel it belongs to. Must be paired with pop_clip_rect

Pop the clip rect pushed by push_clip_rect

Four-corner gradient fill. The only way to draw a gradient panel, slider track or colour ramp from Lua - add_rect_filled is flat only. Colours are packed ImU32 (ABGR)

Filled triangle - chevrons, arrows and pointers without faking them out of two lines

Filled quad, for skewed panels and custom shapes

Cubic bezier curve, for curved connectors and curve previews

True while a drag is in progress. For hand-built draggable things: a custom slider grab, a movable panel, a colour-wheel cursor

How far the mouse has moved since the drag began

Zero the drag delta after consuming it, so the next frame reports movement since now rather than since the drag started

Integer slider that takes the current value and hands back the new one, leaving your script the single owner of the state (same shape as checkbox_value)

Float slider that takes the current value and hands back the new one, leaving your script the single owner of the state (same shape as checkbox_value)

Text input with storage

Integer input with storage

Float input with storage

Dropdown combo with storage

Listbox with storage

Begin a combo popup

End combo popup

Create selectable item

RGBA color picker

Begin tab bar

End tab bar

Begin tab item

End tab item

Begin a table layout

End table layout

Advance to the next table row

Advance to the next table column

Select a table column

Configure a table column

Render table headers

Create tree node

End tree node

Create collapsing header

Place next item on same line

Draw horizontal separator

Add vertical spacing

Open popup by ID

Begin popup content

End popup

Check if last item hovered

Check if last item clicked

Push style color

Pop style color

Push style variable

Pop style variable

Set the next item width

Push an ImGui ID scope

Pop an ImGui ID scope

Store value by ID

Retrieve value by ID

Display progress bar

Get clipboard text

Set clipboard text

Clear clipboard

Check if clipboard has text

Get config value

Set config value

Save config to file

Load config from file

Check if key exists

Remove config key

Clear all config

Get all config as table

Set all config from table

Get config file path

Get local player ID

Get local player ped handle

Get local player as Ped object

Get local player vehicle handle (0 if none)

Get local player vehicle as Vehicle object

Check if player is in vehicle

Get player position

Set player position

Teleport player to position

Get player heading

Set player heading

Get player health

Set player health

Get player max health

Get player armour

Set player armour

Check if player is dead

Set player invincibility

Check if player is invincible

Get wanted level (0-5)

Set wanted level (0-5)

Clear wanted level

Get local player name

Get player money (wallet)

Give weapon to player

Remove weapon from player

Remove all weapons

Get current weapon hash

Set current weapon

Check if player has weapon

Enable infinite ammo

Enable infinite clip

Give all weapons to player

Refill current weapon ammo

Get number of players in session

Get table of all player IDs

Get player name by ID

Get ped handle of player by ID

Get position of player by ID

Check if local player is host

Check if session is started

Spawn vehicle at position

Spawn vehicle in front of player

Spawn vehicle and enter it

Spawn ped at position

Spawn ped near player

Spawn bodyguard with weapon

Clone existing ped

Spawn object at position

Spawn object in front of player

Spawn object attached to entity

Check if model hash is valid

Check if model is a vehicle

Check if model is a ped

Request and load model

Delete spawned entity

Delete all vehicles nearby

Delete all peds nearby

Create blip at coordinates

Create blip for entity

Create radius blip

Create area blip

Remove blip

Set blip sprite/icon

Get blip sprite

Set blip color

Get blip color

Set blip transparency

Get blip transparency

Set blip scale

Set blip name

Show route to blip

Set route line color

Set blip flashing

Set short range display

Set blip as friendly

Get waypoint coordinates

Check if waypoint is set

Set waypoint on map

Clear waypoint

Create scripted camera

Create camera at position

Destroy camera

Destroy all scripted cameras

Set camera position

Get camera position

Set camera rotation

Get camera rotation

Set field of view

Point camera at coordinates

Point camera at entity

Attach camera to entity

Attach camera to ped bone

Set camera as active

Check if camera is active

Enable scripted camera rendering

Shake camera

Stop camera shake

Set motion blur strength

Set depth of field

Get gameplay camera position

Get gameplay camera rotation

Get gameplay camera FOV

Shake gameplay camera

Stop gameplay camera shake

Fade screen in

Fade screen out

Check if screen fading in

Check if screen fading out

Check if screen fully visible

Check if screen fully black

Smoothly transition between cameras

Check if camera is interpolating

Add new tab to menu

-- Native UI template — every widget below appears in the real
-- Scooby menu (ClickUI Lua Content + List UI). No imgui.* needed.
local tab = menu.add_tab("My Script")
local subtab = menu.add_subtab(tab, "Main")
local category = menu.add_category(subtab, "Features")

menu.add_toggle(category, "Example Toggle", function(value)
    notification.info("Toggle: " .. tostring(value), 2000)
end, false)

menu.add_slider_int(category, "Example Slider", 0, 100, function(value)
    notification.info("Slider: " .. value, 2000)
end, 50)

menu.add_button(category, "Example Button", function()
    notification.success("Button pressed!", 2000)
end)

script.on_unload(function()
    -- cleanup here
end)

Add subtab to a tab

Add category/group header

Mount a script sub-tab INSIDE an existing native tab, e.g. menu.attach("Self > Main", "My Script"). The returned id is a normal parent, so every add_* function works underneath it, and both ClickUI and List UI render it. A submenu-only path such as "Self" lands on that submenu's first category

-- Put your features inside a tab the menu already has, instead of
-- a separate Lua Content tab.
local mine = menu.attach("Self > Main", "My Script")

menu.add_toggle(mine, "Example Toggle", function(value)
    notification.info("Toggle: " .. tostring(value), 2000)
end, false)

-- Grid of buttons instead of one long column
local grid = menu.add_group(mine, "Quick Actions", 3)
menu.add_button(grid, "Heal", function() end)
menu.add_button(grid, "Armour", function() end)

-- Discover the paths THIS build actually has
for _, target in ipairs(menu.mount_targets()) do
    log.info(target.path .. "  =  " .. target.label)
end

List every native path menu.attach accepts in this build, as { path = "self>main", label = "Self > Main" }

List this session's active mounts as { path = ..., id = ..., name = ... }

Add a button grid. Button/hyperlink children flow into items_per_row columns in ClickUI; List UI gives the group its own page

Add toggle feature

Add button feature

Add integer slider

Add float slider

Add an integer slider whose callback fires only when the value is CONFIRMED, not on every step. Use it for anything expensive (spawning, stat writes) that must not run once per step while scrolling

Add text input

Add integer input

Add float input

Add dropdown/combo box. Holds a selection; the callback receives the 1-based index

Add a menu of one-shot actions. Holds NO selection: picking an option calls callback(value, name). options is an array of strings, or of { value, name } / { value = , name = } tables

Add color picker

Add horizontal separator

Add info text/label

Add a row with the name on the left and a script-owned value on the right. Drive it with menu.set_value from a script.run_in_callback loop for live stats

Add a row that opens a URL in the default browser

Set feature description

Set feature visibility

Read a feature's visibility

Rename a Lua-created tab, subtab, category or widget at runtime

Read the current name of a Lua-created menu element

Set the icon glyph shown before an element's name. Works on any element, not just main tabs

Read an element's icon glyph

Pick the widget presentation instead of following the menu theme. Toggles: "switch", "checkbox", "box", "radio", "text", "button_toggle". Sliders: "bar", "modern", "drag", "input", "stepper". Combos: "dropdown", "stepper", "radio", "buttons". Buttons: "plain", "accent", "danger", "link". "auto" restores the theme default. A name that does not apply to the element's kind is ignored, so one style is safe to set across a mixed group. List UI honours the toggle looks and draws "stepper"/"input"/"drag" as value-only rows

Read a feature's style name ("auto" when it follows the theme)

Every accepted menu.set_style name

Recolour the active part of a widget - a toggle's on state, a slider's fill, a button's body. Components above 1 are read as 0-255, otherwise as 0-1. Call with no colour to restore the theme accent

Recolour a feature's label. Same colour conventions as set_accent; no colour restores the theme

Width (and optional height) in unscaled pixels for a widget's interactive part. The frontend applies the user's UI scale, so a script never needs to know it. 0 restores auto-sizing

Get current feature value

Set feature value. On a Readonly this sets the right-hand text; on a Text element it sets the label

Retune a slider or numeric input's min/max at runtime. The current value is clamped into the new range

Read a slider or numeric input's bounds

How far one left/right press moves the value. Applies to sliders and numeric inputs in both UIs

Read a feature's step size

Coarse increment for numeric inputs (ImGui's ctrl-click / held +- step)

Decimal places shown on a float widget (0-9)

printf format for the value shown next to a numeric widget, e.g. "%d%%" or "%.1f m/s". Pass "" to restore the default

Read a feature's display format

Show a word INSTEAD of one specific numeric value, e.g. 0 -> "Off". Re-adding the same value replaces its text

Remove every value replacement from a feature

Replace a combo or list_action's options at runtime. Same table shapes as add_list_action; a stale combo selection is clamped

Read a combo or list_action's option names

Grey a feature out without hiding it. The reason shows as its tooltip/description

Check whether a feature is greyed out

Make a button ask for confirmation before firing. Pass "" to clear it

Cycle a colour picker's hue every frame. The change callback does NOT fire while cycling — read the live colour with menu.get_value instead

Element type as a string: tab, subtab, category, group, toggle, button, slider_int, slider_float, click_slider, input_text, input_int, input_float, combo, list_action, color, separator, text, readonly, hyperlink

Parent element id, or nil for root tabs and mounts

Move an element and its whole subtree under a different parent. Refuses to create a cycle

Ids of every root tab this session created

Child element ids of a container, in creation order

Fire an element's callback from script, as if it had been clicked

Remove feature from menu

Remove every child of a container, keeping the container itself so ids handed out earlier stay valid

Overwrite the value menu.reset restores. Every add_* already records its starting value as the default, so this is only needed to change it

Restore a feature to its default and fire its callback

Persist a widget's value to lua/configs/<script>.menu.json. Turning it ON immediately restores any stored value AND fires the callback, so the script's own state matches the widget with no extra wiring. Omit the key to derive one from the widget's path

-- Survives a menu restart with no config plumbing of your own.
local mine = menu.attach("Self > Main", "My Script")

local godmode = menu.add_toggle(mine, "God Mode", function(on)
    player.set_invincible(on)
end, false)
menu.set_saveable(godmode)          -- restored + callback fired on load
menu.set_hotkey(godmode, input.keys.F4)

local power = menu.add_slider_int(mine, "Power", 0, 100, function(v) end, 50)
menu.set_saveable(power)
menu.set_format(power, "%d%%")     -- shows "50%"
menu.add_value_replacement(power, 0, "Off")

-- Hide an overlay while the user is in the menu
script.run_in_callback(function()
    while true do
        if not menu.is_open() then
            -- draw your overlay here
        end
        script.yield(0)
    end
end)

Whether a feature persists, and the key it uses

Force a write now. Omit the id to flush every saveable widget this script owns

Bind a key (or a chord) to a feature. Accepts one input.keys value, or a table where every entry but the last must be HELD and the last must be freshly PRESSED. The binding is shown next to the feature in both UIs and fires it exactly as a click would

A feature's hotkey label ("CTRL + F5") and its virtual-key chain

Remove a feature's hotkey

Whether ClickUI or List UI is currently showing. Use it to hide an overlay while the user is in the menu

Which UI is up: "clickui", "listui" or "closed"

Open/close ClickUI, returning the new state

ClickUI window position in pixels

ClickUI window size in pixels

Navigate ClickUI to where an element lives — the native tab a menu.attach mount sits in, or Settings > Lua Content for a root Lua tab

Mark a widget as acting on the selected player. Its callback then receives (value, player_id, player_name) and it greys out while nothing is selected. Pair it with menu.attach("Players > ...") to sit beside the built-in player features

-- A player feature that lives in the real Players tab.
local mine = menu.attach("Players > Troll", "My Script")

local slap = menu.add_button(mine, "Slap Selected", function(_, id, name)
    if not id then return end
    notification.info("Slapping " .. name, 2000)
end)
menu.set_player_feature(slap)

-- React to the selection changing
local label = menu.add_readonly(mine, "Target", "none")
menu.on_player_change(function(id, name)
    menu.set_value(label, id and name or "none")
end)

-- Live value only while the row is actually on screen
local hp = menu.add_readonly(mine, "Their Health", "-")
menu.set_player_feature(hp)
menu.on_tick_in_view(hp, function()
    local id = menu.get_selected_player()
    if not id then return end
    local ped = players.get_ped(id)
    menu.set_value(hp, ped ~= 0 and tostring(Ped.new(ped):get_health()) or "-")
end)

Whether a widget is flagged as acting on the selected player

The currently selected player id (nil when none) and its name

Run a callback whenever the selected player changes: callback(player_id, player_name), with player_id nil when the selection was cleared. Fires once per change, not per frame. Returns a handler id for menu.remove_handler

Run a callback every frame the element is ACTUALLY drawn — cheaper than a script-wide polling loop for live readonly rows. Registering again replaces the previous handler

Remove an on_player_change handler by its id, or an element's on_tick_in_view handler by passing the element

Register a key with its English default. Registering the same key twice is harmless — the first default wins, which lets two scripts share a key

-- Name a widget after a key and it follows the user's language.
locale.register("MYSCRIPT_GODMODE", "God Mode")

local mine = menu.attach("Self > Main", "My Script")
menu.add_toggle(mine, "MYSCRIPT_GODMODE", function(on)
    player.set_invincible(on)
end, false)

-- Or resolve manually
notification.info(locale.get("MYSCRIPT_GODMODE"), 2000)

Resolve a key to its localised text. Unregistered input comes back unchanged, so this is safe to wrap around any string

Override a key's text for this user, persisted with the menu's other label overrides

Drop an override, falling back to the registered default

Whether a key currently has a user override

Active language index (0 = English)

Switch language. 0 is English; other values start an async translation load that applies on a later resolve

Every registered label as { key, default, text, overridden }

Get label text by hash

Get label text by name

Check if label exists

Add custom text label

Clear custom labels

Get system language ID

Get current game language

Get language name

Return the complete theme table, or one value selected by a dotted path

Apply a complete theme table. The clickui and listui sections are merged into native persisted theme state

Merge a partial table into one native UI surface without replacing unrelated settings

Set one value using a dotted path such as listui.navigation.showMainTabs or notifications.notificationWidth

Invalidate UI image and GIF caches after a Lua script changes assets

Return the managed image folder for listui, clickui, overlays, notifications or player_info

Compatibility bridge version string

Table of script ecosystems this bridge intentionally supports

Lua compatibility is enabled; scripts can use the compatibility aliases for Texture, Time, Utils, Natives, Script, FeatureMgr, ClickGUI, ListGUI, EventMgr, GUI, Logger, eFeatureType, eCallbackTrigger, eLuaEvent, eGuiMode and eLogColor aliases

Compatibility property bridge is enabled for Feature.Value, Feature.Enabled, Feature.List, Feature.Callback and related aliases

Compatibility Tab/ListWidget builder controls are enabled for AddButton, AddToggle, AddSliderInt, AddSliderFloat, AddCombo and AddInputText

Extra compatibility example-script aliases are enabled for Utils.GetTimeEpocheMs, Logger.LogInfo, SetNoCallbackOnPress and player feature iteration

Compatibility runtime wrappers are enabled for Memory allocation helpers, Players/GTA/PoolMgr wrappers and ImGui background draw helpers

Re-install compatibility aliases if another script overwrote them

Create a guarded global table alias when the source table exists

Run a Lua callback through pcall and route errors to the Scooby Lua log

Alias of natives. Call native.load_natives() or natives.load_natives() before using GTA native namespaces

Notification table aliases for scripts that use either naming style

Aliases for the sandboxed file API

Alias/wrapper for file helpers, including GetMenuRootPath, DoesFileExist, ReadFileContent, WriteFileContent, DeleteFile, CreateFolder and FindFiles

Show a Scooby notification from Yim/Stand/2Take1-style scripts

Yield inside a script callback using Scooby's scheduler

Run a callback every script tick from a compatibility script; stops and logs once if the callback errors

Run a callback once on the script thread for FiveM/older menu ports

Load generated natives if they are not already loaded

Hash helper aliases for ported scripts

Alias for a persistent looped callback

FiveM-style wait alias backed by script.yield

FiveM-style script-thread callback wrapper

Run a callback after a delay using thread.set_timeout when available

Common JSON aliases backed by Scooby json.encode/json.decode

Convenience JSON file helpers inside the Lua sandbox

Current-character MP stat prefix helper used by SilentNight/2Take1-style recovery scripts

Native invoker compatibility aliases; raw native hashes are resolved through Scooby's crossmap before calling _I

Compatibility allocation helpers backed by Scooby's memory.allocate/free/read/write APIs

Player and CPed wrapper helpers for scripts that iterate player objects instead of raw ids

Compatibility GTA helper wrappers for local handles, pointer-to-handle conversion and normalized world-to-screen coordinates

Best-effort pool iteration wrappers backed by Scooby entities scans

Compatibility background draw helpers routed through Scooby draw helpers when available

Compatibility uppercase ImGui aliases; table helpers are compatibility stubs when the underlying renderer does not expose real tables

Feature manager compatibility shim for scripts that add their own features or render their own ClickGUI tabs. Supports canonical hash/name/type/desc/callback and simpler name/type/desc/callback forms

Extra Compatibility feature lookup/iteration aliases used by menu scripts

Global compatibility helper aliases for adding and retrieving normal/player features

Feature property aliases mapped to Scooby compatibility feature state

Feature callback triggers for OnClick, OnRender, OnTick and value/list changes

Compatibility button behavior alias for features that should fire registered trigger callbacks without also calling the base callback on press

Custom GUI tab compatibility shim; tabs render in their own Lua windows through script.register_render

Additional ClickGUI compatibility aliases for scripts that register or hide custom tabs

List UI compatibility shim; tabs/widgets/sub-tabs render through the compatibility window instead of the old native ListUI

ListGUI compatibility widget builders that create compatibility Feature objects and add them to the tab/widget

Compatibility metadata helpers backed by Scooby game/version data where available

Compatibility texture helper aliases backed by Scooby's texture module when available

Compatibility time helpers using the Lua runtime clock

Lightweight compatibility vector tables with x/y/z/w fields and basic add/subtract/multiply helpers

Compatibility utility helpers mapped to Scooby player/input modules when available

Event manager compatibility layer; ON_PRESENT/ON_POST_PRESENT and ON_UNLOAD are wired to Scooby callbacks, other events can be registered or manually triggered safely

Notification and logging aliases mapped to Scooby notify/log

ScriptGlobal shortcuts for ported Lua scripts

Create a ScriptGlobal object from a raw global index

ScriptLocal shortcuts for ported Lua scripts; returns default values if the script is not running

Create a ScriptLocal object from script name/hash and local index

Callable aliases for ScriptGlobal.new(index) and ScriptLocal.new(script, index)

Script-thread guards for ported Lua scripts; use before script-local writes

Create/get a default Lua menu root and return an object-style node

Object-style menu category helper used by older Lua scripts

Object-style group helper; maps to a Scooby category

Object-style submenu helper; maps to a Scooby category

Object-style button helper; accepts 2Take1/Yim-style argument shapes

Object-style toggle helper

Object-style input/color helpers for older menu APIs

ScoobyOPMenu/Stand-style menu aliases backed by Scooby menu widgets

Toggle that runs a callback every script tick while enabled

Minimal 2Take1-style feature adapter for action/toggle/value scripts

ScoobyOPMenu-style entity list aliases backed by esp entity scanners

Entity helper aliases backed by Entity.* functions when available

Yim/Stand-style player helper aliases backed by Scooby players

Small pointer object wrapper with add/sub/rip/read/write helpers for byte/short/int/long/float/double/string

Play UI/frontend sound

Play sound at position

Play sound from entity

Stop playing sound

Make ped speak

Stop ped speaking

Set radio station

Get current radio station

Skip to next radio track

Set vehicle siren

Check if siren is on

Blip siren momentarily

Start vehicle horn

Play system beep

Teleport to coordinates

Teleport to waypoint marker

Teleport to blip type

Teleport to mission objective

Teleport forward by distance

Teleport upward by distance

Teleport to another player

Teleport player to you

Get ground Z coordinate

Teleport into vehicle

Teleport to preset location

Get list of preset locations

Check if control is pressed

Check if control was just pressed

Check if control was just released

Check if disabled control is pressed

Disable control for this frame

Enable control for this frame

Disable all controls

Enable all controls

Get control normal value (-1 to 1)

Get unbound control normal

Set control normal for next frame

Check if using keyboard

Vibrate gamepad

Stop gamepad vibration

Set control exclusive to script

Get last input (0=KB/M, 1=gamepad)

Get control constant table

Get hash from string

Get frame delta time

Get current frame count

Get game time in ms

Get system time table

Get in-game date table

Check if cutscene playing

Skip current cutscene

Check if game is loading

Wait for milliseconds

Pause/unpause game

Check if game is paused

Get random integer

Get random float

Get distance between points

Get heading between coords

Clear area of entities

Create pickup

Get pickup hash from name

Check if pickup exists

Remove a pickup

Check if in GTA Online

Check if session started

Get interior at position

Check if interior is ready

Refresh an interior

Enable interior prop

Disable interior prop

Request model to load

Check if model is loaded

Release model from memory

Check if model is valid

Check if model is vehicle

Check if model is ped

Request and wait for model

Request collision at coords

Load game scene at coords

Start new scene load

Check if scene load active

Check if scene is loaded

Stop scene loading

Request particle effect asset

Check if ptfx loaded

Remove ptfx from memory

Request animation dictionary

Check if anim dict loaded

Remove anim dict from memory

Request clip set

Check if clip set loaded

Remove clip set from memory

Request IPL to be loaded

Remove IPL

Check if IPL is active

Give weapon to ped

Remove weapon from ped

Remove all weapons from ped

Check if ped has weapon

Get current weapon hash

Set current weapon

Get weapon ammo count

Set weapon ammo count

Get max ammo for weapon

Get weapon clip size

Get ammo in current clip

Set ammo in current clip

Give weapon component

Remove weapon component

Check if weapon has component

Set weapon tint

Get weapon tint index

Toggle infinite ammo

Toggle infinite clip

Give all weapons to ped

Get common weapon hash constants

Convert 3D world coords to 2D screen

Get entity position on screen

Get bone position on screen

Get entity 2D bounding box

Get all peds from pool

Get all vehicles from pool

Get all objects from pool

Get peds within radius

Get vehicles within radius

Get all bone screen positions

Get ped health/armour info

Get vehicle health/speed info

Check if entity is on screen

Get distance to entity

Get local player ped handle

Get common bone ID constants

Clear all ped tasks

Clear tasks immediately

Task ped to go to entity

Task ped to go to coords

Follow navmesh to coords

Task ped to wander

Task ped to stand still

Task ped to jump

Task ped to cower

Task ped hands up

Task ped to fight target

Task ped to shoot entity

Task ped to shoot coord

Task ped to aim at entity

Task ped to aim at coord

Task ped to reload weapon

Play animation on ped

Play animation with position

Stop animation on ped

Check if playing animation

Task ped to enter vehicle

Task ped to leave vehicle

Task drive to coords

Task vehicle to chase target

Task vehicle to flee target

Start ped scenario

Use nearest scenario

Stop current scenario

Task rappel from helicopter

Task ped to parachute

Parachute to target coords

Task ped to skydive

Get task sequence progress

Get task script status

Create object at coords

Create object with heading

Create object attached to entity

Delete object

Check if object exists

Get object model hash

Get all objects from pool

Get closest object to position

Get nearby objects

Place object on ground

Slide object to coords

Set object targetable

Register door to system

Remove door from system

Set door state

Get door state

Lock/unlock door

Create pickup at coords

Create ambient pickup

Create money pickup

Create portable pickup

Remove pickup

Check if pickup exists