DIS2RBED LUA reference

There are multiple namespaces & types in the current DIS2RBED LUA framework, each with their own set of functions.

Note

New, WIP Rage API Documentation is available here: WIP New RAGE API

Types in the LUA Engine

Types in the LUA Engine are defined in the following order:

• Hash (uint64)

• Entity (int)

• Ped (int)

• Player (int)

• Cam (int)

• Blip (int)

• Any

• Vehicle (int)

• Vector2 (float x, float y)

• Vector3 (float x, float y, float z)

• ColorRGB (int r, int g, int b)

• ColorRGBA (int r, int g, int b, int a)

• eSessionType (int)

• Pickup

• ModelBoundingBox (Vector3, Vector3, Vector3, Vector3, Vector3, Vector3, Vector3, Vector3)

---

Hash

Hash is a hash of a string that is encrypted using the Jenkins hash function. It’s an in-game identifier that is unique to each object and helps identify a gun or a vehicle.

You can find a hash key using this function: rage.gameplay.get_hash_key(“string”), where string is a game object name.

You can find most of the game objects here:

Menu button, children and task hashes can be anything you want, but they have to be unique.

• Weapons

• Weapon Components

• Vehicles

• Peds

• Blips

• Props

---

Entity

Entity is an integer ID of an in-game object (don’t mix up with the Hash!). It’s an integer that is unique to each object, and, unlike the Hash, it only lasts one session. Entity can be used to identify a ped, a vehicle, an animal, a character. Entity is everything.

---

Ped

Ped is an integer ID which represents the NPC in the game session. It’s unique to each NPC, and it only lasts one session. Ped can be converted to Entity, hence it can be used with methods that take Entity as a parameter.

Easiest way to acquire a ped handle is to call player.get_ped() function that returns a Ped object of your character. Or spawn it through rage.ped.create_ped().

• Peds

---

Player

Player is an integer ID that represents Player in the game session. It ranges from 0 to 32. Player ID helps identify a player in the game session. Always 0 in single player mode.

---

Cam

Cam ID represents the game camera. It’s not used anywhere at the moment.

---

Blip

Blip is an Integer ID that represents the mark object on the game map. You can spawn and manage different types of blips.

You can find Blip types here:

• Blips

---

Any

Any is a type that’s used in native methods, whose parameters weren’t completely figured out. You can use false to represent it.

---

Vehicle

Vehicle is an Integer Vehicle ID which represents the Vehicle in the game session. It’s unique to each vehicle, and it only lasts one session. Vehicle can be converted to Entity, hence it can be used with methods that take Entity as a parameter.

Easiest way to acquire a vehicle handle is to call player.get_vehicle() function that returns a Vehicle object of your vehicle. Or spawn it through scripting.spawn.spawn_vehicle().

• Vehicles

---

Vector2

Vector2 is a 2D vector, and is used to represent the coordinates on the screen. It contains two float variables: x and y Only used in Render namespace at the moment.

You can initialize a Vector3 object with following code:

v2 = Vector2.new(x, y)

---

Vector3

Vector3 is a 3D vector, and is used to represent the coordinates in the game world. It contains three float variables: x, y and z

You can initialize vector3 with the following code:

myV3 = Vector3.new(x, y, z)

---

ColorRGB

ColorRGB represents a color in RGB format. It contains three integer variables: r, g and b.

You can initialize a ColorRGB object with the following code:

myColor = ColorRGB.new(r, g, b)

---

ColorRGBA

ColorRGBA represents a color in RGBA format. It contains four integer variables: r, g, b and a.

You can initialize a ColorRGBA object with the following code:

myColor = ColorRGBA.new(r, g, b, a)

---

eSessionType

eSessionType represents a session type that DIS2RBED uses to set up an online session.

Current available session types are:

• PublicJoin = 0

• PublicStart = 1

• CrewClosed = 2

• Crew = 3

• FriendsClosed = 6

• FriendsFind = 9

• Solo = 10

• Invite = 11

• CrewJoin = 12

---

Pickup

Used for money drops. It’s not used anywhere at the moment.

---

ModelBoundingBox

ModelBoundingBox represents a vector consisting of 8 Vector3’s that contain the coordinates of box’s corners (bounding coordinates).

---

Global Variables

• int chatSenderId – Last chat message sender ID

• string chatSenderName – Last chat message sender name

• string chatMessage – Last chat message

• int scriptEventId – Last script event hash

• vector<int> scriptEventArgs – Last script event arguments list

• int scriptEventSenderID – Last script event sender ID

• string scriptEventSenderName – Last script event sender name

---

Namespaces in LUA Engine

Function namespaces in LUA Engine are defined in the following order:

• System namespace

• Web namespace

• Menu namespace

• Stats namespace

• Notify namespace

• Script namespace

• Globals namespace

• Locals namespace

• Render namespace

• Player namespace

• Lobby namespace

• Vehicle namespace

• Weapon namespace

• Text namespace

• FS namespace

• Scripting functions

  • Functions that are not included in any namespace

  • Player namespace

  • Ped namespace

  • Entity namespace

  • Vehicle namespace

  • Online namespace

  • Network namespace

  • Spawn namespace

  • Weapon namespace

  • Teleport namespace

  • World namespace

• RAGE Functions

  • Player namespace

  • Ped namespace

  • Vehicle namespace

  • Entity namespace

  • Object namespace

  • Weapon namespace

  • Streaming namespace

  • UI namespace

  • Draw namespace

  • Cam namespace

  • Gameplay namespace

  • Fire namespace

  • Network namespace

  • Cutscene namespace

  • Controls namespace

  • Graphics namespace

  • Time namespace

  • AI namespace

  • Decorator namespace

  • Interior namespace

  • Audio namespace

  • Rope namespace

---

System namespace

This namespace contains functions that are used to interact with the DIS2RBED’s task management and logging.

---

log_chat(text)

Sends a message to the log as [CHAT]. Has a purple color.

Parameters:

• text (string) – The text to send to the log.

Returns:

• None

Example:

system.log_chat("Hello World!")

---

log_debug(text)

Sends a message to the log as [DEBUG]. Has a grey color.

Parameters:

• text (string) – The text to send to the log.

Returns:

• None

Example:

system.log_debug("Hello World!")

---

log_info(text)

Sends a message to the log as [INFO]. Has a blue color.

Parameters:

• text (string) – The text to send to the log.

Returns:

• None

Example:

system.log_info("Hello World!")

---

log_online(text)

Sends a message to the log as [ONLINE]. Has a bright yellow color.

Parameters:

• text (string) – The text to send to the log.

Returns:

• None

Example:

system.log_online("Hello World!")

---

log_protex(text)

Sends a message to the log as [PROTEX]. Has a light blue color.

Parameters:

• text (string) – The text to send to the log.

Returns:

• None

Example:

system.log_protex("Hello World!")

---

log_warning(text)

Sends a message to the log as [WARNING]. Has a red color.

Parameters:

• text (string) – The text to send to the log.

Returns:

• None

Example:

system.log_warning("Hello World!")

---

get_user_group()

Gets the group of the current user.

Parameters:

• None

Returns:

• int – Returns the group of the user:

  • 1 – User is Basic

  • 2 – User is VIP

  • 3 – User is Tester

Example:

userGroup = system.get_user_group()

if userGroup == 1 then
  system.log_info("User is Basic")
elseif userGroup == 2 then
  system.log_info("User is VIP")
elseif userGroup == 3 then
  system.log_info("User is Tester")
end

---

wait(ms)

Waits for ms milliseconds.

Parameters:

• ms (int) – The number of milliseconds to wait. If -1 is set, skips ticks.

Returns:

• None

Example:

system.wait(10000) -- Waits for 10 seconds

---

add_task(name, hash, ms, fn)

Adds a task into the process’s main loop.

Note

DO NOT USE system.wait() inside task functions! You can use it only in the options functions!

Parameters:

• name (string) – The name of the task.

• hash (string) – The hash of the task. Hash is used to identify the task, so it must be unique.

• ms (int) – The number of milliseconds to wait before calling the task.

  • Can be -1 to execute the task again and again.

• fn (function) – The function to call when the task is executed.

Returns:

• None

Example:

function my_script_function()
     system.log_info("Hello World!")
end
system.add_task("My script task", "luaTestTaskHash", 1000, my_script_function)
--or
function my_script_function()
     -- Test key press
     bIsKeyPressed = system.is_key_pressed("F")
     if bIsKeyPressed then
         system.log_info("Pressed F to pay respect!")
     end
end
system.add_task("My script task", "luaTestTaskHash", -1, my_script_function)

---

remove_task(hash)

Removes a task from the process’s main loop.

Parameters:

• hash (string) – The hash of the task to remove.

Returns:

• None

Example:

function my_script_function()
     system.log_info("Hello World!")
end
system.add_task("My script task", "luaTestTaskHash", 1000, my_script_function)
system.remove_task("luaTestTaskHash")

---

add_chat_listener(name, hash, fn)

Connects a chat listener that calls a task every time a message is sent in the chat.

Note

Chat listener only reacts to other player’s chat messages, not your own ones.

Note

DO NOT USE system.wait() inside task functions! You can use it only in the options functions!

Parameters:

• name (string) – The name of the task.

• hash (string) – The hash of the task. Hash is used to identify the task, so it must be unique.

• fn (function) – The function to call when the task is executed.

Returns:

• None

Example:

function my_script_function(text)
     system.log_info("Hello World!")
end
system.add_chat_listener("My script task", "luaTestTaskHash", my_script_function)

---

remove_chat_listener(hash)

Disconnects a chat listener for a certain task.

Parameters:

• hash (string) – The hash of the task to remove.

Returns:

• None

Example:

function my_script_function(text)
     system.log_info("Hello World!")
end
system.add_chat_listener("My script task", "luaTestTaskHash", my_script_function)
system.remove_chat_listener("luaTestTaskHash")

---

add_script_event_listener(name, hash, fn)

Connects a script event listener that calls a task every time a script event is sent.

Parameters:

• name (string) – The name of the task.

• hash (string) – The hash of the task. Hash is used to identify the task, so it must be unique.

• fn (function) – The function to call when the task is executed.

Returns:

• None

Example:

function my_script_function()
     system.log_info("Hello World!")
end
system.add_script_event_listener("My script task", "luaTestTaskHash", my_script_function)

---

remove_script_event_listener(hash)

Disconnects a script event listener for a certain task.

Parameters:

• hash (string) – The hash of the task to remove.

Returns:

• None

Example:

function my_script_function()
     system.log_info("Hello World!")
end
system.add_script_event_listener("My script task", "luaTestTaskHash", my_script_function)
system.remove_script_event_listener("luaTestTaskHash")

---

add_script_event(name, eventId, args = {})

Add a script event into the protection blacklist.

Parameters:

• name (string) – The name of the task.

• eventId (int) – The event ID to add.

• args (vector<int>) – The arguments to pass to the event. Default is an empty vector.

Returns:

• None

Example:

---

remove_script_event(eventId)

Remove a script event from the protection blacklist.

Parameters:

• eventId (int) – The event ID to remove.

Returns:

• None

Example:

---

string_to_key(key)

Converts a string key to a key hash.

Parameters:

• key (string) – The key to convert.

Returns:

• int – The key hash. -1 if the key is not any special key or it doesn’t exist at all

Example:

key = system.string_to_key("HOME")

system.log_info(tostring(key)) -- get "HOME" key hash

---

key_to_string(key)

Converts a key hash to a string key.

Parameters:

• key (int) – The key hash to convert.

Returns:

• string – The key as string.

Example:

key = system.key_to_string(36)
system.log_info(tostring(key)) -- get "HOME" key hash

-- why 36, you ask? See this: https://www.oreilly.com/library/view/javascript-dhtml/9780596514082/apb.html

---

is_key_pressed(key)

Checks whether the key is pressed

Parameters:

• key (string) – The key to check.

Returns:

• bool

  • True – The key is pressed

  • false – The key is not pressed

Example:

function my_script_function(text)
   bIsKeyPressed = system.is_key_pressed("F")
   if bIsKeyPressed then
      system.log_info("Hello World!")
   end
end

---

reinitialize_d2ui()

Reinitializes DIS2RBED UI and Lua scripts.

Parameters:

• None

Returns:

• None

---

Web namespace

This namespace contains functions for sending web requests to external servers.

---

get(url)

Sends a GET request to a web server.

Parameters:

• url (string) – The URL to send the request to.

Returns:

• string – The response from the server.

Example:

system.log_warning("Test HTTP request GET")
sRequestResult = web.get("http://ip-api.com/php/24.48.0.1")
system.log_warning(sRequestResult)

--or

system.log_warning("Test HTTPS request GET")
sRequestResult = web.get("https://ipapi.co/8.8.8.8/json/")
system.log_warning(sRequestResult)

---

post(url, data)

Sends a POST request to a web server.

Parameters:

• url (string) – The URL to send the request to.

• data (string) – The data to send.

Returns:

• string – The response from the server.

Example:

system.log_warning("Test HTTP request POST") -- https is supported too
sJSONRequest = "[ {\"query\": \"208.80.152.201\", \"fields\": \"city,country,countryCode,query\", \"lang\": \"eu\"},  \"8.8.8.8\",  \"24.48.0.1\" ]"
sRequestResult = web.post("http://ip-api.com/batch", sJSONRequest)
system.log_warning(sRequestResult)

---

Menu namespace

This namespace contains functions for creating and manipulating menu options and sections.

---

Menu

---

add_parent(name)

Adds a parent section into menu resolution.

Parameters:

• name (string) – The name of the parent section.

Returns:

• int – The ID of the parent section.

Example:

menu.add_parent("My parent section")

---

add_parent(name, parent)

Adds a child section to a parent section.

Parameters:

• name (string) – The name of the child section.

• parent (int) – The parent section.

Returns:

• int – The ID of the child section.

Example:

iParentID = menu.add_parent("My parent section")

iChildID = menu.add_parent("Child section of my parent section", iParentID)

---

add_delimiter(name, parent)

Adds a delimiter to a section.

Parameters:

• name (string) – The name of the delimiter.

• parent (int) – The parent section.

Returns:

• int – The ID of the delimiter.

Example:

iParentID = menu.add_parent("My parent section")

menu.add_delimiter("Just a delimiter...", iParentID)

---

add_option(name, hash, parent, fn)

Adds a menu option button.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• parent (int) – The parent section.

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

-- A test function
function test()
   system.log_info("Test function!")
end

iParentID = menu.add_parent("My parent section")

menu.add_option("Lua Option", "luaOptHash", iParentID, test)

---

add_option_toggle(name, hash, parent, fn)

Adds a toggable menu option button.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• parent (int) – The parent section.

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_toggle("Toggle Option", "luaOptDummyToggle", iParentID, function())

---

add_option_slider(name, hash, value, min, max, mod, parent, fn)

Adds a slider menu option.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Delimiter of value increase.

• parent (int) – The parent section.

• fn (function) – Function to call.

Returns:

• None

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_slider("Slider Option", "luaOptDummyToggle", 10, 0, 100, 3, iParentID, function()) -- makes a slider with 3 possible values: on 2, 4, and 6

---

add_option_slider_toggle(name, hash, value, min, max, mod, parent, fn)

Adds a toggable slider menu option.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase.

• parent (int) – The parent section.

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_slider_toggle("Toggable Slider Option", "luaOptDummyToggle", 10, 0, 100, 10, iParentID, function())  -- makes a slider with 10 possible values: on 10, 20, and so on.

---

add_option_value(name, hash, value, min, max, mod, parent, valueSuffix, fn)

Adds a menu option with a pre-set value

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase.

• parent (int) – The parent section.

• valueSuffix (string) – The value suffix text (e.g. m/s)

• fn (function) – Function to call. (optional)

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_value("Lua option with value", "luaOptDummyToggle", 10, 0, 100, 1, iParentID, "kb", function())

---

add_option_value_toggle(name, hash, value, min, max, mod, parent, valueSuffix, fn)

Adds a toggable menu option with a pre-set value.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase.

• parent (int) – The parent section.

• valueSuffix (string) – The value suffix text (e.g. m/s)

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_value_toggle("Toggable Lua option with value", "luaOptDummyToggle", 10, 0, 100, 1, iParentID, "kb", function())

---

add_option_value_str(name, hash, value, parent, list, fn)

Adds a menu option with multiple values.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• parent (int) – The parent section.

• list (vector<string>) – The values list separated with a comma

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_value_str("Lua option with multiple values", "luaOptDummyToggle", 0, iParentID, { "One", "Two", "Three" }, function())

---

add_option_value_str_toggle(name, hash, value, parent, list, fn)

Adds a toggable menu option with multiple values.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• parent (int) – The parent section.

• list (vector<string>) – The values list separated with a comma.

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_value_str("Toggable Lua option with multiple values", "luaOptDummyToggle", 0, iParentID, { "One", "Two", "Three" }, function())

---

add_option_teleport(name, coords, parent)

Adds a teleport option button.

Parameters:

• name (string) – The name of the option.

• coords (Vector3) – The teleport coordinates.

• parent (int) – The parent section.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_teleport("Casino Entrance", { 922.680847, 47.205017, 81.106346 }, iParentID)

---

add_option_spawn(name, model, type, parent)

Adds a spawn option button.

Parameters:

• name (string) – The name of the option.

• model (Hash) – The vehicle hash.

• type (int) – The vehicle spawn type.

• parent (int) – The parent section.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")

menu.add_option_spawn("Spawn Zentorno", uZentornoHash, 0, iParentID) -- 0 is vehicle_spawn type

---

add_option_text(name, hash, text, length, parent, fn)

Adds a text option.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• text (string) – The displayed text to the right of the name.

• length (int) – The max length of the option text.

• parent (int) – The parent section.

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_text("Just a text option", "luaOptHashText", "Text", 10, iParentID, foo)

---

add_option_text_toggle(name, hash, text, length, parent, fn)

Adds a togglable text option.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• text (string) – The displayed text to the right of the name.

• length (int) – The max length of the option text.

• parent (int) – The parent section.

• fn (function) – Function to call.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_text_toggle("Just a text option", "luaOptHashText", "Text", 10, iParentID, foo)

---

add_option_info(name, hash, info, parent)

Adds a text option. (e.g. a note).

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• info (string) – Info to display to the right of the option name.

• parent (int) – The parent section.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_info("Just an info option", "luaOptHashInfo", "Some info", iParentID)

---

add_option_color(name, hash, color, parent)

Adds a color selection button.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• color (ColorRGBA) – The option default color.

• parent (int) – The parent section ID.

Returns:

• int – option ID

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_color("Color option", "luaOptHashColor", {0, 0, 255, 255}, iParentID) -- Blue is the default color

---

update_option(hash, name, fn)

Updates an existing menu option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_option("luaOptHash", "Lua Option", iParentID, function())

-- A test function
function test()
   system.log_info("Test function!")
end

menu.update_option("luaOptHash", "Lua Option", test)

---

update_option_toggle(hash, name, fn)

Updates a toggable option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.update_option_toggle("luaOptHash", "Lua Option", iParentID, test)

-- A test function
function test()
   system.log_info("Test function!")
end

menu.update_option_toggle("luaOptHash", "Lua Option", test)

---

update_option_slider(hash, name, value, min, max, mod, fn)

Updates a slider option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Delimiter of value increase.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.update_option_slider("luaOptDummyToggle", "Slider Option", 10, 0, 100, 3, function())

---

update_option_slider_toggle(hash, name, value, min, max, mod, fn)

Updates a slider toggable option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Delimiter of value increase.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.update_option_slider_toggle("luaOptDummyToggle", "Slider Toggable Option", 10, 0, 100, 3, function())

---

update_option_value( hash, name, value, min, max, mod, valueSuffix, fn)

Updates a value option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase.

• valueSuffix (string) – The value suffix text (e.g. m/s)

• fn (function) – Function to call. (optional)

Returns:

• None

Example:

menu.update_option_value("luaOptDummyToggle", "Lua option with value", 10, 0, 100, 1, "kb", function())

---

update_option_value_toggle( hash, name, value, min, max, mod, valueSuffix, fn)

Updates a toggable menu value option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase.

• valueSuffix (string) – The value suffix text (e.g. m/s)

• fn (function) – Function to call. (optional)

Returns:

• None

Example:

menu.update_option_value_toggle("luaOptDummyToggle", "Toggable Lua option with value values", 10, 0, 100, 1, "kb", function())

---

update_option_value_str(hash, name, value, list, fn)

Updates a value string option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• value (float) – The option default value.

• list (vector<string>) – The values list separated with a comma

• fn (function) – Function to call.

Returns:

• None

Example:

menu.update_option_value_str("luaOptDummyToggle", "Lua option with multiple values", 0, { "One", "Two", "Three" }, function())

---

update_option_value_str_toggle(hash, name, value, list, fn)

Updates a toggable value string option.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• value (float) – The option default value.

• list (vector<string>) – The values list separated with a comma

• fn (function) – Function to call.

Returns:

• None

Example:

menu.update_option_value_str_toggle("luaOptDummyToggle", "Toggable Lua option with multiple values", 0, { "One", "Two", "Three" }, function())

---

update_option_text(hash, name, text, length, fn)

Updates a text option (e.g. a note).

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• text (string) – The displayed text to the right of the name.

• length (int) – The max length of the option text.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.update_option_text("luaOptHashText", "Just a text option", "Text", 10, fn())

---

update_option_info(hash, name, info)

Updates an info text option (e.g. a note).

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• text (string) – The displayed text to the right of the name.

Returns:

• None

Example:

menu.update_option_info("luaOptHashText", "Just an info option", "Some Info")

---

update_option_color(hash, name, color)

Updates a color selection button.

Parameters:

• hash (string) – The option hash.

• name (string) – The name of the option.

• color (ColorRGBA) – The option default color.

Returns:

• None

Example:

menu.update_option_color("luaOptHashColor", "Color option", {0, 0, 255, 255})

---

add_player_option(name, hash, fn)

Adds a player menu option in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• fn (function) – Function to call.

Returns:

• None

Example:

-- Just a test function
function test()
   log_info("Test function!")
end

menu.add_player_option("Lua Player Option", "luaOptHash", test)

---

add_player_option_toggle(name, hash, fn)

Adds a toggable player menu option in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_option_toggle("Toggle Player Option", "luaOptDummyToggle", function())

---

add_player_option_slider(name, hash, value, min, max, mod, fn)

Adds a player menu slider option in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_player_option_slider("Slider Player Option", "luaOptDummyToggle", 10, 0, 100, 10, function())  -- makes a slider with 10 possible values: on 10, 20, 30, and so on.

---

add_player_option_slider_toggle(name, hash, value, min, max, mod, fn)

Adds a toggable slider player menu option in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_player_option_slider_toggle("Toggable Slider Player Option", "luaOptDummyToggle", 10, 0, 100, 10, function()) --  -- makes a slider with 10 possible values: on 10, 20, 30, and so on.

---

add_player_option_value(name, hash, value, min, max, mod, valueSuffix, fn)

Adds a player menu option with a set value in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase

• valueSuffix (string) – The value suffix text

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_player_option_value("Lua option with value", "luaOptDummyToggle", 10, 0, 100, 1, "kb", function())

---

add_player_option_value_toggle(name, hash, value, min, max, mod, valueSuffix, fn)

Adds a toggable player menu option with a set value in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• min (float) – Minimum slider value.

• max (float) – Maximum slider value.

• mod (float) – Step of value increase

• valueSuffix (string) – The value suffix text

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_player_option_value_toggle("Toggable Lua option with value", "luaOptDummyToggle", 10, 0, 100, 1, "kb", function())

---

add_player_option_value_str(name, hash, value, list, fn)

Adds a player menu option with multiple values in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• list (string) – The values list separated with a comma.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_player_option_value_str("Lua option with multiple values", "luaOptDummyToggle", 0, { "One", "Two", "Three" }, function())

---

add_player_option_value_str_toggle(name, hash, value, list, fn)

Adds a toggable player menu option with multiple values in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• value (float) – The option default value.

• list (string) – The values list separated with a comma.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_option_value_str("Toggable Lua option with multiple values", "luaOptDummyToggle", 0, { "One", "Two", "Three" }, function())

---

add_player_option_text(name, hash, text, length, fn)

Adds a player menu text option in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• text (string) – The option displayed text.

• length (int) – The max length of the option text.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_player_option_text("Just a text option", "luaOptHashText", "Text", 10, foo)

---

add_player_option_text_toggle(name, hash, text, length, fn)

Adds a togglable player menu text option in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• text (string) – The option displayed text.

• length (int) – The max length of the option text.

• fn (function) – Function to call.

Returns:

• None

Example:

menu.add_player_option_text_toggle("Just a text option", "luaOptHashText", "Text", 10, foo)

---

add_player_option_info(name, hash, info)

Adds a text menu option in the selected player section.

Parameters:

• name (string) – The name of the option.

• hash (string) – The option hash.

• info (string) – The option displayed info as text.

Returns:

• None

Example:

menu.add_player_option_text("Just a text option", "luaOptHashInfo", "Some info")

---

set_option_toggled(hash, toggle)

Switch the option on or off.

Parameters:

• hash (string) – The hash of the option

• toggle (bool) – Whether to toggle the option

Returns:

• None

Example:

iRecoverySectionID = menu.section_recovery()
menu.add_option("Sample option", "sampleOption", iRecoverySectionID, fn())
menu.set_option_toggled("sampleOption", true)

---

set_option_description(hash, description)

Sets a description for the specified option

Parameters:

• hash (string) – Option hash

• description (string) – Option description

Returns:

• None

Example:

iRecoverySectionID = menu.section_recovery()
menu.add_option("Sample option", "sampleOption", iRecoverySectionID, fn())
menu.set_option_description("sampleOption", "Sample Option Description")

---

set_option_visible(hash, toggle)

Sets the option visible or invisible to user.

Parameters:

• hash (string) - the hash of the option

• toggle (bool) - whether to toggle the option visibility

Returns:

• None

Example:

iRecoverySectionID = menu.section_recovery()
menu.add_option("Sample option", "sampleOption", iRecoverySectionID, fn())
menu.set_option_visible("sampleOption", true)

---

set_option_vip(hash, toggle)

Sets the option to be available only to VIP users

Parameters:

• hash (string) - the hash of the option

• toggle (bool) - whether to toggle the option VIP-only availability

Returns:

• None

Example:

iRecoverySectionID = menu.section_recovery()
menu.add_option("Sample option", "sampleOption", iRecoverySectionID, fn())
menu.set_option_vip("sampleOption", true)

---

set_option_value(hash, value)

Returns the value of an option.

Parameters:

• hash (string) – The option hash.

• value (float) – Option value.

Returns:

• None

---

toggle_option(hash)

Toggles the option.

Parameters:

• hash (string) – The option hash.

Returns:

• None

Examples:

iRecoverySectionID = menu.section_recovery()
menu.add_option("Sample option", "sampleOption", iRecoverySectionID, fn())
menu.toggle_option("sampleOption")

---

increase_option(hash)

“Scroll up” the option value

Parameters:

• hash (string) – The option hash.

Returns:

• None

---

decrease_option(hash)

“Scroll down” the option value

Parameters:

• hash (string) – The option hash.

Returns:

• None

---

update_root_parent(keepActiveOption = false)

Updates the main section to display the created Lua section/option.

Parameters:

• keepActiveOption (bool)

  • true – Save the cursor position

  • false – Don’t save the cursor position (default)

Returns:

• None

Example:

menu.update_root_parent(true)

---

update_current_parent(keepActiveOption = false)

Updates the current section to display the created Lua section/option.

Parameters:

• keepActiveOption (bool)

  • true – Save the cursor position

  • false – Don’t save the cursor position (default)

Returns:

• None

Example:

menu.update_current_parent(true)

---

is_option_toggled(hash)

Checks whether an option is toggled.

Parameters:

• hash (string) – The option hash.

Returns:

• bool

  • True – The option is toggled

  • False – The option is not toggled

Example:

-- Get option state
bIsOptionToggled = "Option toggled: " .. tostring(menu.is_option_toggled("luaOptDummyToggle"))

---

is_option_visible(hash)

Checks whether an option is visible.

Parameters:

• hash (string) – The option hash.

Returns:

• bool

  • True – The option is visible

  • False – The option is invisible

Example:

bIsOptionVisible = "Option visibility state is: " .. tostring(menu.is_option_visible("luaOptDummyToggle"))

---

is_option_enabled(hash)

Checks whether an option is enabled.

Parameters:

• hash (string) – The option hash.

Returns:

• bool

  • True – The option is enabled

  • False – The option is disabled

Example:

bIsOptionEnabled = "Option state is: " .. tostring(menu.is_option_enabled("luaOptDummyToggle"))

---

does_option_exist(hash)

Checks whether the option exists

Parameters:

• hash (string) – The hash of the option

Returns:

• bool – whether the option exists

---

get_option_value(hash)

Returns the value of an option.

Parameters:

• hash (string) – The option hash.

Returns:

• float – Option value.

Example:

-- Get option value
fOptionValue = "Option value is: " .. tostring(menu.get_option_value("luaOptHashValue"))

---

get_option_value_str(hash)

Returns the value of an option as a string.

Parameters:

• hash (string) – The option hash.

Returns:

• string – Option value.

---

get_option_text(hash)

Returns the option text.

Parameters:

• hash (string) – The option hash.

Returns:

• string – Option text.

Example:

-- Get option text
fOptionText = "Option text is: " .. tostring(menu.get_option_text("luaOptHashText"))

---

get_option_color(hash)

Returns the selected color of a color selection option.

Parameters:

• hash (string) – The option hash.

Returns:

• ColorRGBA – Option color.

Example:

iParentID = menu.add_parent("My parent section")

menu.add_option_color("Color option", "luaOptHashColor", {0, 0, 255, 255}, iParentID) -- Blue is the default color

crgbaOptionColor = "Option color is: " .. tostring(menu.get_option_color("luaOptHashColor"))

---

get_option_description(hash)

Returns an option description for the specified option hash

Parameters:

• hash (string) – Option hash

Returns:

• string – Option Description

Example:

iRecoverySectionID = menu.section_recovery()
menu.add_option("Sample option", "sampleOption", iRecoverySectionID, fn())
menu.set_option_description("sampleOption", "Sample Option Description")

sOptionDescription = menu.get_option_description("sampleOption")
system.log_info(sOptionDescription)

---

remove_option(hash)

Removes an option.

Parameters:

• hash (string) – The option hash.

Returns:

• None

Example:

menu.remove_option("luaOpt") --assuming there's an option with hash "luaOpt"

---

remove_parent(id)

Removes a parent section

Parameters:

• id (int) – The parent section ID

Returns:

• None

Example:

iParentID = menu.add_parent("Parent section")
menu.remove_parent(iParentID)

---

Menu sections

---

section_self_mods()

Returns the Self Mods section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

-- Let's add an option named "Useless Button" in the main Self Mods section.

iSelfModsSectionID = menu.section_self_mods()

menu.add_option("Useless Button", "optUselessBtn", iSelfModsSectionID, function())

---

section_self_mods_other()

Returns the Self Mods -> Other section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

-- Let's add an option named "Other Option" in the Self Mods -> Other section..

iSelfModsOtherSectionID = menu.section_self_mods_other()

menu.add_option("Other Option", "optOtherOpt", iSelfModsOtherSectionID, function())

---

section_self_mods_no_clip()

Returns the Self Mods -> No Clip section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

-- Let's add an option named "No Clip Plus" in the Self Mods -> No Clip section.

iSelfModsNoClipSectionID = menu.section_self_mods_no_clip()

menu.add_option("No Clip Plus", "optNoclipPlus", iSelfModsNoClipSectionID, function())

---

section_self_mods_invincibility()

Returns the Self Mods -> Invincibility section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

-- Let's add an option named "Thanos Mode" in the Self Mods -> Invincibility section.

iSelfModsInvincibilitySectionID = menu.section_self_mods_invincibility()
menu.add_option("Thanos Mode", "optThanosMode", iSelfModsInvincibilitySectionID, function())

---

section_online()

Returns the Online section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

-- Let's add an option named "Useless Button" in the Online section.

iOnlineSectionID = menu.section_online()
menu.add_option("Useless Button", "optUselessBtn2", iOnlineSectionID, function())

---

section_online_player(playerId)

Returns the Online -> Player (specific) section ID.

Parameters:

• playerId (int) – The player ID.

Returns:

• int – The ID of the player’s menu tab.

Example:

iPlayerSectionID = menu.section_online_player(23)
menu.add_option("Look Player", "optLookPlayer", iPlayerSectionID, function())

---

section_online_players()

Returns the Online -> Players section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iPlayersSectionID = menu.section_online_players()
menu.add_option("All Online Players", "optAllOnlPlayers", iPlayersSectionID, function())

---

section_online_all_players()

Returns the Online -> All Players section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iAllPlayersSectionID = menu.section_online_all_players()
menu.add_option("All Online Players", "optAllOnlPlayers", iAllPlayersSectionID, function())

---

section_online_protex()

---

Returns the Online -> Protections section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iProtectionsSectionID = menu.section_online_protex()
menu.add_option("Super Protex", "optSuperPrtx", iProtectionsSectionID, function())

---

section_online_other()

Returns the Online -> Other section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iOtherSectionID = menu.section_online_other()
menu.add_option("Other Button", "optOtherBtn", iOtherSectionID, function())

---

section_online_spoofer()

Returns the Online -> Spoofing section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iSpoofingSectionID = menu.section_online_spoofer()

menu.add_option("Spoof All", "optSpoofAll", iSpoofingSectionID, function())

---

section_network()

Returns the Online -> Network section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iNetworkSectionID = menu.section_network()
menu.add_option("Disconnect", "optNtwrkDisconnect", iNetworkSectionID, function())

---

section_recovery()

Returns the Recovery section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iRecoverySectionID = menu.section_recovery()

iCayoPericoHeistSectionID = menu.add_parent("Cayo Perico Heist", iRecoverySectionID)

---

section_recovery_bunker()

Returns the Recovery -> Bunker Options section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iBunkerSectionID = menu.section_recovery_bunker()
menu.add_option("Sell Everything", "optSellEvery", iBunkerSectionID, function())

---

section_recovery_night_club()

Returns the Recovery -> NightClub Options section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iNightClubSectionID = menu.section_recovery_night_club()
menu.add_option_toggle("Loop Nightclub Safe Cash", "optNcSafeLoop", iNightClubSectionID, function())

---

section_recovery_motorcycle_club()

Returns the Recovery -> Motorcycle Club Options section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iMotorcycleClubSectionID = menu.section_recovery_motorcycle_club()
menu.add_option("Ride or Die", "optMcRideOrDie", iMotorcycleClubSectionID, function())

---

section_recovery_casino()

Returns the Recovery -> Casino Options section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

function casinoJackpot()
   system.log_warning("You hit the jackpot!!!")
end
iCasinoSectionID = menu.section_recovery_casino()
menu.add_option("Jackpot", "optCasinoJckpt", iCasinoSectionID, casinoJackpot)

---

section_vehicle_spawn()

Returns the Vehicle Spawn section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iVehicleSpawnSectionID = menu.section_vehicle_spawn()
zentornoHash = rage.gameplay.get_hash_key("ZENTORNO")
menu.add_option_spawn("Spawn Zentorno", zentornoHash, 0, iVehicleSpawnSectionID)

---

section_weapons()

Returns the Weapons section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iWeaponsSectionID = menu.section_weapons()

menu.add_option("Add Weapon", "optAddWeapon", iWeaponsSectionID, function())

---

section_weapons_ammo()

Returns the Weapons -> Weapons Ammo section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iWeaponsAmmoSectionID = menu.section_weapons_ammo()
menu.add_option("Add Ammo", "optAddAmmo", iWeaponsAmmoSectionID, function())

---

section_teleport()

Returns the Teleport section.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

-- Let's add a direct Casino Entrance teleport option, in the Teleport section.

iTeleportSectionID = menu.section_teleport()

menu.add_option_teleport("Casino Entrance", { 922.680847, 47.205017, 81.106346 }, iTeleportSectionID)

---

section_teleport_ipl()

Returns the Teleport -> IPL section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iIplSectionID = menu.section_teleport_ipl()
menu.add_option("Another IPL Teleport", "optAnotherIplTp", iIplSectionID, function())

---

section_vehicle_mods()

Returns the Vehicle Mods section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iVehicleModsSectionID = menu.section_vehicle_mods()

menu.add_option("Full Upgrade", "optFullUpgrade", iVehicleModsSectionID, function())

---

section_los_santos_customs()

Returns the LSC Mods section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iLSCModsSectionID = menu.section_los_santos_customs()
menu.add_option("Rainbow Color", "optLscRainbowClrs", iLSCModsSectionID, function())

---

section_model_changer()

Returns the Model Changer section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iModelChangerSectionID = menu.section_model_changer()

menu.add_option("Turn into a cat", "optModelBecomeCat", iModelChangerSectionID, function())

---

section_animations()

Returns the Animations section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iAnimationsSectionID = menu.section_animations()
menu.add_option("Dance2", "optAnimDance2", iAnimationsSectionID, function())

---

section_model_swapper()

Returns the Model Swapper section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iModelSwapperSectionID = menu.section_model_swapper()
menu.add_option("Swap Model", "optModelSwap", iModelSwapperSectionID, function())

---

section_crafting_workshop()

Returns the Crafting Workshop section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iCraftingWorkshopSectionID = menu.section_crafting_workshop()

menu.add_option("Foo", "optCraftingFoo", iCraftingWorkshopSectionID, function())

---

section_outfit_store()

Returns he Outfit Store section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iOutfitStoreSectionID = menu.section_outfit_store()

menu.add_option("Random Outfit", "optOutfitRandom", iOutfitStoreSectionID, function())

---

section_settings()

Returns the Settings section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iSettingsSectionID = menu.section_settings()
menu.add_option("Reset Settings", "optSettingsResetStngs", iSettingsSectionID, function())

---

section_settings_lua()

Returns the Settings -> Lua section ID.

Parameters:

• None

Returns:

• int – The ID of the menu section.

Example:

iSettingsLuaSectionID = menu.section_settings_lua()
menu.add_option("Save Lua Settings", "optLuaSettingsSave", iSettingsLuaSectionID, function())

---

section_interface()

Returns the Interface section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iInterfaceSectionID = menu.section_interface()

menu.add_option("Reset Theme", "optInterfaceResetTheme", iInterfaceSectionID, function())

---

section_world()

Returns the World section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iWorldSectionID = menu.section_world()
menu.add_option("World", "optWorld", iWorldSectionID, function())

---

section_about()

Returns the About section ID.

Parameters:

• None

Returns:

• int – The ID of the parent menu section.

Example:

iAboutSectionID = menu.section_about()
menu.add_option("About Me", "optAboutAbtMe", iAboutSectionID, function())

---

is_menu_active()

Checks whether the menu is active.

Parameters:

• None

Returns:

• bool

  • true – The menu is opened

  • false – The menu is closed

Example:

bIsMenuOpened = menu.is_menu_active()
if bIsMenuOpened then
   system.log_debug("The menu is opened")
end

---

is_menu_controls_active()

Checks whether the menu controls are active.

Parameters:

• None

Returns:

• bool

  • true – The menu controls are active

  • false – The menu controls are inactive

Example:

bIsMenuControlsActive = menu.is_menu_controls_active()
if bIsMenuControlsActive then
   system.log_debug("The menu controls are active")
end

---

is_menu_mouse_controls_active()

Checks whether the menu mouse controls are active.

Parameters:

• None

Returns:

• bool

  • true – The menu mouse controls are active

  • false – The menu mouse controls are inactive

Example:

bIsMenuMouseActive = menu.is_menu_mouse_controls_active()
if bIsMenuMouseActive then
   system.log_debug("The menu mouse controls are active")
end

---

menu_set_controls(toggle)

Toggles menu controls on/off.

Parameters:

• toggle (bool)

  • true to enable menu controls

  • false to disable them

Returns:

• None

Example:

menu.set_controls(true)
system.log_debug("The menu controls are enabled")

---

menu_set_mouse_controls(toggle)

Toggles menu mouse controls on/off.

Parameters:

• toggle (bool)

  • true to enable menu mouse controls

  • false to disable them

Returns:

• None

Example:

menu.set_mouse_controls(true)
system.log_debug("The menu mouse controls are active")

---

menu_set_value()

Brings up set value menu.

Parameters:

• None

Returns:

• None

Example:

menu.set_value()

---

menu_back()

Menu navigation action (Back).

Parameters:

• None

Returns:

• None

Example:

menu.menu_back()

---

menu_back_mouse()

Menu mouse navigation action (Back).

Parameters:

• None

Returns:

• None

Example:

menu.menu_back_mouse()

---

menu_down()

Menu navigation action (Down).

Parameters:

• None

Returns:

• None

Example:

menu.menu_down()

---

menu_left()

Menu navigation action (Left).

Parameters:

• None

Returns:

• None

Example:

menu.menu_left()

---

menu_remove_hotkey()

Menu action (Remove Hotkey).

Parameters:

• None

Returns:

• None

Example:

menu.menu_remove_hotkey()

---

menu_right()

Menu navigation action (Right).

Parameters:

• None

Returns:

• None

Example:

menu.menu_right()

---

menu_save()

Menu action (Save settings).

Parameters:

• None

Returns:

• None

Example:

menu.menu_save()

---

menu_select()

Menu navigation action (Select).

Parameters:

• None

Returns:

• None

Example:

menu.menu_select()

---

menu_select_mouse()

Menu mouse navigation action (Select).

Parameters:

• None

Returns:

• None

Example:

menu.menu_select_mouse()

---

menu_toggle()

Menu navigation action (Toggle).

Parameters:

• None

Returns:

• None

Example:

menu.menu_toggle()

---

menu_up()

Menu navigation action (Up).

Parameters:

• None

Returns:

• None

Example:

menu.menu_up()

---

get_current_option_hash()

Returns the hash of the current option.

Parameters:

• None

Returns:

• string – The hash of the current option

---

get_current_spawn_option_hash()

Returns the current model hash for a newly-spawned entity

Parameters:

• None

Returns:

• Hash – current model hash

---

get_child_count(parentId)

Returns the number of children of the specified parent.

Parameters:

• parentId (string) – The parent ID

Returns:

• int – The number of children of the specified parent

Example:

iChildCount = menu.get_child_count("parentId")
system.log_debug("The number of children of the parent is " .. iChildCount)

---

get_option_spawn_hash(hash)

Note

This function is not yet implemented.

---

set_active_parent(parentId)

Sets an active parent section in the menu.

Parameters:

• parentId (string) – The parent ID

Returns:

• None

Example:

iSectionWorld = menu.section_world()
menu.set_active_parent(iSectionWorld)

---

Stats namespace

This namespace contains functions that are used to get and set certain stats in the game.

Warning

These functions are meant to be used by experienced users only, as they can be used to break the character and the account.

There are no examples for this namespace, as advanced users will know how to use it.

Sapienti sat

---

set_packed_bool(index, value)

Sets a packed boolean stat.

Parameters:

• index (int) – The index of the packed bool stat.

• value (bool) – The value to set.

Returns:

• None

---

get_packed_bool(index)

Returns a packed boolean stat.

Parameters:

• index (int) – The index of the packed bool stat.

Returns:

• bool – The value of the packed bool stat.

---

set_mass_packed_bool(value, min, max)

Sets a mass-packed boolean stat.

Parameters:

• value (bool) – The value to set.

• min (int) – The minimum value of the mass-packed bool stat.

• max (int) – The maximum value of the mass-packed bool stat.

Returns:

• None

---

get_mass_packed_bool(min, max)

Note

This function is not implemented yet.

Returns a mass-packed boolean stat.

Parameters:

• min (int) – The minimum value of the mass-packed bool stat.

• max (int) – The maximum value of the mass-packed bool stat.

Returns:

• None

---

set_packed_int(index, value)

Sets a packed integer stat.

Parameters:

• index (int) – The index of the packed integer stat.

• value (int) – The value to set.

Returns:

• None

---

get_packed_int(index)

Returns a packed integer stat.

Parameters:

• index (int) – The index of the packed integer stat.

Returns:

• int – The value of the packed integer stat.

---

get_mass_packed_int(min, max)

Note

This function is not implemented yet.

Returns a mass-packed integer stat.

Parameters:

• min (int) – The minimum value of the mass-packed integer stat.

• max (int) – The maximum value of the mass-packed integer stat.

Returns:

• None

---

set_stat_bit(string stat, int bit)

Set a bit in a stat.

Parameters:

• stat (string) – The stat name.

• bit (int) – The bit to set.

Returns:

• None

---

clear_stat_bit(stat, bit)

Clear a bit in a stat.

Parameters:

• stat (string) – The stat name.

• bit (int) – The bit to clear.

Returns:

• None

---

stat_get_int(stat)

Returns an integer stat.

Parameters:

• stat (string) – The name of the stat.

Returns:

• int – The value of the stat.

---

stat_set_int(stat, value)

Parameters:

• stat (string) – The name of the stat.

• value (int) – The value to set.

Returns:

• None

---

stat_get_bool(stat)

Returns a boolean stat.

Parameters:

• stat (string) – The name of the stat.

Returns:

• bool – The value of the stat.

---

stat_set_bool(stat, value)

Sets a boolean stat.

Parameters:

• stat (string) – The name of the stat.

• value (bool) – The value to set.

Returns:

• None

---

stat_get_float(stat)

Returns a float stat.

Parameters:

• stat (string) – The name of the stat.

Returns:

• float – The value of the stat.

---

stat_set_float(stat, value)

Sets a float stat.

Parameters:

• stat (string) – The name of the stat.

• value (float) – The value to set.

Returns:

• None

---

Notify namespace

This namespace contains functions for sending notifications.

---

above_map(text)

Sends a notification in the bottom-left corner of the screen.

Parameters:

• text (string) – The text to display.

Returns:

• None

Example:

notify.above_map("Hello world!")

---

info(text)

Sends a blue-colored notification in the bottom-right corner of the screen.

Parameters:

• text (string) – The text to display.

Returns:

• None

Example:

notify.info("Hello world!")

---

success(text)

Sends a green-colored notification in the bottom-right corner of the screen.

Parameters:

• text (string) – The text to display.

Returns:

• None

Example:

notify.success("Hello world!")

---

warning(text)

Sends a red-colored notification in the bottom-right corner of the screen.

Parameters:

• text (string) – The text to display.

Returns:

• None

Example:

notify.warning("Hello world!")

---

lua(text)

Sends a lime-colored notification in the bottom-right corner of the screen.

Parameters:

• text (string) – The text to display.

Returns:

• None

Example:

notify.lua("Hello world!")

---

force_next_notify()

Disables antispam for the next notification.

Parameters:

• None

Returns:

• None

---

Script namespace

This namespace contains functions for executing in-game events.

Warning

These functions are meant to be used by experienced users only.

Sapienti sat

---

trigger_script_event(eventGroup, args, playerId)

Triggers a script event.

Parameters:

• eventGroup (int) – The event group ID.

• args (int64_t) – The arguments to pass to the event.

• playerId (int) – The player ID to send the event to.

Returns:

• None

Example:

script.trigger_script_event(0x0000000, { 1234567, 7654321, 1234321 }, chatSenderId)

---

is_script_running(scriptName)

Checks whether a script is running.

Parameters:

• scriptName (string) – The name of the script.

Returns:

• bool – True if the script is running, false otherwise.

---

execute_as_script(scriptName, fn)

Execute function as script

Parameters:

• scriptName (string) – The name of the script.

• fn (function) – The function to execute.

Returns:

• None

---

Globals namespace

This namespace contains functions for accessing global in-game values.

Warning

These functions are meant to be used by experienced users only.

Sapienti sat

---

set_global_int(global, value)

Sets a new global integer value.

Parameters:

• global (uint64_t) – The name of the global value.

• value (int) – The value to set.

Returns:

• None

---

set_global_float(global, value)

Sets a new global float value.

Parameters:

• global (uint64_t) – The name of the global value.

• value (float) – The value to set.

Returns:

• None

---

set_global_bool(global, value)

Sets a new global boolean value.

Parameters:

• global (uint64_t) – The name of the global value.

• value (bool) – The value to set.

Returns:

• None

---

set_global_string(global, value)

Sets a new global string value.

Parameters:

• global (uint64_t) – The name of the global value.

• value (string) – The value to set.

Returns:

• None

---

get_global_int(global)

Returns a global integer value.

Parameters:

• global (uint64_t) – The name of the global value.

Returns:

• int – The global value.

---

get_global_float(global)

Returns a global float value.

Parameters:

• global (uint64_t) – The name of the global value.

Returns:

• float – The global value.

---

get_global_bool(global)

Returns a global boolean value.

Parameters:

• global (uint64_t) – The name of the global value.

Returns:

• bool – The global value.

---

get_global_string(global)

Returns a global string value.

Parameters:

• global (uint64_t) – The name of the global value.

Returns:

• string – The global value.

---

get_global_addr(global)

Returns the memory address of a global.

Parameters:

• global (uint64_t) – The name of the global value.

Returns:

• uint64_t – The memory address of the global.

---

Locals namespace

This namespace contains functions for accessing local in-game values.

Warning

These functions are meant to be used by experienced users only.

Sapienti sat

---

set_local_int(scriptName, local, value)

Sets a new local integer value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

• value (int) – The value to set.

Returns:

• None

---

set_local_float(scriptName, local, value)

Sets a new local float value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

• value (float) – The value to set.

Returns:

• None

---

set_local_bool(scriptName, local, value)

Sets a new local boolean value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

• value (bool) – The value to set.

Returns:

• None

---

set_local_string(scriptName, local, value)

Sets a new local string value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

• value (string) – The value to set.

Returns:

• None

---

get_local_int(scriptName, local)

Returns a local integer value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

Returns:

• int – The local value.

---

get_local_float(scriptName, local)

Returns a local float value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

Returns:

• float – The local value.

---

get_local_bool(scriptName, local)

Returns a local boolean value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

Returns:

• bool – The local value.

---

get_local_string(scriptName, local)

Returns a local string value.

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

Returns:

• string – The local value.

---

get_local_addr(scriptName, local)

Parameters:

• scriptName (string) – The name of the script.

• local (uint64_t) – The name of the local value.

Returns:

• uint64_t – The memory address of the local.

---

Render namespace

This namespace contains functions that are used to render certain objects in the game and gathering certain objects’ coordinates on screen.

---

draw_rect(hash, draw, x, y, w, h, color, rounding = 0, rounding_flags = 0)

Draws a box with the given color and rounding.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the box to draw. Hash is used to identify the box, so it must be unique.

• draw (bool) – Whether to draw the box or not.

• • True to draw the box

• • false to not draw the box

• x (float) – The X coordinate of the box’s starting point.

• y (float) – The Y coordinate of the box’s starting point.

• w (float) – The width of the box (in pixels)

• h (float) – The height of the box (in pixels)

• color (ColorRGBA) – The color of the box. {R, G, B, A}

• rounding (float) – The rounding rule of the box.

• • Default is 0.

• rounding_flags (int) – The rounding flags of the box.

• • Default is 0.

More about rounding flags: Rounding Flags

Returns:

• None

Example:

render.draw_rect("MyHash", true, 0, 0, 100, 100, { 255, 255, 255, 255 }, 10, 0)

---

draw_rect_filled(hash, draw, x, y, w, h, color, rounding = 0, rounding_flags = 0)

Draws a filled box with the given color and rounding.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the box to draw. Hash is used to identify the box, so it must be unique.

• draw (bool) – Whether to draw the box or not.

• • True to draw the box

• • false to not draw the box

• x (float) – The X coordinate of the box’s starting point.

• y (float) – The Y coordinate of the box’s starting point.

• w (float) – The width of the box (in pixels)

• h (float) – The height of the box (in pixels)

• color (ColorRGBA) – The color of the box. {R, G, B, A}

• rounding (float) – The rounding rule of the box.

• • Default is 0.

• rounding_flags (int) – The rounding flags of the box.

• • Default is 0.

More about rounding flags: Rounding Flags

Returns:

• None

Example:

render.draw_rect_filled("MyHash", true, 0, 0, 100, 100, { 255, 255, 255, 255 }, 10, 0)

---

draw_rect_border_filled(hash, draw, x, y, w, h, borderSize, color, colorBorder, borderFilled = true, rounding = 0, rounding_flags = 0)

Draws a filled border box with the given color and rounding.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the box to draw. Hash is used to identify the box, so it must be unique.

• draw (bool) – Whether to draw the box or not.

• • True to draw the box

• • false to not draw the box

• x (float) – The X coordinate of the box’s starting point.

• y (float) – The Y coordinate of the box’s starting point.

• w (float) – The width of the box (in pixels)

• h (float) – The height of the box (in pixels)

• borderSize (float) – The width of the border (in pixels)

• color (ColorRGBA) – The color of the box. {R, G, B, A}

• colorBorder (ColorRGBA) – The color of the border. {R, G, B, A}

• borderFilled (bool)

• • True to fill the border

• • false to not fill the border

• rounding (float) – The rounding rule of the box.

• • Default is 0.

• rounding_flags (int) – The rounding flags of the box.

• • Default is 0.

More about rounding flags: Rounding Flags

Returns:

• None

Example:

render.draw_rect_border_filled("MyHash", true, 0, 0, 100, 100, 10, { 255, 255, 255, 255 }, { 0, 0, 0, 255 }, true, 10, 0)

---

draw_circle(hash, draw, x, y, radius, color, segments = 16)

Draws a circle with the given color.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the circle to draw. Hash is used to identify the circle, so it must be unique.

• draw (bool) – Whether to draw the circle or not.

• • True to draw the circle

• • false to not draw the circle

• x (float) – The X coordinate of the circle’s center.

• y (float) – The Y coordinate of the circle’s center.

• radius (float) – The radius of the circle (in pixels).

• color (ColorRGBA) – The color of the circle. {R, G, B, A}

• segments (int) – The number of segments of the circle.

• • Default is 16.

• • Better to keep between 1-50. Going further may cause the process to crash.

Returns:

• None

Example:

render.draw_circle("MyHash", true, 0, 0, 100, { 255, 255, 255, 255 }, 16)

---

draw_circle_filled(hash, draw, x, y, radius, color, segments = 16)

Draws a filled circle with the given color.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the circle to draw. Hash is used to identify the circle, so it must be unique.

• draw (bool) – Whether to draw the circle or not.

• • True to draw the circle

• • false to not draw the circle

• x (float) – The X coordinate of the circle’s center.

• y (float) – The Y coordinate of the circle’s center.

• radius (float) – The radius of the circle (in pixels).

• color (ColorRGBA) – The color of the circle. {R, G, B, A}

• segments (int) – The number of segments of the circle.

• • Default is 16.

• • Better to keep between 1-50. Going further may cause the process to crash.

Returns:

• None

Example:

render.draw_circle_filled("MyHash", true, 0, 0, 100, { 255, 255, 255, 255 }, 16)

---

draw_circle_border_filled(hash, draw, x, y, radius, color, colorBorder, borderFilled = true, segments = 16)

Draws a filled border circle with the given color.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the circle to draw. Hash is used to identify the circle, so it must be unique.

• draw (bool) – Whether to draw the circle or not.

• • True to draw the circle

• • false to not draw the circle

• x (float) – The X coordinate of the circle’s center.

• y (float) – The Y coordinate of the circle’s center.

• radius (float) – The radius of the circle (in pixels).

• color (ColorRGBA) – The color of the circle. {R, G, B, A}

• colorBorder (ColorRGBA) – The color of the border. {R, G, B, A}

• borderFilled (bool)

• • True to fill the border

• • false to not fill the border

• segments (int) – The number of segments of the circle.

• • Default is 16.

• • Better to keep between 1-50. Going further may cause the process to crash.

Returns:

• None

Example:

render.draw_circle_border_filled("MyHash", true, 0, 0, 100, { 255, 255, 255, 255 }, { 0, 0, 0, 255 }, true, 16)

---

draw_triangle(hash, draw, x, y, color, size = 1.1)

Draws a triangle with the given color.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the triangle to draw. Hash is used to identify the triangle, so it must be unique.

• draw (bool) – Whether to draw the triangle or not.

• • True to draw the triangle

• • false to not draw the triangle

• x (float) – The X coordinate of the triangle’s center.

• y (float) – The Y coordinate of the triangle’s center.

• color (ColorRGBA) – The color of the triangle. {R, G, B, A}

• size (float) – The size of the triangle (in pixels).

• • Default is 1.1.

Returns:

• None

Example:

render.draw_triangle("MyHash", true, 0, 0, { 255, 255, 255, 255 }, 1.1)

---

draw_triangle_filled(hash, draw, x, y, color, size = 1.1)

Draws a filled triangle with the given color.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the triangle to draw. Hash is used to identify the triangle, so it must be unique.

• draw (bool) – Whether to draw the triangle or not.

• • True to draw the triangle

• • false to not draw the triangle

• x (float) – The X coordinate of the triangle’s center.

• y (float) – The Y coordinate of the triangle’s center.

• color (ColorRGBA) – The color of the triangle. {R, G, B, A}

• size (float) – The size of the triangle (in pixels).

• • Default is 1.1.

Returns:

• None

Example:

render.draw_triangle_filled("MyHash", true, 0.f, 0.f, { 255, 255, 255, 255 }, 1.1)

---

draw_triangle_border_filled(hash, draw, x, y, color, colorBorder, borderFilled = true)

Draws a filled border triangle with the given color.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the triangle to draw. Hash is used to identify the triangle, so it must be unique.

• draw (bool) – Whether to draw the triangle or not.

• • True to draw the triangle

• • false to not draw the triangle

• x (float) – The X coordinate of the triangle’s center.

• y (float) – The Y coordinate of the triangle’s center.

• color (ColorRGBA) – The color of the triangle. {R, G, B, A}

• colorBorder (ColorRGBA) – The color of the border. {R, G, B, A}

• borderFilled (bool)

• • True to fill the border (Default)

• • false to not fill the border

Returns:

• None

Example:

render.draw_triangle_border_filled("MyHash", true, 0, 0, { 255, 255, 255, 255 }, { 0, 0, 0, 255 }, true)

---

draw_text(hash, draw, text, x, y, scale, color, flags = 0)

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Draws a text with the given color.

Parameters:

• hash (string) – The hash of the text to draw. Hash is used to identify the text, so it must be unique.

• draw (bool) – Whether to draw the text or not.

• • True to draw the text

• • false to not draw the text

• text (string) – The text to draw.

• x (float) – The X coordinate of the text’s center.

• y (float) – The Y coordinate of the text’s center.

• scale (float) – The scale of the text.

• color (ColorRGBA) – The color of the text. {R, G, B, A}

• flags (int) – The flags for the text.

• • Default is 0.

More about text flags: Text Flags

Returns:

• None

Example:

render.draw_text("MyHash", true, "Hello World", 0, 0, 10, { 255, 255, 255, 255 }, 0)

---

draw_image(path, hash, draw, x, y, w, h, color, rounding = 0.f, rounding_flags = 0)

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Draws an image. Supports PNG & JPEG files.

Parameters:

• path (string) – The path of the image to draw.

• hash (string) – The hash of the image to draw. Hash is used to identify the image, so it must be unique.

• draw (bool) – Whether to draw the image or not.

• • True to draw the image

• • false to not draw the image

• x (float) – The X coordinate of the image’s center.

• y (float) – The Y coordinate of the image’s center.

• w (float) – The width of the image.

• h (float) – The height of the image.

• color (ColorRGBA) – The color of the image. {R, G, B, A}

• rounding (float) – The rounding of the image.

• • Default is 0.

• rounding_flags (int) – The flags for the rounding.

• • Default is 0.

• • More about rounding flags: Rounding Flags

Returns:

• None

Example:

render.draw_image("/path/to/image.png", "MyHash", true, 0, 0, 100, 100, { 255, 255, 255, 255 }, 0.f, 0)

---

draw_atlas_frame(hash, atlasHash, frameName, draw, x, y, w, h, color, rounding = 0.0, rounding_flags = 0)

Draw an atlas texture frame.

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Parameters:

• hash (string) – The hash of the atlas texture frame to draw.

• atlasHash (string) – The hash of the atlas texture.

• frameName (string) – The name of the frame to draw.

• draw (bool) – Whether to draw the atlas texture frame or not.

• • True to draw the atlas texture frame

• • false to not draw the atlas texture frame

• x (float) – The X coordinate of the atlas texture frame

• y (float) – The Y coordinate of the atlas texture frame

• w (float) – The width of the atlas texture frame.

• h (float) – The height of the atlas texture frame.

• color (ColorRGBA) – The color of the atlas texture frame. {R, G, B, A}

• rounding (float) – The rounding of the atlas texture frame.

• • Default is 0.

• rounding_flags (int) – The flags for the rounding.

• • Default is 0.

• • More about rounding flags: Rounding Flags

Returns:

• None

Example:

--assuming there's a texture named "test" in the atlas
render.load_atlas("/path/to/atlas.png", "MyAtlas")
render.draw_atlas_frame("MyFrameHash", "MyAtlas", "test", true, 240, 15, 0, 0, { 255, 255, 255, 255 }, 0, 0)

---

draw_box(hash, draw, boundingData, color, thickness = 1.0)

Note

This doesn’t have to be called every frame, only if you have to constantly change its parameters.

Draws a 3D box with the given color and thickness.

Parameters:

• hash (string) – The hash of the box to draw. Hash is used to identify the box, so it must be unique.

• draw (bool) – Whether to draw the box or not.

• • True to draw the box

• • false to not draw the box

• boundingData (ModelBoundingBox) – The vector consisting of 8 Vector3’s that contain the coordinates of box’s corners.

• color (ColorRGBA) – The color of the box. {R, G, B, A}

• thickness (float) – The thickness of the box.

• • Default is 1.0.

Returns:

• None

Example:

pSelfPed = player.get_ped()
mbbBoundingCoords = scripting.get_entity_bounding_coords(pSelfPed)
render.draw_box("MyHash", true, mbbBoundingCoords, { 255, 255, 255, 255 }, 1.0)

---

remove_draw_task(hash)

Remove a draw task.

Parameters:

• hash (string) – The hash of the task to remove.

Returns:

• None

Example:

render.remove_draw_task("MyTask")

---

remove_draw_tasks_by_mask(mask)

Remove multiple draw tasks with the same masks.

Parameters:

• mask (string) – The mask of the tasks to remove.

Returns:

• None

Example:

render.remove_draw_tasks_by_mask("Task_*") -- Remove all tasks with the hash that starts with "Task_"

---

load_atlas(path, atlasHash)

Load a texture atlas.

Parameters:

• path (string) – The path of the atlas to load.

• atlasHash (string) – The atlas hash.

Returns:

• None

Example:

render.load_atlas("/path/to/atlas.png", "MyAtlas")

---

remove_atlas(atlasHash)

Unload a texture atlas.

Parameters:

• atlasHash (string) – The atlas hash.

Returns:

• None

Example:

render.load_atlas("/path/to/atlas.png", "MyAtlas")
render.remove_atlas("MyAtlas")

---

is_color_picker_rendering()

Checks whether the color picker is active.

Parameters:

• None

Returns:

• bool

  • true – The color picker is active

  • false – The color picker is inactive

Example:

if render.is_color_picker_rendering() then
   system.log_info("The color picker is active!") -- Prints if the color picker is active.
end

---

is_cursor_hover_menu()

Checks whether the cursor is hovering over the menu.

Parameters:

• None

Returns:

• bool

  • true – The cursor is hovering over the menu

  • false – The cursor is not hovering over the menu

Example:

if render.is_cursor_hover_menu() then
   system.log_info("The cursor is hovering over the menu!") -- This will only be logged if the cursor is hovering over the menu.
end

---

is_cursor_hover_option()

Checks whether the cursor is hovering over an option.

Parameters:

• None

Returns:

• bool

  • true – The cursor is hovering over an option

  • false – The cursor is not hovering over an option

Example:

if render.is_cursor_hover_option() then
   system.log_info("The cursor is hovering over an option!") -- This will only be logged if the cursor is hovering over an option.
end

---

is_input_active()

Checks whether the input window is active. (The input window is for example, the window that appears when you press the ` key in story mode)

Parameters:

• None

Returns:

• bool

  • true – The input window is active

  • false – The input window is inactive

Example:

if render.is_input_active() then
   system.log_info("The input window is active!") -- This will only be logged if the input window is active.
end

---

get_border_size()

Returns the process window’s border size.

Parameters:

• None

Returns:

• float – The border size.

Example:

v3BorderSize = render.get_border_size() -- Returns the border size.
system.log_info("The border size is " .. tostring(v3BorderSize) .. ".") -- Prints the border size.

---

get_fps()

Returns the current FPS.

Parameters:

• None

Returns:

• float – The current FPS.

Example:

fFPSCount = render.get_fps() -- Returns the FPS.
system.log_info("The FPS is " .. tostring(fFPSCount) .. ".") -- Prints the FPS.

---

get_menu_rounding()

Returns the menu’s rounding.

Parameters:

• None

Returns:

• float – The menu’s rounding.

Example:

fMenuRounding = render.get_menu_rounding() -- Returns the rounding.
system.log_info("The rounding is " .. tostring(fMenuRounding) .. ".") -- Prints the rounding.

---

get_menu_width()

Returns the menu’s width.

Parameters:

• None

Returns:

• float – The menu’s width.

Example:

fMenuWidth = render.get_menu_width() -- Returns the width.
system.log_info("The width is " .. tostring(fMenuWidth) .. ".") -- Prints the width.

---

get_font_header_size()

Returns the font header size.

Parameters:

• None

Returns:

• int – The font header size.

Example:

fHeaderFontSize = render.get_font_header_size() -- Returns the header size.
system.log_info("The header size is " .. tostring(fHeaderFontSize) .. ".") -- Prints the header size.

---

get_font_helper_size()

Returns the font helper size.

Parameters:

• None

Returns:

• int – The font helper size.

Example:

fHelperFontSize = render.get_font_helper_size() -- Returns the helper size.
system.log_info("The helper size is " .. tostring(fHelperFontSize) .. ".") -- Prints the helper size.

---

get_font_option_size()

Returns the font option size.

Parameters:

• None

Returns:

• int – The font option size.

Example:

fOptionFontSize = render.get_font_option_size() -- Returns the option size.
system.log_info("The option size is " .. tostring(fOptionFontSize) .. ".") -- Prints the option size.

---

get_font_warning_size()

Returns the font warning size.

Parameters:

• None

Returns:

• int – The font warning size.

Example:

fWarningFontSize = render.get_font_warning_size() -- Returns the warning size.
system.log_info("The warning size is " .. tostring(fWarningFontSize) .. ".") -- Prints the warning size.

---

get_menu_cursor_pos()

Returns the cursor position.

Parameters:

• None

Returns:

Vector2 – The cursor position.

Example:

v2CursorPos = render.get_menu_cursor_pos() -- Returns the cursor position.
system.log_info("The cursor position is " .. tostring(v2CursorPos.x) .. ".") -- Prints the cursor X position coordinate.
system.log_info("The cursor position is " .. tostring(v2CursorPos.y) .. ".") -- Prints the cursor Y position coordinate.

---

get_menu_position()

Returns the menu position.

Parameters:

• None

Returns:

Vector2 – The menu position.

Example:

v2MenuPos = render.get_menu_position() -- Returns the menu position.
system.log_info("The menu position is " .. tostring(v2MenuPos.x) .. ".") -- Prints the menu X position coordinate.
system.log_info("The menu position is " .. tostring(v2MenuPos.y) .. ".") -- Prints the menu Y position coordinate.

---

get_menu_total_size()

Returns the menu total size.

Parameters:

• None

Returns:

Vector2 – The menu total size.

Example:

v2TotalSize = render.get_menu_total_size() -- Returns the menu total size.
system.log_info("The menu total size is " .. tostring(v2TotalSize.x) .. ".") -- Prints the menu total X size.
system.log_info("The menu total size is " .. tostring(v2TotalSize.y) .. ".") -- Prints the menu total Y size.

---

get_screen_resolution()

Returns the screen resolution.

Parameters:

• None

Returns:

Vector2 – The screen resolution.

Example:

v2ScreenRes = render.get_screen_resolution() -- Returns the screen resolution.
system.log_info("The screen resolution is " .. tostring(v2ScreenRes.x) .. ".") -- Prints the screen X resolution.
system.log_info("The screen resolution is " .. tostring(v2ScreenRes.y) .. ".") -- Prints the screen Y resolution.

---

get_text_size()

Returns the size of the drawn text.

Note

not documented yet

---

set_warning(message)

Brings up a warning (as if a moderator was detected in a session)

Parameters:

• message (string) – The warning message.

Returns:

• None

Example:

render.set_warning("This is a warning.") -- Brings up a warning.

---

Player namespace

This namespace contains functions that are related to the character of the menu user.

---

is_alive()

Returns whether the user is alive.

Parameters:

• None

Returns:

• bool – Whether the user is alive.

Example:

if player.is_alive() then -- Checks whether the user is alive.
   system.log_info("The user is alive.")
else
   system.log_info("The user is dead.")
end

---

is_in_vehicle()

Checks whether the user is in a vehicle.

Parameters:

• None

Returns:

• bool – Whether the user is in a vehicle.

Example:

if player.is_in_vehicle() then -- Checks whether the user is in a vehicle.
   system.log_info("The user is in a vehicle.")
else
   system.log_info("The user is not in a vehicle.")
end

---

is_valid()

Checks whether the player is valid – the player is alive, is fully loaded into the session, and has control of the character.

Parameters:

• None

Returns:

• bool – Whether the player is valid.

  • Can also be true during cutscenes.

Example:

if player.is_valid() then -- Checks whether the player is valid.
   system.log_info("The player is valid.")
else
   system.log_info("The player is invalid.")
end

---

get_online_index()

Returns the online index of the user’s character.

Parameters:

• None

Returns:

• int – The online index of the user’s character.

  • 0 – The first character is used

  • 1 – The second character is used

Example:

iOnlineIndex = player.get_online_index() -- Returns the online index of the user's character.
if iOnlineIndex == 0 then -- Checks whether the first character is used.
   system.log_info("The first character is used.")
elseif iOnlineIndex == 1 then -- Checks whether the second character is used.
   system.log_info("The second character is used.")
end

---

get_ped()

Returns the user’s character’s ped ID

Parameters:

• None

Returns:

• int – The user’s character’s ped ID.

Example:

pSelfPed = player.get_ped()
if rage.ped.is_ped_a_player(pSelfPed) then -- If the ped is a player.
   system.log_info("The ped is a player.")
end

---

get_id()

Returns the player as a player handle

Parameters:

• None

Returns:

• int – The player handle

Example:

plHandle = player.get_id()
system.log_info("The character ID is " .. tostring(plHandle) .. ".")

---

get_name()

Returns your own username.

Parameters:

• None

Returns:

• string

Example:

sUsername = player.get_name()
system.log_info("My username is: " .. sUsername)

---

get_original_scid()

Returns your SCID (Social Club ID).

Parameters:

• None

Returns:

• uint32_t – Original Social Club ID

Example:

sMyRealSCID = player.get_original_scid()
system.log_info("My original SCID is: " .. tostring(sMySCID))

---

get_scid()

Returns your current SCID (Social Club ID).

Parameters:

• None

Returns:

• uint32_t – Current Social Club ID

Example:

sMySCID = player.get_scid()
system.log_info("My current SCID is: " .. tostring(sMySCID))

---

get_saved_scid()

Returns your saved SCID (Social Club ID).

Parameters:

• None

Returns:

• uint64_t – Saved Social Club ID

Example:

sMySavedSCID = player.get_saved_scid()
system.log_info("My saved SCID is: " .. tostring(sMySavedSCID))

---

get_coords()

Returns your character’s coordinates.

Parameters:

• None

Returns:

• Vector3 – Coordinates

Example:

v3CurrentCoords = player.get_coords()
system.log_info("I'm located at the following coords: " .. tostring(v3CurrentCoords.x) .. ", " .. tostring(v3CurrentCoords.y) .. ", " .. tostring(v3CurrentCoords.z) .. " .")

---

get_coords_infront(distance = 5.0)

Returns coordinates in front of your character.

Parameters:

• distance (float) – Distance calculated starting from in front of self.

  • Default value is 5.0.

Returns:

• Vector3 – Coordinates in front of self.

Example:

v3CoordsInfront = player.get_coords_infront(5)
system.log_info("The coords in front of me are: " .. tostring(v3CoordsInfront.x) .. ", " .. tostring(v3CoordsInfront.y) .. ", " .. tostring(v3CoordsInfront.z) .. " .")

---

get_vehicle()

Returns your current vehicle’s ID.

Parameters:

• None

Returns:

• Vehicle – Vehicle handle.

Example:

vCurrentVehicle = player.get_vehicle()
system.log_info("You're riding vehicle ID: " .. tostring(vCurrentVehicle))

---

Lobby namespace

This namespace contains functions related to the interaction with the online game session.

Note

Functions from this namespace only work in online mode.

---

is_player_active(player)

Checks whether the player is in active, in the session, is fully loaded, connected, is in the same game mode as you (e.g. freemode)

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is active.

Example:

plHostPlayer = lobby.get_host()

bIsActive = lobby.is_player_active(places) -- Checks whether the player is active.
if bIsActive then -- If the player is active.
   system.log_info("The player is active.")
end

---

is_player_connected(player)

Checks whether the player is connected.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is connected.

Example:

plHostPlayer = lobby.get_host()
bIsConnected = lobby.is_player_connected(plHostPlayer) -- Checks whether the player is connected.
if bIsConnected then -- If the player is connected.
   system.log_info("The player is connected.")
end

---

is_player_friend(player)

Checks whether the player is a friend.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is a friend.

Example:

plHostPlayer = lobby.get_host()
bIsFriend = lobby.is_player_friend(plHostPlayer) -- Checks whether the session host is a friend.
if bIsFriend then -- If the player is a friend.
   system.log_info("The player is a friend.")
end

---

is_player_host(player)

Checks whether the player is the host.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is the host.

Example:

plHostPlayer = lobby.get_host()
bIsHost = lobby.is_player_host(plHostPlayer) -- Checks whether the player is the host.
if bIsHost then -- If the player is the host.
   system.log_info("The player is the host.")
end

---

is_player_host_next(player)

Checks whether the player is the next script host.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is the next script host.

Example:

plHostPlayer = lobby.get_host()
bIsNextHost = lobby.is_player_host_next(plHostPlayer) -- Checks whether the player is the next script host.
if bIsNextHost then -- If the player is the next script host.
   system.log_info("The player is the next script host.")
end

---

is_player_in_vehicle(player)

Checks whether the player is in a vehicle.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is in a vehicle.

Example:

plHostPlayer = lobby.get_host()
bIsInVehicle = lobby.is_player_in_vehicle(plHostPlayer) -- Checks whether the player is in a vehicle.
if bIsInVehicle then -- If the player is in a vehicle.
   system.log_info("The player is in a vehicle.")
end

---

is_player_modder(player)

Checks whether the player is a modder.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is a modder.

Example:

plHostPlayer = lobby.get_host()
bIsModder = lobby.is_player_modder(plHostPlayer) -- Checks whether the player is a modder.
if bIsModder then -- If the player is a modder.
   system.log_info("The player is a modder.")
end

---

is_player_selected(player)

Checks whether the player is selected in the menu’s online section.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is selected.

Example:

plHostPlayer = lobby.get_host()
bIsSelected = lobby.is_player_selected(plHostPlayer) -- Checks whether the player is selected.
if bIsSelected then -- If the player is selected.
   system.log_info("The player is selected.")
end

---

is_player_staff(player)

Checks whether the player is a Rockstar staff member.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is a Rockstar staff member.

Example:

plHostPlayer = lobby.get_host()
bIsStaff = lobby.is_player_staff(plHostPlayer) -- Checks whether the player is a Rockstar staff member.
if bIsStaff then -- If the player is a Rockstar staff member.
   system.log_info("The player is a Rockstar staff member.")
end

---

is_player_valid(player)

Checks whether the player is valid - if it’s connected to the session, fully loaded, and alive.

Parameters:

• player (Player) – The player ID.

Returns:

• bool – Whether the player is valid.

Example:

plHostPlayer = lobby.get_host()
bIsValid = lobby.is_player_valid(plHostPlayer) -- Checks whether the player is valid.
if bIsValid then -- If the player is valid.
   system.log_info("The player is valid.")
end

---

is_session_started()

Checks whether the session has started: returns true if it’s fully loaded and you’re not hanging in the clouds.

Parameters:

• None

Returns:

• bool – Whether the session has started.

Example:

bIsStarted = lobby.is_session_started() -- Checks whether the session has started.
if bIsStarted then -- If the session has started.
   system.log_info("The session has started.")
end

---

get_active_players()

Returns a number of all active players.

Parameters:

• None

Returns:

• int – a number of all active players.

Example:

iActivePlayersCount = lobby.get_active_players() -- Returns a number of all active players.
system.log_info("There are " .. tostring(iActivePlayersCount) .. " active players.")

---

get_connected_players()

Returns a number of connected players.

Parameters:

• None

Returns:

• int – a number of connected players.

Example:

iConnectedPlayersCount = lobby.get_connected_players() -- Returns a number of connected players.
system.log_info("There are " .. tostring(iConnectedPlayersCount) .. " connected players.")

---

get_player_armour(player)

Returns the player’s armour health.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s armour health.

Example:

plHandle = player.get_id()
iArmourHealth = lobby.get_player_armour(plHandle) -- Returns the player's armour health.
if armour == 0 then -- If the player has no armour.
   system.log_info("The player has no armour.")
end

---

get_player_health(player)

Returns the player’s health.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s health.

Example:

plHandle = player.get_id()

iHealth = lobby.get_player_health(plHandle)
iMaxHealth = lobby.get_player_max_health(plHandle)
if iHealth == iMaxHealth then
   system.log_info("The player has full health.")
end

---

get_player_max_health(player)

Returns the player’s maximum health.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s maximum health.

Example:

plHandle = player.get_id()

iMaxHealth = lobby.get_player_max_health(plHandle)
iHealth = lobby.get_player_health(plHandle)
if iMaxHealth == iHealth then
   system.log_info("The player has full health.")
end

---

get_player_team(player)

Returns the player’s team.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s team ID. -1 if the player is not in a team.

Example:

plHandle = player.get_id()

iTeam = lobby.get_player_team(plHandle)
if iTeam == -1 then -- If the player is not in a team.
   system.log_info("The player is not in a team.")
end

---

get_player_ped(player)

Returns the player’s ped.

Parameters:

• player (Player) – The player ID.

Returns:

• Ped – The player’s ped.

Example:

plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer) -- Returns the host's ped.
if rage.ped.is_ped_a_player(pHostPed) then -- If the ped is a player.
   system.log_info("The ped is a player.")
end

---

get_host()

Returns the host player ID.

Parameters:

• None

Returns:

• Player – The host player ID.

Example:

plHostPlayer = lobby.get_host() -- Returns the host player ID.
system.log_debug("The host is " .. get_player_name(plHostPlayer) .. ".")

---

get_next_host()

Returns the next host player ID.

Parameters:

• None

Returns:

• Player – The next host player ID.

Example:

plNextHost = lobby.get_next_host() -- Returns the next host player ID.
system.log_debug("The next host is " .. get_player_name(plNextHost) .. ".")

---

get_selected_player()

Returns the ID of a player that is currently selected in the Online section.

Parameters:

• None

Returns:

• Player – The selected player ID.

---

get_player_coords_str(player)

Returns the player’s coordinates as a string.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s coordinates

Example:

plHostPlayer = lobby.get_host()

v3PlayerCoords = lobby.get_player_coords_str(plHostPlayer) -- Returns the host's coordinates.
system.log_debug("The host is at " .. v3PlayerCoords .. ".")

---

get_player_ip(player)

Returns the player’s IP.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s IP.

Example:

plHostPlayer = lobby.get_host()

sIPAddress = lobby.get_player_ip(plHostPlayer) -- Returns the host's IP.
system.log_debug("The host's IP is " .. sIPAddress .. ".")

---

get_player_name(player)

Returns the player’s name.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s name.

Example:

plHostPlayer = lobby.get_host()
sNickname = lobby.get_player_name(plHostPlayer) -- Returns the host's name.
system.log_debug("The host's name is " .. sNickname .. ".")

---

get_player_status(player)

Returns the player’s status.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s status.

  • H – The player is the host.

  • NH – The player is the next host.

  • F – The player is a friend.

  • M – The player is a modder.

Example:

plSelected = lobby.get_selected_player()

sPlayerStatus = lobby.get_player_status(plSelected) -- Returns the selected player's status.
system.log_debug("The selected player's status is " .. sPlayerStatus .. ".")

---

get_player_vehicle_name(player)

Returns the player’s vehicle name.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s vehicle name. If the player is not in a vehicle, the string “None” is returned.

Example:

plHostPlayer = lobby.get_host()
sVehicleName = lobby.get_player_vehicle_name(plHostPlayer) -- Returns the host's vehicle name.
system.log_debug("The host's vehicle name is " .. sVehicleName .. ".")

---

get_player_deaths(player)

Returns the total player’s deaths.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s deaths.

Example:

plHostPlayer = lobby.get_host()
iDeathsCount = lobby.get_player_deaths(plHostPlayer) -- Returns the host's deaths.
system.log_debug("The host has died " .. tostring(iDeathsCount) .. " times.")

---

get_player_kills(player)

Returns the total player’s kills.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s kills.

Example:

plHostPlayer = lobby.get_host()
iKillsCount = lobby.get_player_kills(plHostPlayer) -- Returns the host's kills.
system.log_debug("The host has killed " .. tostring(iKillsCount) .. " people.")

---

get_player_level(player)

Returns the player’s level.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s level.

Example:

plHostPlayer = lobby.get_host()
iLevel = lobby.get_player_level(plHostPlayer) -- Returns the host's level.
system.log_debug("The host's level is " .. tostring(iLevel) .. ".")

---

get_player_money_bank(player)

Returns the player’s bank money.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s bank money.

Example:

plHostPlayer = lobby.get_host()
iBankMoneyAmount = lobby.get_player_money_bank(plHostPlayer) -- Returns the host's bank money.
system.log_debug("The host has $" .. tostring(iBankMoneyAmount) .. " in the bank.")

---

get_player_money_wallet(player)

Returns the player’s wallet money.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s wallet money.

Example:

plHostPlayer = lobby.get_host()
iWalletMoneyAmount = lobby.get_player_money_wallet(plHostPlayer) -- Returns the host's wallet money.
system.log_debug("The host has $" .. tostring(iWalletMoneyAmount) .. " in the wallet.")

---

get_player_rp(player)

Returns the player’s RP points.

Parameters:

• player (Player) – The player ID.

Returns:

• int – The player’s RP.

Example:

plHostPlayer = lobby.get_host()
iRPpoints = lobby.get_player_rp(plHostPlayer) -- Returns the host's RP.
system.log_debug("The host has " .. tostring(iRPpoints) .. " RP.")

---

get_player_host_token(player)

Returns the player’s host token.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s host token.

Example:

plHostPlayer = lobby.get_host()
sHostToken = lobby.get_player_host_token(plHostPlayer) -- Returns the host's host token.
system.log_debug("The host's host token is " .. sHostToken .. ".")

---

get_player_original_scid(player)

Returns the player’s original SCID.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s original SCID.

Example:

plHostPlayer = lobby.get_host()
sPlayerOriginalSCID = lobby.get_player_original_scid(plHostPlayer) -- Returns the host's original SCID.
system.log_debug("The host's original SCID is " .. sPlayerOriginalSCID .. ".")

---

get_player_scid(player)

Returns the player’s SCID.

Parameters:

• player (Player) – The player ID.

Returns:

• string – The player’s SCID.

Example:

plHostPlayer = lobby.get_host()
sPlayerSCID = lobby.get_player_scid(plHostPlayer) -- Returns the host's SCID.
system.log_debug("The host's SCID is " .. sPlayerSCID .. ".")

---

get_player_coords(player)

Returns the player’s coordinates.

Parameters:

• player (Player) – The player ID.

Returns:

• Vector3 – The player’s coordinates.

Example:

plHostPlayer = lobby.get_host()
v3PlayerCoords = lobby.get_player_coords(plHostPlayer) -- Returns the host's coordinates.
system.log_debug("The host is at " .. tostring(v3PlayerCoords.x) .. ", " .. tostring(v3PlayerCoords.y) .. ", " .. tostring(v3PlayerCoords.z) .. " .")

---

get_player_vehicle(player)

Returns the player’s vehicle.

Parameters:

• player (Player) – The player ID.

Returns:

• Vehicle – The player’s vehicle.

Example:

plHostPlayer = lobby.get_host()
vPlayerVehicle = lobby.get_player_vehicle(plHostPlayer) -- Returns the host's vehicle.
system.log_debug("The host's vehicle is " .. tostring(vPlayerVehicle) .. ".")

---

set_player_modder(player, toggle)

Sets the player’s modder status.

Parameters:

• player (Player) – The player ID.

• toggle (bool) – The modder status.

  • true – The player is a modder.

  • false – The player is not a modder.

Returns:

• None

Example:

plHostPlayer = lobby.get_host()

lobby.set_player_modder(plHostPlayer, true) -- Sets the host as a modder.
system.log_debug("The host is now marked as a modder.")

---

set_player_selected(player, toggle)

Sets the player as selected in the online menu.

Parameters:

• player (Player) – The player ID.

• toggle (bool) – The selected status.

  • true – The player is set as selected.

  • false – The player is set as not selected.

Returns:

• None

Example:

plHostPlayer = lobby.get_host()
lobby.set_player_selected(plHostPlayer, true) -- Sets the host as selected.
system.log_debug("The host is now selected.")

---

set_player_staff(player, toggle)

Sets the player’s staff status.

Parameters:

• player (Player) – The player ID.

• toggle (bool) – The staff status.

  • true – The player is a staff member.

  • false – The player is not a staff member.

Returns:

• None

Example:

plHostPlayer = lobby.get_host()
lobby.set_player_staff(plHostPlayer, true) -- Sets the host as a staff member.
system.log_debug("The host is a staff member.")

---

Vehicle namespace

This namespace contains functions related to vehicle manipulation

---

get_vehicle_handling(vehicle, param)

Returns the value for the specified handling parameter.

Parameters:

• vehicle (Vehicle) – The vehicle ID.

• param (string) – The handling parameter.

  • You can find a list of handling parameters here: Vehicle handling parameters.

Returns:

• float – The value for the specified handling parameter.

Example:

vCurrentVehicle = player.get_vehicle()
handling = vehicle.get_vehicle_handling(vCurrentVehicle, "fBrakeForce") -- Returns the brake force of the vehicle.
system.log_debug("The player's vehicle has " .. tostring(handling) .. " brake force.")

---

set_vehicle_handling(vehicle, param, value)

Sets the value for the specified handling parameter.

Parameters:

• vehicle (Vehicle) – The vehicle ID.

• param (string) – The handling parameter.

  • You can find a list of handling parameters here: Vehicle handling parameters.

• value (float) – The value for the specified handling parameter.

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
vehicle.set_vehicle_handling(vCurrentVehicle, "fAcceleration", 100) -- Sets the acceleration of the vehicle to 100 points.
system.log_debug("The player's vehicle has been set to have 100 acceleration points.")

---

get_vehicle_handling_parameters()

Get all vehicle handling parameters.

Parameters:

• None

Returns:

• vector<string> – The vehicle handling parameters vector.

Example:

vCurrentVehicle = player.get_vehicle()
vstrHandlingParameters = vehicle.get_vehicle_handling_parameters() -- Returns the vehicle handling parameters vector.
for i,v in pairs(vstrHandlingParameters) do
             system.log_debug(tostring(i) .. " " .. tostring(v))
end

---

Weapon namespace

This namespace contains functions related to weapon manipulation

---

get_weapon_info(ped, param)

Returns the value for the specified weapon parameter.

Parameters:

• ped (Ped) – The ped ID.

• param (string) – The weapon parameter.

  • You can find a list of weapon parameters here: Weapon Info parameters.

Returns:

• float – The value for the specified weapon parameter.

Example:

pSelfPed = player.get_player()
fWeaponInfo = weapon.get_weapon_info(pSelfPed, "fWeaponRange") -- Returns the weapon range of the player.
system.log_debug("The player's weapon has " .. tostring(weaponInfo) .. " weapon range.")

---

set_weapon_info(ped, param, value)

Sets the value for the specified weapon parameter.

Parameters:

• ped (Ped) – The ped ID.

  • You can find a list of weapon parameters here: Weapon Info parameters.

• param (string) – The weapon parameter.

• value (float) – The value for the specified weapon parameter.

Returns:

• None

Example:

pSelfPed = player.get_player()
fWeaponRange = weapon.get_weapon_info(pSelfPed, "fWeaponRange") -- Returns the weapon range of the player.
weapon.set_weapon_info(pSelfPed, "fWeaponRange", fWeaponRange+10)
system.log_debug("The player's weapon has been set to have " .. tostring((fWeaponRange+10)) .. " weapon range.")

---

get_vehicle_weapon_info(vehicle, param)

Returns the value of the vehicle weapon for the specified weapon parameter.

Parameters:

• vehicle (Vehicle) – The vehicle ID.

• param (string) – The weapon parameter.

  • You can find a list of weapon parameters here: Weapon Info parameters.

Returns:

• float – The value for the specified weapon parameter.

Example:

vCurrentVehicle = player.get_vehicle()
fWeaponInfo = weapon.get_vehicle_weapon_info(vCurrentVehicle, "fWeaponRange") -- Returns the weapon range of the vehicle.
system.log_debug("The player's vehicle has " .. tostring(weaponInfo) .. " weapon range.")

---

set_vehicle_weapon_info(vehicle, param, value)

Sets the value of the vehicle weapon for the specified weapon parameter.

Parameters:

• vehicle (Vehicle) – The vehicle ID.

  • You can find a list of weapon parameters here: Weapon Info parameters.

• param (string) – The weapon parameter.

• value (float) – The value for the specified weapon parameter.

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
fWeaponInfo = weapon.get_vehicle_weapon_info(vCurrentVehicle, "fWeaponRange") -- Returns the weapon range of the vehicle.
weapon.set_vehicle_weapon_info(vCurrentVehicle, "fWeaponRange", fWeaponRange+10)
system.log_debug("The player's vehicle has been set to have " .. tostring((fWeaponRange+10)) .. " weapon range.")

---

get_ammo_info(ped, param)

Returns the value for the specified ammo parameter.

Parameters:

• ped (Ped) – The ped ID.

• param (string) – The ammo parameter.

  • You can find a list of ammo parameters here: Ammo info parameters.

Returns:

• float – The value for the specified ammo parameter.

Example:

pSelfPed = player.get_player()
fMissileSpeed = weapon.get_ammo_info(pSelfPed, "fMissileSpeed") -- Returns the missile speed
system.log_debug("The player's weapon has " .. tostring(fMissileSpeed) .. " missile speed.")

---

set_ammo_info(ped, param, value)

Sets the value for the specified ammo parameter.

Parameters:

• ped (Ped) – The ped ID.

• param (string) – The ammo parameter.

  • You can find a list of ammo parameters here: Ammo info parameters.

• value (float) – The value for the specified ammo parameter.

Returns:

• None

Example:

pSelfPed = player.get_player()
fMissileSpeed = weapon.get_ammo_info(pSelfPed, "fMissileSpeed") -- Returns the missile speed
weapon.set_ammo_info(pSelfPed, "fMissileSpeed", fMissileSpeed+10)
system.log_debug("The player's weapon has been set to have " .. tostring((fMissileSpeed+10)) .. " missile speed.")

---

get_weapon_info_parameters()

Returns a list of weapon parameters.

Parameters:

• None

Returns:

• vector<string> – A list of weapon parameters.

Example:

vstrWeaponParams = weapon.get_weapon_info_parameters()
for i,v in pairs(vstrWeaponParams) do
             system.log_debug(tostring(i) .. " " .. tostring(v))
end

---

get_ammo_info_parameters()

Returns a list of ammo parameters.

Parameters:

• None

Returns:

• vector<string> – A list of ammo parameters.

Example:

vstrAmmoParams = weapon.get_ammo_info_parameters()
for i,v in pairs(vstrAmmoParams) do
   system.log_debug(tostring(i) .. " " .. tostring(v))
end

Text namespace

This namespace contains functions related to text manipulation.

---

contains(source, data)

Checks whether a string contains character/word.

Parameters:

• source (string) – The string to check.

• data (string) – The data to check for.

Returns:

• bool

  • true – The string contains the data.

  • false – The string does not contain the data.

Example:

sloremIpsum = "Lorem ipsum dolor sit amet"
bContains = text.contains(sloremIpsum, "Lorem")
if bContains then
   system.log_debug("The string contains the word \"Lorem\".")
else
   system.log_debug("The string does not contain the word \"Lorem\".")
end

---

is_float(data)

Checks whether a string is float type.

Parameters:

• data (string) – The data to check.

Returns:

• bool

  • true – The data is a float.

  • false – The data is not a float.

Example:

bIsFloat = text.is_float("10.1")
if bIsFloat then
   system.log_debug("The string is a float.")
else
   system.log_debug("The string is not a float.")
end

---

is_number(data)

Checks whether a string is a number.

Parameters:

• data (string) – The data to check.

Returns:

• bool

  • true – The data is a number.

  • false – The data is not a number.

Example:

bIsNumber = text.is_number("10")
if bIsNumber then
   system.log_debug("The string is a number.")
else
   system.log_debug("The string is not a number.")
end

---

is_valid_ip4(data)

Checks whether the string is a valid IPv4 address.

Parameters:

• data (string) – The data to check.

Returns:

• bool

  • true – The data is a valid IPv4 address.

  • false – The data is not a valid IPv4 address.

Example:

isValid = text.is_valid_ip4("1.1.1.1")
if isValid then
   system.log_debug("The string is a valid IPv4 address.")
else
   system.log_debug("The string is not a valid IPv4 address.")
end

---

get_random_string(length, type)

Generates a random string.

Parameters:

• length (int) – Length of the string.

• type (eRandomType) – Type of string generation:

  • 0 – Upper

  • 1 – Lower

  • 2 – Digits

  • 3 – UpperLower

  • 4 – UpperDigits

  • 5 – LowerDigits

Returns:

• string – The generated random string.

Example:

sRandom = text.get_random_string(10, 2) -- Generates a random string made of digits
system.log_debug(sRandom)

---

remove_characters(data, word)

Removes certain characters from string.

Parameters:

• data (string) – The data to check.

• word (string) – Word/Character to remove.

Returns:

• string – The output string.

Example:

sCutCharacters = remove_characters("Road", "o")
system.log_debug(sCutCharacters)

---

replace_characters(data, first, second)

Replaces certain characters from string.

Parameters:

• data (string) – The data to check.

• first (string) – Word/Character to replace

• second (string) – Replacement word/character

Returns:

• string – The new, replaced string

Example:

sReplacedCharacters = replace_characters("John", "hn", "e")
system.log_debug(sReplacedCharacters)

---

resize_string_center(data, length)

Cuts string from center.

Parameters:

• data (string) – The data to check.

• length (int) – Length of the end string.

Returns:

• string – The new string.

Example:

sResizedCenter = resize_string_center("Hello World", 5)
system.log_debug(sResizedCenter)

Output:

He...ld

---

resize_string_left(data, length)

Cuts string from the left

Parameters:

• data (string) – The data to check.

• length (int) – Length of the end string.

Returns:

• string – The new string.

Example:

sResizedLeft = resize_string_left("Hello World", 5)
system.log_debug(sResizedLeft)

Output:

...World

---

resize_string_right(data, length)

Cuts string from the right.

Parameters:

• data (string) – The data to check.

• length (int) – Length of the end string.

Returns:

• string – The new string.

Example:

sResizedRight = resize_string_right("Hello World", 5)
system.log_debug(sResizedRight)

Output:

Hello...

---

get_clipboard_text()

Copies the text from the clipboard

Parameters:

• None

Returns:

• string – The text from the clipboard.

Example:

sClipboardText = get_clipboard_text()
system.log_debug(sClipboardText)

---

FS namespace

This namespace contains functions that let you interact with the file system.

---

dir_exist(dir)

Checks whether the directory exists.

Parameters:

• dir (string) – Directory to check

Returns:

• bool

  • True – directory exists

  • False – directory does not exist

Example:

if fs.dir_exist("C:\Users\") then
   system.log_info("Directory exists.")
end

---

file_exist(file)

Checks whether the file exists.

Parameters:

• file (string) – File to check

Returns:

• bool

  • True – file exists

  • False – file does not exist

Example:

if not fs.file_exist("D:\NewFolder\BetterCallSaulS05E06.mp4") then
   system.log_info("Better not to call Saul.")
end

---

file_remove(file)

Removes a file.

Parameters:

• file (string) – File to remove

Returns:

• bool

  • True – The file was removed

  • False – The file was not removed (e.g. file was not found)

Example:

success = fs.file_remove("test.txt") -- Removes the file.
if success then
   system.log_info("File removed.") -- Prints a message if the file was removed.
end

---

file_validate(file)

Checks whether the file is corrupted, Checks whether the permissions are correct, if it’s readable and if it’s writable.

Parameters:

• file (string) – File to validate

Returns:

• bool

  • True – The file is valid

  • False – The file is invalid (e.g. file was not found)

Example:

if fs.file_validate("test.txt") then
   system.log_info("File is valid and ready.")
end

---

is_file_empty(file)

Checks whether the file is empty.

Parameters:

• file (string) – File to check

Returns:

• bool

  • True – The file is empty

  • False – The file is not empty

Example:

if fs.is_file_empty("test.txt") then
   system.log_info("The file is empty.")
else
   system.log_info("The file is not empty.")
end

---

dir_check(dir)

Checks whether the directory exists, and if not, creates it.

Parameters:

• dir (string) – Directory to check

Returns:

• None

Example:

fs.dir_check("D:\NewFolder") -- Creates the directory if it doesn't exist.

---

dir_create(dir)

Creates a directory.

Parameters:

• dir (string) – Directory to create

Returns:

• None

Example

fs.dir_create("D:\NewFolder") -- Creates a directory.

---

file_copy(source, dest)

Copies a file.

Parameters:

• source (string) – Path to source file

• dest (string) – Path to destination file

Returns:

• None

Example

fs.file_copy("source.txt", "dest.txt")
-- or
fs.file_copy("files/source.txt", "files/dest.txt")

---

get_dis2rbed_dir()

Returns the filepath for the DIS2RBED home directory.

Parameters:

• None

Returns:

• string – The filepath for the DIS2RBED home directory

Example:

sDirectoryPath = fs.get_dis2rbed_dir()
system.log_debug(sDirectoryPath)

---

get_fonts_dir()

Returns the filepath for the DIS2RBED fonts directory.

Parameters:

• None

Returns:

• string – The filepath for the DIS2RBED fonts directory

Example:

sDirectoryPath = fs.get_fonts_dir()
system.log_debug(sDirectoryPath)

---

get_themes_dir()

Returns the filepath for the DIS2RBED themes directory.

Parameters:

• None

Returns:

• string – The filepath for the DIS2RBED themes directory

Example:

sDirectoryPath = fs.get_themes_dir()
system.log_debug(sDirectoryPath)

---

get_locales_dir()

Returns the filepath for the DIS2RBED locales directory.

Parameters:

• None

Returns:

• string – The filepath for the DIS2RBED locales directory

Example:

sDirectoryPath = fs.get_locales_dir()
system.log_debug(sDirectoryPath)

---

get_lua_dir()

Returns the filepath for the DIS2RBED lua directory.

Parameters:

• None

Returns:

• string – The filepath for the DIS2RBED lua directory

Example:

sDirectoryPath = fs.get_lua_dir()
system.log_debug(sDirectoryPath)

---

get_gta_dir()

Returns the filepath for the GTA directory.

Parameters:

• None

Returns:

• string – The filepath for the GTA directory

Example:

sDirectoryPath = fs.get_gta_dir()
system.log_debug(sDirectoryPath)

---

Scripting functions

Scripting functions are functions that let you interact with DIS2RBED’s built-in options

---

Functions that are not included in any namespace

get_vehicle_bypass()

Checks whether the bypass for spawning Online cars in SinglePlayer is enabled.

Parameters:

• None

Returns:

• bool

  • True – The bypass is enabled

  • False – The bypass is disabled

Example:

if get_vehicle_bypass() then
   system.log_info("The bypass is enabled.")
end

---

set_vehicle_bypass(toggle)

Sets whether the bypass for spawning Online cars in SinglePlayer is enabled.

Parameters:

• toggle (bool) – Toggle the bypass

  • True – Enable the bypass

  • False – Disable the bypass

Returns:

• None

Example:

if not scripting.get_vehicle_bypass() then
   scripting.set_vehicle_bypass(true) -- Enables the bypass.
   system.log_info("The bypass is enabled.")
end

---

get_coords_infront_of_coords(position, rotation, distance)

Returns the coordinates in front of the specified coordinates.

Parameters:

• position (Vector3) – Specified coordinates

• rotation (Vector3) – Rotation to use

• distance (float) – Distance to the object

Returns:

• Vector3 – Coordinates in front of the object

Example:

v3CurrentCoords = player.get_coords()
v3CoordsInfrontOfCoords = scripting.get_coords_infront_of_coords(v3CurrentCoords, rage.entity.get_entity_rotation(player.get_ped(), 1), 10)
system.log_debug(tostring(v3CoordsInfrontOfCoords.x) .. ", " .. tostring(v3CoordsInfrontOfCoords.y) .. ", " .. tostring(v3CoordsInfrontOfCoords.z))

---

get_coords_above_of_coords(position, distance)

Returns the coordinates above of the specified coordinates.

Parameters:

• position (Vector3) – Specified coordinates

• distance (float) – Distance from the coordinates

Returns:

• Vector3 – Coordinates above of the object

Example:

v3CurrentCoords = player.get_coords()
v3CoordsAboveCoords = get_coords_above_of_coords(v3CurrentCoords, 10)
system.log_debug(tostring(v3CoordsAboveCoords.x) .. ", " .. tostring(v3CoordsAboveCoords.y) .. ", " .. tostring(v3CoordsAboveCoords.z))

---

get_blip_coords(sprite, color)

Returns the coordinates of the specified Blip.

Parameters:

• sprite (int) – Sprite of the blip

• color (int) – Color of the blip

Returns:

• Vector3 – Coordinates of the blip

Example:

v3BlipCoords = scripting.get_blip_coords(8, -1) -- waypoint blip
system.log_debug(tostring(v3BlipCoords.x) .. ", " .. tostring(v3BlipCoords.y) .. ", " .. tostring(v3BlipCoords.z))

---

get_ground_z(coords)

Returns the ground Z coordinate (height) of the specified coordinates.

Parameters:

• coords (Vector3) – Coordinates to check

Returns:

• float – Ground Z coordinate

Example:

v3CurrentCoords = player.get_coords()
fGroundZ = scripting.get_ground_z(v3CurrentCoords)
system.log_debug(tostring(fGroundZ))

---

get_entity_bounding_coords(entity)

Returns the bounding coordinates of the specified entity.

Parameters:

• entity (Entity) – Entity to check

Returns:

• ModelBoundingBox – Bounding coordinates

Example:

pSelfPed = player.get_ped()
mbbBoundingCoords = scripting.get_entity_bounding_coords(pSelfPed)
render.draw_box("MyHash", true, mbbBoundingCoords, { 255, 255, 255, 255 }, 1.0)

---

get_direction_from_rotation(rotation)

Returns the direction from the specified rotation.

Parameters:

• rotation (Vector3) – Rotation to use

Returns:

• Vector3 – Direction from the rotation

Example:

pSelfPed = player.get_ped()
v3Rotation = rage.entity.get_entity_rotation(pSelfPed, 2)
v3Direction = scripting.get_direction_from_rotation(v3Rotation)
system.log_debug(tostring(v3Direction.x) .. ", " .. tostring(v3Direction.y) .. ", " .. tostring(v3Direction.z))

---

Player namespace

This namespace contains functions that are related to player and are used to execute built-in menu features

---

get_mp_gender()

Returns the player’s character’s gender.

Parameters:

• None

Returns:

• int – Gender ID

  • 0 - Any non-gender game model

  • 1 - Male (mp_male)

  • 2 - Female (mp_female)

Example:

iSelfGenderID = player.get_mp_gender()
system.log_debug("Gender ID: " .. tostring(iSelfGenderID))

set_clean()

Cleans the character.

Parameters:

• None

Returns:

• None

Example:

scripting.player.set_clean()
system.log_debug("Character cleaned.")

---

set_force_field(toggle, type = 0)

Toggles and configures the force field.

Parameters:

• toggle (bool) – Toggle

  • true to enable the force field

  • false to disable it

• type (int) – Type of the force field

  • 0 for Normal (Default)

  • 1 for Lethal

Returns:

• None

Example:

scripting.player.set_force_field(true, 1)
system.log_debug("Lethal force field enabled.")

---

set_god_mode(toggle)

Toggles god mode.

Parameters:

• toggle (bool) – Toggle

  • true to enable god mode

  • false to disable it

Returns:

• None

Example:

scripting.player.set_god_mode(true)
system.log_debug("God mode enabled.")

---

set_infinite_stamina(toggle)

Toggles infinite stamina.

Parameters:

• toggle (bool) – Toggle

  • true to enable infinite stamina

  • false to disable it

Returns:

• None

Example:

scripting.player.set_infinite_stamina(true)
system.log_debug("Infinite stamina enabled.")

---

set_invisibility(toggle)

Toggles invisibility.

Parameters:

• toggle (bool) – Toggle

  • true to enable invisibility

  • false to disable it

Returns:

• None

Example:

scripting.player.set_invisibility(true)
system.log_debug("Invisibility enabled.")

---

set_mobile_radio(toggle)

Toggles mobile radio.

Parameters:

• toggle (bool) – Toggle

  • true to enable mobile radio

  • false to disable it

Returns:

• None

Example:

scripting.player.set_mobile_radio(true)
system.log_debug("Mobile radio enabled.")

---

set_night_vision(toggle)

Toggles night vision.

Parameters:

• toggle (bool) – Toggle

  • true to enable night vision

  • false to disable it

Returns:

• None

Example:

scripting.player.set_night_vision(true)
system.log_debug("Night vision enabled.")

---

set_no_wanted_level()

Sets the wanted level to 0.

Parameters:

• None

Returns:

• None

Example:

scripting.player.set_no_wanted_level()
system.log_debug("Wanted level set to 0.")

---

set_noclip(toggle, speed)

Toggles noclip.

Parameters:

• toggle (bool) – Toggle

  • true to enable noclip

  • false to disable it

• speed (float) – Speed of the noclip

Returns:

• None

Example:

scripting.player.set_noclip(true, 1.0)
system.log_debug("Noclip enabled.")

---

set_ragdoll(toggle)

Toggles ragdoll.

Parameters:

• toggle (bool) – Toggle

  • true to enable ragdoll

  • false to disable it

Returns:

• None

Example:

scripting.player.set_ragdoll(true)
system.log_debug("Ragdoll enabled.")

---

set_regeneration(value)

Sets the regeneration value.

Parameters:

• value (float) – The regeneration value

Returns:

• None

Example:

scripting.player.set_regeneration(0.5)
system.log_debug("Regeneration set to 0.5.")

---

set_run_speed(toggle, value)

Toggles and configures the walk & run speed.

Parameters:

• toggle (bool) – Toggle

  • true to enable speed hack

  • false to disable it

• value (float) – Speed

Returns:

• None

Example:

scripting.player.set_run_speed(true, 1.0)
system.log_debug("Run speed enabled.")

---

set_seatbelt(toggle)

Toggles seatbelt.

Parameters:

• toggle (bool) – Toggle

  • true to enable seatbelt

  • false to disable it

Returns:

• None

Example:

scripting.player.set_seatbelt(true)
system.log_debug("Seatbelt enabled.")

set_super_run(value)

Toggles and configures super run mode.

Parameters:

• value (float) – Speed

Returns:

• None

Example:

scripting.player.set_super_run(4.0)
system.log_debug("Super run enabled.")

---

set_swim_speed(toggle, value)

Toggles and configures the swim speed.

Parameters:

• toggle (bool) – Toggle

  • true to enable swim hack

  • false to disable it

• value (float) – Speed

Returns:

• None

Example:

scripting.player.set_swim_speed(true, 4.0)
system.log_debug("Swim speed enabled.")

---

set_thermal_vision(toggle)

Toggles thermal vision.

Parameters:

• toggle (bool) – Toggle

  • true to enable thermal vision

  • false to disable it

Returns:

• None

Example:

scripting.player.set_thermal_vision(true)
system.log_debug("Thermal vision enabled.")

---

set_walk_on_air(toggle)

Toggles walk on air.

Parameters:

• toggle (bool) – Toggle

  • true to enable walk on air

  • false to disable it

---

set_wanted_level(value)

Sets the wanted level.

Parameters:

• value (int) – The wanted level

Returns:

• None

Example:

scripting.player.set_wanted_level(5)
system.log_debug("Wanted level set to 5.")

---

Ped namespace

This namespace contains functions that are related to ped and are used to execute built-in menu features

---

clone_companion(owner, target, weaponHash)

Clones the target ped and sets it as a companion of the owner.

Parameters:

• owner (Entity) – The owner of the clone

• target (Entity) – The target to clone

• weaponHash (Hash) – The weapon hash to clone with

Returns:

• None

Example:

pSelfPed = player.get_ped()
scripting.ped.clone_companion(pSelfPed, pSelfPed, rage.gameplay.get_hash_key("weapon_pistol"))
system.log_debug("Cloned player.")

---

kill_enemies()

Kills all enemies.

Parameters:

• None

Returns:

• None

Example:

scripting.ped.kill_enemies()
system.log_debug("Killed all enemies.")

---

kill_nearby_peds()

Kills all nearby peds.

Parameters:

• None

Returns:

• None

Example:

scripting.ped.kill_nearby_peds()
system.log_debug("Killed all nearby peds.")

---

get_nearby_peds()

Returns the array of the nearby peds’ IDs

Parameters:

• None

Returns:

• vector<Ped> – The array of the nearby peds’ IDs

Example:

vectPeds = scripting.ped.get_nearby_peds()
for i, ped in ipairs(vectPeds) do
   system.log_debug("Ped " .. i .. ": " .. ped)
end

---

Entity namespace

This namespace contains functions that are related to Entities and are used to execute built-in menu features

---

is_entity_in_whitelist(entity)

Note

This function is still in development.

Checks whether the entity is in the whitelist.

Parameters:

• entity (Entity) – The entity to check

Returns:

• bool

  • true – The entity is in the whitelist

  • false – The entity is not in the whitelist

Example:

pSelfPed = player.get_ped()
bIsInWhitelist = scripting.entity.is_entity_in_whitelist(pSelfPed)
system.log_debug("Entity is in whitelist: " .. tostring(bIsInWhitelist))

---

entity_add_to_whitelist(entity)

Note

This function is still in development.

Adds the entity to the whitelist.

Parameters:

• entity (Entity) – The entity to add

Returns:

• None

Example:

pSelfPed = player.get_ped()
scripting.entity.entity_add_to_whitelist(pSelfPed)
system.log_debug("Entity added to whitelist.")

---

entity_remove_from_whitelist(entity)

Note

This function is still in development.

Removes the entity from the whitelist.

Parameters:

• entity (Entity) – The entity to remove

Returns:

• None

Example:

pSelfPed = player.get_ped()
scripting.entity.entity_remove_from_whitelist(pSelfPed)
system.log_debug("Entity removed from whitelist.")

---

set_proofs(entity, bulletProof, fireProof, explosionProof, collisionProof, meleeProof, drownProof)

Sets resistance to certain damage.

Parameters:

• entity (Entity) – The entity to set resistance to

• bulletProof (bool) – Bullet resistance

• fireProof (bool) – Fire resistance

• explosionProof (bool) – Explosion resistance

• collisionProof (bool) – Collision resistance

• meleeProof (bool) – Melee resistance

• drownProof (bool) – Drown resistance

Returns:

• None

Example:

pSelfPed = player.get_ped()
scripting.entity.set_proofs(pSelfPed, true, true, true, true, true, true)
system.log_debug("Nanomachines, son.")

---

get_nearby_entities()

Returns the array of the nearby entities’ IDs

Parameters:

• None

Returns:

• vector<Entity> – The array of the nearby entities’ IDs

Example:

vectEntities = scripting.entity.get_nearby_entities()
for i, entity in ipairs(vectEntities) do
   system.log_debug("Entity " .. i .. ": " .. entity)
end

---

Vehicle namespace

This namespace contains functions that are related to vehicle mods and are used to execute built-in menu features

---

get_name_from_hash(hash)

Returns the name of the vehicle based on its hash.

Parameters:

• hash (Hash) – The hash of the vehicle

Returns:

• string – The name of the vehicle

Example:

uBMXHash = rage.gameplay.get_hash_key("BMX")
sVehicleName = scripting.vehicle.get_name_from_hash(uBMXHash)
system.log_debug("Vehicle name: " .. sVehicleName)

---

get_personal_vehicle()

Returns the personal vehicle ID.

Parameters:

• None

Returns:

• Vehicle – The personal vehicle ID

Example:

vPersonalVehicle = scripting.vehicle.get_personal_vehicle()
system.log_debug("Personal vehicle: " .. tostring(vPersonalVehicle))

---

remove_nearby_vehicles()

Removes all nearby vehicles.

Parameters:

• None

Returns:

• None

Example:

scripting.vehicle.remove_nearby_vehicles()
system.log_debug("Removed all nearby vehicles.")

---

set_air_vehicles_collision(toggle)

Sets the air vehicles collision.

Parameters:

• toggle (bool) – Toggle

  • true – Enable the air vehicles collision

  • false – Disable the air vehicles collision

Returns:

• None

Example:

scripting.vehicle.set_air_vehicles_collision(true)
system.log_debug("Air vehicles collision is now enabled.")

---

set_boost(vehicle, speed)

Sets the boost speed of the specified vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle to set the boost speed of

• speed (float) – The boost speed

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
scripting.vehicle.set_boost(vCurrentVehicle, 50)
system.log_debug("Boost speed set to 50 units.")

---

set_bulletproof_tires(toggle)

Sets the bulletproof tires.

Parameters:

• toggle (bool) – Toggle

  • true – Enable the bulletproof tires

  • false – Disable the bulletproof tires

Returns:

• None

Example:

scripting.vehicle.set_bulletproof_tires(true)
system.log_debug("Bulletproof tires are now enabled.")

---

set_clean(vehicle)

Cleans the specified vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle to clean

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
scripting.vehicle.set_clean(vCurrentVehicle)
system.log_debug("Vehicle cleaned.")

---

set_doors_opened(vehicle, toggle, doorId)

Opens or closes the doors of the specified vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle to open or close the doors of

• toggle (bool) – Toggle

  • true – Open the doors

  • false – Close the doors

• doorId (int) – The door ID

  • For door IDs, see this: Doors Index

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
scripting.vehicle.set_doors_opened(vCurrentVehicle, true, 0)
system.log_debug("Door opened.")

---

set_drift(toggle)

Toggles the drift mode.

Parameters:

• toggle (bool) – Toggle

  • true – Enable the drift mode

  • false – Disable the drift mode

Returns:

• None

Example:

scripting.vehicle.set_drift(true)
system.log_debug("Drift mode is now enabled.")

---

set_drive_on_air(vehicle, toggle)

Toggles the Drive on Air mode.

Parameters:

• vehicle (Vehicle) – The vehicle to toggle the Drive on Air mode of

• toggle (bool) – Toggle

  • true – Enable the Drive on Air mode

  • false – Disable the Drive on Air mode

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
scripting.vehicle.set_drive_on_air(vCurrentVehicle, true)
system.log_debug("Drive on Air mode is now enabled.")

---

set_force_jump(toggle)

Toggles the vehicle force jump mode.

Parameters:

• toggle (bool) – Toggle

  • true – Enable the force jump mode

  • false – Disable the force jump mode

Returns:

• None

Example:

scripting.vehicle.set_force_jump(true)
system.log_debug("Force jump mode is now enabled.")

---

set_god_mode(toggle)

Toggles the god mode for the vehicle.

Parameters:

• toggle (bool) – Toggle

  • true – Enable the god mode

  • false – Disable the god mode

Returns:

• None

Example:

scripting.vehicle.set_god_mode(true)
system.log_debug("God mode is now enabled.")

---

set_headlight_color(color)

Sets the headlight color of the specified vehicle.

Parameters:

• color (int) – The headlight color ID

  • For color IDs, see this: things/headlightcolor

Returns:

• None

Example:

scripting.vehicle.set_headlight_color(1)
system.log_debug("Headlight color set to white.")

---

set_license_plate_madness(toggle)

Toggle license plate madness.

Parameters:

• toggle (bool) – Toggle

  • true – Toggle license plate madness on

  • false – Toggle license plate madness off

Returns:

• None

Example:

scripting.vehicle.set_license_plate_madness(true)

---

set_license_plate_scrolling(toggle)

Toggle license plate scrolling.

Parameters:

• toggle (bool) – Toggle

  • true – Toggle license plate scrolling on

  • false – Toggle license plate scrolling off

Returns:

• None

Example:

scripting.vehicle.set_license_plate_scrolling(true)

---

set_license_plate_speedo(toggle)

Toggle license plate speedo mode.

Parameters:

• toggle (bool)

  • true – Toggle license plate speedo on

  • false – Toggle license plate speedo off

Returns:

• None

Example:

scripting.vehicle.set_license_plate_speedo(true)

---

set_rainbow_car(type)

Toggle rainbow car mode.

Parameters:

• type (eRainbowCarType) – Car type

  • 0 – Personal car

  • 1 – All cars

Returns:

• None

Example:

scripting.vehicle.set_rainbow_car(1) -- Sets all cars rainbow

---

set_rainbow_headlights()

Toggle rainbow headlights feature.

Parameters:

• None

Returns:

• None

Example:

scripting.vehicle.set_rainbow_headlights()

---

set_rainbow_neon()

Toggle rainbow neon feature.

Parameters:

• None

Returns:

• None

Example:

scripting.vehicle.set_rainbow_neon()

---

set_rainbow_tires_smoke()

Toggle rainbow tires smoke.

Parameters:

• None

Returns:

• None

Example:

scripting.vehicle.set_rainbow_tires_smoke()

---

set_repair()

Repairs vehicle.

Parameters:

• None

Returns:

• None

Example:

scripting.vehicle.set_repair()

---

set_stick_to_ground()

Make a vehicle stick to the ground.

Parameters:

• None

Returns:

• None

Example:

scripting.vehicle.set_stick_to_ground()

---

set_stop(vehicle)

Make a vehicle stop.

Parameters:

• vehicle (Vehicle) – Vehicle hash

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()

scripting.vehicle.set_stop(vCurrentVehicle)

---

set_vehicle_clean_upgrade(vehicle)

Make a vehicle be max upgraded (only non-visible parts eg. engine, turbo…)

Parameters:

• vehicle (Vehicle) – Vehicle hash

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()

scripting.vehicle.set_vehicle_clean_upgrade(vCurrentVehicle)

---

set_vehicle_color(v, primary, secondary, pearl, wheel)

Set vehicle color (primary, secondary, pearlescence, wheels)

Parameters:

• v (Vehicle) – Vehicle hash

• primary (int) – Primary color ID

• secondary (int) – Secondary color ID

• pearl (int) – Pearlescence color ID (if applicable)

• wheel (int) – Wheel color ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()

scripting.vehicle.set_vehicle_color(vCurrentVehicle, 12, 28, 12)

---

set_vehicle_max_upgrade(vehicle)

Make a vehicle be max upgraded.

Parameters:

• vehicle (Vehicle) – Vehicle hash

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()

scripting.vehicle.set_vehicle_max_upgrade(vCurrentVehicle)

---

set_waterproof(vehicle, toggle)

Set a vehicle waterproof.

Parameters:

• vehicle (Vehicle) – Vehicle hash

• toggle (bool) – Toggle waterproof on/off

  • true – Vehicle is waterproof

  • false – Vehicle is not waterproof

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()

scripting.vehicle.set_waterproof(vCurrentVehicle, true) -- Your vehicle can now swim

---

set_windows_opened(vehicle, toggle, windowId)

Set windows opened on a vehicle.

Parameters:

• vehicle (Vehicle) – Vehicle hash

• toggle (bool) – Toggle windows open/closed

  • true – Windows open

  • false – Windows closed

• windowId (int) – Window ID to manipulate

  • For window IDs, see this: Windows Index

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()

scripting.vehicle.set_windows_opened(vCurrentVehicle, true, 1)

---

get_nearby_vehicles()

Returns the array of the nearby vehicles’ IDs

Parameters:

• None

Returns:

• vector<Vehicle> – Array of nearby vehicles’ IDs

Example:

vectVehicles = scripting.vehicle.get_nearby_vehicles()
for i, veh in ipairs(vectVehicles) do
   system.log_debug("Vehicle " .. i .. ": " .. veh)
end

---

Online namespace

This namespace contains functions that are related to online features and are used to execute built-in menu features

---

reset_idle_kick_timer()

Resets the AFK kick timer.

Parameters:

• None

Returns:

• None

Example:

scripting.online.reset_idle_kick_timer()
system.log_debug("Reset AFK kick timer.")

---

set_off_radar(toggle)

Toggle the off radar feature.

Parameters:

• toggle (bool) – Toggle the off radar feature

  • true – Enable the off radar feature

  • false – Disable the off radar feature

Returns:

• None

Example:

scripting.online.set_off_radar(true)
system.log_debug("Off radar enabled.")

---

set_passive_mode(toggle)

Toggle the passive mode.

Parameters:

• toggle (bool) – Toggle the passive mode

  • true – Enable the passive mode

  • false – Disable the passive mode

Returns:

• None

Example:

scripting.online.set_passive_mode(true)
system.log_debug("Passive mode enabled.")

---

set_securoserv_bypass()

Activates the securoserv bypass.

Parameters:

• None

Returns:

• None

Example:

scripting.online.set_securoserv_bypass()
system.log_debug("Securoserv bypass activated.")

---

set_skip_cutscene()

Activates the skip cutscene feature.

Parameters:

• None

Returns:

• None

Example:

scripting.online.set_skip_cutscene()
system.log_debug("Skip cutscene activated.")

---

set_spectating_mode(toggle, player)

Toggle and configure the spectating mode.

Parameters:

• toggle (bool) – Toggle the spectating mode

  • true – Enable the spectating mode

  • false – Disable the spectating mode

• player (Player) – The player to spectate

Returns:

• None

Example:

plHostPlayer = lobby.get_host()
scripting.online.set_spectating_mode(true, plHostPlayer)
system.log_debug("Spectating mode enabled.")

---

suicide()

Kills the player.

Parameters:

• None

Returns:

• None

Example:

scripting.online.suicide()
system.log_debug("RIP, " .. rage.player.get_player_name(rage.player.player_id()))

---

teleport_in_player_vehicle(player)

Teleports the player into specified player’s vehicle.

Parameters:

• player (Player) – The player to teleport to

Returns:

• None

Example:

plHostPlayer = lobby.get_host()
scripting.online.teleport_in_player_vehicle(plHostPlayer)
system.log_debug("Teleported into host's vehicle.")

---

teleport_to_player(player)

Teleports the player to specified player.

Parameters:

• player (Player) – The player to teleport to

Returns:

• None

Example:

plHostPlayer = lobby.get_host()
scripting.online.teleport_to_player(plHostPlayer)
system.log_debug("Teleported to host.")

---

toggle_protex(toggle)

Toggle the online protections.

Parameters:

• toggle (bool) – Toggle the online protections

  • true – Enable the online protections

  • false – Disable the online protections

Returns:

• None

Example:

scripting.online.toggle_protex(true)
system.log_debug("Online protections enabled.")

---

Network namespace

This namespace contains functions that are related to session creation and are used to execute built-in menu features.

---

session_choose_character()

Sends the player to the character selection screen.

Parameters:

• None

Returns:

• None

Example:

scripting.network.session_choose_character()
system.log_debug("Sent to character selection screen.")

---

session_leave_online()

Sends the player to the singleplayer mode.

Parameters:

• None

Returns:

• None

Example:

scripting.network.session_leave_online()
system.log_debug("Sent to singleplayer mode.")

---

session_manager(id)

Sends the player to the specified session.

Parameters:

• id (eSessionType) – The session to send the player to

  • Read more about eSessionType here – eSessionType

Returns:

• None

Example:

scripting.network.session_manager(0)
system.log_debug("Sent to the open public session.")

---

Spawn namespace

This namespace contains functions that are related to spawn and are used to execute built-in menu features.

---

spawn_vehicle(hash, position, heading)

Spawns a vehicle in a given position and heading.

Parameters:

• hash (Hash) – Vehicle hash

• position (Vector3) – Vehicle coordinates

• heading (float) – Vehicle heading

Returns:

• Vehicle – The spawned vehicle handle.

Example:

uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")
v3CurrentCoords = player.get_coords()

scripting.spawn.spawn_vehicle(uZentornoHash, v3CurrentCoords, 1)

---

spawn_vehicle_personal(hash)

Spawns a personal vehicle.

Parameters:

• hash (Hash) – Vehicle hash

Returns:

• Vehicle – The spawned vehicle handle.

Example:

uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")
scripting.spawn.spawn_vehicle_personal(uZentornoHash)

---

Weapon namespace

This namespace contains functions that are related to weapons and are used to execute built-in menu features.

---

give_all_weapons(ped, maxAmmo = true, maxComponents = true)

Give all weapons to a ped with toggable max ammo and max components.

Parameters:

• ped (Ped) – The ped to give all weapons to.

• maxAmmo (bool) – Toggle Max Ammo

  • true – Weapons will be given with max ammo (default)

  • false – Weapons will be given without max ammo

• maxComponents – Toggles Max Components

  • true – Weapons will be given fully upgraded in components (default)

  • false – Weapons will be given in their default form

Returns:

• None

Example:

pSelfPed = player.get_ped()

scripting.weapon.give_all_weapons(pSelfPed, true, true) -- Gives all maxed and upgraded weapons.

---

remove_all_weapons_from_ped(ped)

Removes all weapons from a ped.

Parameters:

• ped (Ped) – The ped to remove all weapons from.

Returns:

• None

Example:

pSelfPed = player.get_ped()

scripting.weapon.remove_all_weapons_from_ped(pSelfPed) -- Removes all weapons

---

give_weapon_self(weaponHash)

Gives weapon to the player (self).

Parameters:

• weaponHash (Hash) – Weapon Whash to give to self.

Returns:

• None

Example:

uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")

scripting.weapon.give_weapon_self(uWeaponHash) -- Gives self the MicroSMG

---

give_weapon(ped, weaponHash, maxAmmo = true, maxComponents = true)

Gives a weapon to ped with toggable max ammo and max components.

Parameters:

• ped (Ped) – The ped to give the weapon to.

• weaponHash (Hash) – Weapon Whash to give to the player.

• maxAmmo (bool) – Toggles Max Ammo

  • true – Weapon will be given with max ammo (default)

  • false – Weapon will be given without max ammo

• maxComponents – Toggles Max Components

  • true – Weapon will be given fully upgraded in components (default)

  • false – Weapon will be given in its default form

Returns:

• None

Example:

uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")

pSelfPed = player.get_ped()

scripting.weapon.give_weapon(pSelfPed, uWeaponHash, true, true) -- Gives session host a fully loaded and upgraded MicroSMG

---

give_ammo(ped)

Gives ammo to a ped.

Parameters:

• ped (Ped) – The ped to ammo to.

Returns:

• None

Example:

pSelfPed = player.get_ped()

scripting.weapon.give_ammo(pSelfPed) -- Gives ammo to all your weapons

---

give_ammo_for_weapon(ped, weaponHash)

Gives ammo for a precise weapon to a ped.

Parameters:

• ped (Ped) – The targeted ped.

• weaponHash (Hash) – Ped’s weapon Whash to give ammo to.

Returns:

• None

Example:

pSelfPed = player.get_ped()

uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")

scripting.weapon.give_ammo_for_weapon(pSelfPed, uWeaponHash) -- Gives ammo to your MicroSMG

---

ammo_infinite(ped)

Gives infinite ammo to a ped.

Parameters:

• ped (Ped) – The targeted ped.

Returns:

• None

Example:

pSelfPed = player.get_ped()
scripting.weapon.ammo_infinite(pSelfPed) -- Gives infinite ammo

---

ammo_enhanced(ped, explosionId)

Gives enhanced ammo (ammo that generates a particular explosion) to a ped.

Parameters:

• ped (Ped) – The targeted ped.

• explosionId (int) – The explosion ID determinates the type of explosion to assign to the ammo.

  • You can read more about explosion IDs here: Explosion types

Returns:

• None

Example:

pSelfPed = player.get_ped()
scripting.weapon.ammo_enhanced(pSelfPed, 7) -- Sets EXPLOSION_CAR explosion type for ammo

---

ammo_mega_damage(ped)

Gives mega damage ammo to a ped.

Parameters:

• ped (Ped) – The targeted ped.

Returns:

• None

Example:

pSelfPed = player.get_ped()

scripting.weapon.ammo_mega_damage(pSelfPed) -- Gives mega damage ammo

---

Teleport namespace

This namespace contains functions that are related to teleport and are used to execute built-in menu features.

---

to_blip(sprite, color = -1)

Teleport to blip.

Parameters:

• sprite (int) – The blip sprite ID to use.

• color (int) – The blip color ID to use.

  • -1 to use the default color

Returns:

• bool

  • true – Teleportation successful

  • false – Teleportation failed

Example:

scripting.teleport.to_blip(1, 1) -- red circle blip

---

to_entity(ent)

Teleport to entity.

Parameters:

• ent (Entity) – Targeted entity to teleport to.

Returns:

• bool

  • true – Teleportation successful

  • false – Teleportation failed

Example:

scripting.teleport.to_entity("prop_storagetank_02b") -- Teleport to the nearest fuel storage tank entity.

---

to_player(player)

Teleport to player.

Parameters:

• player (Player) – Targeted player to teleport to.

Returns:

• bool

  • true – Teleportation successful

  • false – Teleportation failed

Example:

scripting.teleport.to_player(lobby.get_host()) -- Teleport to the host player.

---

to_position(coords)

Teleport to position (through coordinates).

Parameters:

• coords (Vector3) – Targeted coordinates (Vector3) to teleport to.

Returns:

• bool

  • true – Teleportation successful

  • false – Teleportation failed

Example:

scripting.teleport.to_position(lobby.get_player_coords(lobby.get_host())) -- Teleport to the host player's coordinates.

---

to_waypoint()

Teleport to waypoint.

Parameters:

• None

Returns:

• bool

  • true – Teleportation successful

  • false – Teleportation failed

Example:

scripting.teleport.to_waypoint()

---

to_objective()

Teleport to objective.

Parameters:

• None

Returns:

• bool

  • true – Teleportation successful

  • false – Teleportation failed

Example:

scripting.teleport.to_objective()

---

to_nearest_vehicle()

Teleport to the nearest vehicle.

Parameters:

• None

Returns:

• bool

  • true – Teleportation successful

  • false – Teleportation failed

Example:

scripting.teleport.to_nearest_vehicle()

---

to_personal_vehicle()

Teleport to personal vehicle.

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.to_personal_vehicle()

---

ipl_to_yankton()

Teleport to North Yankton (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_yankton()

---

ipl_to_cargo_ship()

Teleport to Cargo Ship (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_cargo_ship()

---

ipl_to_hospital()

Teleport to Hospital (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_hospital()

---

ipl_to_yacht_sp()

Teleport to SinglePlayer Yacht (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_yacht_sp()

---

ipl_to_yacht_online()

Teleport to Online Yacht (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_yacht_online()

---

ipl_to_morgue()

Teleport to Morgue (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_morgue()

---

ipl_to_ranch()

Teleport to Ranch (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_ranch()

---

ipl_to_jewelry()

Teleport to Jewelry (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_jewelry()

---

ipl_to_life_invader()

Teleport to Life Invader (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_life_invader()

---

ipl_to_fib()

Teleport to FIB building (IPL location).

Parameters:

• None

Returns:

• None

Example:

scripting.teleport.ipl_to_fib()

---

World namespace

This namespace contains functions that are related to world and are used to execute built-in menu features.

---

set_weather(weatherType)

Set weather type.

Parameters:

• weatherType (string) – The weather type

  • For weather types, see this: Weather Types

Returns:

• None

Example:

scripting.world.set_weather("RAIN") -- make it rain

---

set_clouds(cloudsType, transitionTime)

Set clouds type and their transition time.

Parameters:

• cloudsType (string) – The clouds type

  • For weather types, see this: Weather Types

• transitionTime (float) – The speed of clouds

Returns:

• None

Example:

scripting.world.set_clouds("RAIN")

---

set_rain_intensity(value)

Set the rain intensity.

Parameters:

• value (float) – Rain intensity value.

Returns:

• None

Example:

scripting.world.set_rain_intensity(5.5)

---

set_wind_speed(value)

Set the wind speed.

Parameters:

• value (float) – Wind speed value.

Returns:

• None

Example:

scripting.world.set_wind_speed(3)

---

set_waves_height(value)

Set the waves height.

Parameters:

• value (float) – Waves height value.

Returns:

• None

Example:

scripting.world.set_waves_height(4)

---

set_time(hours, minutes, seconds)

Set the in-game time.

Parameters:

• hours (int) – Hours

• minutes (int) – Minutes

• seconds (int) – Seconds

Returns:

• None

Example:

scripting.world.set_time(12, 30, 10) -- 12:30:10

---

blackout(toggle)

Toggle blackout on/off.

Parameters:

• toggle (bool) – Toggle

  • true – Toggle blackout on

  • false – Toggle blackout off

Returns:

• None

Example:

scripting.world.blackout(true) -- Blackout is on.

---

angry_ufo()

Activates Angry Ufo feature.

Parameters:

• None

Returns:

• None

Example:

scripting.world.angry_ufo()

---

disable_phone(toggle)

Disable phone option

Parameters:

• toggle (bool) – Toggle

  • true – Toggle disable phone on

  • false – Toggle disable phone off

Returns:

• None

Example:

scripting.world.disable_phone(true) -- Disable phone option toggled on, phone is disabled.

---

disable_recording()

Disable GTA built-in recording feature.

Parameters:

• None

Returns:

• None

Example:

scripting.world.disable_recording() -- Disable recording

---

disable_restricted_areas()

Disable GTA restricted areas.

Parameters:

• None

Returns:

• None

Example:

scripting.world.disable_restricted_areas()

---

disable_stunt_cameras()

Disable GTA built-in stunt cameras.

Parameters:

• None

Returns:

• None

Example:

scripting.world.disable_stunt_cameras()

---

RAGE Functions

This namespace contains native game functions. Use WIP New RAGE API for rage functions, as these are obsolete and only kept here just in case.

---

Player namespace

Functions here

This namespace contains player-related game functions.

---

get_player_group(player)

Returns the group ID the player is member of. Used for AI namespace.

Parameters:

• player (Player) – The player ID

Returns:

• int – Group ID

Example:

plHandle = rage.player.player_id()
iPlayerGroup = rage.player.get_player_group(plHandle)
system.log_debug("Player is member of group: " .. tostring(iPlayerGroup))

---

get_player_name(player)

Returns the player name.

Parameters:

• player (Player) – The player ID

Returns:

• string – Player name

Example:

plHandle = rage.player.player_id()
sPlayerName = rage.player.get_player_name(plHandle)
system.log_debug("Player name: " .. tostring(sPlayerName))

---

get_player_parachute_model_override(player)

Returns the hash of the parachute model.

Parameters:

• player (Player) – The player ID

Returns:

• Hash – Parachute model hash

Example:

plHandle = rage.player.player_id()
uPlayerParachuteModel = rage.player.get_player_parachute_model_override(plHandle)
system.log_debug("Player parachute model hash: " .. tostring(uPlayerParachuteModel))

---

get_player_ped_script_index(player)

Returns the Ped ID of the player’s character.

Parameters:

• player (Player) – The player ID

Returns:

• Ped – Ped ID

Example:

plHandle = rage.player.player_id()
pSelfPed = rage.player.get_player_ped_script_index(plHandle)
system.log_debug("Player ped: " .. tostring(pSelfPed))

---

get_player_team(player)

Returns the team ID the player is member of. Almost like get_player_team(player).

Note

Doesn’t work in singleplayer.

Parameters:

• player (Player) – The player ID

Returns:

• int – Team ID

Example:

plHandle = rage.player.player_id()
iPlayerTeam = rage.player.get_player_team(plHandle)
system.log_debug("Player is member of team: " .. tostring(iPlayerTeam))

---

get_player_wanted_level(player)

Returns the player’s wanted level.

Parameters:

• player (Player) – The player ID

Returns:

• int – Wanted level

Example:

plHandle = rage.player.player_id()
iPlayerWantedLevel = rage.player.get_player_wanted_level1(plHandle)
system.log_debug("Player wanted level: " .. tostring(iPlayerWantedLevel))

---

is_player_free_aiming(player)

Returns whether the player is aiming.

Parameters:

• player (Player) – The player ID

Returns:

• bool

  • true – the player is aiming

  • false – the player is not aiming

Example:

plHandle = rage.player.player_id()
if rage.player.is_player_free_aiming(plHandle) then
   system.log_debug("Player is aiming")
end

---

is_player_playing(player)

Returns whether the wasted/busted screen is visible or not.

Parameters:

• player (Player) – The player ID

Returns:

• bool

  • true – the wasted/busted screen is visible

  • false – the wasted/busted screen is not visible

Example:

plHandle = rage.player.player_id()
if rage.player.is_player_playing(plHandle) then
   system.log_debug("Player is playing")
end

---

is_player_pressing_horn(player)

Checks whether the player is pressing the horn.

Parameters:

• player (Player) – The player ID

Returns:

• bool

  • true – Player is pressing the horn

  • false – Player is not pressing the horn

Example:

plHandle = rage.player.player_id()<