31 KiB
YimMenuV2 Lua API
This document lists every global table, class, and function exposed to Lua scripts in YimMenuV2.
Scripts live in %appdata%/YimMenuV2/scripts. Each script runs in its own sandboxed Lua (LuaJIT) state with the globals below already available.
Contents
- Conventions
- Standard libraries
- Core / UI: notify · log · util · script · event · menu · commandmgr · ImGui
- Memory: memory · pointer
- Math: Vector3
- Entities: Entity · Ped · Vehicle · entities
- Players: Player · players
- Game scripts: ScriptGlobal · ScriptLocal · ScriptPointer · ScriptPatch · ScriptFunction · scripts
- Natives & online: natives · network · tunables · stats · transactions
- Files: FileMgr
- internal
Conventions
table.func(args)— a function called on a global table, e.g.notify.info(...).obj:method(args)— a method called on an object instance, e.g.ped:set_health(100).Class.new(...)/Class(...)— a constructor that returns a new object.- Arguments in
[brackets]are optional.-> typedescribes the return value. - A hash argument accepts either an integer hash or a string name (it's hashed with Joaat automatically).
- A latent call yields the current script coroutine until it finishes, so it may only be used inside a script callback.
Standard libraries
Scripts get a whitelisted subset of LuaJIT's standard library: base, table, string, math, debug, bit, jit.
package, io, os, and ffi are intentionally not available. Use FileMgr for file access and util.time for time.
notify
In-game notifications. duration is in milliseconds (default 5000).
| Function | Description |
|---|---|
notify.success(title, message, [duration]) |
Green success notification. |
notify.info(title, message, [duration]) |
Blue info notification. |
notify.warn(title, message, [duration]) |
Yellow warning notification. |
notify.error(title, message, [duration]) |
Red error notification. |
log
Writes to the menu log file (cout.log), prefixed with the script name.
| Function | Description |
|---|---|
log.verbose(message) |
Log at verbose severity. |
log.info(message) |
Log at info severity. |
log.warn(message) |
Log at warning severity. |
log.error(message) |
Log at error severity. |
log.trace(message) |
Log a message together with a Lua stack traceback. |
util
| Function | Description |
|---|---|
util.joaat(string) -> integer |
Returns the Joaat hash of a string. |
util.time() -> integer |
Returns the current Unix time in milliseconds. |
script
Controls script execution and coroutines.
| Function | Description |
|---|---|
script.run_in_callback(fn) |
Registers fn to run as a script callback (its own coroutine). |
script.yield([ms]) |
Yields the current callback for at least ms milliseconds (default 0 = one frame). Must be called from inside a callback. |
script.is_inside_callback() -> boolean |
Returns true if called from inside a script callback coroutine. |
event
Register callbacks for menu/game events.
event.register_handler(menu_event, handler)
Calls handler (a function) whenever menu_event fires.
The menu_event enum table holds the event ids:
| Event | Fires when |
|---|---|
menu_event.PlayerLeave |
A player leaves the session. |
menu_event.PlayerJoin |
A player joins the session. |
menu_event.ScriptedGameEventReceived |
A scripted game event is received. |
menu_event.ChatMessageReceived |
A chat message is received. |
menu_event.Unload |
The script is being unloaded. |
menu
Build menu UI: submenus, categories, and groups. Most builders return a handle you keep calling methods on.
Top-level
| Function | Description |
|---|---|
menu.set_menu_name(name) |
Sets the script's submenu display name. |
menu.set_menu_icon(icon) |
Sets the script's submenu icon. |
menu.get_menu_name() -> string |
Returns the current submenu name. |
menu.get_submenu([name]) -> Submenu |
Finds or creates a submenu (defaults to the menu/script name). |
menu.find_submenu(name) -> Submenu | nil |
Finds an existing submenu by name. |
menu.create_group(name, [per_row]) -> Group |
Creates a standalone group (drawn manually via group:draw()). per_row default 7. |
menu.is_open() -> boolean |
Returns true if the menu is open. |
menu.toggle() |
Toggles the menu open/closed. |
Submenu
| Method | Description |
|---|---|
submenu:add_category(name) -> Category |
Adds a category to the submenu. |
submenu:find_category(name) -> Category | nil |
Finds a category by name. |
Category
| Method | Description |
|---|---|
category:add_group(name, [per_row]) -> Group |
Adds a group. per_row default 7. |
category:find_group(name) -> Group | nil |
Finds a group by name. |
category:imgui(fn) |
Registers a raw ImGui draw callback rendered every frame. |
Group
| Method | Description |
|---|---|
group:add_command(name) |
Adds an existing command by name. |
group:add_bool_command(name) |
Adds an existing bool command by name. |
group:add_int_command(name, [slider]) |
Adds an existing int command (slider default true). |
group:add_float_command(name, [slider]) |
Adds an existing float command (slider default true). |
group:add_list_command(name) |
Adds an existing list command by name. |
group:add_button(name, label, [desc], fn) -> CommandHandle |
Creates and adds a button command. |
group:add_checkbox(name, label, [desc], [default], [on_enable], [on_disable]) -> CommandHandle |
Creates and adds a checkbox command. |
group:add_looped_checkbox(name, label, [desc], tick, [on_enable], [on_disable]) -> CommandHandle |
Creates and adds a looped checkbox (runs tick every frame while enabled). |
group:imgui(fn) |
Registers a raw ImGui draw callback inside the group. |
group:draw() |
Manually renders the group (for standalone groups inside an imgui callback). |
commandmgr
Create commands directly (without placing them in a group). Each returns a CommandHandle.
| Function | Description |
|---|---|
commandmgr.add_command(name, label, desc, on_call) -> CommandHandle |
Creates a one-shot command. |
commandmgr.add_bool_command(name, label, desc, [default], [on_enable], [on_disable]) -> CommandHandle |
Creates a toggle command. |
commandmgr.add_looped_command(name, label, desc, tick, [on_enable], [on_disable]) -> CommandHandle |
Creates a looped command (tick runs every frame while enabled). |
commandmgr.add_int_command(name, label, desc, [min], [max], [default], [on_change]) -> CommandHandle |
Creates an int command. |
commandmgr.add_float_command(name, label, desc, [min], [max], [default], [on_change]) -> CommandHandle |
Creates a float command. |
commandmgr.add_list_command(name, label, desc, entries, [default], [on_change]) -> CommandHandle |
Creates a list command. entries is an array of { key, label } pairs. |
commandmgr.get_command(name) -> CommandHandle | nil |
Looks up any existing command by name (built-in or Lua). |
CommandHandle
| Method | Description |
|---|---|
cmd:get_value() -> value |
Returns the command's current value (bool/int/float/list index; nil for one-shot). |
cmd:set_value(value) |
Sets the command's value, firing its callbacks. |
cmd:get_name() -> string |
Returns the command's label. |
cmd:get_desc() -> string |
Returns the command's description. |
cmd:draw() |
Draws the command (call from inside an ImGui callback). |
ImGui
Full immediate-mode GUI bindings, used inside category:imgui / group:imgui callbacks. Widgets that edit a value take the current value and return the (possibly updated) value plus a changed/pressed boolean — e.g. value, changed = ImGui.Checkbox("Label", value).
Colors are passed as separate r, g, b, a numbers or as a Lua table depending on the function. Flag/condition arguments use the enum tables listed at the end.
Windows & layout
Begin, End, BeginChild, EndChild, BeginChildFrame, EndChildFrame, BeginGroup, EndGroup, Separator, SeparatorText, SameLine, NewLine, Spacing, Dummy, Indent, Unindent, BeginDisabled, EndDisabled, Columns, NextColumn, GetColumnIndex, GetColumnWidth, SetColumnWidth, GetColumnOffset, SetColumnOffset, GetColumnsCount.
Window state
IsWindowAppearing, IsWindowCollapsed, IsWindowFocused, IsWindowHovered, GetWindowPos, GetWindowSize, GetWindowWidth, GetWindowHeight, SetNextWindowPos, SetNextWindowSize, SetNextWindowSizeConstraints, SetNextWindowContentSize, SetNextWindowCollapsed, SetNextWindowFocus, SetNextWindowBgAlpha, SetWindowPos, SetWindowSize, SetWindowCollapsed, SetWindowFocus, SetWindowFontScale.
Cursor & content region
GetContentRegionMax, GetContentRegionAvail, GetWindowContentRegionMin/Max/Width, GetCursorPos, GetCursorPosX/Y, SetCursorPos, SetCursorPosX/Y, GetCursorStartPos, GetCursorScreenPos, SetCursorScreenPos, AlignTextToFramePadding, GetTextLineHeight, GetTextLineHeightWithSpacing, GetFrameHeight, GetFrameHeightWithSpacing.
Scrolling
GetScrollX/Y, GetScrollMaxX/Y, SetScrollX/Y, SetScrollHereX/Y, SetScrollFromPosX/Y.
Style stacks
PushStyleColor, PopStyleColor, PushStyleVar, PopStyleVar, GetStyleColorVec4, GetStyle, GetFontSize, GetFontTexUvWhitePixel, PushItemWidth, PopItemWidth, SetNextItemWidth, CalcItemWidth, PushTextWrapPos, PopTextWrapPos, PushButtonRepeat, PopButtonRepeat, PushID, PopID, GetID.
Text
Text, TextUnformatted, TextColored, TextDisabled, TextWrapped, LabelText, BulletText, Bullet.
Widgets
Button, SmallButton, InvisibleButton, ArrowButton, Checkbox, RadioButton, ProgressBar.
Combo & lists
BeginCombo, EndCombo, Combo, Selectable, ListBox, ListBoxHeader, ListBoxFooter, Value.
Drags
DragFloat, DragFloat2/3/4, DragInt, DragInt2/3/4.
Sliders
SliderFloat, SliderFloat2/3/4, SliderAngle, SliderInt, SliderInt2/3/4, VSliderFloat, VSliderInt.
Inputs
InputText, InputTextMultiline, InputTextWithHint, InputFloat, InputFloat2/3/4, InputInt, InputInt2/3/4, InputDouble.
Colors
ColorEdit3/4, ColorPicker3/4, ColorButton, SetColorEditOptions, ColorConvertFloat4ToU32, ColorConvertRGBAToU32, ColorConvertU32ToFloat4, ColorConvertRGBtoHSV, ColorConvertHSVtoRGB.
Trees & headers
TreeNode, TreeNodeEx, TreePush, TreePop, GetTreeNodeToLabelSpacing, CollapsingHeader, SetNextItemOpen.
Menus
BeginMenuBar, EndMenuBar, BeginMainMenuBar, EndMainMenuBar, BeginMenu, EndMenu, MenuItem.
Tooltips & popups
BeginTooltip, EndTooltip, SetTooltip, BeginPopup, BeginPopupModal, EndPopup, OpenPopup, OpenPopupContextItem, CloseCurrentPopup, BeginPopupContextItem, BeginPopupContextWindow, BeginPopupContextVoid, IsPopupOpen.
Tabs
BeginTabBar, EndTabBar, BeginTabItem, EndTabItem, SetTabItemClosed.
Tables
BeginTable, EndTable, TableNextColumn, TableNextRow, TableSetColumnIndex, TableSetupColumn, TableHeadersRow.
Draw list
AddLine, AddRect, AddRectFilled, AddRectFilledMultiColor, AddCircle, AddCircleFilled, AddTriangle, AddTriangleFilled, AddText.
Item & input queries
IsItemHovered, IsItemActive, IsItemFocused, IsItemClicked, IsItemVisible, IsItemEdited, IsItemActivated, IsItemDeactivated, IsItemDeactivatedAfterEdit, IsItemToggledOpen, IsAnyItemHovered/Active/Focused, GetItemRectMin/Max/Size, IsKeyDown, IsKeyPressed, IsKeyReleased, GetKeyIndex, GetKeyPressedAmount, IsMouseDown, IsMouseClicked, IsMouseReleased, IsMouseDoubleClicked, IsMouseHoveringRect, IsAnyMouseDown, GetMousePos, IsMouseDragging, GetMouseDragDelta, ResetMouseDragDelta, GetMouseCursor, SetMouseCursor.
Misc
GetDisplaySize, GetFrameRate, GetTime, GetFrameCount, CalcTextSize, IsRectVisible, GetStyleColorName, SetItemDefaultFocus, SetKeyboardFocusHere, PushClipRect, PopClipRect, GetClipboardText, SetClipboardText, LogToTTY/File/Clipboard, LogFinish, LogButtons, LogText.
Enum tables
Use these global tables for flags/cond/col/idx arguments (each maps a name to an integer):
ImGuiWindowFlags, ImGuiChildFlags, ImGuiCond, ImGuiCol, ImGuiStyleVar, ImGuiDir, ImGuiKey, ImGuiMouseButton, ImGuiMouseCursor, ImGuiHoveredFlags, ImGuiFocusedFlags, ImGuiComboFlags, ImGuiInputTextFlags, ImGuiColorEditFlags, ImGuiTreeNodeFlags, ImGuiSelectableFlags, ImGuiPopupFlags, ImGuiTabBarFlags, ImGuiTabItemFlags, ImGuiTableFlags, ImGuiTableColumnFlags.
memory
Pattern scanning and heap allocation. Returns pointer objects.
| Function | Description |
|---|---|
memory.scan_pattern(pattern) -> pointer | nil |
Scans GTA5_Enhanced.exe for an IDA-format byte signature. |
memory.handle_to_ptr(entity) -> pointer |
Resolves an entity handle to its game pointer. |
memory.ptr_to_handle(ptr) -> integer |
Resolves a game pointer back to an entity handle. |
memory.allocate(size) -> pointer |
Allocates size zeroed bytes (auto-freed on unload). |
memory.free(ptr) |
Frees a block returned by memory.allocate. |
pointer
A calculator over a raw memory address. Construct with pointer(address). All reads/writes error on a null pointer.
Construction & address
| Method | Description |
|---|---|
pointer(addr) -> pointer |
Creates a pointer at an address. |
ptr:get_address() -> integer |
Returns the address. |
ptr:set_address(addr) |
Sets the address. |
ptr:is_null() -> boolean |
True if the address is null. |
ptr:is_valid() -> boolean |
True if the address is non-null. |
Arithmetic
| Method | Description |
|---|---|
ptr:add(offset) -> pointer |
Returns a pointer advanced by offset bytes. |
ptr:sub(offset) -> pointer |
Returns a pointer moved back by offset bytes. |
ptr:rip([offset]) -> pointer |
Follows a RIP-relative reference, then applies an optional offset. |
ptr:deref() -> pointer |
Reads the 64-bit value at the address and returns it as a pointer. |
Reads & writes
| Method | Description |
|---|---|
ptr:get_byte/word/int/dword/qword() -> integer |
Reads an integer of the given width. |
ptr:set_byte/word/int/dword/qword(value) |
Writes an integer of the given width. |
ptr:get_float() -> number / ptr:set_float(value) |
Reads/writes a float. |
ptr:get_string() -> string / ptr:set_string(value) |
Reads/writes a C string. |
Patches
ptr:patch_byte/word/dword/qword(value) -> patch writes a value and returns a patch handle. The patch is reversible:
| Method | Description |
|---|---|
patch:apply() |
Applies the patch. |
patch:restore() |
Restores the original bytes. |
Vector3
A 3D float vector. Construct with Vector3() (zero) or Vector3(x, y, z). Fields x, y, z are directly readable and writable (v.x = 1.0).
| Method | Description |
|---|---|
v:get_coords() -> x, y, z |
Returns all three components. |
v:get_x/get_y/get_z() -> number |
Returns a single component. |
v:set_x/set_y/set_z(value) |
Sets a single component. |
v:get_distance(other) -> number |
Distance to another Vector3. |
v:is_zero() -> boolean |
True if all components are zero. |
Entity
Base class for game entities. Construct with Entity(handle). All methods below are inherited by Ped and Vehicle.
Identity
| Method | Description |
|---|---|
entity:get_handle() -> integer |
Returns the script handle. |
entity:is_valid() -> boolean |
True if the entity exists. |
entity:is_ped/is_vehicle/is_object/is_player() -> boolean |
Type checks. |
entity:is_mission_entity() -> boolean |
True if flagged as a mission entity. |
entity:get_model() -> integer |
Returns the model hash. |
Position & movement
| Method | Description |
|---|---|
entity:get_position() -> Vector3 |
World position. |
entity:set_position(pos) |
Sets the position. |
entity:get_rotation([order]) -> Vector3 |
Rotation (default order 2). |
entity:set_rotation(rot, [order]) |
Sets the rotation. |
entity:get_velocity() -> Vector3 / entity:set_velocity(vel) |
Velocity. |
entity:get_heading() -> number / entity:set_heading(h) |
Heading in degrees. |
entity:get_speed() -> number |
Current speed. |
entity:set_collision(enabled) |
Toggles collision. |
entity:set_frozen(frozen) |
Freezes/unfreezes position. |
entity:has_interior() -> boolean |
True if inside an interior. |
Networking
| Method | Description |
|---|---|
entity:is_networked() -> boolean |
True if networked. |
entity:is_remote() -> boolean |
True if owned by a remote machine. |
entity:has_control() -> boolean |
True if locally controlled. |
entity:get_network_object_id() -> integer |
Network object id. |
entity:prevent_migration() |
Stops the entity migrating owners. |
entity:force_control() |
Forces local control. |
entity:request_control([timeout]) |
Latent. Requests control (default 100 ms). |
Health & state
| Method | Description |
|---|---|
entity:is_invincible() -> boolean / entity:set_invincible(enabled) |
Invincibility. |
entity:is_dead() -> boolean |
True if dead. |
entity:kill() |
Kills the entity. |
entity:get_health() -> integer / entity:set_health(h) |
Health. |
entity:get_max_health() -> integer |
Max health. |
entity:is_visible() -> boolean / entity:set_visible(v) |
Visibility. |
entity:get_alpha() -> integer / entity:set_alpha(a) / entity:reset_alpha() |
Opacity (0–255). |
entity:delete() |
Deletes the entity. |
Ped
A pedestrian. Inherits all Entity methods. Construct with Ped(handle) or spawn with Ped.create(...).
| Method | Description |
|---|---|
Ped.create(model, pos, [heading]) -> Ped |
Latent. Spawns a ped (heading default 0). |
ped:get_vehicle() -> Vehicle |
Current vehicle. |
ped:get_last_vehicle() -> Vehicle |
Last vehicle. |
ped:get_vehicle_object_id() -> integer |
Network object id of the current vehicle. |
ped:set_in_vehicle(vehicle, [seat]) |
Warps into a vehicle (seat default 0). |
ped:get_ragdoll() -> boolean / ped:set_ragdoll(enabled) |
Ragdoll toggle. |
ped:get_bone_position(bone) -> Vector3 |
World position of a bone index. |
ped:is_enemy() -> boolean |
True if hostile. |
ped:get_accuracy() -> integer / ped:set_accuracy(a) |
Weapon accuracy. |
ped:give_weapon(weapon, [equip]) |
Gives a weapon (equip default false). |
ped:remove_weapon(weapon) |
Removes a weapon. |
ped:get_current_weapon() -> integer |
Equipped weapon hash. |
ped:has_weapon(weapon) -> boolean |
True if the ped has the weapon. |
ped:set_infinite_ammo(enabled) |
Toggles infinite ammo. |
ped:set_infinite_clip(enabled) |
Toggles no-reload. |
ped:set_max_ammo_for_weapon(weapon) |
Fills ammo for a weapon. |
ped:teleport_to(pos) |
Teleports the ped. |
ped:get_armour() -> integer / ped:set_armour(a) |
Armour. |
ped:set_leader_of_group(group) |
Makes the ped a group leader. |
ped:add_to_group(group) / ped:remove_from_group() |
Group membership. |
ped:is_member_of_group(group) -> boolean |
Group check. |
ped:randomize_outfit() |
Randomizes outfit. |
ped:start_scenario(name, [duration], [play_anim]) |
Starts a scenario by name. |
ped:set_keep_task(enabled) |
Keeps the assigned task. |
ped:clear_damage() |
Clears damage and decals. |
ped:set_max_time_underwater(time) |
Max underwater time (seconds). |
ped:set_as_cop() |
Flags the ped as a cop. |
Vehicle
A vehicle. Inherits all Entity methods. Construct with Vehicle(handle) or spawn with Vehicle.create(...).
| Method | Description |
|---|---|
Vehicle.create(model, pos, [heading]) -> Vehicle |
Latent. Spawns a vehicle (heading default 0). |
vehicle:fix() |
Repairs to full health. |
vehicle:get_gear() -> integer |
Current gear. |
vehicle:get_rev_ratio() -> number |
Engine rev ratio. |
vehicle:get_speed() -> number |
Current speed. |
vehicle:upgrade() |
Applies max performance upgrades. |
vehicle:get_plate_text() -> string / vehicle:set_plate_text(text) |
License plate. |
vehicle:is_seat_free(seat) -> boolean |
True if a seat is free. |
vehicle:supports_boost() -> boolean |
True if the vehicle supports boost. |
vehicle:is_boost_active() -> boolean |
True if boost is active. |
vehicle:set_boost_charge([charge]) |
Sets boost charge (default 100). |
vehicle:lower_stance(enabled) |
Lowers/raises stance. |
vehicle:bring_to_halt(distance, time) |
Brings the vehicle to a stop. |
vehicle:set_on_ground_properly() -> boolean |
Places the vehicle on the ground. |
vehicle:get_full_name() -> string |
Localized display name. |
entities
World pool queries. Each returns an array of integer entity handles (wrap with Entity, Ped, or Vehicle).
| Function | Description |
|---|---|
entities.get_all_vehicles_as_handles() -> integer[] |
All vehicles. |
entities.get_all_peds_as_handles() -> integer[] |
All peds. |
entities.get_all_objects_as_handles() -> integer[] |
All objects. |
Player
A session player. Construct with Player(id).
| Method | Description |
|---|---|
player:is_valid() -> boolean |
True if the slot is active. |
player:is_local() -> boolean |
True if this is the local player. |
player:is_host() -> boolean |
True if the session host. |
player:is_modder() -> boolean |
True if flagged as a modder. |
player:get_id() -> integer |
Player index. |
player:get_name() -> string |
Player name. |
player:get_ped() -> Ped |
The player's ped. |
player:get_message_id() -> integer |
Network message id. |
player:get_rid() -> integer |
Rockstar ID. |
player:get_external_address() -> string, integer |
External IP and port. |
player:get_internal_address() -> string, integer |
Internal IP and port. |
player:get_average_latency() -> number |
Average latency. |
player:get_average_packet_loss() -> number |
Average packet loss. |
player:get_rank() -> integer |
Level/rank. |
player:get_rp() -> integer |
Reputation points. |
player:get_money() -> integer |
Money. |
player:get_wanted_level() -> integer / player:set_wanted_level(l) |
Wanted level. |
player:get_max_armour() -> integer |
Max armour. |
player:get_group() -> integer |
Group id. |
player:set_visible_locally(visible) |
Local visibility. |
player:teleport_to(pos) |
Teleports the player. |
player:set_fall_distance_override(distance) |
Overrides fall distance. |
player:set_ped(ped, [delete_old]) |
Sets the player's ped (delete old default true). |
players
Session player collection.
| Function | Description |
|---|---|
players.get_all() -> Player[] |
All players in the session. |
players.get_local() -> Player |
The local player. |
players.get_selected() -> Player |
The currently selected player. |
players.set_selected(player) |
Sets the selected player. |
players.get_by_rid(rid) -> Player |
Player by Rockstar ID. |
players.get_by_message_id(id) -> Player |
Player by network message id. |
players.get_random() -> Player |
A random player. |
ScriptGlobal
Reads/writes a GTA script global variable. Construct with ScriptGlobal(index).
| Method | Description |
|---|---|
ScriptGlobal(index) -> ScriptGlobal |
Handle to a global by index. |
sg:at(offset, [size]) -> ScriptGlobal |
Offset handle (size multiplies for array stride). |
sg:can_access() -> boolean |
True if currently mapped and safe to use. |
sg:get_int/get_float() -> number |
Reads an int/float. |
sg:get_string() -> string | nil |
Reads a string. |
sg:get_vector3() -> Vector3 |
Reads three slots as a vector. |
sg:set_int/set_float(value) |
Writes an int/float. |
sg:set_string(value, [max_length]) |
Writes a string. |
sg:set_vector3(v) |
Writes a vector into three slots. |
ScriptLocal
Reads/writes a local variable in a running script thread. Construct with ScriptLocal(script, index) (script = name or hash); returns nil if the thread isn't running.
| Method | Description |
|---|---|
ScriptLocal(script, index) -> ScriptLocal | nil |
Handle to a local in a script thread. |
sl:at(offset, [size]) -> ScriptLocal |
Offset handle (size multiplies for array stride). |
sl:get_int/get_float() -> number |
Reads an int/float. |
sl:get_vector3() -> Vector3 |
Reads three slots as a vector. |
sl:set_int/set_float(value) |
Writes an int/float. |
sl:set_vector3(v) |
Writes a vector into three slots. |
ScriptPointer
A pattern-based pointer into a script's bytecode. Construct with ScriptPointer(name, pattern, [offset], [rip], [address]).
| Method | Description |
|---|---|
sp:add(offset) -> ScriptPointer |
Advances by offset bytes. |
sp:sub(offset) -> ScriptPointer |
Moves back by offset bytes. |
sp:rip() -> ScriptPointer |
Resolves a RIP-relative reference. |
sp:scan(target) -> ScriptPointer | nil |
Scans for the pattern (target = script hash). |
sp:get_address() -> integer |
Resolved address. |
sp:get_name() -> string |
Pointer name. |
ScriptPatch
Patches a script's bytecode; auto-restored on script unload. Construct with ScriptPatch(script, name, pattern, [offset], patch_bytes) — created and enabled immediately. patch_bytes is an array of integers (0–255).
| Method | Description |
|---|---|
patch:enable() |
Applies the patch. |
patch:disable() |
Reverts but keeps it registered. |
patch:remove() |
Reverts and unregisters. |
ScriptFunction
Calls a function inside a GTA script. Construct with ScriptFunction(script, script_pointer).
fn:call(param_string, ...) -> any
Invokes the function. param_string describes arg types (i int32, f float, h hash, b bool) plus an optional =<r> return type (n none, i, f, b, h). Following arguments map to the type chars. Example: fn:call("ii=i", 5, 10).
scripts
| Function | Description |
|---|---|
scripts.is_active(script) -> boolean |
True if the script (name/hash) is running. |
scripts.run_as_script(script, callback) |
Runs callback in the named script's thread context. |
natives
Loads the auto-generated GTA native bindings into your script.
| Function | Description |
|---|---|
natives.load_natives() |
Loads every native namespace table (PLAYER, ENTITY, VEHICLE, …) as globals. |
natives.are_natives_loaded() -> boolean |
True if natives have already been loaded. |
After loading, call natives as NAMESPACE.NATIVE_NAME(args), e.g. PLAYER.PLAYER_ID(). The full native list mirrors the standard GTA V natives — see natives.lua for every signature.
Internally each native wraps the global
_I(hash, format, ...)invoker. You normally never call_Idirectly.
network
| Function | Description |
|---|---|
network.trigger_script_event(hash, bits, format, ...) |
Sends a scripted game event. bits = target player bitset; format chars i/f/l/h describe the varargs (max 36). |
network.force_script_host(script_hash) |
Forces the local player to host a script. |
network.force_script_on_player(script_hash, bits) |
Forces a script to run on the players in bits. |
network.is_session_started() -> boolean |
True if in a multiplayer session. |
tunables
Read/write game tunables. The first argument is a tunable name or hash.
| Function | Description |
|---|---|
tunables.set_int/set_bool/set_float(hash, value) |
Writes a tunable. |
tunables.get_int(hash) -> integer |
Reads an int tunable (0 if not ready). |
tunables.get_bool(hash) -> boolean |
Reads a bool tunable. |
tunables.get_float(hash) -> number |
Reads a float tunable. |
stats
Read/write local player stats by name or packed index.
| Function | Description |
|---|---|
stats.set_int/set_bool/set_float/set_string(name, value) |
Writes a named stat. |
stats.get_int/get_bool/get_float/get_string(name) |
Reads a named stat. |
stats.set_packed_int/set_packed_bool(index, value) |
Writes a packed stat. |
stats.get_packed_int/get_packed_bool(index) |
Reads a packed stat. |
stats.set_packed_bool_range(start, end, value) |
Sets a range of packed bools. |
stats.set_masked_int(name, value, offset, bits) |
Writes a bit-masked int field. |
stats.get_masked_int(name, offset, bits) -> integer |
Reads a bit-masked int field. |
stats.set_masked_bool(name, offset, value) |
Writes a single bit. |
stats.get_masked_bool(name, offset) -> boolean |
Reads a single bit. |
transactions
GTA Online network-shop (money) transactions.
| Function | Description |
|---|---|
transactions.create_basket(category, action) -> BasketTransaction |
Creates a basket. |
transactions.run_service(category, action, item, value) -> boolean |
Fire-and-forget single service transaction. |
transactions.can_use_transactions() -> boolean |
True if the shop catalog is valid and FSL local saves are off. |
BasketTransaction
| Method | Description |
|---|---|
basket:add_item(primary, secondary, value, stat_value, quantity) |
Adds an item (max 70; secondary may be nil). |
basket:run() -> boolean |
Latent. Runs the checkout; returns success. |
FileMgr
Sandboxed file access, rooted at Documents/YimMenuV2/scripts. Paths outside the sandbox raise an error.
| Function | Description |
|---|---|
FileMgr.GetMenuRootPath() -> string |
Absolute path of the sandbox root. |
FileMgr.CreateDir(path) -> boolean |
Creates a directory (and parents). |
FileMgr.DeleteFile(path) |
Deletes a file. |
FileMgr.DoesFileExist(path) -> boolean |
True if the path exists. |
FileMgr.FindFiles(path, extension, [recursive]) -> string[] |
Lists files, optionally filtered/recursive. |
FileMgr.ReadFileContent(path) -> string |
Reads raw bytes ("" on failure). |
FileMgr.WriteFileContent(path, content, [append]) -> boolean |
Writes (or appends) to a file. |
internal
For menu testing only — not intended for normal scripts.
| Function | Description |
|---|---|
internal.spawn_vehicle(model) |
Spawns a vehicle at the local player. |