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

  • Task 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 Task 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()
if rage.player.is_player_pressing_horn(plHandle) then
   system.log_debug("Player is pressing the horn")
end

---

player_id()

Returns the player ID.

Parameters:

• None

Returns:

• Player – Player ID

Example:

plHandle = rage.player.player_id()
system.log_debug("Player ID: " .. tostring(plHandle))

---

set_player_model(player, model)

Sets the model for a specific player.

Note

This will destroy the current Ped for the Player and create a new one.

Parameters:

• player (Player) – The player ID

• model (Hash) – The model hash

Returns:

• None

Example:

iPlayerId = player.get_id()
uModel = rage.gameplay.get_hash_key("s_f_y_hooker_02")

for i=1,50 do
   rage.streaming.request_model(uModel)
   system.wait()
end

if rage.streaming.has_model_loaded(uModel) then
   rage.player.set_player_model(iPlayerId, uModel)
   iPlayerPed = player.get_ped()
   rage.ped.set_ped_default_component_variation(iPlayerPed)
   system.wait()
   rage.streaming.set_model_as_no_longer_needed(uModel)
else
   system.log_warning("Cannot load model " .. tostring(uModel))
end

---

set_player_parachute_model_override(player, model)

Sets the parachute model for a player.

Parameters:

• player (Player) – The player ID

• model (Hash) – The model hash

Returns:

• None

Example:

plHandle = rage.player.player_id()
rage.player.set_player_parachute_model_override(plHandle, 73268708)

---

set_player_targeting_mode(targetMode)

Sets your targeting mode.

Parameters:

• targetMode (int) – Targeting mode

  • 0 = Assisted Aim – Full

  • 1 = Assisted Aim – Partial

  • 2 = Free Aim – Assisted

  • 3 = Free Aim

Returns:

• None

Example:

rage.player.set_player_targeting_mode(3)
system.log_debug("Targeting mode: Free Aim")

---

Ped namespace

This namespace contains ped-related game functions.

---

get_ped_config_flag(ped, flag, p2)

Returns whether the ped has the specified configuration flag set or not.

Parameters:

• ped (Ped) – The ped ID

• flag (int) – The flag to check

  • You can check ped config flags here: Ped configuration flags

• p2 (bool) – Unknown. Always 1.

Returns:

• bool

  • true – The ped has the flag set

  • false – The ped does not have the flag set

Example:

plHandle = rage.player.player_id()
pSelfPed = rage.player.get_player_ped(plHandle)
if rage.ped.get_ped_config_flag(pSelfPed, 32, 1) then
   system.log_debug("Ped can fly through the windscreen")
end

add_relationship_group(name, groupHash)

Adds a new ped relationship group.

Parameters:

• name (string) – The name of the relationship group

• groupHash (Hash) – The hash of the created relationship group is output in the second parameter.

Returns:

• Any – This function returns nothing.

Example:

iGroupHash = 0
rage.ped.add_relationship_group("COPS", iGroupHash)
system.log_debug("Group hash: " .. tostring(iGroupHash))

---

can_create_random_cops()

Checks whether a Ped can summon random cops.

Parameters:

• None

Returns:

• bool

  • true – Ped can summon random cops

  • false – Ped can’t summon random cops

Example:

bCanSummonCops = rage.ped.can_create_random_cops()
system.log_debug(tostring(bCanSummonCops))

---

can_ped_ragdoll(ped)

Check if ragdoll is enabled for this ped

Parameters:

• ped (Ped) – The ped ID

Returns:

• bool

  • true – Ped ragdoll on

  • false – Ped ragdoll off

Example:

pSelfPed = player.get_ped()
bCanPedRagdoll = rage.ped.can_ped_ragdoll(pSelfPed)

system.log_debug(tostring(bCanPedRagdoll))

---

clear_ped_prop(ped, propId)

Clears the specified prop from the ped.

Parameters:

• ped (Ped) – The ped ID

• propId (int) – The prop ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.clear_ped_prop(pSelfPed, 0) -- removes the hat

---

clear_all_ped_props(ped)

Clears all ped’s props.

Parameters:

• ped (Ped) – The ped ID

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.ped.clear_all_ped_props(pSelfPed)

---

clear_ped_blood_damage(ped)

Clears the blood on a ped.

Parameters:

• ped (Ped) – The ped ID

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.ped.clear_ped_blood_damage(pSelfPed)

---

clear_ped_tasks_immediately(ped)

Clears all ped’s tasks.

Parameters:

• ped (Ped) – The ped ID

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.ped.clear_ped_tasks_immediately(pSelfPed)

---

clear_relationship_between_groups(relationship, group1, group2)

Clears the relationship between two groups. This should be called twice (once for each group).

Parameters:

• relationship (int) – Relationship ID

  • Relationship types here: Relationship groups

• group1 (Hash) – Group 1 hash

• group2 (Hash) – Group 2 hash

Returns:

• None

Example:

uGroupHash1 = rage.gameplay.get_hash_key("GANG_1")
uGroupHash2 = rage.gameplay.get_hash_key("COP")

rage.ped.clear_relationship_between_groups((2, uGroupHash1, uGroupHash2))
rage.ped.clear_relationship_between_groups((2, uGroupHash2, uGroupHash1))

---

clone_ped(ped, isNetwork, bScriptHostPed, copyHeadBlendFlag)

Creates a copy of the passed ped, optionally setting it as local and/or shallow-copying the head blend data.

Parameters:

• ped (Ped) – The ped ID

• isNetwork (bool) – Whether or not the ped should be registered as a network object

• bScriptHostPed (bool) – Script host flag

• copyHeadBlendFlag (bool) – If true, head blend data is referenced, not copied

Returns:

• Ped – A new ped handle representing the ped’s copy

Example:

pSelfPed = player.get_ped()

rage.ped.clone_ped(pSelfPed, false, false, true)

---

create_group(unused)

Creates a new ped group. Note: groups can contain up to 8 peds.

Note

Groups can contain up to 8 peds.

Parameters:

• unused (int) – The parameter is unused

Returns:

• int – A handle to the created group, or 0 if a group couldn’t be created

Example:

rage.ped.create_group()

---

create_ped(pedType, modelHash, x, y, z, heading, isNetwork, bScriptHostPed)

Spawns a ped (biped character, pedestrian, actor) with the specified model at the specified position and heading. This ped will initially be owned by the creating script as a mission entity, and the model should be loaded already (e.g. using streaming.request_model).

Parameters:

• pedType (int) – Unused Peds get set to CIVMALE/CIVFEMALE/etc. no matter the value specified

• modelHash (Hash) – The model of ped to spawn

  • Ped Models

• x (float) – Spawn coordinate X component

• y (float) – Spawn coordinate Y component

• z (float) – Spawn coordinate Z component

• heading (float) – Heading to face towards, in degrees

• isNetwork (bool) – Whether to create a network object for the ped

  • true – A network object is created for the ped

  • false – The ped exists only locally

• bScriptHostPed (bool) – Whether to register the ped as pinned to the script host in the R* network model

Returns:

• Ped – A script handle for the ped

  • 0 – The ped spawn failed

Example:

v3CoordsInfront = player.get_coords_infront(20)
uPedModelHash = rage.gameplay.get_hash_key("csb_mp_agent14")
rage.ped.create_ped(uPedModelHash, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 90, true, true)

---

does_group_exist(groupId)

Checks whether a group exists.

Parameters:

• groupId (int) – The group ID

Returns:

• bool – Group status

  • true – Group exists

  • false – Group does not exist

Example:

pSelfPed = player.get_ped()

rage.ped.can_ped_ragdoll(pSelfPed)

---

does_relationship_group_exist(groupHash)

Checks whether a relationship group exists.

Parameters:

• groupHash (Hash) – The group hash

Returns:

• bool – Group status

  • true – Group exists

  • false – Group does not exist

Example:

bDoesRelGroupExist = rage.ped.does_relationship_group_exist(rage.gameplay.get_hash_key("PLAYER") -- true
bDoesRelGroupExist2 = rage.ped.does_relationship_group_exist(0x6F0783F5) -- true
bDoesRelGroupExist3 = rage.ped.does_relationship_group_exist("") -- false

system.log_debug(tostring(bDoesRelGroupExist)))
system.log_debug(tostring(bDoesRelGroupExist2))
system.log_debug(tostring(bDoesRelGroupExist3))

---

get_current_ped_weapon(ped, p2)

Returns hash of the ped’s active weapon

Parameters:

• ped (Ped) – The ped ID

• p2 (bool) – Always seems to be true

Returns:

• Hash – The current weapon hash

  • Find out more about weapon hashes here

Example:

pSelfPed = player.get_ped()

uCurrentWeaponHash = rage.ped.get_current_ped_weapon(pSelfPed, true)

system.log_debug(tostring(uCurrentWeaponHash))

---

get_group_size(groupId, unknown)

Returns ped group size.

Parameters:

• groupId (int) – The group ID

• unknown (Any) – Unknown, seems to be a boolean that represents if the group exists at all

Returns:

• int – The group member count

Example:

Note

This example was not tested.

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
iGroupID = rage.ped.create_group()
rage.ped.set_ped_as_group_leader(pSelfPed, iGroupID)
rage.ped.set_ped_as_group_member(pClonePed, iGroupID)
iGroupSize = rage.ped.get_group_size(iGroupID, true)
system.log_debug(tostring(iGroupSize)) -- should return 2

---

get_number_of_ped_drawable_variations(ped, componentID)

Returns the number of drawable variations for the specified body part.

Parameters:

• ped (Ped) – The ped ID

• componentID (int) – The component ID / body part ID

  • You can find the component IDs here: Ped Component IDs

Returns:

• int – The number of drawable variations

Example:

pSelfPed = player.get_ped()
iPedDrawVariationsCount = rage.ped.get_number_of_ped_drawable_variations(pSelfPed, 0)
system.log_debug(tostring(iPedDrawVariationsCount)) -- drawable variations number for head

---

get_number_of_ped_prop_drawable_variations(ped, propID)

Returns the number of drawable variations for the specified prop.

Parameters:

• ped (Ped) – The ped ID

• propID (int) – The prop ID

  • You can find the prop IDs here: Ped Prop IDs

Returns:

• int – The number of drawable variations

Example:

pSelfPed = player.get_ped()

iPropDrawVariationsCount = rage.ped.get_number_of_ped_prop_drawable_variations(pSelfPed, 0)
system.log_debug(tostring(iPropDrawVariationsCount))

---

get_number_of_ped_prop_texture_variations(ped, propID, drawableID)

Note

this function is not yet documented.

---

get_number_of_ped_texture_variations(ped, componentID, drawableID)

Returns a number of possible texture variations for the specified component

Parameters:

• ped (Ped) – The ped ID

• componentID (int) – The component ID / body part ID

  • You can find the component IDs here: Ped Prop IDs

• drawableID (int) – The drawable ID

Returns:

• int – The number of texture variations

Example:

pSelfPed = player.get_ped()
iPedTextureVariationsCount = rage.ped.get_number_of_ped_texture_variations(pSelfPed, 0, 0)
system.log_debug(tostring(iPedTextureVariationsCount)) -- texture variations number for head

---

get_ped_bone_index(ped, boneID)

Returns the bone index for the specified bone ID.

Parameters:

• ped (Ped) – The ped ID

• boneID (int) – The bone ID

  • You can find the bone IDs here: Bones

Returns:

• int – The bone index

Example:

pSelfPed = player.get_ped()
sBoneIndex = rage.ped.get_ped_bone_index(pSelfPed, 0) -- SKEL_ROOT
sBoneIndex2 = rage.ped.get_ped_bone_index(pSelfPed, 1356) -- FB_R_Brow_Out_000
sBoneIndex3 = rage.ped.get_ped_bone_index(pSelfPed, 2108) -- SKEL_L_Toe0

system.log_debug(tostring(sBoneIndex)) -- 0
system.log_debug(tostring(sBoneIndex2)) -- -1
system.log_debug(tostring(sBoneIndex3)) -- 5

---

get_ped_drawable_variation(ped, componentID)

Get variation ID based on component ID.

Parameters:

• ped (Ped) – The ped ID

• componentID (int) – The component ID / body part ID

  • You can find the component IDs here: Ped Component IDs

Returns:

• int – The variation ID

Example:

pSelfPed = player.get_ped()
iCurDrawVariation = rage.ped.get_ped_drawable_variation(pSelfPed, 0) -- variations count for head
system.log_debug(tostring(iCurDrawVariation))

---

get_ped_eye_color(ped)

Returns the eye color of the specified ped.

Parameters:

• ped (Ped) – The ped ID

Returns:

• int – The eye color

  • For eye colors list, see this: Ped eye colors

Example:

pSelfPed = player.get_ped()
iEyeColorID = rage.ped.get_ped_eye_color(pSelfPed)
system.log_debug(tostring(iEyeColorID))

---

get_ped_group_index(ped)

Returns the group id of which the specified ped is a member of.

Parameters:

• ped (Ped) – The ped ID

Returns:

• int – The group id

Example:

pSelfPed = player.get_ped()
iGroupID = rage.ped.create_group()
rage.ped.set_ped_as_group_leader(pSelfPed, iGroupID)
iGroupIndex = rage.ped.get_ped_group_index(pSelfPed)
system.log_debug(tostring(iGroupIndex))

---

get_ped_head_blend_data(ped, headBlendData)

Note

This function is not yet documented and is not yet available to use in Lua.

Returns face shape data of the specified ped.

Parameters:

• ped (Ped) – The ped ID

• headBlendData (int) – The head blend data

  • shapeFirst – dad shape

  • shapeSecond – mom shape

  • shapeThird – third shape (unused)

  • skinFirst – dad skin color

  • skinSecond – mom skin color

  • skinThird – third skin color (unused)

  • shapeMix – shape mix

  • skinMix – skin mix

  • thirdMix – third mix (unused)

Returns:

• bool – Unknown

---

get_ped_head_overlay_value(ped, overlayID)

Returns the setting of the specified head part (makeup, complexion, etc.)

Parameters:

• ped (Ped) – The ped ID

• overlayID (int) – The overlay ID

  • You can find the overlay IDs here: Ped head overlay IDs

Returns:

• int – The overlay value

Example:

pSelfPed = player.get_ped()
iHeadOverlay = rage.ped.get_ped_head_overlay_value(pSelfPed, 0) -- get Blemishes overlay value
system.log_debug(tostring(iHeadOverlay))

---

get_ped_max_health(ped)

Returns the maximum health of the specified ped.

Parameters:

• ped (Ped) – The ped ID

Returns:

• int – The maximum health

Example:

pSelfPed = player.get_ped()
iPedMaxHealth = rage.ped.get_ped_max_health(pSelfPed)
system.log_debug(tostring(iPedMaxHealth))

---

get_ped_prop_index(ped, componentID)

Returns a ped’s prop index (identifier) based on component ID.

Parameters:

• ped (Ped) – The ped ID

• componentID (int) – The component ID / body part ID

  • You can find the component IDs here: Ped Prop IDs

Returns:

• int – The prop index

Example:

pSelfPed = player.get_ped()
iPedPropIndex = rage.ped.get_ped_prop_index(pSelfPed, 0) -- get helmet prop index
system.log_debug(tostring(iPedPropIndex))

---

get_ped_prop_texture_index(ped, componentID)

Returns a ped’s prop texture index (identifier) based on component ID.

Parameters:

• ped (Ped) – The ped ID

• componentID (int) – The component ID / body part ID

  • You can find the component IDs here: Ped Prop IDs

Returns:

• int – The prop texture index

Example:

pSelfPed = player.get_ped()
iPropTextureIndex = rage.ped.get_ped_prop_texture_index(pSelfPed, 0) -- get helmet prop texture index
system.log_debug(tostring(iPropTextureIndex))

---

get_ped_relationship_group_hash(ped)

Returns a ped’s relationship group hash.

Parameters:

• ped (Ped) – The ped ID

Returns:

• int – The relationship group hash

  • You can find the relationship group hashes here: Relationship groups

Example:

pSelfPed = player.get_ped()
uRelGroupHash = rage.ped.get_ped_relationship_group_hash(pSelfPed)
system.log_debug(tostring(uRelGroupHash))

---

get_ped_texture_variation(ped, componentID)

Returns a ped’s texture variation (identifier) based on component ID.

Parameters:

• ped (Ped) – The ped ID

• componentID (int) – The component ID / body part ID

  • You can find the component IDs here: Ped Component IDs

Returns:

• int – The texture variation ID

Example:

pSelfPed = player.get_ped()
iPedTextureVariation = rage.ped.get_ped_texture_variation(pSelfPed, 0) -- get helmet texture variation
system.log_debug(tostring(iPedTextureVariation))

---

get_vehicle_ped_is_using(ped)

Returns the vehicle that the specified ped is in.

Parameters:

• ped (Ped) – The ped ID

Returns:

• Vehicle – The vehicle handle

  • If the ped is not in a vehicle, the handle will be 0.

Example:

pSelfPed = player.get_ped()
vCurrentPedVehicle = rage.ped.get_vehicle_ped_is_using(pSelfPed)
sPlateText = rage.vehicle.get_vehicle_number_plate_text(vCurrentPedVehicle)
system.log_debug(tostring(sPlateText))

---

is_ped_a_player(ped)

Checks whether the specified ped is a player.

Parameters:

• ped (Ped) – The ped ID

Returns:

• bool

  • true – the ped is a player

  • false – the ped is not a player

Example:

pSelfPed = player.get_ped()
bIsPedPlayer = rage.ped.is_ped_a_player(pSelfPed)
system.log_debug(tostring(bIsPedPlayer))

---

is_ped_group_member(ped, group)

Parameters:

• ped (Ped) – The ped ID

• group (Group) – The group ID

Returns:

• bool

  • true – the ped is a member of the group

  • false – the ped is not a member of the group

Example:

pSelfPed = player.get_ped()
iGroupID = rage.ped.create_group()
bIsGroupMember = rage.ped.is_ped_group_member(pSelfPed, iGroupID)
if bIsGroupMember then
   system.log_debug("Ped is a member of group " .. tostring(iGroupID))
else
   system.log_debug("Ped is not a member of group " .. tostring(iGroupID))
end

---

is_ped_in_any_vehicle(ped, atGetIn)

Whether or not the specified ped is in any vehicle.

Parameters:

• ped (Ped) – The ped ID

• atGetIn (bool) – Whether or not to check if the ped is currently in the process of entering a vehicle

  • true – Check if the ped is in the process of entering a vehicle

  • false – Check if the ped is in any vehicle

Returns:

• bool

  • true – the ped is in any vehicle (or is in the process of entering a vehicle)

  • false – the ped is not in any vehicle (or is not in the process of entering a vehicle)

Example:

pSelfPed = player.get_ped()
bIsPedInVehicle = rage.ped.is_ped_in_any_vehicle(pSelfPed, true)
if bIsPedInVehicle then
   system.log_debug("Ped is going to enter or already is in the vehicle")
else
   system.log_debug("Ped is not going to enter or is not in the vehicle")
end

---

is_ped_ragdoll(ped)

Checks whether the ragdoll is currently active for this ped

Parameters:

• ped (Ped) – The ped ID

Returns:

• bool

  • true – the ragdoll is active

  • false – the ragdoll is inactive

Example:

pSelfPed = player.get_ped()
bIsRagdoll = rage.ped.is_ped_ragdoll(pSelfPed)
if bIsRagdoll then
   system.log_debug("Ped ragdoll active")
else
   system.log_debug("Ragdoll inactive")
end

---

is_ped_shooting(ped)

Checks whether the specified ped is shooting.

Parameters:

• ped (Ped) – The ped ID

Returns:

• bool

  • true – the ped is shooting

  • false – the ped is not shooting

Example:

pSelfPed = player.get_ped()
isPedShooting = rage.ped.is_ped_shooting(pSelfPed)
if isPedShooting then
   system.log_debug("Ped is shooting")
else
   system.log_debug("Ped is not shooting")
end

---

is_ped_swimming(ped)

Checks whether the specified ped is swimming.

Parameters:

• ped (Ped) – The ped ID

Returns:

• bool

  • true – the ped is swimming

  • false – the ped is not swimming

Example:

pSelfPed = player.get_ped()
bIsPedSwimming = rage.ped.is_ped_swimming(pSelfPed)
if bIsPedSwimming then
   system.log_debug("Ped is swimming")
else
   system.log_debug("Ped is not swimming")
end

---

is_ped_using_any_scenario(ped)

Checks whether the specified ped is using any scenario.

Parameters:

• ped (Ped) – The ped ID

Returns:

• bool

  • true – the ped is using any scenario

  • false – the ped is not using any scenario

Example:

pSelfPed = player.get_ped()
bIsPedUsingScenario = rage.ped.is_ped_using_any_scenario(pSelfPed)
if bIsPedUsingScenario then
   system.log_debug("Ped is using any scenario")
else
   system.log_debug("Ped is not using any scenario")
end

---

remove_group(groupId)

Removes a ped group from the game session.

Parameters:

• groupId (Group) – The group ID

Returns:

• None

Example:

iGroupID = rage.ped.create_group()
rage.ped.remove_group(iGroupID)
system.log_debug("Group " .. tostring(iGroupID) .. " removed")

---

remove_ped_from_group(ped)

Removes a ped from its group.

Parameters:

• ped (Ped) – The ped ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.remove_ped_from_group(pSelfPed)
system.log_debug("Ped " .. tostring(pSelfPed) .. " removed from group")

---

remove_relationship_group(groupHash)

Removes a relationship group from the game session.

Parameters:

• groupHash (Hash) – The relationship group hash

Returns:

• None

Example:

rage.ped.remove_relationship_group(0xA49E591C)
system.log_debug("Relationship group COP removed")

---

reset_group_formation_default_spacing(group)

Resets group formation settings.

Parameters:

• group (Group) – The group ID

Returns:

• None

Note

This example was not tested.

Example:

iGroupID = rage.ped.create_group()
rage.ped.reset_group_formation_default_spacing(iGroupID)
system.log_debug("Group formation settings reset")

---

reset_ped_movement_clipset(ped, p1)

Resets the ped movement clip set (walking animation set).

Note

Seems to only work with player peds. Needs more testing with ordinary peds.

Parameters:

• ped (Ped) – The ped ID

• p1 (float) – Unknown

  • If p1 is 0.0, you are back to normal.

  • If p1 is 1.0, it looks like you can only rotate the ped, not walk.

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.reset_ped_movement_clipset(pSelfPed, 0.0)
system.log_debug("Ped movement clipset reset")

---

resurrect_ped(ped)

Resurrects a ped.

Parameters:

• ped (Ped) – The ped ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
pDeadPed = rage.ped.clone_ped(pSelfPed, false, false, true)

-- imagine your clone gets killed

rage.ped.resurrect_ped(pDeadPed)
system.log_debug("Clone resurrected")

---

set_can_attack_friendly(ped, bool, p2)

Sets whether the ped can attack friendly peds.

Parameters:

• ped (Ped) – The ped ID

• bool (bool) – Whether the ped can attack friendly peds

• p2 (bool) – Unknown. Use false, as setting it to true doesn’t let you attack friends.

Returns:

• None

Note

This example was not tested.

Example:

pSelfPed = player.get_ped()
rage.ped.set_can_attack_friendly(pSelfPed, true, false)
system.log_debug("Ped can now attack friendly peds")

---

set_create_random_cops(toggle)

Sets whether random cops can be summoned

Parameters:

• toggle (bool) – Whether random cops can be summoned

  • true – random cops can be summoned

  • false – random cops can’t be summoned

Returns:

• None

Example:

rage.ped.set_create_random_cops(true)
system.log_debug("Random cops can now be summoned")

---

set_group_formation(group, formationType)

Sets the group formation type.

Parameters:

• group (Group) – The group ID

• formationType (int) – The formation type

  • You can find formation types here: Group formations

Returns:

• None

Example:

iGroupID = rage.ped.create_group()
rage.ped.set_group_formation(iGroupID, 1)
system.log_debug("Group formation set to formation type Circle Around Leader")

---

set_group_formation_spacing(group, p1, p2, p3)

Sets the group formation spacing.

Parameters:

• group (Group) – The group ID

• p1 (float) – The spacing between members (in meters)

• p2 (float) – Unknown. Seen to be -1

• p3 (float) – Unknown. Seen to be -1

Returns:

• None

Example:

iGroupID = rage.ped.create_group()
rage.ped.set_group_formation_spacing(iGroupID, 10, -1, -1)
system.log_debug("Group formation spacing set to 10 meters")

---

set_ped_accuracy(ped, accuracy)

Sets the ped shooting accuracy.

Parameters:

• ped (Ped) – The ped ID

• accuracy (int) – Accuracy rate (0-100)

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_accuracy(pSelfPed, 100)
system.log_debug("Ped accuracy set to 100")

---

set_ped_as_group_leader(ped, groupId)

Sets the ped as a ped group leader.

Parameters:

• ped (Ped) – The ped ID

• groupId (int) – The group ID

Returns:

• None

Example:

iGroupID = rage.ped.create_group()
pSelfPed = player.get_ped()
rage.ped.set_ped_as_group_leader(pSelfPed, iGroupID)
system.log_debug("Ped set as group leader")

---

set_ped_as_group_member(ped, groupId)

Sets the ped as a ped group member.

Parameters:

• ped (Ped) – The ped ID

• groupId (int) – The group ID

Returns:

• None

Example:

iGroupID = rage.ped.create_group()
pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(ped, false, false, true)
rage.ped.set_ped_as_group_leader(pSelfPed, iGroupID)
rage.ped.set_ped_as_group_member(pClonePed, iGroupID)
system.log_debug("Clone set as group member")

---

set_ped_can_ragdoll(ped, toggle)

Toggles the ragdoll for a ped

Parameters:

• ped (Ped) – The ped ID

• toggle (bool) – Ragdoll toggle

Returns:

• None

Example:

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
rage.ped.set_ped_can_ragdoll(pClonePed, true)
system.log_debug("Clone's ragdoll is now on")

---

set_ped_combat_ability(ped, abilityLevel)

Sets combat ability level for a ped.

Parameters:

• ped (Ped) – The ped ID

• abilityLevel (int) – The ability level

  • 100 = attack

  • less than 50 -ish would mean run away

Returns:

• None

Example:

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
rage.ped.set_ped_combat_ability(pClonePed, 100)
system.log_debug("Clone combat ability set to \"Attack\" level")

---

set_ped_combat_attributes(ped, attributeId, enabled)

Configures various combat attributes for a ped

Parameters:

• ped (Ped) – The ped ID

• attributeId (int) – The attribute ID

  • You can find attribute IDs here: Combat attributes

• enabled (bool) – Whether the attribute is enabled

Returns:

• None

Example:

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
rage.ped.set_ped_combat_attributes(pClonePed, 1, true)
system.log_debug("Clone combat attributes set to 1 (BF_CanUseVehicles)")

---

set_ped_combat_movement(ped, combatMovement)

Sets the combat movement rule for a ped.

Parameters:

• ped (Ped) – The ped ID

• combatMovement (int) – The combat movement rule

  • You can find combat movement rules here: Combat movement rules

Returns:

• None

Example:

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
rage.ped.set_ped_combat_movement(pClonePed, 2)
system.log_debug("Clone combat movement set to 2 (Offensive)")

---

set_ped_combat_range(ped, combatRange)

Sets the combat range for a ped.

Parameters:

• ped (Ped) – The ped ID

• combatRange (int) – The combat range

  • You can find combat ranges here: Combat ranges

Returns:

• None

Example:

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
rage.ped.set_ped_combat_range(pClonePed, 1)
system.log_debug("Clone combat range set to 1 (Medium)")

---

set_ped_component_variation(ped, componentId, drawableId, textureId, paletteId)

Sets the component variation for a ped.

Parameters:

• ped (Ped) – The ped ID

• componentId (int) – The component ID

  • You can find component IDs here: Ped Component IDs

• drawableId (int) – The drawable ID

• textureId (int) – The texture ID

• paletteId (int) – The palette ID

  • Can be from 0 to 3.

Returns:

• None

Example:

pSelfPed = player.get_ped()
iComponentID = 0  -- face
iDrawableCount = rage.ped.get_number_of_ped_drawable_variations(pSelfPed, iComponentID) -- face drawable count
iTextureCount = rage.ped.get_number_of_ped_texture_variations(pSelfPed, iComponentID, 0) -- face texture count
rage.ped.set_ped_component_variation(pSelfPed, iComponentID, iDrawableCount, iTextureCount, 2)

system.log_debug("Manipulated face components.")

---

set_ped_config_flag(ped, flagId, value)

Sets a ped config flag.

Note

1. When flagId is set to 33 and the bool value to true, peds will die by ragdolling, so you should set this flag to false when you resurrect a ped.

2. When flagId is set to 62 and the bool value to false, peds may jump out of their vehicles and never return.

Config flags changes during game session:

• Jumping: changes 60, 61, 104 to false.

• Being in water (swimming): changes 60, 61 to false and 65, 66, 168 to true.

• Falling: changes 60, 61, 104, 276 to false and 76 to true.

• Dying: changes 60, 61, 104, 276 to false.

• Being in a car: changes 60, 79, 104 to false and 62 to true.

Maximum value for flagId is 426. FlagId 240 appears to be somewhat special.

Parameters:

• ped (Ped) – The ped ID

• flagId (int) – The flag ID

  • You can find flag IDs here: Ped configuration flags

• value (bool) – The flag value

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_config_flag(pSelfPed, 149, false)
system.log_debug("Damage reduced for self.")

---

set_ped_default_component_variation(ped)

Resets ped clothes to default

Parameters:

• ped (Ped) – The ped ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
rage.ped.set_ped_default_component_variation(pClonePed)
system.log_debug("Clone's clothes set to default.")

---

set_ped_density_multiplier_this_frame(multiplier)

Sets the ped density on the streets.

Note

You have to call this every frame, so use this inside a loop.

Parameters:

• multiplier (float) – The density multiplier (should be between 0 and 1)

Returns:

• None

Example:

function noPeds()
   rage.ped.set_ped_density_multiplier_this_frame(0.0)
end

system.add_task("lua no peds task", "npt", -1, noPeds)

---

set_ped_eye_color(ped, index)

Sets the eye color for a ped.

Parameters:

• ped (Ped) – The ped ID

• index (int) – The eye color index

  • For eye colors list, see this: Ped eye colors

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_eye_color(pSelfPed, 1)
system.log_debug("Ped's eye color set to Emerald.")

---

set_ped_head_blend_data(ped, shapeFirst, shapeSecond, shapeThird, skinFirst, skinSecond, skinThird, shapeMix, skinMix, thirdMix)

Sets the face shape settings for the selected ped.

Note

This function is often called prior to set_ped_head_overlay_color and set_ped_head_overlay native functions.

Parameters:

• ped (Ped) – The ped ID

• shapeFirst (int) – dad shape (from 0 to 45)

• shapeSecond (int) – mom shape (from 0 to 45)

• shapeThird (int) – third shape (unused)

• skinFirst (int) – dad skin color (from 0 to 45)

• skinSecond (int) – mom skin color (from 0 to 45)

• skinThird (int) – third skin color (unused)

• shapeMix (float) – shape mix (0.0 -> 1.0 of whose characteristics to take: Father -> Mother)

• skinMix (float) – skin mix (0.0 -> 1.0 of whose characteristics to take: Father -> Mother)

• thirdMix (float) – third mix (unused)

• isParent (bool) – usually false

Returns:

• None

Example:

Note

This example was not tested, and there are no lists of possible input values.

pSelfPed = player.get_ped()
rage.ped.set_ped_head_blend_data(pSelfPed, 0, 0, 0, 0, 0, 0, 0, 0, 0, false)

---

set_ped_head_overlay(ped, overlayID, index, opacity)

Sets the setting of the specified head part (makeup, complexion, etc.)

Note

You may need to call set_ped_head_blend_data for this to work.

Parameters:

• ped (Ped) – The ped ID

• overlayID (int) – The overlay ID

• index (int) – The overlay index

  • You can find overlay ID data here: Ped head overlay IDs

• opacity (float) – The overlay opacity (0.0 - 1.0)

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_head_overlay(pSelfPed, 8, 1, 0.5)
system.log_debug("Ped's lipstick set to 1, half opacity.")

---

set_ped_head_overlay_color(ped, overlayID, colorType, colorID, secondColorID)

Sets the color of the specified head part (lipstick, beards, eyebrows, chest hair.)

Note

You may need to call set_ped_head_blend_data for this to work.

Parameters:

• ped (Ped) – The ped ID

• overlayID (int) – The overlay ID

  • You can find overlay ID data here: Ped head overlay IDs

• colorType (int) – The color type

  • 1 for eyebrows, beards and chest hair.

  • 2 for lipstick and blush.

• colorID (int) – The color ID

  • For color ID list, see this: Ped head overlay IDs

• secondColorID (int) – The second color ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_head_overlay_color(pSelfPed, 8, 1, 1, 1)
system.log_debug("Ped's lipstick set to red.")

---

set_ped_into_vehicle(ped, vehicle, seatIndex)

Warps the ped into a vehicle.

Parameters:

• ped (Ped) – The ped ID

• vehicle (Vehicle) – The vehicle ID

• seatIndex (int) – The seat index

  • For seat index list, see this: Seat types

Returns:

• None

Example:

-- assuming you are already in a vehicle
pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
vCurrentVehicle = player.get_vehicle()
rage.ped.set_ped_into_vehicle(pClonePed, vCurrentVehicle, 0)
system.log_debug("Ped warped into vehicle, right front seat.")

---

set_ped_max_health(ped, value)

Sets the maximum health for the ped.

Parameters:

• ped (Ped) – The ped ID

• value (int) – The maximum health

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_max_health(pSelfPed, 100000)
system.log_debug("Doomguy mode activated.")

---

set_ped_movement_clipset(ped, clipset, transitionSpeed)

Sets the movement clipset (walking animation set) for the ped.

Note

You have to request an animation set before using this.

Parameters:

• ped (Ped) – The ped ID

• clipset (string) – The movement clipset name

  • For a list of movement clipsets, see this: Ped movement clipsets

• transitionSpeed (float) – The speed of transition between two clipsets

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.streaming.request_anim_set("MOVE_M@DRUNK@VERYDRUNK")
rage.ped.set_ped_movement_clipset(pSelfPed, "MOVE_M@DRUNK@VERYDRUNK", 5.0)

---

set_ped_never_leaves_group(ped, toggle)

Sets whether the ped can leave a ped group or not.

Parameters:

• ped (Ped) – The ped ID

• toggle (bool) – Toggle

  • true to not let the ped be able leave the group

  • false to let him leave the group

Returns:

• None

Example:

pSelfPed = player.get_ped()
pClonePed = rage.ped.clone_ped(pSelfPed, false, false, true)
iGroupID = rage.ped.create_group()

rage.ped.set_ped_as_group_leader(pSelfPed, iGroupID)
rage.ped.set_ped_as_group_member(pClonePed, iGroupID)

rage.ped.set_ped_never_leaves_group(pClonePed, true)
system.log_debug("Clone can't leave group now.")

---

set_ped_prop_index(ped, componentID, drawableID, textureID, attach)

Set prop variation on a ped. Components, drawables and textures IDs are related to the ped model.

Parameters:

• ped (Ped) – The ped ID

• componentID (int) – The component ID

  • For component ID list, see this: Ped Prop IDs

• drawableID (int) – The drawable ID

• textureID (int) – The texture ID

• attach (bool) – Attach the prop to the ped

Returns:

• None

Example:

Note

This example was not tested.

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_prop_index(pSelfPed, 0, 51, 0, true) -- places a black helmet
system.log_debug("Ped's helmet set to 0, 51, 0.")

---

set_ped_random_component_variation(ped, p1)

Sets a random component variation for the ped.

Parameters:

• ped (Ped) – The ped ID

• p1 (int) – Seems to be always 0, unused anyway.

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_random_component_variation(pSelfPed, 0)
system.log_debug("Ped's component variation set.")

---

set_ped_relationship_group_hash(ped, hash)

Sets the relationship group for the ped.

Parameters:

• ped (Ped) – The ped ID

• hash (int) – The relationship group hash

  • For a list of relationship group hashes, see this: Relationship groups

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_relationship_group_hash(pSelfPed, 0xA49E591C)
system.log_debug("Ped's relationship group set to COP.")

---

set_ped_to_ragdoll(ped, time1, time2, ragdollType, p4, p5, p6)

Forces the ped to ragdoll.

Parameters:

• ped (Ped) – The ped ID

• time1 (int) – The time ped is in ragdoll state (in ms)

• time2 (int) – The time ped needs to stand up (in ms)

• ragdollType (int) – The ragdoll type

  • 0 – Normal ragdoll

  • 1 – Falls with stiff legs/body

  • 2 – Narrow leg stumble(may not fall)

  • 3 – Wide leg stumble(may not fall)

• p4 (int) – Unknown, seems to be always true

• p5 (int) – Unknown, seems to be always true

• p6 (int) – Unknown, seen to be both true and false

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.ped.set_ped_to_ragdoll(pSelfPed, 10000, 3000, 0, true, true, false)
system.log_debug("Ped ragdolled.")

---

set_relationship_between_groups(relationship, group1, group2)

Sets the relationship between two groups.

Note

This should be called twice (once for each group).

Parameters:

• relationship (int) – The relationship type

• group1 (Hash) – The first group hash

• group2 (Hash) – The second group hash

  • For relationship groups and types, see this: Relationship groups

Returns:

• None

Example:

rage.ped.set_relationship_between_groups(1, 0xA49E591C, 0x6F0783F5)
rage.ped.set_relationship_between_groups(1, 0x6F0783F5, 0xA49E591C)
system.log_debug("Set respect relationship between cops and player")

---

set_scenario_ped_density_multiplier_this_frame(p0, p1)

Sets ped density during scenarios

Note

You have to call this every frame, so use this inside a loop.

Parameters:

• p0 (float) – The density multiplier (should be between 0 and 1)

• p1 (float) – Should be the same as p0

Returns:

• None

Example:

function halfPeds()
   rage.ped.set_scenario_ped_density_multiplier_this_frame(0.5, 0.5)-- thanos moment
end
system.add_task("half of all peds", "thanos", -1, halfPeds)

---

Vehicle namespace

This namespace contains vehicle-related game functions.

---

add_vehicle_phone_explosive_device(vehicle)

Adds a phone explosive device to the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.add_vehicle_phone_explosive_device(vCurrentVehicle)

---

clear_vehicle_custom_primary_colour(vehicle)

Resets the vehicle’s primary custom colour to it’s real primary one.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.clear_vehicle_custom_primary_colour(vCurrentVehicle)
system.log_debug("Vehicle's primary custom colour reset.")

---

clear_vehicle_custom_secondary_colour(vehicle)

Resets the vehicle’s secondary custom colour to it’s real secondary one.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.clear_vehicle_custom_secondary_colour(vCurrentVehicle)
system.log_debug("Vehicle's secondary custom colour reset.")

---

control_landing_gear(vehicle, state)

Switches the landing gear of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• state (int) – The gear state

  • 0 – Deployed

  • 1 – Closing

  • 2 – Opening

  • 3 – Retracted

Returns:

• None

Example:

-- assuming you're in a plane or a helicopter
vCurrentVehicle = player.get_vehicle()
rage.vehicle.control_landing_gear(vCurrentVehicle, 0)
system.log_debug("Landing gear deployed.")

---

create_vehicle(modelHash, x, y, z, heading, isNetwork, bScriptHostVeh, p7)

Creates a vehicle.

Note

You have to load the model first before creating a vehicle.

Parameters:

• modelHash (Hash) – The vehicle model hash

• x (float) – Spawn coordinate X component

• y (float) – Spawn coordinate Y component

• z (float) – Spawn coordinate Z component

• heading (float) – Spawn heading (to face towards, degrees)

• isNetwork (bool) – Whether to create a network object for the vehicle.

  • true – Create a network object for the vehicle. Other players will be able to see it.

  • false – the vehicle exists only locally.

• bScriptHostVeh (bool) – Whether to register the vehicle as pinned to the script host in the R* network model.

• p7 (bool) – Unknown

Returns:

• Vehicle – The vehicle ID

  0 – The vehicle couldn’t be created.

Example:

uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")
v3CoordsInfront = player.get_coords_infront(10)

rage.streaming.request_model(uZentornoHash)
vCreatedVehicle = rage.vehicle.create_vehicle(uZentornoHash, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 0, true, false, false)
if vCreatedVehicle ~= 0 then
   system.log_debug("Created vehicle.")
end
rage.streaming.set_model_as_no_longer_needed(uZentornoHash)

---

detonate_vehicle_phone_explosive_device()

Detonates a previously-added phone explosive device.

Parameters:

• None

Returns:

• None

Example:

-- assuming you're in a vehicle

vCurrentVehicle = player.get_vehicle()

rage.vehicle.add_vehicle_phone_explosive_device(vCurrentVehicle)
rage.vehicle.detonate_vehicle_phone_explosive_device()
system.log_debug("Detonated phone explosive device.")

---

does_extra_exist(vehicle, extraId)

Note

This function is not yet documented.

---

explode_vehicle(vehicle, isAudible, isInvisible)

Explode a vehicle

Parameters:

• vehicle (Vehicle) – The vehicle ID

• isAudible (bool) – Whether the explosion is audible

• isInvisible (bool) – Whether the explosion is invisible

Returns:

• None

Example:

v3CoordsInfront = player.get_coords_infront(10)
uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")
vCreatedVehicle = scripting.spawn.spawn_vehicle(uZentornoHash, v3CoordsInfront, 30.0)
rage.vehicle.explode_vehicle(vCreatedVehicle, true, false)

---

get_all_vehicles()

Note

This function is not yet documented.

---

get_convertible_roof_state(vehicle)

Returns the state of the vehicle’s convertible roof.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The roof state

  • For the list of roof states, see this: Vehicle roof states

  • 0 if not in a vehicle

Example:

vCurrentVehicle = player.get_vehicle()
iRoofState = rage.vehicle.get_convertible_roof_state(vCurrentVehicle)
system.log_debug("Vehicle's roof state is " .. iRoofState) --assuming the roof is closed, or you're on a bike

---

get_landing_gear_state(vehicle)

Returns the state of the vehicle’s landing gear.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The gear state

• 0 - Down

• 1 - Raising

• 3 - Lowering

• 4 - Up

• 5 - Broken

Example:

vCurrentVehicle = player.get_vehicle()
iGearState = rage.vehicle.get_landing_gear_state(vCurrentVehicle)
system.log_debug("Vehicle's gear state is " .. iGearState)

---

get_livery_name(vehicle, liveryIndex)

Returns vehicle livery name

Parameters:

• vehicle (Vehicle) – The vehicle ID

• liveryIndex (int) – The livery index

Returns:

• string – The livery name

Example:

Note

Additionally, you can get localized livery name using get_label_text

vCurrentVehicle = player.get_vehicle()
iLiveryCount = rage.vehicle.get_vehicle_livery_count(vCurrentVehicle)
for i = 0, iLiveryCount do
   sLiveryName = rage.vehicle.get_livery_name(vCurrentVehicle, i)
   system.log_debug("Livery " .. i .. ": " .. sLiveryName)
end

-- or

vCurrentVehicle = player.get_vehicle()
iLiveryIndex = rage.vehicle.get_vehicle_livery(vCurrentVehicle)
sLiveryName = rage.vehicle.get_livery_name(vCurrentVehicle, iLiveryIndex)
system.log_debug("Livery name: " .. sLiveryName)

-- or

vCurrentVehicle = player.get_vehicle()
iLiveryIndex = rage.vehicle.get_vehicle_livery(vCurrentVehicle)
sLiveryName = rage.vehicle.get_livery_name(vCurrentVehicle, iLiveryIndex)
sLabelText = rage.vehicle.get_label_text(sLiveryName)
system.log_debug("Livery name: " .. sLabelText)

---

get_mod_slot_name(vehicle, modType)

Returns the name for the type of vehicle mod(Armour, engine etc)

Note

Unreliable. Sometimes returns “”.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modType (int) – The mod type

  • For the list of mod types, see this: Vehicle modification types

Returns:

• string – The mod type name

Example:

vCurrentVehicle = player.get_vehicle()
sModType = rage.vehicle.get_mod_slot_name(vCurrentVehicle, 0)
system.log_debug("Type: " .. sModType)

---

get_mod_text_label(vehicle, modType, modValue)

Returns the label name for the type of vehicle mod(Armour, engine etc)

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modType (int) – The mod type

  • For the list of mod types, see this: Vehicle modification types

• modValue (int) – The mod value

Returns:

• string – The mod label name

Example:

Note

Additionally, you can get localized mod name using get_label_text

vCurrentVehicle = player.get_vehicle()
sVehicleModVariation = rage.vehicle.get_vehicle_mod(vCurrentVehicle, 0) -- get spoiler installed
sModLabel = rage.vehicle.get_mod_text_label(vCurrentVehicle, 0, sVehicleModVariation)
system.log_debug("Spoiler: " .. sModLabel)

---

get_num_vehicle_mods(vehicle, modType)

Returns the number of possible mod variations for the type of vehicle mod(Armour, engine etc)

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modType (int) – The mod type

  • For the list of mod types, see this: Vehicle modification types

Returns:

• int – The number of mod variations

Example:

vCurrentVehicle = player.get_vehicle()
iVehicleModVariationCount = rage.vehicle.get_num_vehicle_mods(vCurrentVehicle, 0) -- spoiler possible variations
system.log_debug("Spoiler count: " .. iVehicleModVariationCount)

---

get_ped_in_vehicle_seat(vehicle, seat, p2)

Returns the Ped handle of the ped in the specified vehicle seat.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• seat (int) – The seat ID

  • For the list of seat IDs, see this: Seat types

• p2 (int) – Unknown (unused)

Returns:

• Ped – The ped handle

  • If no ped is in the seat, returns 0

Example:

vCurrentVehicle = player.get_vehicle()
pPassengerInVehicle = rage.vehicle.get_ped_in_vehicle_seat(vCurrentVehicle, 0)
system.log_debug("Ped in a right front seat: " .. pPassengerInVehicle)

---

get_vehicle_class(vehicle)

Returns the class of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The class of the vehicle

  • For vehicle classes, see this: :doc: vehicleClasses

Example:

Note

Additionally, you can get localized class name using get_label_text

vCurrentVehicle = player.get_vehicle()
iVehicleClass = rage.vehicle.get_vehicle_class(vCurrentVehicle)
sVehicleClassName = rage.vehicle.get_label_text("VEH_CLASS_" .. tostring(iVehicleClass))
system.log_debug("Vehicle class: " .. sVehicleClassName)

---

get_vehicle_custom_primary_colour(vehicle)

Returns the custom primary colour of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• ColorRGB – The custom primary colour

Example:

vCurrentVehicle = player.get_vehicle()
crgbPrimaryColour = rage.vehicle.get_vehicle_custom_primary_colour(vCurrentVehicle)
system.log_debug("Custom primary colour: " .. tostring(crgbPrimaryColour.r) .. " " .. tostring(crgbPrimaryColour.g) .. " " .. tostring(crgbPrimaryColour.b))

---

get_vehicle_custom_secondary_colour(vehicle)

Returns the custom secondary colour of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• ColorRGB – The custom secondary colour

Example:

vCurrentVehicle = player.get_vehicle()
crgbSecondaryColour = rage.vehicle.get_vehicle_custom_secondary_colour(vCurrentVehicle)
system.log_debug("Custom secondary colour: " .. tostring(crgbSecondaryColour.r) .. " " .. tostring(crgbSecondaryColour.g) .. " " .. tostring(crgbSecondaryColour.b))

---

get_vehicle_doors_locked_for_player(vehicle, player)

Returns whether the vehicle doors are locked for the specified player.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• player (Player) – The player handle

Returns:

• bool – Whether the vehicle doors are locked

Example:

vCurrentVehicle = player.get_vehicle()
plHandle = player.get_player()
bDoorsLocked = rage.vehicle.get_vehicle_doors_locked_for_player(vCurrentVehicle, plHandle)
system.log_debug("Vehicle doors locked: " .. tostring(bDoorsLocked)) -- 100% false if the vehicle is personal

---

get_vehicle_estimated_max_speed(vehicle)

Returns max vehicle speed

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• float – The estimated max speed of the vehicle

Example:

vCurrentVehicle = player.get_vehicle()
fSpeed = rage.vehicle.get_vehicle_estimated_max_speed(vCurrentVehicle)
system.log_debug("Vehicle max speed: " .. tostring(fSpeed))

---

get_vehicle_livery(vehicle)

Returns the livery index of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The livery index

  • -1 means no livery

Example:

vCurrentVehicle = player.get_vehicle()
iLiveryIndex = rage.vehicle.get_vehicle_livery(vCurrentVehicle)
system.log_debug("Vehicle livery: " .. tostring(iLiveryIndex))

---

get_vehicle_livery_count(vehicle)

Returns the number of livery variations for the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The number of livery variations

Example:

vCurrentVehicle = player.get_vehicle()
iLiveryCount = rage.vehicle.get_vehicle_livery_count(vCurrentVehicle)
system.log_debug("Vehicle livery count: " .. tostring(iLiveryCount))

---

get_vehicle_max_number_of_passengers(vehicle)

Returns the maximum number of passengers for the vehicle.

Note

This does not include a driver.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The maximum number of passengers

Example:

vCurrentVehicle = player.get_vehicle()
iMaxPassengers = rage.vehicle.get_vehicle_max_number_of_passengers(vCurrentVehicle)
system.log_debug("Vehicle max passengers: " .. tostring(iMaxPassengers))

---

get_vehicle_mod(vehicle, modType)

Returns the vehicle mod variation ID

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modType (int) – The mod type

  • For mod types, see this: :doc: modTypes

Returns:

• int – The mod variation ID

  • -1 means mod is stock

Example:

vCurrentVehicle = player.get_vehicle()
iModVariation = rage.vehicle.get_vehicle_mod(vCurrentVehicle, 0) -- get spoiler installed
system.log_debug("Vehicle engine mod: " .. tostring(iModVariation))

---

get_vehicle_model_number_of_seats(modelHash)

Returns the number of seats for the specified vehicle model.

Parameters:

• modelHash (int) – The model hash

Returns:

• int – The number of seats

Example:

uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")
iSeatsCount = rage.vehicle.get_vehicle_model_number_of_seats(uZentornoHash)
system.log_debug("Vehicle seats: " .. tostring(iSeatsCount)) -- 2

---

get_vehicle_number_of_passengers(vehicle)

Returns the number of passengers for the vehicle, not including the driver.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The number of passengers

Example:

vCurrentVehicle = player.get_vehicle()
iPassengerCount = rage.vehicle.get_vehicle_number_of_passengers(vCurrentVehicle)
system.log_debug("Vehicle passengers: " .. tostring(iPassengerCount))

---

get_vehicle_number_plate_text(vehicle)

Returns the number plate text of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• string – The number plate text

Example:

vCurrentVehicle = player.get_vehicle()
sPlateText = rage.vehicle.get_vehicle_number_plate_text(vCurrentVehicle)
system.log_debug("Vehicle plate: " .. tostring(sPlateText))

---

get_vehicle_roof_livery_count(vehicle)

Returns a number of available rooftop liveries

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The number of available livery variations

  • -1 if vehicle has no rooftop liveries available.

Example:

vCurrentVehicle = player.get_vehicle()
iRoofLiveryCount = rage.vehicle.get_vehicle_roof_livery_count(vCurrentVehicle)
system.log_debug("Vehicle roof livery count: " .. tostring(iRoofLiveryCount))

---

get_vehicle_wheel_type(vehicle)

Returns the wheel type of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The wheel type

  • For wheel types, see this: :doc: wheelTypes

Example:

vCurrentVehicle = player.get_vehicle()
iWheelType = rage.vehicle.get_vehicle_wheel_type(vCurrentVehicle)
system.log_debug("Vehicle wheel type: " .. tostring(iWheelType))

---

get_vehicle_window_tint(vehicle)

Returns the window tint color of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• int – The window tint color

  • For window tint colors, see this: :doc: windowTints

Example:

vCurrentVehicle = player.get_vehicle()
iTintColorID = rage.vehicle.get_vehicle_window_tint(vCurrentVehicle)
system.log_debug("Vehicle window tint: " .. tostring(iTintColorID))

---

has_vehicle_phone_explosive_device(vehicle)

Checks whether the vehicle has a phone explosive device.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• bool

  • true – the vehicle has a phone explosive device

  • false – the vehicle does not have a phone explosive device

Example:

vCurrentVehicle = player.get_vehicle()
bHasDevice = rage.vehicle.has_vehicle_phone_explosive_device(vCurrentVehicle)
system.log_debug("Vehicle has explosive device: " .. tostring(bHasDevice))

---

is_taxi_light_on(vehicle)

Checks whether the taxi light is on.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• bool – true if the taxi light is on, false otherwise

  • true – the taxi light is on

  • false – the taxi light is off

Example:

vCurrentVehicle = player.get_vehicle()
bIsTaxiLightOn = rage.vehicle.is_taxi_light_on(vCurrentVehicle)
system.log_debug("Taxi light is on: " .. tostring(bIsTaxiLightOn))

---

is_toggle_mod_on(vehicle, modType)

Checks whether the vehicle mod is turned on (xenon, for example)

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modType (int) – The mod type

  • For mod types, see this: :doc: modTypes

Returns:

• bool

  • true – the mod is turned on

  • false – the mod is turned off

Example:

vCurrentVehicle = player.get_vehicle()
iModType = 22 -- xenon
bIsModOn = rage.vehicle.is_toggle_mod_on(vCurrentVehicle, iModType)
system.log_debug("Mod is on: " .. tostring(bIsModOn))

---

is_vehicle_a_convertible(vehicle, p1)

Checks whether the vehicle is a convertible.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• p1 (bool) – Unknown parameter

  • If false, the function will only return true, when the roof is convertible while pressing INPUT_VEH_ROOF (roof switch button)

  • If true, the function will always return true.

Returns:

• bool

  • true – the vehicle is a convertible

  • false – the vehicle is not a convertible

---

get_is_vehicle_engine_running(vehicle)

Checks whether the vehicle engine is running.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• bool

  • true – the engine is running

  • false – the engine is not running

Example:

vCurrentVehicle = player.get_vehicle()
bIsRunning = rage.vehicle.get_is_vehicle_engine_running(vCurrentVehicle)
system.log_debug("Vehicle engine is running: " .. tostring(bIsRunning))

---

is_vehicle_extra_turned_on(vehicle, extraId)

Note

This function is not yet documented.

---

is_vehicle_model(vehicle, model)

Checks whether the model specified is a vehicle model.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• model (Hash) – The model hash

Returns:

• bool

  • true – the model is a vehicle model

  • false – the model is not a vehicle model

Example:

vCurrentVehicle = player.get_vehicle()
uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")
bIsVehicleModel = rage.vehicle.is_vehicle_model(vCurrentVehicle, uZentornoHash) -- true
system.log_debug("Vehicle model is: " .. tostring(bIsVehicleModel))

---

is_vehicle_neon_light_enabled(vehicle, index)

Checks whether the neon light is enabled on the specified vehicle and side.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• index (int) – The vehicle side index

  • 0 = Left

  • 1 = Right

  • 2 = Front

  • 3 = Back

Returns:

• bool

  • true – the neon light is enabled

  • false – the neon light is not enabled

Example:

vCurrentVehicle = player.get_vehicle()
isNeonOn = rage.vehicle.is_vehicle_neon_light_enabled(vCurrentVehicle, 0) -- left
system.log_debug("Vehicle neon light is on: " .. tostring(isNeonOn)) -- a stock car will always return false

---

is_vehicle_on_all_wheels(vehicle)

Checks whether the vehicle is on all wheels.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• bool

  • true – the vehicle is on all wheels

  • false – the vehicle is not on all wheels

Example:

vCurrentVehicle = player.get_vehicle()
bIsOnWheels = rage.vehicle.is_vehicle_on_all_wheels(vCurrentVehicle)
system.log_debug("Is vehicle on all wheels: " .. tostring(bIsOnWheels))

---

get_is_vehicle_primary_colour_custom(vehicle)

Note

This function is not yet documented.

---

is_vehicle_rocket_boost_active(vehicle)

Checks whether the vehicle rocket boost is active.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• bool

  • true – the rocket boost is active

  • false – the rocket boost is not active

Example:

vCurrentVehicle = player.get_vehicle()
bIsBoostActive = rage.vehicle.is_vehicle_rocket_boost_active(vCurrentVehicle)
system.log_debug("Rocket boost is active: " .. tostring(bIsBoostActive))

---

get_is_vehicle_secondary_colour_custom(vehicle)

Note

This function is not yet documented.

---

is_vehicle_stopped(vehicle)

Checks whether the vehicle is stopped, not moving.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• bool

  • true – the vehicle is stopped

  • false – the vehicle is not stopped

Example:

vCurrentVehicle = player.get_vehicle()
bIsVehicleStopped = rage.vehicle.is_vehicle_stopped(vCurrentVehicle)
system.log_debug("Vehicle is stopped: " .. tostring(bIsVehicleStopped))

---

is_vehicle_stuck_on_roof(vehicle)

Checks whether the vehicle is stuck on the roof, upside down.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• bool

  • true – the vehicle is stuck on the roof

  • false – the vehicle is not stuck on the roof

Example:

vCurrentVehicle = player.get_vehicle()
bIsStuck = rage.vehicle.is_vehicle_stuck_on_roof(vCurrentVehicle)
system.log_debug("Vehicle is stuck on roof: " .. tostring(bIsStuck))

---

modify_vehicle_top_speed(vehicle, value)

Changes the top speed of the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• value (float) – The new top speed

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.modify_vehicle_top_speed(vCurrentVehicle, 1000.0)

---

set_ambient_vehicle_range_multiplier_this_frame(value)

Sets the density on vehicles that are pulling out of driveways and parking spots, crossroads too.

Note

This function has to be called every frame. Use this in a looped function, or use add_task().

Parameters:

• value (float) – The density multiplier

  • 0.0 = No cars

  • 1.0 = Normal density

Returns:

• None

Example:

function noCars()
   rage.vehicle.set_ambient_vehicle_range_multiplier_this_frame(0.0)
end

system.add_task("No Cars", "NC", -1, noCars)

---

set_convertible_roof(vehicle, p1)

Extend or retract the roof of a convertible vehicle.

Note

Seems to only extend the roof, not retract it.

Has to be called every frame.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• p1 (bool) – Whether to extend or retract the roof (seems to be unused)

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_convertible_roof(vCurrentVehicle) -- Extend

---

set_heli_blades_full_speed(vehicle)

Sets the helicopter blades to full speed.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• None

Example:

-- assuming you're in a helicopter
vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_heli_blades_full_speed(vCurrentVehicle)

---

set_heli_blades_speed(vehicle, speed)

Sets the helicopter blades speed.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• speed (float) – The speed of the blades (0 - 100)

Returns:

• None

Example:

-- assuming you're in a helicopter

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_heli_blades_speed(vCurrentVehicle, 50.0) -- half speed

---

set_parked_vehicle_density_multiplier_this_frame(multiplier)

Sets the density for parked vehicles.

Note

This function has to be called every frame. Use this in a looped function, or use add_task().

Parameters:

• multiplier (float) – The density multiplier

  • 0.0 = No cars parked

  • 1.0 = Normal density

Returns:

• None

Example:

rage.vehicle.set_parked_vehicle_density_multiplier_this_frame(0.0) -- no cars

---

set_random_vehicle_density_multiplier_this_frame(multiplier)

Sets the density for random vehicles on the streets.

Note

This function has to be called every frame. Use this in a looped function, or use add_task().

Parameters:

• multiplier (float) – The density multiplier

  • 0.0 = No cars on the roads

  • 1.0 = Normal density

Returns:

• None

Example:

rage.vehicle.set_random_vehicle_density_multiplier_this_frame(0.0) -- no cars

---

set_taxi_lights(vehicle, state)

Sets the taxi lights for a vehicle.

Note

Doesn’t seem to work.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• state (bool)

  • true = On

  • false = Off

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_taxi_lights(vCurrentVehicle, true) -- taxi lights should be on now

---

set_vehicle_brake_lights(vehicle, toggle)

Sets the brake lights for a vehicle.

Note

Doesn’t seem to work. Should be used every frame.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• toggle (bool)

  • true = On

  • false = Off

Returns:

• None

Example:

function lights()
   vCurrentVehicle = player.get_vehicle()
   rage.vehicle.set_vehicle_brake_lights(vCurrentVehicle, true)
   system.wait(-1)
end

iParentID = menu.add_parent("My Lua Script")
menu.add_option("brake lights ON", "light", iParentID, lights)

---

set_vehicle_can_be_locked_on(vehicle, canBeLockedOn, unk)

Sets whether a vehicle can be locked on.

Note

Doesn’t seem to work.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• canBeLockedOn (bool) – Whether the vehicle can be locked on

• unk (bool) – Unknown

Returns:

• None

---

set_vehicle_can_be_visibly_damaged(vehicle, state)

Sets whether the vehicle can be visibly damaged

Parameters:

• vehicle (Vehicle) – The vehicle ID

• state (bool) – Whether the vehicle can be damaged

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_can_be_visibly_damaged(vCurrentVehicle, false) -- vehicle can't be visibly damaged now

---

set_vehicle_custom_primary_colour(vehicle, r, g, b)

Sets the primary custom colour for a vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• r (int) – The red colour value

• g (int) – The green colour value

• b (int) – The blue colour value

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_custom_primary_colour(vCurrentVehicle, 255, 0, 0) -- vehicle is now red

---

set_vehicle_custom_secondary_colour(vehicle, r, g, b)

Sets the secondary custom colour for a vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• r (int) – The red colour value

• g (int) – The green colour value

• b (int) – The blue colour value

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_custom_secondary_colour(vCurrentVehicle, 0, 255, 0) -- secondary vehicle color is now green

---

set_vehicle_deformation_fixed(vehicle)

Sets the vehicle deformation to 0.

Note

This does not repair a vehicle, only restore the texture to its original state.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_deformation_fixed(vCurrentVehicle) -- vehicle deformation is now 0

---

set_vehicle_door_open(vehicle, door, loose, openInstantly)

Sets a vehicle door to open.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• door (int) – The door ID

  • You can find door IDs here: Doors Index

• loose (bool) – Whether the door is loose. In this case, the door won’t close itself after a while.

• openInstantly (bool) – Whether the door should open instantly.

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_door_open(vCurrentVehicle, 5, true, false) -- open the trunk

---

set_vehicle_doors_locked(vehicle, doorLockStatus)

Sets the vehicle doors lock to a certain state.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• doorLockStatus (int) – The door lock status

  • You can find door lock status here: Doors Index

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_doors_locked(vCurrentVehicle, 1) -- vehicle doors are now unlocked

---

set_vehicle_doors_locked_for_all_players(vehicle, toggle)

Sets whether the vehicle doors are locked for all players.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• toggle (bool) – Whether the vehicle doors are locked for all players

  • true – vehicle doors are locked for all players

  • false – vehicle doors are not locked for all players

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_doors_locked_for_all_players(vCurrentVehicle, true) -- vehicle doors are now locked for all players

---

set_vehicle_doors_locked_for_non_script_players(vehicle, toggle)

Sets whether the vehicle doors are locked for non-script players.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• toggle (bool) – Whether the vehicle doors are locked for non-script players

  • true – vehicle doors are locked for non-script players

  • false – vehicle doors are not locked for non-script players

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_doors_locked_for_non_script_players(vCurrentVehicle, true) -- vehicle doors are now locked for non-script players

---

set_vehicle_doors_locked_for_player(vehicle, player, toggle)

Locks or unlocks the vehicle doors for a certain player.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• player (Player) – The player ID

• toggle (bool) – Whether the vehicle doors are locked for the player

  • true – vehicle doors are locked for the player

  • false – vehicle doors are not locked for the player

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
plHandle = player.get_player()
rage.vehicle.set_vehicle_doors_locked_for_player(vCurrentVehicle, plHandle, true) -- vehicle doors are now locked for you

---

set_vehicle_doors_locked_for_team(vehicle, team, toggle)

Locks or unlocks the vehicle doors for a certain team.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• team (int) – The team ID

• toggle (bool) – Whether the vehicle doors are locked for the team

  • true – vehicle doors are locked for the team

  • false – vehicle doors are not locked for the team

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
iPlayerTeam = player.get_player_team()
rage.vehicle.set_vehicle_doors_locked_for_team(vCurrentVehicle, iPlayerTeam, false) -- vehicle doors are now unlocked for your team

---

set_vehicle_doors_shut(vehicle, closeInstantly)

Closes all vehicle doors.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• closeInstantly (bool) – Whether the doors should close instantly.

  • true – doors close instantly

  • false – doors don’t close instantly

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_doors_shut(vCurrentVehicle, true) -- vehicle doors are now closed

---

set_vehicle_engine_health(vehicle, health)

Sets the vehicle engine health.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• health (float) – The engine health value

  • For health values, see this: Vehicle engine health

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_engine_health(vCurrentVehicle, -4000) -- vehicle engine is now broken

---

set_vehicle_engine_on(vehicle, value, instantly, disableAutoStart)

Sets the vehicle engine is on.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• value (bool) – Whether the engine is on

• instantly (bool) – Whether the engine should be turned on instantly

• disableAutoStart (bool) – Disable the engine’s ability to autostart.

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_engine_on(vCurrentVehicle, false, false, true) -- vehicle engine is now false

---

set_vehicle_extra(vehicle, extraId, disable)

Note

This function is not yet documented.

---

set_vehicle_fixed(vehicle)

Repairs the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_fixed(vCurrentVehicle) -- vehicle is now fixed

---

set_vehicle_forward_speed(vehicle, speed)

Sets the vehicle forward speed (boost).

Parameters:

• vehicle (Vehicle) – The vehicle ID

• speed (float) – The vehicle forward speed value

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_forward_speed(vCurrentVehicle, 1000.0) -- vehicle forward speed is now 1000

---

set_vehicle_fullbeam(vehicle, toggle)

Switches the vehicle’s lights to fullbeam.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• toggle (bool) – Toggle

  • true – vehicle lights are in fullbeam mode

  • false – vehicle lights are in normal mode

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_fullbeam(vCurrentVehicle, true) -- vehicle lights are now in fullbeam mode

---

set_vehicle_has_been_owned_by_player(vehicle, owned)

Sets the vehicle as owned by the played

Parameters:

• vehicle (Vehicle) – The vehicle ID

• owned (bool) – Whether the vehicle is owned by the player

  • true – vehicle is owned by the player

  • false – vehicle is not owned by the player

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_has_been_owned_by_player(vCurrentVehicle, true) -- vehicle is now flagged as owned by the player

---

set_vehicle_indicator_lights(vehicle, turnSignal, toggle)

Sets vehicle’s indicator lights on/off

Parameters:

• vehicle (Vehicle) – The vehicle ID

• turnSignal (int) – The turn signal to set

  • 1 – Left turn signal

  • 0 – Right turn signal

• toggle (bool) – Toggle

  • true – turn signal is on

  • false – turn signal is off

Returns:

• None

---

set_vehicle_livery(vehicle, livery)

Sets the vehicle livery.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• livery (int) – The livery ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
iLiveryCount = rage.vehicle.get_vehicle_livery_count(vCurrentVehicle)
iRandomLivery = math.random(iLiveryCount)
rage.vehicle.set_vehicle_livery(vCurrentVehicle, iRandomLivery) -- Random livery set

---

set_vehicle_mod(vehicle, modType, modIndex, customTires)

Modifies the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modType (int) – The modification type

  • For modification types, see this: Vehicle modification types

• modIndex (int) – The modification variation

• customTires (bool) – Whether the mod is a custom tire

Returns:

• None

Example:

Note

There’s no mod variation list. Test, explore.

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_mod(vCurrentVehicle, 0, 2, false) -- Vehicle spoiler variation 2 is now installed.

---

set_vehicle_neon_light_enabled(vehicle, index, toggle)

Toggles neon light on/off

Parameters:

• vehicle (Vehicle) – The vehicle ID

• index (int) – The vehicle side index

  • 0 = Left

  • 1 = Right

  • 2 = Front

  • 3 = Back

• toggle (bool) – Toggle

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_neon_light_enabled(vCurrentVehicle, 0, true) -- Left neon light is now on

---

set_vehicle_number_plate_text(vehicle, plateText)

Sets the vehicle number plate text.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• plateText (string) – The number plate text

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_number_plate_text(vCurrentVehicle, "JOHN117") -- Vehicle number plate is now "JOHN117"

---

set_vehicle_on_ground_properly(vehicle, p1)

Sets a vehicle on the ground on all wheels.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• p1 (float) – Unknown. Set to 5.0.

Returns:

• bool – Whether the vehicle was set on the ground successfully

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_on_ground_properly(vCurrentVehicle, 5.0) -- Vehicle is now on the ground

---

set_vehicle_out_of_control(vehicle, killDriver, explodeOnImpact)

Sets the vehicle out of control.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• killDriver (bool) – Whether to kill the driver

• explodeOnImpact (bool) – Whether to explode the vehicle on impact

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_out_of_control(vCurrentVehicle, true, true) -- Vehicle is now out of control with dead driver, set to explode on impact.

---

set_vehicle_parachute_active(vehicle, active)

Sets the vehicle’s parachute active. Ruiner 2000 is the only vehicle with the parachute.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• active (bool) – Whether the parachute is active

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_parachute_active(vCurrentVehicle, true) -- Parachute is now active

---

set_vehicle_parachute_model(vehicle, modelHash)

Sets parachute model for a vehicle

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modelHash (Hash) – The model hash

  • sr_prop_specraces_para_s_01

  • imp_prop_impexp_para_s (SecuroServ; Default)

  • Plus, many more props can be used as vehicle parachutes, like umbrellas (prop_beach_parasol_03)

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
uUmbrellaHash = rage.gameplay.get_has_key("prop_beach_parasol_03")
rage.vehicle.set_vehicle_parachute_model(vCurrentVehicle, uUmbrellaHash) -- Parachute is now an umbrella

---

set_vehicle_reduce_grip(vehicle, toggle)

Sets the vehicle’s grip to be significantly reduced.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• toggle (bool) – Whether to reduce the grip or not

  • true = Reduce the grip

  • false = Don’t reduce the grip

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_reduce_grip(vCurrentVehicle, true) -- Vehicle grip is now reduced

---

set_vehicle_rocket_boost_active(vehicle, active)

Sets the vehicle’s rocket boost active.

Note

Can only be used on the vehicles with rocket boosters.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• active (bool) – Boost toggle

  • true = Boost is active

  • false = Boost is inactive

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_rocket_boost_active(vCurrentVehicle, true) -- Rocket boost is now active

---

set_vehicle_rocket_boost_percentage(vehicle, percentage)

Sets the vehicle’s rocket boost fill percentage. .. note:

Can only be used on the vehicles with rocket boosters.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• percentage (float) – The percentage of boost “progress”

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_rocket_boost_percentage(vCurrentVehicle, 0.5) -- Rocket boost is now 50% filled

---

set_vehicle_rocket_boost_refill_time(vehicle, seconds)

Sets the vehicle’s rocket boost refill time.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• seconds (float) – Time in seconds

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_rocket_boost_refill_time(vCurrentVehicle, 0.5) -- Rocket boost will refill in a half a second

---

set_vehicle_steer_bias(vehicle, value)

Locks the vehicle’s steering to the desired angle.

Note

Needs to be called every frame.

Steering is unlocked the moment the function stops being called on the vehicle.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• value (float) – The steering angle

  • -1.0 – full right

  • 0.0 – centered steering

  • 1.0 – full left

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_steer_bias(vCurrentVehicle, 1.0) -- Vehicle steering set to full left.

---

set_vehicle_timed_explosion(vehicle, ped, toggle)

Sets a timed explosion for a vehicle

Note

Doesn’t seem to work.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• ped (Ped) – The ped ID, probably driver

• toggle (bool) – Toggle timed explosion

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
pSelfPed = player.get_ped()
rage.vehicle.set_vehicle_timed_explosion(vCurrentVehicle, pSelfPed, true)

---

set_vehicle_undriveable(vehicle, toggle)

Sets a vehicle as undriveable.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• toggle (bool) – Toggle

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_undriveable(vCurrentVehicle, true) -- Vehicle is now undriveable

---

set_vehicle_wheel_type(vehicle, wheelType)

Sets the vehicle’s wheel type.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• wheelType (int) – The wheel type

  • For wheel types, see Vehicle wheel types

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_wheel_type(vCurrentVehicle, 0) -- vehicle now has sport wheel type

---

set_vehicle_window_tint(vehicle, tint)

Sets the vehicle’s window tint.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• tint (int) – The tint ID

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_window_tint(vCurrentVehicle, 6) -- vehicle now has green tint

---

start_vehicle_horn(vehicle, duration, mode, forever)

Sounds the horn for the specified vehicle.

Note

If a player is in the vehicle, it will only sound briefly.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• duration (float) – The duration of the horn in seconds

• mode (Hash) – The horn mode

  • NORMAL – Normal horn

  • HELDDOWN

  • 0

• forever (bool) – If true, the horn will sound forever

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
uHornModeHash = rage.gameplay.get_hash_key("NORMAL")
rage.vehicle.start_vehicle_horn(vCurrentVehicle, 10.0, uHornModeHash, false) -- vehicle now sounds its horn for 10 seconds

---

toggle_vehicle_mod(vehicle, modType, toggle)

Toggles a vehicle mod on/off.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• modType (int) – The mod type

  • For mod types, see Vehicle modification types

• toggle (bool) – Toggle

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.toggle_vehicle_mod(vCurrentVehicle, 22, true) -- xenon headlights on

---

set_vehicle_cheat_power_increase(vehicle, value)

Sets the vehicle’s torque value.

Note

Negative values will cause the vehicle to go backwards instead of forwards while accelerating.

This has to be called every frame.

Parameters:

• vehicle (Vehicle) – The vehicle ID

• value (float) – The torque value

  • Less than 1.0 – Decreased torque

  • 1.0 – Default torque

  • More than 1.0 – Increased torque

Returns:

• None

Example:

vCurrentVehicle = player.get_vehicle()
rage.vehicle.set_vehicle_cheat_power_increase(vCurrentVehicle, 1.0) -- vehicle torque set to default

---

Entity namespace

This namespace contains entity-related game functions.

---

apply_force_to_entity(entity, forceFlags, x, y, z, offX, offY, offZ, boneIndex, isDirectionRel, ignoreUpVec, isForceRel, p12, p13)

Applies a force to the specified entity.

Parameters:

• entity (Entity) – The entity handle

• forceFlags (int) – Commonly used values:

  • MinForce = 0

  • MaxForceRot = 1

  • MinForce2 = 2

  • MaxForceRot2 = 3

  • ForceNoRot = 4

  • ForceRotPlusForce = 5

• x (float) – Force amount (X)

• y (float) – Force amount (Y)

• z (float) – Force amount (Z)

• offX (float) – Rotation/offset force (X)

• offY (float) – Rotation/offset force (Y)

• offZ (float) – Rotation/offset force (Z)

• boneIndex (int) – Entity bone index (Often 0)

• isDirectionRel (bool) – Vector defined in local (body-fixed) coordinate frame (Usually false)

• ignoreUpVec (bool) – Usually true

• isForceRel (bool)

  • true – Force Returns multiplied with the objects mass and different objects will have the same acceleration

  • false – Otherwise

• p12 (bool) – Unknown, usually false

• p13 (bool) – Unknown, usually true

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.apply_force_to_entity(pSelfPed, 1, 10, 10, 10, 0, 0, 0, 0, false, true, true, false, true)

---

attach_entity_to_entity(entity1, entity2, boneIndex, xPos, yPos, zPos, xRot, yRot, zRot, p9, useSoftPinning, collision, isPed, vertexIndex, fixedRot)

Attach an entity to the specified entity.

Parameters:

• entity1 (Entity) – The entity handle.

• entity2 (Entity) – Entity ID to attach entity1 with.

• boneIndex (int) – This is different to boneID, use get_ped_bone_index to get the index from the ID. use the index for attaching to specific bones. entity1 will be attached to the center of entity2 if bone index given doesn’t correspond to bone indexes for that entity type.

• xPos (float) – X-axis offset from the center of entity2.

• yPos (float) – Y-axis offset from the center of entity2.

• zPos (float) – Z-axis offset from the center of entity2.

• xRot (float) – X-axis rotation.

• yRot (float) – Y-axis rotation.

• zRot (float) – Z-axis rotation.

• p9 (bool) – Unknown. Does not seem to have any effect.

• useSoftPinning (bool) – If set to false attached entity will not detach when fixed.

• collision (bool) – Controls collision between the two entities

  • true – Collision enabled

  • false – Collision disabled

• isPed (bool) – Pitch doesnt work when false and roll will only work on negative numbers (only peds)

• vertexIndex (int) – The order in which the rotation is applied.

• fixedRot (bool) – If false, it ignores entity vector.

Returns:

• None

Example:

pSelfPed = player.get_ped()
plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)

iBoneIndex = rage.ped.get_ped_bone_index(entity2, 1)

rage.entity.attach_entity_to_entity(pSelfPed, pHostPed, iBoneIndex, 10, 10, 10, 1, 1, 0, false, true, true, 1, true)

---

delete_entity(entity)

Deletes a specified entity.

Parameters:

• entity (Entity) – The entity ID

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.delete_entity(pSelfPed)

---

detach_entity(entity, dynamic, collision)

Detaches a specified entity, with toggable options.

Parameters:

• entity (Entity) – The entity ID

• dynamic (bool) – no effect

• collision (bool)

  • true – both entities won’t collide with each other until the distance between is 4 meters or more. (may not work with some entities)

  • false – entities will collide with each other.

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.detach_entity(pSelfPed, false, true)

---

does_entity_have_drawable(entity)

Checks whether an entity has a drawable (weapon?).

Note

Seems to be always returning 0 no matter what the entity is or does it have a weapon (could be even a car, still true.)

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity drawable (weapon?) status

  • true – Entity has a drawable weapon (always?)

  • false – Entity does not have a drawable weapon

Example:

pSelfPed = player.get_ped()
bDoesHaveDrawable = rage.entity.does_entity_have_drawable(pSelfPed)

system.log_debug(tostring(bDoesHaveDrawable))

---

does_entity_have_physics(entity)

Checks whether an entity has physics enabled.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity physics status

  • true – Entity has physics enabled

  • false – Entity does not have physics enabled

Example:

pSelfPed = player.get_ped()
bDoesHavePhysics = rage.entity.does_entity_have_physics(pSelfPed)
system.log_debug(tostring(bDoesHavePhysics))

---

freeze_entity_position(entity, toggle)

Toggles freeze entity position.

Parameters:

• entity (Entity) – The entity ID

• toggle (bool) – Toggle

  • true – Freeze entity position on

  • false – Freeze entity position off

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.freeze_entity_position(pSelfPed, true)

---

get_entity_attached_to(entity)

Returns the entity that this entity is attached to.

Parameters:

• entity (Entity) – The entity ID

Returns:

• Entity – The attached entity handle. 0 returned if the entity is not attached.

Example:

pSelfPed = player.get_ped()

eAttached = rage.entity.get_entity_attached_to(pSelfPed)

system.log_debug(tostring(eAttached))

---

get_entity_bone_index_by_name(entity, boneName)

Returns the entity bone ID by name.

Parameters:

• entity (Entity) – The entity ID

• boneName (string) – Bone identifier

  • You can find out more about bones here: bones

Returns:

• int – The index of the bone.

Example:

pSelfPed = player.get_ped()

iBoneIndex = rage.entity.get_entity_bone_index_by_name(pSelfPed, "SKEL_L_Forearm")

system.log_debug(tostring(iBoneIndex))

---

get_entity_coords(entity, alive)

Returns the current coordinates for a specified entity.

Parameters:

• entity (Entity) – The entity ID

• alive (bool) – Checks whether an entity is alive

  • true – Entity is alive (optional)

  • false – Entity is dead

Returns:

• Vector3 – The current entity coordinates.

Example:

pSelfPed = player.get_ped()
v3EntityCoords = rage.entity.get_entity_coords(pSelfPed)
system.log_debug(tostring(v3EntityCoords.x) .. " " .. tostring(v3EntityCoords.y) .. " " .. tostring(v3EntityCoords.z))

---

get_entity_forward_vector(entity)

Returns the entity’s forward vector.

Parameters:

• entity (Entity) – The entity ID

Returns:

• Vector3 – The forward vector. X, Y and Z range from -1 to 1.

Example:

pSelfPed = player.get_ped()

v3ForwardVector = rage.entity.get_entity_forward_vector(pSelfPed)

system.log_debug(tostring(v3ForwardVector))

---

get_entity_heading(entity)

Returns the entity’s heading.

Parameters:

• entity (Entity) – The entity ID

Returns:

• float – The entity’s heading.

Example:

pSelfPed = player.get_ped()

fEntityHeading = rage.entity.get_entity_heading(pSelfPed)

system.log_debug(tostring(fEntityHeading))

---

get_entity_physics_heading(entity)

Returns the entity’s physics heading.

Parameters:

• entity (Entity) – The entity ID

Returns:

• float – The entity’s physics heading.

Example:

pSelfPed = player.get_ped()

fEntityPhysicsHeading = rage.entity.get_entity_physics_heading(pSelfPed)

system.log_debug(tostring(fEntityPhysicsHeading))

---

get_entity_pitch(entity)

Returns the entity’s pitch.

Parameters:

• entity (Entity) – The entity ID

Returns:

• float – The entity’s pitch.

Example:

pSelfPed = player.get_ped()

fEntityPitch = rage.entity.get_entity_pitch(pSelfPed)

system.log_debug(tostring(fEntityPitch))

---

get_entity_population_type(entity)

Returns the entity’s population type.

Parameters:

• entity (Entity) – The entity ID

Returns:

• int – the entity’s population type

  • POPTYPE_UNKNOWN = 0

  • POPTYPE_RANDOM_PERMANENT = 1

  • POPTYPE_RANDOM_PARKED = 2

  • POPTYPE_RANDOM_PATROL = 3

  • POPTYPE_RANDOM_SCENARIO = 4

  • POPTYPE_RANDOM_AMBIENT = 5

  • POPTYPE_PERMANENT = 6

  • POPTYPE_MISSION = 7

  • POPTYPE_REPLAY = 8

  • POPTYPE_CACHE = 9

  • POPTYPE_TOOL = 10

Example:

pSelfPed = player.get_ped()

bPopulationType = rage.entity.get_entity_population_type(pSelfPed)

system.log_debug(tostring(bPopulationType))

---

get_entity_roll(entity)

Returns the entity’s roll.

Parameters:

• entity (Entity) – The entity ID

Returns:

• float – The entity’s roll

Example:

pSelfPed = player.get_ped()

fRoll = rage.entity.get_entity_roll(pSelfPed)

system.log_debug(tostring(fRoll))

---

get_entity_rotation(entity, rotationOrder)

Returns the entity rotation.

Parameters:

• entity (Entity) – The entity ID

• rotationOrder (int) – The order yaw, pitch and roll is applied. Usually 2.

Returns:

• Vector3 – A vector where the Z coordinate is the yaw.

Example:

pSelfPed = player.get_ped()

v3EntityRotation = rage.entity.get_entity_rotation(pSelfPed, 2)

system.log_debug(tostring(v3EntityRotation.x) .. " " .. tostring(v3EntityRotation.y) .. " " .. tostring(v3EntityRotation.z))

---

get_entity_rotation_velocity(entity)

Returns the entity rotation velocity.

Parameters:

• entity (Entity) – The entity ID

Returns:

• Vector3 – A vector where the Z coordinate is the rotation velocity.

Example:

pSelfPed = player.get_ped()

v3EntityRotationVelocity = rage.entity.get_entity_rotation_velocity(pSelfPed)

system.log_debug(tostring(v3EntityRotationVelocity.x) .. " " .. tostring(v3EntityRotationVelocity.y) .. " " .. tostring(v3EntityRotationVelocity.z))

---

get_entity_speed(entity)

Returns the entity’s speed.

Parameters:

• entity (Entity) – The entity ID

Returns:

• float – The entity’s speed

Example:

pSelfPed = player.get_ped()

fSpeed = rage.entity.get_entity_speed(pSelfPed)

system.log_debug(tostring(fSpeed))

---

get_entity_submerged_level(entity)

Returns the entity’s submerged level.

Parameters:

• entity (Entity) – The entity ID

Returns:

• float – The entity’s submerged level

Example:

pSelfPed = player.get_ped()
fSubmergedLevel = rage.entity.get_entity_submerged_level(pSelfPed)
system.log_debug(tostring(fSubmergedLevel))

---

get_entity_type(entity)

Returns the entity type.

Parameters:

• entity (Entity) – The entity ID

Returns:

• int – The entity type ID as following:

  • 0 = no entity

  • 1 = ped

  • 2 = vehicle

  • 3 = object

Example:

pSelfPed = player.get_ped()
iEntityType = rage.entity.get_entity_type(pSelfPed)

system.log_debug(tostring(iEntityType))

---

get_entity_velocity(entity)

Returns the entity velocity.

Parameters:

• entity (Entity) – The entity ID

Returns:

• Vector3 – A vector where the Z coordinate is the velocity.

Example:

pSelfPed = player.get_ped()
v3EntityVelocity = rage.entity.get_entity_velocity(pSelfPed)

system.log_debug(tostring(v3EntityVelocity.x) .. " " .. tostring(v3EntityVelocity.y) .. " " .. tostring(v3EntityVelocity.z))

---

has_entity_been_damaged_by_any_object(entity)

Checks whether an entity has been damaged by any object.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – The entity damage status

  • true – Entity has been damaged by an object

  • false – Entity has not been damaged by an object

Example:

pSelfPed = player.get_ped()
bHasBeenDamaged = rage.entity.has_entity_been_damaged_by_any_object(entity)
system.log_debug(tostring(bHasBeenDamaged))

---

has_entity_been_damaged_by_any_ped(entity)

Checks whether an entity has been damaged by any ped.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – The entity damage status

  • true – Entity has been damaged by a ped

  • false – Entity has not been damaged by a ped

Example:

pSelfPed = player.get_ped()
bHasBeenDamagedByPed = rage.entity.has_entity_been_damaged_by_any_ped(bHasBeenDamaged)

system.log_debug(tostring(bHasBeenDamagedByPed))

---

has_entity_been_damaged_by_any_vehicle(entity)

Checks whether an entity has been damaged by any vehicle.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity damage status

  • true – Entity has been damaged by a vehicle

  • false – Entity has not been damaged by a vehicle

Example:

pSelfPed = player.get_ped()

bHasBeenDamagedByVehicle = rage.entity.has_entity_been_damaged_by_any_vehicle(pSelfPed)

system.log_debug(tostring(bHasBeenDamagedByVehicle))

---

has_entity_been_damaged_by_entity(entity)

Checks whether an entity has been damaged by another entity.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity damage status

  • true – Entity has been damaged by another entity

  • false – Entity has not been damaged by another entity

Example:

pSelfPed = player.get_ped()

bHasBeenDamagedByEntity = rage.entity.has_entity_been_damaged_by_entity(pSelfPed)
system.log_debug(tostring(bHasBeenDamagedByEntity))

---

has_entity_collided_with_anything(entity)

Checks whether an entity has collided with anything.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity collision status

  • true – Entity has collided with anything

  • false – Entity has not collided with anything

Example:

pSelfPed = player.get_ped()

bHasCollided = rage.entity.has_entity_collided_with_anything(pSelfPed)

system.log_debug(tostring(bHasCollided))

---

is_an_entity(handle)

Checks whether an ScrHandle is an entity.

Parameters:

• handle (ScrHandle) – The handle ID

Returns:

• bool – Entity status

  • true – The ScrHandle is an entity

  • false – The ScrHandle is not an entity

Example:

pSelfPed = player.get_ped()

bIsEntity = rage.entity.is_an_entity(pSelfPed)

system.log_debug(tostring(bIsEntity))

---

is_entity_a_ped(entity)

Checks whether an entity is a ped.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is a ped

  • false – Entity is not a ped

Example:

pSelfPed = player.get_ped()

bIsPed = rage.entity.is_entity_a_ped(pSelfPed)

system.log_debug(tostring(bIsPed))

---

is_entity_a_vehicle(entity)

Checks whether an entity is a vehicle.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is a vehicle

  • false – Entity is not a vehicle

Example:

pSelfPed = player.get_ped()

bIsVehicle = rage.entity.is_entity_a_vehicle(pSelfPed)

system.log_debug(tostring(bIsVehicle))

---

is_entity_an_object(entity)

Checks whether an entity is an object.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is an object

  • false – Entity is not an object

Example:

pSelfPed = player.get_ped()

bIsObject = rage.entity.is_entity_an_object(pSelfPed)

system.log_debug(tostring(bIsObject))

---

is_entity_attached(entity)

Checks whether an entity is attached to anything.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is attached

  • false – Entity is not attached

Example:

pSelfPed = player.get_ped()

bIsAttached = rage.entity.is_entity_attached(pSelfPed)

system.log_debug(tostring(bIsAttached))

---

is_entity_dead(entity, p1)

Checks whether an entity is dead.

Parameters:

• entity (Entity) – The entity ID

• p1 (bool) – Unknown

Returns:

• bool – Entity status

  • true – Entity is dead

  • false – Entity is alive

Example:

pSelfPed = player.get_ped()

bIsDead = rage.entity.is_entity_dead(pSelfPed, true)

system.log_debug(tostring(bIsDead))

---

is_entity_in_air(entity)

Checks whether an entity is in air.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is in air

  • false – Entity is not in air

Example:

pSelfPed = player.get_ped()

bIsInAir = rage.entity.is_entity_in_air(pSelfPed)

system.log_debug(tostring(bIsInAir))

---

is_entity_in_water(entity)

Checks whether an entity is in water.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is in water

  • false – Entity is not in water

Example:

pSelfPed = player.get_ped()

bIsInWater = rage.entity.is_entity_in_water(pSelfPed)

system.log_debug(tostring(bIsInWater))

---

is_entity_in_zone(entity, zone)

Checks whether an entity is in a specified zone

Parameters:

• entity (Entity) – The entity ID

• zone (string) – The zone name

  • You can read more about zone names here: Zones

Returns:

• bool – Entity status

  • true – Entity is in the specified zone

  • false – Entity is not in the specified zone

Example:

pSelfPed = player.get_ped()

bIsInZone = rage.entity.is_entity_in_zone(pSelfPed, "AirP")

system.log_debug(tostring(bIsInZone))

---

is_entity_on_fire(entity)

Checks whether an entity is on fire.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is on fire

  • false – Entity is not on fire

Example:

pSelfPed = player.get_ped()

bIsOnFire = rage.entity.is_entity_on_fire(pSelfPed)

system.log_debug(tostring(bIsOnFire))

---

is_entity_static(entity)

Checks whether an entity is static.

Note

A static ped will not react to native functions like rage.entity.apply_force_to_entity or rage.entity.set_entity_velocity. The only way to make them react to something is to ragdoll them or use rage.ped.clear_ped_tasks_immediately. Static peds include almost all far-away peds, beach-combers, peds in certain scenarios, peds crossing a crosswalk, peds walking to get back into their cars, and others.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is static

  • false – Entity is not static

Example:

pSelfPed = player.get_ped()

bIsStatic = rage.entity.is_entity_static(pSelfPed)

system.log_debug(tostring(bIsStatic))

---

is_entity_upright(entity, angle)

Checks whether an entity is upright a specified angle.

Parameters:

• entity (Entity) – The entity ID

• angle (float) – The angle value

Returns:

• bool – Entity status

  • true – Entity is upright at the specified angle

  • false – Entity is not upright at the specified angle

Example:

pSelfPed = player.get_ped()

bIsUpright = rage.entity.is_entity_upright(pSelfPed, 0.0)

system.log_debug(tostring(bIsUpright))

---

is_entity_visible(entity)

Checks whether an entity is visible.

Parameters:

• entity (Entity) – The entity ID

Returns:

• bool – Entity status

  • true – Entity is visible

  • false – Entity is not visible

Example:

pSelfPed = player.get_ped()

bIsVisible = rage.entity.is_entity_visible(pSelfPed)

system.log_debug(tostring(bIsVisible))

---

reset_entity_alpha(entity)

Resets given entity alpha.

Parameters:

• entity (Entity) – The entity ID

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.reset_entity_alpha(pSelfPed)

---

set_entity_alpha(entity, alphaLevel, skin)

Sets the entity’s alpha level.

Parameters:

• entity (Entity) – The entity ID

• alphaLevel (int) – The alpha level ranges from 0 to 255, but changes occur every 20% (every 51).

• skin (bool) – Whether or not to change the alpha of the entity’s skin.

  • true – Change alpha of the entity’s skin

  • false – Do not change alpha of the entity’s skin

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_alpha(pSelfPed, 51, false)

---

set_entity_as_mission_entity(entity, p1, p2)

Makes the specified entity (ped, vehicle or object) persistent. Persistent entities will not automatically be removed by the engine.

Parameters:

• entity (Entity) – The entity ID

• p1 (bool) – Unknown. Doesn’t seem to do anything.

• p2 (bool) – Unknown. Doesn’t seem to do anything.

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_as_mission_entity(pSelfPed)

---

set_entity_as_no_longer_needed(entity)

Marks the specified entity (ped, vehicle or object) as no longer needed.

Note

Entities marked as no longer needed, will be deleted as the engine sees fit.

Parameters:

• entity (Entity) – The entity ID

• xPos (float) – The X coordinate

• yPos (float) – The Y coordinate

• zPos (float) – The Z coordinate

• xAxis (bool) – Toggle X axis on/off

• yAxis (bool) – Toggle Y axis on/off

• zAxis (bool) – Toggle Z axis on/off

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_as_no_longer_needed(pSelfPed)

---

set_entity_heading(entity, heading)

Sets the heading of an entity in degrees also known as “Yaw”.

Parameters:

• entity (Entity) – The entity ID

• xPos (float) – The heading in degrees.

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_heading(pSelfPed, 90)

---

set_entity_lights(entity, toggle)

Toggles entity’s lights on/off.

Parameters:

• entity (Entity) – The entity ID

• toggle (bool) – Toggle

  • true – Lights on

  • false – Lights off

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_lights(pSelfPed, true)

---

set_entity_max_speed(entity, speed)

Sets the entity’s max speed.

Parameters:

• entity (Entity) – The entity ID

• speed (float) – The max speed to set for the entity

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_max_speed(pSelfPed, 250)

---

set_entity_no_collision_entity(entity1, entity2, thisFrameOnly)

Sets collision state between two entities.

Note

Has to be called twice (once for each entity)

Note

Has to be called twice (once for each entity)

Parameters:

• entity1 (Entity) – The first entity ID

• entity2 (Entity) – The second entity ID

• thisFrameOnly (bool) – Decides when to disable the collision

  • true – Disabled until it is turned back on

  • false – Disabled just this frame

Returns:

• None

Example:

pSelfPed = player.get_ped()

pHostPed = lobby.get_player_ped(lobby.get_host())

rage.entity.set_entity_no_collision_entity(pSelfPed, pHostPed, true)
rage.entity.set_entity_no_collision_entity(pHostPed, pSelfPed, true)

---

set_entity_rotation(entity, pitch, roll, yaw, rotationOrder, p5)

Sets the entity’s rotation with customizable options.

Parameters:

• entity (Entity) – The entity ID

• pitch (float) – Rotation pitch

• roll (float) – Rotation roll

• yaw (float) – Rotation yaw

• rotationOrder (int) – Rotation order

• p5 (bool) – Unknown, usually set to true

Note

What you use for rotationOrder when setting must be the same as rotationOrder when getting the rotation. For the most part R* uses 1 or 2 as the order, overall value ranges from 0 to 5.

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_rotation(pSelfPed, 10, 2, 5, 1)

---

set_entity_velocity(entity, x, y, z)

Sets the entity velocity.

Parameters:

• entity (Entity) – The entity ID

• x (float) – The X vector coordinate

• y (float) – The Y vector coordinate

• z (float) – The Z vector coordinate

  • Note that z is “up and down” with positive numbers encouraging upwards movement.

Returns:

• None

Example:

pSelfPed = player.get_ped()
v3ForwardVector = rage.entity.get_entity_forward_vector(pSelfPed)
rage.entity.set_entity_velocity(pSelfPed, v3ForwardVector.x, v3ForwardVector.y, v3ForwardVector.z)

---

set_entity_visible(entity, toggle, unk)

Toggles the visibility of a given entity.

Parameters:

• entity (Entity) – The entity ID

• toggle (bool) – Whether or not the entity will be visible

  • true – Entity is visible

  • false – Entity is not visible

• unk (bool) – Always 0 in scripts

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.entity.set_entity_visible(pSelfPed, true)

---

get_entity_model(entity)

Returns the model hash of the given entity.

Parameters:

• entity (Entity) – The entity ID

Returns:

• Hash – The model hash

Example:

pSelfPed = player.get_ped()

uEntityModel = rage.entity.get_entity_model(pSelfPed)
uFreemodeModel = rage.gameplay.get_hash_key("mp_f_freemode_01")

if uEntityModel == uFreemodeModel then
   system.log_debug("This entity has a freemode model")
end

---

Object namespace

This namespace contains object-related game functions.

---

create_object(modelHash, x, y, z, isNetwork, bScriptHostObj, dynamic)

Creates an object (prop) with the specified model at the specified position.

Parameters:

• modelHash (Hash) – The model to spawn.

  • Models here

• x (float) – Spawn coordinate X component.

• y (float) – Spawn coordinate Y component.

• z (float) – Spawn coordinate Z component.

• isNetwork (bool) – Whether to create a network object for the object.

  • true to create a network object for the object

  • false to create a local object for the object. In this case, the object exists only locally.

• bScriptHostObj (bool) – Whether to register the object as pinned to the script host in the R* network model.

• dynamic (bool) – False to create a door archetype (archetype flag bit 26 set) as a door. Required to be set to true to create door models in network mode.

Returns:

• Object – An object ID.

Example:

uModelHash = rage.gameplay.get_hash_key("apa_mp_apa_crashed_usaf_01a") -- https://gta-objects.xyz/objects/apa_mp_apa_crashed_usaf_01a
oObjectID = rage.object.create_object(uModelHash, 0.0, 0.0, 0.0, true, false, false)
system.log_debug("Object ID: " .. tostring(oObjectID))

---

Weapon namespace

This namespace contains weapon-related game functions.

---

get_max_ammo(ped, weaponHash)

Gets ped max ammo for a weapon.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

Returns:

• bool

  • true – Max ammo has been given

  • false – Max ammo hasn’t been given

Example:

pSelfPed = player.get_ped()

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

rage.weapon.get_max_ammo(pSelfPed, uWeaponHash) -- Gives session host a fully loaded MicroSMG

---

get_ped_ammo_type_from_weapon(ped, weaponHash)

Gets ammo type from a specific weapon of a ped.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

Returns:

• Hash – Ammo type hash

Example:

plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)

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

rage.weapon.get_ped_ammo_type_from_weapon(pHostPed, uWeaponHash) -- Returns ammo type from session's host MicroSMG

---

get_ammo_in_clip(ped, weaponHash)

Returns current ammo amount in the clip.

Parameters:

• ped (Ped) – Ped ID

• weaponHash (Hash) – Game hash of the weapon

Returns:

• int – ammo count

**Example:*

pSelfPed = player.get_ped()
uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")
iAmmoCount = rage.weapon.get_ammo_in_clip(pSelfPed, uWeaponHash)
system.log_debug(tostring(iAmmoCount))

---

get_ammo_in_ped_weapon(ped, weaponHash)

Returns current ammo amount in the ped’s weapon.

Parameters:

• ped (Ped) – Ped ID

• weaponHash (Hash) – Game hash of the weapon

Returns:

• int – ammo count

**Example:*

pSelfPed = player.get_ped()
uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")
iAmmoCount = rage.weapon.get_ammo_in_ped_weapon(pSelfPed, uWeaponHash)
system.log_debug(tostring(iAmmoCount))

---

get_ped_weapon_tint_index(ped, weaponHash)

Gets weapon tint ID from a ped.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

Returns:

• int – Weapon tint ID

Example:

pSelfPed = player.get_ped()

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

rage.weapon.get_ped_weapon_tint_index(pSelfPed, uWeaponHash) -- Returns weapon tint ID from session's host MicroSMG

---

get_ped_weapon_tint_count(weaponHash)

Gets weapon tint count.

Parameters:

• weaponHash (Hash) – Weapon Whash

Returns:

• int – Weapon tint count

Example:

uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")
rage.weapon.get_ped_weapon_tint_count(uWeaponHash) -- Returns weapon tint count from session's host MicroSMG

---

give_delayed_weapon_to_ped(ped, weaponHash, ammoCount, bForceInHand)

Gives a weapon to PED with a delay.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

• ammoCount (int) – Ammo count

• bForceInHand (bool) – Togglable force in hand

  • true – Equip now

  • false – Don’t equip

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

rage.weapon.give_delayed_weapon_to_ped(pSelfPed, uWeaponHash, 100, true)

---

give_weapon_component_to_ped(ped, weaponHash, componentHash)

Give a weapon component to a ped.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

• componentHash (Hash) – Weapon component Chash

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

uComponentHash = rage.gameplay.get_hash_key("COMPONENT_MICROSMG_CLIP_02")

rage.weapon.give_delayed_weapon_to_ped(pSelfPed, uWeaponHash, uComponentHash) -- Gives extended clip component to your MicroSMG

---

has_ped_got_weapon(ped, weaponHash, p2)

Checks whether a ped has got a weapon.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

• p2 (bool) – Should always be false, otherwise the function always returns false

Returns:

• bool

  • true – Ped has got the weapon

  • false – Ped doesn’t have the weapon

Example:

pSelfPed = player.get_ped()

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

rage.weapon.has_ped_got_weapon(pSelfPed, uWeaponHash, true) -- Checks whether the player has got MicroSMG

---

has_ped_got_weapon_component(ped, weaponHash, componentHash)

Checks whether a ped’s weapon has got a component.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

• componentHash (Hash) – Weapon component Chash

Returns:

• bool

  • true – Ped’s weapon has got component

  • false – Ped’s weapon doesn’t have the component

Example:

pSelfPed = player.get_ped()

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

uComponentHash = rage.gameplay.get_hash_key("COMPONENT_MICROSMG_CLIP_02")

rage.weapon.has_ped_got_weapon_component(pSelfPed, uWeaponHash, uComponentHash) -- Checks whether your MicroSMG has got Extended Clip

---

remove_all_ped_weapons(ped, p1)

Remove all ped’s weapons.

Parameters:

• ped (Ped) – The ped

• p1 (bool) – The value doesn’t seem to matter.

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.weapon.remove_all_ped_weapons(pSelfPed, true) -- Removes all your weapons

---

remove_weapon_component_from_ped(ped, weaponHash, componentHash)

Remove component from a ped’s weapon.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

• componentHash (Hash) – Weapon component Chash

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

uComponentHash = rage.gameplay.get_hash_key("COMPONENT_MICROSMG_CLIP_02")

rage.weapon.remove_weapon_component_from_ped(pSelfPed, uWeaponHash, uComponentHash) -- Removes Extended Clip from your MicroSMG

---

remove_weapon_from_ped(ped, weaponHash)

Remove a weapon from a ped.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

rage.weapon.remove_weapon_from_ped(pSelfPed, uWeaponHash) -- Removes MicroSMG

---

set_ped_ammo(ped, weaponHash, ammo, p3)

Set ped ammo amount.

Note

This function is still in development.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

• ammo (int) –

• p3 (bool) –

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

rage.weapon.set_ped_ammo(pSelfPed, uWeaponHash, 100, true)

---

set_ped_ammo_by_type(ped, ammoTypeHash, ammo)

Set ped ammo by type.

Note

This function is still in development.

Parameters:

• ped (Ped) – The ped

• ammoTypeHash (Hash) – Weapon ammo hash

  • You can read more about ammo types here: Ammo types

• ammo (int) – Ammo Type

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

iAmmoType = rage.weapon.get_ped_ammo_type_from_weapon(pSelfPed, uWeaponHash) -- Get ammo type from MicroSMG

rage.weapon.set_ped_ammo_by_type(pSelfPed, iAmmoType, 100) -- Set self ammo type

---

set_ped_weapon_tint_index(ped, weaponHash, tintIndex)

Set ped weapon tint ID.

Parameters:

• ped (Ped) – The ped

• weaponHash (Hash) – Weapon Whash

• tintIndex (int) – Weapon tint ID

  • tintIndex can be the following:

    • Default/Black = 0

    • Green = 1

    • Gold = 2

    • Pink = 3

    • Army = 4

    • LSPD = 5

    • Orange = 6

    • Platinum = 7

  • tineIndex for MK2 weapons:

    • Classic Black = 0

    • Classic Gray = 1

    • Classic Two-Tone = 2

    • Classic White = 3

    • Classic Beige = 4

    • Classic Green = 5

    • Classic Blue = 6

    • Classic Earth = 7

    • Classic Brown & Black = 8

    • Red Contrast = 9

    • Blue Contrast = 10

    • Yellow Contrast = 11

    • Orange Contrast = 12

    • Bold Pink = 13

    • Bold Purple & Yellow = 14

    • Bold Orange = 15

    • Bold Green & Purple = 16

    • Bold Red Features = 17

    • Bold Green Features = 18

    • Bold Cyan Features = 19

    • Bold Yellow Features = 20

    • Bold Red & White = 21

    • Bold Blue & White = 22

    • Metallic Gold = 23

    • Metallic Platinum = 24

    • Metallic Gray & Lilac = 25

    • Metallic Purple & Lime = 26

    • Metallic Red = 27

    • Metallic Green = 28

    • Metallic Blue = 29

    • Metallic White & Aqua = 30

    • Metallic Orange & Yellow = 31

    • Metallic Red and Yellow = 32

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

iTintID = rage.weapon.get_ped_weapon_tint_index(pSelfPed, uWeaponHash) -- Returns current weapon tint ID installed on MicroSMG

rage.weapon.set_ped_weapon_tint_index(pSelfPed, uWeaponHash, (iTintID + 1)) -- Sets next weapon tint

---

add_ammo_to_ped(ped, weaponHash, ammo)

Adds ammo to ped’s weapon

Parameters:

• ped (Ped) – Ped handle

• weaponHash (Hash) – Weapon model hash

• ammo (int)

Returns:

• None

Example:

pSelfPed = player.get_ped()
uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")
rage.weapon.add_ammo_to_ped(pSelfPed, uWeaponHash, 9999) -- 9999 ammo for microsmg

---

get_weapon_clip_size()

Get weapon clip size.

Parameters:

• None

Returns:

• int – Weapon clip size

Example:

uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")
iClipSize = rage.weapon.get_weapon_clip_size(uWeaponHash) -- Returns clip size for microsmg
system.log_debug("Clip size: " .. iClipSize)

---

has_entity_been_damaged_by_weapon(entity, weaponHash, weaponType)

Check if entity has been damaged by weapon.

Parameters:

• entity (Entity) – Entity handle

• weaponHash (Hash) – Weapon model hash

• weaponType (int) – Weapon type

Note

If you want to define only a specific weapon, second parameter=weapon hash code, third parameter=0 If you want to define any melee weapon, second parameter=0, third parameter=1. If you want to identify any weapon (firearms, melee, rockets, etc.), second parameter=0, third parameter=2.

Returns:

• bool – true if entity has been damaged by weapon, false otherwise

Example:

pSelfPed = player.get_ped()
uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")
bDamaged = rage.weapon.has_entity_been_damaged_by_weapon(pSelfPed, uWeaponHash, 0) -- Check if self ped has been damaged by microsmg
if bDamaged then
    system.log_debug("Self ped has been damaged by microsmg")
end

---

refill_ammo_instantly(ped)

Refills ammo for all weapons.

Parameters:

• ped (Ped) – Ped handle

Returns:

• bool – true if ammo was refilled, false otherwise

Example:

pSelfPed = player.get_ped()
bRefilled = rage.weapon.refill_ammo_instantly(pSelfPed) -- Refills ammo for all weapons for self ped
if bRefilled then
    system.log_debug("Ammo was refilled")
end

---

set_ammo_in_clip(ped, weaponHash, ammo)

Set ammo in clip.

Parameters:

• ped (Ped) – Ped handle

• weaponHash (Hash) – Weapon model hash

• ammo (int) – Ammo in clip

Returns:

• bool – true if ammo was set, false otherwise

Example:

pSelfPed = player.get_ped()
uWeaponHash = rage.gameplay.get_hash_key("weapon_microsmg")
rage.weapon.set_ammo_in_clip(pSelfPed, uWeaponHash, 9999) -- 9999 ammo in clip for microsmg

---

set_ped_infinite_ammo_clip(ped, toggle)

Sets infinite clip ammo for ped.

Parameters:

• ped (Ped) – Ped handle

• toggle (bool) – true to enable infinite clip ammo, false to disable

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.weapon.set_ped_infinite_ammo_clip(pSelfPed, true) -- Sets infinite clip ammo for self ped

---

Streaming namespace

This namespace contains ui-related game functions.

---

has_anim_dict_loaded(animDict)

Checks whether an animation dictionary is loaded.

Parameters:

• animDict (string) – Animation dictionary

  • You can read more about animations dicts and names here: Animation types

Returns:

• bool – Animation dictionary status

  • true – Animation dictionary is loaded

  • false – Animation dictionary is not loaded

Example:

bHasAnimDictLoaded = rage.streaming.has_anim_dict_loaded("move_f@injured")

system.log_debug(tostring(bHasAnimDictLoaded))

---

has_anim_set_loaded(animSet)

Checks whether an animation set is loaded.

Parameters:

• animSet (string) – Animation set

  • You can read more about animations dicts and names here: Animation types

Returns:

• bool – Animation set status

  • true – Animation set is loaded

  • false – Animation set is not loaded

Example:

bHasAnimSetLoaded = rage.streaming.has_anim_set_loaded("idle_intro")

system.log_debug(tostring(bHasAnimSetLoaded))

---

has_model_loaded(model)

Checks whether a specified model has loaded into memory.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is loaded

  • false – Model is not loaded

Example:

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

bHasModelLoaded = rage.streaming.has_model_loaded(uZentornoHash)

system.log_debug(tostring(bHasModelLoaded))

---

has_named_ptfx_asset_loaded(fxName)

Checks whether a particles effect is loaded.

Parameters:

• fxName (string) – Effect name

Returns:

• bool – Effect status

  • true – Effect is loaded

  • false – Effect is not loaded

Example:

bHasPTFXassetLoaded = rage.streaming.has_named_ptfx_asset_loaded("blood_stab")

system.log_debug(tostring(bHasPTFXassetLoaded))

---

is_this_model_a_bicycle(model)

Checks whether the model is a bicycle.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a bicycle

  • false – Model is not a bicycle

Example:

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

bIsThisModelABicycle = rage.streaming.is_this_model_a_bicycle(uZentornoHash)

system.log_debug(tostring(bIsThisModelABicycle))

---

is_this_model_a_bike(model)

Checks whether the model is a bike.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a bike

  • false – Model is not a bike

Example:

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

bIsThisModelABike = rage.streaming.is_this_model_a_bike(uZentornoHash)

system.log_debug(tostring(bIsThisModelABike))

---

is_this_model_a_boat(model)

Checks whether the model is a boat.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a boat

  • false – Model is not a boat

Example:

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

bIsThisModelABoat = rage.streaming.is_this_model_a_boat(uZentornoHash)

system.log_debug(tostring(bIsThisModelABoat))

---

is_this_model_a_car(model)

Checks whether the model is a car.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a car

  • false – Model is not a car

Example:

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

bIsThisModelACar = rage.streaming.is_this_model_a_car(uZentornoHash)

system.log_debug(tostring(bIsThisModelACar)) -- Returns true

---

is_this_model_a_heli(model)

Checks whether the model is a helicopter.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a helicopter

  • false – Model is not a helicopter

Example:

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

bIsThisModelAHeli = rage.streaming.is_this_model_a_heli(uZentornoHash)

system.log_debug(tostring(bIsThisAHeli))

---

is_model_a_ped(model)

Checks whether the model is a ped.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a ped

  • false – Model is not a ped

Example:

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

bIsThisModelAPed = rage.streaming.is_model_a_ped(uZentornoHash)

system.log_debug(tostring(bIsThisAPed))

---

is_this_model_a_plane(model)

Checks whether the model is a plane.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a plane

  • false – Model is not a plane

Example:

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

bIsThisModelAPlane = rage.streaming.is_this_model_a_plane(uZentornoHash)

system.log_debug(tostring(bIsThisModelAPlane))

---

is_this_model_a_quadbike(model)

Checks whether the model is a quadbike.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a quadbike

  • false – Model is not a quadbike

Example:

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

bIsThisModelAQuadbike = rage.streaming.is_this_model_a_quadbike(uZentornoHash)

system.log_debug(tostring(bIsThisModelAQuadbike))

---

is_this_model_a_train(model)

Checks whether the model is a train.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a train

  • false – Model is not a train

Example:

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

bIsThisModelATrain = rage.streaming.is_this_model_a_train(uZentornoHash)

system.log_debug(tostring(bIsThisModelATrain))

---

is_model_a_vehicle(model)

Checks whether the model is a vehicle.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is a vehicle

  • false – Model is not a vehicle

Example:

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

bIsThisModelAVehicle = rage.streaming.is_model_a_vehicle(uZentornoHash)

system.log_debug(tostring(bIsThisModelAVehicle))

---

is_model_in_cdimage(model)

Checks whether the model is in cdimage (rpf).

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is in cdimage

  • false – Model is not in cdimage

Example:

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

bIsThisModelInCDImage = rage.streaming.is_model_in_cdimage(uZentornoHash)

system.log_debug(tostring(bIsThisModelInCDImage))

---

is_model_valid(model)

Checks whether the specified model exists in the game.

Parameters:

• model (Hash) – Model hash

Returns:

• bool – Model status

  • true – Model is valid

  • false – Model is not valid

Example:

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

bIsModelValid = rage.streaming.is_model_valid(uZentornoHash)

system.log_debug(tostring(bIsModelValid))

---

remove_anim_dict(animDict)

Removes the animation dictionary.

Parameters:

• animDict (string) – Animation dictionary

  • You can read more about animations dicts and names here: Animation types

Returns:

• None

Example:

rage.streaming.remove_anim_dict("move_f@injured")

---

remove_anim_set(animSet)

Removes the animation set.

Parameters:

• animSet (string) – Animation set

  • You can read more about animations dicts and names here: Animation types

Returns:

• None

Example:

rage.streaming.has_anim_set_loaded("idle_intro")

---

remove_ipl(iplName)

Removes the IPL.

Parameters:

• iplName (string) – IPL name

Returns:

• None

Example:

rage.streaming.remove_ipl("gr_case10_bunkerclosed")

---

remove_named_ptfx_asset(fxName)

Removes the named particle effects asset.

Parameters:

• fxName (string) – Effect name

Returns:

• None

Example:

rage.streaming.remove_named_ptfx_asset("blood_stab")

---

request_anim_dict(animDict)

Requests the animation dictionary.

Parameters:

• animDict (string) – Animation dictionary

  • You can read more about animations dicts and names here: Animation types

Returns:

• None

Example:

rage.streaming.request_anim_dict("move_f@injured")

---

request_anim_set(animSet)

Requests the animation set.

Parameters:

• animSet (string) – Animation set

  • You can read more about animations dicts and names here: Animation types

Returns:

• None

Example:

rage.streaming.request_anim_set("idle_intro")

---

request_ipl(iplName)

Requests the IPL.

Parameters:

• iplName (string) – IPL name

Returns:

• None

Example:

rage.streaming.request_ipl("gr_case10_bunkerclosed")

---

request_model(model)

Requests a model to be loaded into memory.

Parameters:

• model (Hash) – Model hash

Returns:

• None

Example:

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

rage.streaming.request_model(uZentornoHash)

---

request_named_ptfx_asset(fxName)

Requests the named particle effects asset.

Parameters:

• fxName (string) – Effect name

Returns:

• None

Example:

rage.streaming.request_named_ptfx_asset("blood_stab")

---

set_model_as_no_longer_needed(model)

Sets the model as no longer needed.

Note

Unloads model from memory. Engine unloads this later as seems fit.

Parameters:

• model (Hash) – Model hash

Returns:

• None

Example:

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

rage.streaming.set_model_as_no_longer_needed(uZentornoHash)

---

UI namespace

This namespace contains ui-related game functions.

---

add_blip_for_coord(x, y, z)

Add blip for given coordinates.

Parameters:

• x (float) – X position

• y (float) – Y position

• z (float) – Z position

Returns:

• Blip – A blip object at the specified coordinates.

Example:

v3CoordsInfront = player.get_coords_infront(100)
rage.ui.add_blip_for_coord(v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z)

---

add_blip_for_entity(entity)

Add blip for given entity.

Parameters:

• entity (Entity) – Entity to add the blip to

Returns:

• Blip – A blip object at the specified entity.

Example:

pSelfPed = player.get_ped()

rage.ui.add_blip_for_entity(pSelfPed) -- Adds a blip to player's ped location.

---

add_blip_for_pickup(pickup)

Add blip for given pickup.

Parameters:

• pickup (Pickup) – Pickup item to add the blip to

Returns:

• Blip – A blip object

Example:

pSelfPed = player.get_ped()

rage.ui.add_blip_for_pickup(pSelfPed)

---

add_blip_for_radius(posX, posY, posZ, radius)

Add blip for given coords with custom radius.

Parameters:

• posX (float) – X position

• posY (float) – Y position

• posZ (float) – Z position

• radius (float) – Radius

Returns:

• Blip – A blip object

Example:

plHostPlayer = lobby.get_host()
v3CurrentHostCoords = lobby.get_player_coords(plHostPlayer)

rage.ui.add_blip_for_radius(v3CurrentHostCoords.x, v3CurrentHostCoords.y, v3CurrentHostCoords.z, 20)

---

get_blip_coords(blip)

Gets coordinates for a blip.

Parameters:

• blip (Blip) – Blip object

Returns:

• Vector3 – Blip coords

Example:

plHostPlayer = lobby.get_host()
blEntityBlip = rage.ui.add_blip_for_entity(plHostPlayer)

rage.ui.get_blip_coords(blEntityBlip) -- Returns coords of the created self ped's blip

---

get_blip_from_entity(entity)

Gets blip from entity.

Parameters:

• entity (Entity) – Entity to get the blip from

Returns:

• Blip – A blip ID

Example:

pSelfPed = player.get_ped()

rage.ui.get_blip_from_entity(pSelfPed)

---

get_label_text(labelName)

Gets label text from label name.

Parameters:

• string (labelName) – Label name to get text from

Returns:

• string – Label text

Example:

sBlipLabelText = rage.ui.get_label_text("Label")
system.log_debug("Label text: " .. sBlipLabelText)

---

hide_hud_and_radar_this_frame()

Hide HUD (Heads-up Display) and radar.

Parameters:

• None

Returns:

• None

Example:

rage.ui.hide_hud_and_radar_this_frame()

---

hide_hud_component_this_frame(id)

Hide specified HUD (Heads-up Display) component.

Parameters:

• id (int) – Hud component ID

  Hud component IDs:

  • 1 : WANTED_STARS

  • 2 : WEAPON_ICON

  • 3 : CASH

  • 4 : MP_CASH

  • 5 : MP_MESSAGE

  • 6 : VEHICLE_NAME

  • 7 : AREA_NAME

  • 8 : VEHICLE_CLASS

  • 9 : STREET_NAME

  • 10 : HELP_TEXT

  • 11 : FLOATING_HELP_TEXT_1

  • 12 : FLOATING_HELP_TEXT_2

  • 13 : CASH_CHANGE

  • 14 : RETICLE

  • 15 : SUBTITLE_TEXT

  • 16 : RADIO_STATIONS

  • 17 : SAVING_GAME

  • 18 : GAME_STREAM

  • 19 : WEAPON_WHEEL

  • 20 : WEAPON_WHEEL_STATS

  • 21 : HUD_COMPONENTS

  • 22 : HUD_WEAPONS

Returns:

• None

Example:

rage.ui.hide_hud_component_this_frame(19) -- Hides Weapon Wheel from the HUD.

---

is_hud_component_active(id)

Checks whether specified HUD (Heads-up Display) component is active.

Parameters:

• id (int) – Hud component ID

Returns:

• bool – Returns hud component status

  • true – Hud component is active

  • false – Hud component is inactive

Example:

bIsWeaponWheelActive = rage.ui.is_hud_component_active(19) -- Checks whether the Weapon Wheel is active
system.log_debug("Weapon Wheel active: " .. tostring(bIsWeaponWheelActive))

---

is_mission_creator_blip(blip)

Checks whether a blip is a mission creator.

Parameters:

• blip (Blip) – Blip

Returns:

• bool – Blip status

  • true – Blip is a mission creator

  • false – Blip is not a mission creator

Example:

pSelfPed = player.get_ped()
blEntityBlip = rage.ui.add_blip_for_entity(pSelfPed)

rage.ui.is_mission_creator_blip(blEntityBlip)

---

remove_blip(blip)

Removes a blip.

Parameters:

• blip (Blip) – Blip

Returns:

• None

Example:

pSelfPed = player.get_ped()
blEntityBlip = rage.ui.add_blip_for_entity(pSelfPed)

rage.ui.remove_blip(blEntityBlip) -- Removes added blip

---

set_blip_as_mission_creator_blip(blip, toggle)

Set blip as mission creator blip.

Parameters:

• blip (Blip) – Blip

• toggle (bool) – Toggles blip settings

  • true – Set blip as mission creator blip

  • false – Don’t set blip as mission creator blip / remove mission creator blip

Returns:

• None

Example:

pSelfPed = player.get_ped()
blEntityBlip = rage.ui.add_blip_for_entity(pSelfPed)

rage.ui.set_blip_as_mission_creator_blip(blEntityBlip, true) -- Sets added blip as mission creator blip

---

set_blip_colour(blip, color)

Set blip colour.

Parameters:

• blip (Blip) – Blip

• color (int) – Blip Color ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
blEntityBlip = rage.ui.add_blip_for_entity(pSelfPed)

rage.ui.set_blip_colour(blEntityBlip, 38) -- Makes added blip Blue

---

set_blip_coords(blip, posX, posY, posZ)

Set blip coordinates.

Parameters:

• blip (Blip) – Blip

• posX (float) – X position

• posY (float) – Y position

• posZ (float) – Z position

Returns:

• None

Example:

pSelfPed = player.get_ped()
plHostPlayer = lobby.get_host()

blEntityBlip = rage.ui.add_blip_for_entity(pSelfPed)

v3HostCurrentCoords = lobby.get_player_coords(plHostPlayer) -- Returns host's coordinates

rage.ui.set_blip_coords(blEntityBlip, v3HostCurrentCoords.x, v3HostCurrentCoords.y, v3HostCurrentCoords.z)

---

set_blip_route(blip, enabled)

Set blip route, toggable.

Parameters:

• blip (Blip) – Blip

• enabled (bool) – Toggle blip route

  • true – Blip route enabled

  • false – Blip route disabled

Returns:

• None

Example:

pSelfPed = player.get_ped()
blEntityBlip = rage.ui.add_blip_for_entity(pSelfPed) -- Adds a blip for player's ped

rage.ui.set_blip_route(blEntityBlip, true)

---

set_blip_sprite(blip, spriteId)

Set blip sprite.

Parameters:

• blip (Blip) – Blip

• spriteId (int) – Blip Sprite ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
blEntityBlip = rage.ui.add_blip_for_entity(pSelfPed) -- Adds a blip for player's ped

rage.ui.set_blip_sprite(blEntityBlip, 64) -- Sets radar_helicopter sprite to created blip

---

set_new_waypoint(x, y)

Set new waypoint to given coordinates.

Parameters:

• x (float) – X position

• y (float) – Y position

Returns:

• None

Example:

rage.ui.set_new_waypoint(1391.7, 3608.716) -- trevor's meth lab

---

set_text_centre(align)

Set text centre.

Parameters:

• align (bool) – Toggle text alignment

  • true – Text is aligned

  • false – Text is not aligned

Returns:

• None

Example:

rage.ui.set_text_centre(true)

---

set_text_font(fontType)

Set text font.

Parameters:

• fontType (int) – Font type ID

  • Font type IDs:

  • FontChaletLondon = 0

  • FontHouseScript = 1

  • FontMonospace = 2

  • FontWingDings = 3

  • FontChaletComprimeCologne = 4

  • FontPricedown = 7

Returns:

• None

Example:

rage.ui.set_text_font(0) -- Font type 0, default (Chalet London)

---

set_text_justification(justifyType)

Set text justification.

Parameters:

• justifyType (int) – Text justification ID

  • Justification types ID:

  • 0 = Center-Justify

  • 1 = Left-Justify

  • 2 = Right-Justify

Note

Right-Justify requires set_text_wrap(), otherwise it will draw to the far right of the screen.

Returns:

• None

Example:

rage.ui.set_text_justification(1) -- Font justification left

---

set_text_outline()

Set text outline.

Parameters:

• None

Returns:

• None

Example:

rage.ui.set_text_outline()

---

set_text_right_justify(toggle)

Toggle set text right justify.

Parameters:

• toggle (bool) – Toggle text right justify

  • true – Toggle on

  • false – Toggle off

Returns:

• None

Example:

rage.ui.set_text_right_justify(true) -- Toggle on text right justify

---

set_text_scale(scale, size)

Set text scale.

Parameters:

• scale (float) – Text scale

• size (float) – Text size

Returns:

• None

Example:

rage.ui.set_text_scale(12, 10)

---

set_text_wrap(start, end)

Set the text in a specified box and wrap the text if it exceeds the boundaries. Both values are for X axis. Useful when positioning text set to center or aligned to the right.

Parameters:

• start (float) – Left boundary on screen position (0.0 - 1.0)

• end (float) – Right boundary on screen position (0.0 - 1.0)

Returns:

• None

Example:

rage.ui.set_text_wrap(0, 0)

---

set_waypoint_off()

Remove the current waypoint from the map.

Parameters:

• None

Returns:

• None

Example:

rage.ui.set_waypoint_off(0, 0)

---

show_hud_component_this_frame(id)

Show specified HUD (Heads-up Display) component.

Parameters:

• id (int) – Hud component ID

  Hud component IDs:

  • 1 : WANTED_STARS

  • 2 : WEAPON_ICON

  • 3 : CASH

  • 4 : MP_CASH

  • 5 : MP_MESSAGE

  • 6 : VEHICLE_NAME

  • 7 : AREA_NAME

  • 8 : VEHICLE_CLASS

  • 9 : STREET_NAME

  • 10 : HELP_TEXT

  • 11 : FLOATING_HELP_TEXT_1

  • 12 : FLOATING_HELP_TEXT_2

  • 13 : CASH_CHANGE

  • 14 : RETICLE

  • 15 : SUBTITLE_TEXT

  • 16 : RADIO_STATIONS

  • 17 : SAVING_GAME

  • 18 : GAME_STREAM

  • 19 : WEAPON_WHEEL

  • 20 : WEAPON_WHEEL_STATS

  • 21 : HUD_COMPONENTS

  • 22 : HUD_WEAPONS

Returns:

• None

Example:

rage.ui.show_hud_component_this_frame(19) -- Shows Weapon Wheel from the HUD.

---

get_first_blip_info_id(blipSprite)

Get the first blip info ID for the specified blip sprite.

Parameters:

• blipSprite (int) – Blip sprite ID

  • Blip sprite IDs here.

Returns:

• Blip – Blip handle

Example:

blip = rage.ui.get_first_blip_info_id(8) -- Get the first blip info ID for the waypoint blip sprite.

---

get_gps_waypoint_route_end(p1, p2, p3)

Get the end of the GPS waypoint route.

Note

This seems to crash the thread. More testing is required.

Parameters:

• p1 (int) – Unknown. Seen to be 1

• p2 (float) – Unknown. Seen to be 500

• p3 (bool) – Unknown. Seen to be true

Returns:

• Vector3 – End of the GPS waypoint route

Example:

v3WaypointRouteEnd = rage.ui.get_gps_waypoint_route_end(1, 500, true) -- Get the end of the GPS waypoint route.
scripting.teleport.to_position(v3WaypointRouteEnd) -- Teleport to the end of the GPS waypoint route.

---

get_next_blip_info_id(blipSprite)

Get the next blip info ID for the specified blip sprite.

Parameters:

• blipSprite (int) – Blip sprite ID

  • Blip sprite IDs here.

Returns:

• Blip – Blip handle

Example:

blHandle = rage.ui.get_next_blip_info_id(8) -- Get the next blip ID for the waypoint blip sprite.
v3BlipCoords = rage.ui.get_blip_coords(blHandle) -- Get the coordinates of the blip
scripting.teleport.to_position(v3BlipCoords) -- Teleport to the blip

---

Draw namespace

This namespace contains drawing-related game functions.

---

draw_sprite(textureDict, textureName, screenX, screenY, width, height, heading, red, green, blue, alpha, p11, p12)

Draw a 2D sprite on the screen.

Parameters:

• textureDict (string) – Name of texture dictionary to load texture from (e.g. “CommonMenu”, “MPWeaponsCommon”, etc.)

• textureName (string) – Name of texture to load from texture dictionary (e.g. “last_team_standing_icon”, “tennis_icon”, etc.)

• screenX (float) – Screen offset (0.5 = center)

• screenY (float) – Screen offset (0.5 = center)

• width (float) – Texture scaling. Negative values can be used to flip the texture on that axis. (0.5 = half)

• height (float) – Texture scaling. Negative values can be used to flip the texture on that axis. (0.5 = half)

• heading (float) – Texture rotation in degrees. Positive is clockwise, measured in degrees

• red (int) – Sprite R color

• green (int) – Sprite G color

• blue (int) – Sprite B color

• alpha (int) – Opacity level

• p11 (bool) – Unknown

• p12 (Any) – Unknown

Returns:

• None

Example:

rage.ui.draw_sprite("CommonMenu", "shop_new_star", 0.5, 0.5, 0.5, 0.5, 0.0, 255, 255, 255, 255, false, false)

---

Cam namespace

This namespace contains draw-related game functions.

---

get_gameplay_cam_relative_pitch()

Gets camera relative pitch.

Parameters:

• None

Returns:

• float – Cam’s relative pitch value

Example:

fCamRelativePitch = rage.cam.get_gameplay_cam_relative_pitch()

system.log_debug("LocalPlayer pitch: " .. fCamRelativePitch)

---

get_gameplay_cam_coords()

Gets camera coordinates.

Parameters:

• None

Returns:

• Vector3 – Camera coordinates

Example:

v3CamCoords = rage.cam.get_gameplay_cam_coords()

system.log_debug("Camera coords: " .. v3CamCoords.x .. ", " .. v3CamCoords.y .. ", " .. v3CamCoords.z)

---

get_gameplay_cam_rot(rotationOrder)

Note

This function requires proper documentation & testing.

Gets camera rotation

Parameters:

• rotationOrder (int) – Rotation order.

  • Experiments show that this doesn’t seem to make a difference.

  • 0-Pitch(X): -70.000092

  • 0-Roll(Y): -0.000001

  • 0-Yaw(Z): -43.886459

  • 1-Pitch(X): -70.000092

  • 1-Roll(Y): -0.000001

  • 1-Yaw(Z): -43.886463

  • 2-Pitch(X): -70.000092

  • 2-Roll(Y): -0.000002

  • 2-Yaw(Z): -43.886467

Returns:

• Vector3 – Camera rotation data

Example:

v3CamRotation = rage.cam.get_gameplay_cam_rot(0) -- Returns the rotation of the camera with the first rotation order.
system.log_debug("LocalPlayer pitch: " .. tostring(v3CamRotation.x) .. " roll: " .. tostring(v3CamRotation.y) .. " yaw: " .. tostring(v3CamRotation.z))

---

set_gameplay_cam_raw_pitch(pitch)

Sets the camera pitch.

Note

Doesn’t seem to do anything. Use set_gameplay_cam_relative_pitch instead.

Parameters:

• pitch (float) – Pitch value

Returns:

• None

Example:

rage.cam.set_gameplay_cam_raw_pitch(0.0) -- Set the camera pitch to 0.

---

set_gameplay_cam_raw_yaw(yaw)

Sets the camera yaw.

Note

Doesn’t seem to do anything. Try to use set_gameplay_cam_relative_heading instead.

Parameters:

• yaw (float) – Yaw value

Returns:

• None

Example:

rage.cam.set_gameplay_cam_raw_yaw(0.0) -- Set the camera yaw to 0.

---

set_gameplay_cam_relative_heading(heading)

Sets the camera heading.

Parameters:

• heading (float) – Heading value

Returns:

• None

Example:

rage.cam.set_gameplay_cam_relative_heading(0.0) -- Set the camera heading to 0 degrees.

---

set_gameplay_cam_relative_pitch(angle, scalingFactor)

Sets the camera pitch.

Parameters:

• angle (float) – The angle to rotate the camera by

• scalingFactor (float) – Always seems to be set to 1.0 in native calls

Returns:

• None

Example:

rage.cam.set_gameplay_cam_relative_pitch(0.0, 1.0) -- Set the camera pitch to 0 degrees.

---

set_gameplay_cam_relative_rotation(roll, pitch, yaw)

Sets camera rotation.

Parameters:

• roll (float) – Roll value

• pitch (float) – Pitch value

• yaw (float) – Yaw value

Returns:

• None

Example:

rage.cam.set_gameplay_cam_relative_rotation(0.0, 0.0, 0.0) -- Set all parameters to 0.0 degrees.

---

set_gameplay_cam_vehicle_camera(vehicleName)

Note

Not documented yet.

---

set_gameplay_cam_vehicle_camera_name(vehicleModel)

Note

Not documented yet.

---

Gameplay namespace

This namespace contains gameplay-related game functions.

---

clear_area_of_cops(x, y, z, radius, flags)

Clear defined area of cops.

Parameters:

• x (float) – X coordinate of the area center

• y (float) – Y coordinate of the area center

• z (float) – Z coordinate of the area center

• radius (float) – Radius of the area

• flags (int) – Flags

  • flags appears to always be 0.

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()

rage.gameplay.clear_area_of_cops(v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, 100.0, 0) -- 100m cop purge

---

clear_area_of_objects(x, y, z, radius, flags)

Clear defined area of props.

Parameters:

• x (float) – X coordinate of the area center

• y (float) – Y coordinate of the area center

• z (float) – Z coordinate of the area center

• radius (float) – Radius of the area

• flags (int) – Flags

  • There seem to be some most used flags, though it’s unknown what do they change.

    • 0

    • 2

    • 6

    • 16

    • 17

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()

rage.gameplay.clear_area_of_objects(v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, 100.0, 0) -- 100m prop purge

---

clear_area_of_peds(x, y, z, radius, flags)

Clear defined area of peds.

Parameters:

• x (float) – X coordinate of the area center

• y (float) – Y coordinate of the area center

• z (float) – Z coordinate of the area center

• radius (float) – Radius of the area

• flags (int) – Flags

  • flags appears to always be 1.

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()

rage.gameplay.clear_area_of_peds(v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, 100.0, 1) -- 100m ped purge

---

clear_area_of_vehicles(x, y, z, radius, p4, p5, p6, p7, p8, p9, p10)

Clear defined area of vehicles.

Parameters:

• x (float) – X coordinate of the area center

• y (float) – Y coordinate of the area center

• z (float) – Z coordinate of the area center

• radius (float) – Radius of the area

• p4 (bool) – Unknown (Optional)

• p5 (bool) – Unknown (Optional)

• p6 (bool) – Unknown (Optional)

• p7 (bool) – Unknown (Optional)

• p8 (bool) – Unknown (Optional)

• p9 (bool) – Unknown (Optional)

• p10 (Any) – Unknown (Optional)

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()

rage.gameplay.clear_area_of_vehicles(v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, 100.0) -- 100m vehicle purge

---

clear_override_weather()

Clears the weather override.

Note

This method only works if the weather using set_override_weather().

Note

If the weather was previously set by scripting.world.set_weather(), the weather will be reset to that weather.

Parameters:

• None

Returns:

• None

Example:

rage.gameplay.set_override_weather("RAIN") -- set rain weather
rage.gameplay.clear_override_weather() -- clear the weather

---

display_onscreen_keyboard(p0, windowTitle, p2, defaultText, defaultConcat1, defaultConcat2, defaultConcat3, maxInputLength)

Displays an onscreen input window.

Parameters:

• p0 (int) – Unknown

  • p0 has to be 6, otherwise the method might not work as intended.

• windowTitle (string) – Title of the window

  • All available window titles are listed here: windowtitles

• p2 (string) – Unknown

• defaultText (string) – Default text in the input box

• defaultConcat1 (string) – Unknown

• defaultConcat2 (string) – Unknown

• defaultConcat3 (string) – Unknown

• maxInputLength (int) – Maximum length of the input box

Returns:

• None

Example:

function foo()
   enteredText = nil
   rage.gameplay.display_onscreen_keyboard(6, "FMMC_KEY_TIP10", "", "Default Text", "", "", "", 30) -- display onscreen keyboard with the "Enter Synopsis" title and a maximum input length of 30 characters
   while enteredText == "" or enteredText == nil do
      enteredText = rage.gameplay.get_onscreen_keyboard_result()
      system.wait(-1)
   end
   system.log_debug("The player entered " .. enteredText .. ".")
end

parent = menu.add_parent("My Lua Script")
menu.add_option("Get Data", "gd", parent, foo)
menu.update_root_parent(true)

---

find_spawn_point_in_direction(posX, posY, posZ, fwdVecX, fwdVecY, fwdVecZ, distance, spawnPoint)

Attempts to find a spawn point in the specified direction.

Parameters:

• posX (float) – X coordinate of the spawn point

• posY (float) – Y coordinate of the spawn point

• posZ (float) – Z coordinate of the spawn point

• fwdVecX (float) – X coordinate of the direction vector

• fwdVecY (float) – Y coordinate of the direction vector

• fwdVecZ (float) – Z coordinate of the direction vector

• distance (float) – Limit the search to this distance

• spawnPoint (vector3) – The found spawn point

Returns:

• bool

  • true – A spawn point was found

  • false – No spawn point was found

Example:

v3CurrentCoords = player.get_coords()
pSelfPed = player.get_ped()
v3ForwardVector = rage.entity.get_entity_rotation(pSelfPed, 1)
v3SpawnPoint = nil
rage.gameplay.find_spawn_point_in_direction(v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, v3ForwardVector.x, v3ForwardVector.y, v3ForwardVector.z, 100.0, v3SpawnPoint) -- find spawn point in 100m radius in the direction of the player

if v3SpawnPoint then
   system.log_debug(tostring(v3SpawnPoint.x) .. " " .. tostring(v3SpawnPoint.y) .. " " .. tostring(v3SpawnPoint.z))
end

---

get_cloud_hat_opacity()

Returns the current clouds opacity.

Parameters:

• None

Returns:

• float – The current clouds opacity

Example:

iCloudOpacity = rage.gameplay.get_cloud_hat_opacity() -- get current clouds opacity
system.log_debug("The clouds opacity is " .. tostring(iCloudOpacity)) -- log the current clouds opacity

---

get_frame_count()

Returns the current frame count.

Parameters:

• None

Returns:

• int – The current frame count

Example:

iFrameCount = rage.gameplay.get_frame_count() -- get current frame count
system.log_debug("The frame count is " .. tostring(iFrameCount)) -- log the current frame count

---

get_frame_time()

Returns the current frame time - the time it takes for a frame to be rendered.

Parameters:

• None

Returns:

• float – The current frame time

Example:

fFrameTime = rage.gameplay.get_frame_time() -- get current frame time
system.log_debug("The frame time is " .. tostring(fFrameTime)) -- log the current frame time

---

get_hash_key(string)

Returns the hash key of the specified game object.

Parameters:

• string (string) – The game object to get the hash key of

Returns:

• uint_64 – The hash key of the specified string

Example:

uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO") -- get the hash key of "example"
system.log_debug("The hash key of \"ZENTORNO\" is " .. tostring(uZentornoHash)) -- log the hash key of "example"

---

get_onscreen_keyboard_result()

Returns the result of an onscreen input window.

Parameters:

• None

Returns:

• string – The result of the onscreen input window

Example:

function foo()
   enteredText = nil
   rage.gameplay.display_onscreen_keyboard(6, "FMMC_KEY_TIP10", "", "Default Text", "", "", "", 30) -- display onscreen keyboard with the "Enter Synopsis" title and a maximum input length of 30 characters
   while enteredText == "" or enteredText == nil do
      enteredText = rage.gameplay.get_onscreen_keyboard_result()
      system.wait(-1)
   end
   system.log_debug("The player entered " .. enteredText .. ".")
end

parent = menu.add_parent("My Lua Script")
menu.add_option("Get Data", "gd", parent, foo)
menu.update_root_parent(true)

---

preload_cloud_hat(name)

Preloads the specified cloud hat.

Parameters:

• name (string) – The cloud type

  • You can read more about cloud types here: Clouds Types

Returns:

• None

Example:

rage.gameplay.preload_cloud_hat("altostratus") -- preload the altostratus cloud hat

---

load_cloud_hat(name, transitionTime)

Loads the specified cloud hat.

Note

It appears that the cloud hat can be loaded without calling preload_cloud_hat().

Parameters:

• name (string) – The cloud type

  • You can read more about cloud types here: Clouds Types

• transitionTime (float) – The time to smoothly transit between the current cloud hat and the new cloud hat

Returns:

• None

Example:

rage.gameplay.load_cloud_hat("altostratus", 1.0) -- load the altostratus cloud hat with a 1 second transition time

---

unload_cloud_hat(name, p1)

Unloads the specified cloud hat.

Note

After unloading, it falls back to the previous cloud hat

Parameters:

• name (string) – The cloud type

  • You can read more about cloud types here: Clouds Types

• p1 (float) – appears to be 0

Returns:

• None

Example:

rage.gameplay.unload_cloud_hat("altostratus", 0) -- unload the altostratus cloud hat

---

set_cloud_hat_opacity(opacity)

Sets the opacity of the current cloud hat.

Parameters:

• opacity (float) – The new opacity of the current cloud hat

Returns:

• None

Example:

rage.gameplay.set_cloud_hat_opacity(5) -- set the current cloud hat opacity to 5

---

set_override_weather(weatherType)

Sets the weather to the specified weather type.

Parameters:

• weatherType (string) – The weather type

  • You can read more about weather types here: Weather Types

Returns:

• None

Example:

rage.gameplay.set_override_weather("XMAS") -- set the weather to XMAS

---

shoot_single_bullet_between_coords(x1, y1, z1, x2, y2, z2, damage, p7, weaponHash, ownerPed, isAudible, isInvisible, speed)

Shoots a bullet from the first coordinates to the second coordinates

Parameters:

• x1 (float) – The X coordinate to start the shot at

• y1 (float) – The Y coordinate to start the shot at

• z1 (float) – The Z coordinate to start the shot at

• x2 (float) – The X coordinate the shot should end up at

• y2 (float) – The Y coordinate the shot should end up at

• z2 (float) – The Z coordinate the shot should end up at

• damage (int) – The amount of damage the bullet carries

• p7 (bool) – Whether the bullet should have pinpoint accuracy

• weaponHash (Hash) – Hash of the weapon the bullet is used as ammunition for

• ownerPed (Ped) – Owner of the bullet, e.g. if the bullet kills someone the kill feed shows ‘X was shot by ownerPed.’

• isAudible (bool) – Whether the bullet should be audible.

• isInvisible (bool) – Whether the bullet should be invisible.

• speed (float) – Speed the bullet should fly at.

Returns:

• None

Example:

Note

This example is untested.

v3CurrentCoords = player.get_coords()
v3CoordsInfront = player.get_coords_infront(10)
rage.gameplay.shoot_single_bullet_between_coords(v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 1000, true, rage.gameplay.get_hash_key("WEAPON_SAWNOFFSHOTGUN"), player.get_ped(), true, true, 50.0) -- shoot a bullet from player coords to 10 meters in front of them with a damage of 1000, with pinpoint accuracy, using the shotgun, the bullet owner is the player, the bullet is audible and invisible, and the bullet speed is 50.0

update_onscreen_keyboard()

Returns the current status of the onscreen input window

Parameters:

• None

Returns:

• int – Status code

  • -1 The onscreen input window is not active

  • 0 User still editing

  • 1 User has finished editing

  • 2 – User has canceled editing

---

Fire namespace

This namespace contains fire-related game functions.

---

add_explosion(x, y, z, explosionType, damageScale, isAudible, isInvisible, cameraShake, noDamage)

Add explosion in certain coordinates with multiple options.

Parameters:

• x (float) – X position

• y (float) – Y position

• z (float) – Z position

• explosionType (int) – Explosion types

  • Read more about explosion types here: Explosion types

• damageScale (float) – Damage scale

• isAudible (bool) – Toggle explosion sound

  • true – Explosion is audible

  • false – Explosion is silent

• isInvisible (bool) – Toggle explosion visibility

  • true – Explosion is invisible

  • false – Explosion is visible

• cameraShake (float) – Camera shake intensity

• noDamage (bool) – Toggle no damage

  • true – Explosion doesn’t cause damage

  • false – Explosion causes damage

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()
v3CasinoCoords = Vector3.new(922.60430908203, 49.672721862793, 80.89803314209)
rage.fire.add_explosion(v3CasinoCoords.x, v3CasinoCoords.y, v3CasinoCoords.z, 7, 10, true, false, 10, false)

---

start_entity_fire(entity)

Start fire on entity.

Parameters:

• entity (Entity) – Entity ID

Returns:

int – A value which represents how many times the fire was applied

Example:

pSelfPed = player.get_ped()

iTimesApplied = rage.fire.start_entity_fire(pSelfPed)
system.log_debug("Times applied: " .. iTimesApplied)

---

stop_entity_fire(entity)

Stop fire on entity.

Parameters:

• entity (Entity) – Entity ID

Returns:

• None

Example:

pSelfPed = player.get_ped()
rage.fire.start_entity_fire(pSelfPed)
rage.fire.stop_entity_fire(pSelfPed)

---

Network namespace

This namespace contains network-related game functions.

---

network_get_friend_count()

Gets friend count.

Parameters:

• None

Returns:

• int – Friend count

Example:

iFriendCount = rage.network.network_get_friend_count()
system.log_debug("Friend count: " .. iFriendCount)

---

network_get_host_of_this_script()

Gets ID of the player host of this script.

Parameters:

• None

Returns:

• Player – Player ID

Example:

iHostOfTheScript = rage.network.network_get_host_of_this_script()
system.log_debug("Host of the script: " .. iHostOfTheScript)

---

network_get_max_friends()

Gets max friends.

Parameters:

• None

Returns:

• int – Max friends

Example:

iMaxFriends = rage.network.network_get_max_friends()
system.log_debug("Max friends: " .. iMaxFriends)

---

network_has_control_of_entity(entity)

Check network control of entity.

Parameters:

• entity (Entity) – The entity to check

Returns:

• bool

  • true – Network has control of the entity

  • false – Network doesn’t have control of the entity

Example:

pSelfPed = player.get_ped()

bHasControlOfEntity = rage.network.network_has_control_of_entity(pSelfPed)
system.log_debug("Got control of entity: " .. tostring(bHasControlOfEntity))

---

network_is_friend_in_multiplayer(friendName)

Checks whether a friend is in multiplayer.

Parameters:

• friendName (string) – The friend name to check

Returns:

• bool

  • true – Friend is in multiplayer

  • false – Friend isn’t in multiplayer

Example:

bIsInMultiplayer = rage.network.network_is_friend_in_multiplayer("Acid_Burn9")
system.log_debug("Is friend in multiplayer: " .. tostring(bIsInMultiplayer))

---

network_is_friend_index_online(friendIndex)

Note

This function is poorly documented. It requires testing.

Checks whether a friend is online by friend index.

Parameters:

• friendIndex (int) – The friend index to check

Returns:

• bool

  • true – Friend is online

  • false – Friend isn’t online

---

network_is_friend_online(name)

Checks whether a friend is online.

Parameters:

• name (string) – The friend name to check

Returns:

• bool

  • true – Friend is online

  • false – Friend isn’t online

Example:

bIsFriendOnline = rage.network.network_is_friend_online("Huginn5") -- stalking Huginn
system.log_debug("Is friend online: " .. tostring(bIsFriendOnline))

---

network_is_session_started()

Checks whether a session has started - you’re fully connected, can control your character, and not hanging in the clouds.

Parameters:

• None

Returns:

• bool

  • true – Session has started

  • false – Session hasn’t started

Example:

bIsSessionStarted = rage.network.network_is_session_started()
system.log_debug("Is session started: " .. tostring(bIsSessionStarted))

---

network_hash_from_player_handle(player)

Gets hash from player handle.

Parameters:

• player (Player) – The Player ID

Returns:

• Hash – Hash of the player nickname

Example:

plHostPlayer = lobby.get_host()
rage.network.network_hash_from_player_handle(plHostPlayer)

---

network_is_host()

Checks if you are a session host.

Parameters:

• None

Returns:

• bool

  • true – Player is a host

  • false – Player isn’t a host

Example:

bIsHost = rage.network.network_is_host()
system.log_debug("Am I host: " .. tostring(bIsHost))

---

network_session_kick_player(player)

Kick player out of the session.

Parameters:

• player (Player) – The Player ID

Returns:

• None

Example:

plHostPlayer = lobby.get_host()

rage.network.network_session_kick_player(plHostPlayer)

---

network_request_control_of_entity(entity)

Request control of entity.

Parameters:

• Entity (Entity) – The Entity ID

Returns:

• bool

  • true – Request successful

  • false – Request failed

Example:

pSelfPed = player.get_ped()

rage.network.network_request_control_of_entity(pSelfPed)

---

network_get_network_id_from_entity(entity)

Returns netId from the given entity.

Parameters:

• entity (Entity) – The Entity ID

Returns:

• int – NetId

Example:

pSelfPed = player.get_ped()

iNetworkID = rage.network.network_get_network_id_from_entity(pSelfPed)

system.log_debug("NetID = " .. iNetworkID)

---

Cutscene namespace

This namespace contains cutscene-related game functions.

---

is_cutscene_active()

Checks whether a cutscene is active.

Parameters:

• None

Returns:

• bool

  • true – Cutscene is active

  • false – Cutscene is inactive

Example:

bIsCutsceneActive = rage.cutscene.is_cutscene_active()

if bIsCutsceneActive then
   system.log_debug("Cutscene is active")
else
   system.log_debug("Cutscene is not active")
end

---

is_cutscene_playing()

Checks whether a cutscene is playing.

Parameters:

• None

Returns:

• bool

  • true – Cutscene is playing

  • false – Cutscene is not playing

Example:

bIsCutscenePlaying = rage.cutscene.is_cutscene_playing()
if bIsCutscenePlaying then
   system.log_debug("Cutscene is playing")
else
   system.log_debug("Cutscene is not playing")
end

---

remove_cutscene()

Removes cutscene.

Parameters:

• None

Returns:

• None

Example:

rage.cutscene.remove_cutscene()

---

stop_cutscene_immediately()

Immediately stop cutscene.

Parameters:

• None

Returns:

• None

Example:

rage.cutscene.stop_cutscene_immediately()

---

Controls namespace

This namespace contains controls-related game functions.

---

disable_control_action(padIndex, control, disable)

Disable control action.

Parameters:

• padIndex (int) – Control padIndex

• control (int) – Control types

• disable (bool) – Toggle disable

  • true – Disable control action

  • false – Do not disable control action

Returns:

• None

Example:

rage.controls.disable_control_action(21, 0, true)

---

get_control_normal(padIndex, control)

Note

This function needs more testing.

Parameters:

• padIndex (int) – Control padIndex

• control (int) – Control Ctypes

Returns:

• float – current control value

Example:

rage.controls.get_control_normal(71, 0) -- returns INPUT_VEH_ACCELERATE value (normalized)

---

is_control_just_pressed(padIndex, control)

Note

This function needs more testing.

Parameters:

• padIndex (int) – Control padIndex

• control (int) – Control Ctypes

Returns:

• bool

  • true – Control was just pressed

  • false – Control wasn’t just pressed

Example:

bIsControlJustPressed = rage.controls.is_control_just_pressed(21, 0)

if bIsControlJustPressed == 1 then
  notify.above_map("True")
end

---

is_control_pressed(padIndex, control)

Note

This function needs more testing.

Note

inputGroup is always 2 for xbox 360 controller.

Parameters:

• padIndex (int) – Control padIndex

• control (int) – Control Ctypes

Returns:

• bool

  • true – Control button is pressed

  • false – Control button is not pressed

Example:

bIsControlPressed = rage.controls.is_control_pressed(21, 0)
if bIsControlPressed == 1 then
  notify.above_map("True")
end

---

is_disabled_control_just_pressed(padIndex, control)

Checks whether a disabled control is just pressed.

Parameters:

• padIndex (int) – Control padIndex

• control (int) – Control Ctypes

Returns:

• bool

  • true – Control is pressed

  • false – Control is not pressed

Example:

bIsDisabledControlJustPressed = rage.controls.is_disabled_control_just_pressed(21, 0)
if bIsDisabledControlJustPressed == 1 then
  notify.above_map("True")
end

---

is_disabled_control_pressed(padIndex, control)

Checks whether a disabled control is pressed.

Parameters:

• padIndex (int) – Control padIndex

• control (int) – Control Ctypes

Returns:

• bool – Control status

  • true – Control is pressed

  • false – Control is not pressed

Example:

bIsDisabledControlPressed = rage.controls.is_disabled_control_pressed(21, 0)
if bIsDisabledControlPressed == 1 then
  notify.above_map("True")
end

---

set_control_normal(padIndex, control, amount)

This function simulates player input.

Note

This function needs more testing.

Parameters:

• padIndex (int) – Control padIndex

• control (int) – Control Ctypes

• amount (float)

Returns:

• bool

  • true – input success

  • false – input failed

Example:

bIsControlSet = rage.controls.set_control_normal(71, 0, 1) -- sets 1.0 to INPUT_VEH_ACCELERATE
if bIsControlSet == true then
  notify.above_map("True")
end

---

Graphics namespace

animpostfx_is_running(effectName)

Checks whether a postFX effect is running.

Parameters:

• effectName (string) – Name of the animation postFX

  • You can find more effect names here: List of screen FX effects

Returns:

• bool

  • true – Animation postFX is running

  • false – Animation postFX is not running

Example:

bIsFXRunning = rage.graphics.animpostfx_is_running("FocusIn")
if bIsFXRunning then
   system.log_debug("Drugs effect is running")
end

---

animpostfx_play(effectName, duration, looped)

Launches a postFX effect.

Parameters:

• effectName (string) – Name of the postFX effect

• duration (int) – Duration of the postFX effect in milliseconds

• looped (bool) – If the postFX effect should be looped

  • true – PostFX effect will be looped

  • false – PostFX effect will not be looped

Returns:

• None

Example:

rage.graphics.animpostfx_play("FocusIn", 10000, false) -- plays the FocusIn postFX for 10 seconds

---

animpostfx_stop(effectName)

Stops a postFX effect.

Parameters:

• effectName (string) – Name of the postFX effect

  • true – PostFX effect will be stopped

  • false – PostFX effect will not be stopped

Returns:

• None

Example:

rage.graphics.animpostfx_stop("FocusIn") -- stops the FocusIn postFX

---

animpostfx_stop_all()

Stops all postFX effects.

Parameters:

• None

Returns:

• None

Example:

rage.graphics.animpostfix_stop_all() -- stops all postFX effects

---

begin_scaleform_movie_method(scaleform, methodName)

Display a scaleform.

Note

This has to be called every frame.

Parameters:

• scaleform (int) – Scaleform ID

• methodName (string) – Name of the scaleform method

For scaleform IDs and methods, go here: Decompiled Scaleforms

Returns:

• bool

  • true – Scaleform is displayed

  • false – Scaleform is not displayed

Example:

Note

This should be called each frame.

request_scaleform_movie() should be called to prepare a scaleform.

iScaleformHandle = rage.graphics.request_scaleform_movie("MP_BIG_MESSAGE_FREEMODE")
rage.graphics.end_scaleform_movie_method()
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_scaleform_movie(iScaleformHandle, 0.5, 0.5, 0.5, 0.5, 255, 255, 255, 255)
   rage.graphics.begin_scaleform_movie_method(iScaleformHandle, "SHOW_SHARD_WASTED_MP_MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("BIG MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("small message")
   rage.graphics.scaleform_movie_method_add_param_int(5)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle)
return

---

create_checkpoint(type, posX1, posY1, posZ1, posX2, posY2, posZ2, diameter, red, green, blue, alpha, reserved)

Creates a checkpoint.

Note

20/03/17 : Attention, checkpoints are already handled by the game itself, so you must not loop it like markers.

Parameters:

• type (int)– The type of checkpoint to create.

  • 0-4 – Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker

  • 5-9 – Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker

  • 10-14 – Ring: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker

  • 15-19 – 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker

  • 20-24 – Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker

  • 25-29 – Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker

  • 30-34 – Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker

  • 35-38 – Ring: Airplane Up, Left, Right, UpsideDown

  • 39 – ?

  • 40 – Ring: just a ring

  • 41 – ?

  • 42-44 – Cylinder w/ number (uses ‘reserved’ parameter)

  • 45-47 – Cylinder no arrow or number

• posX1 (float) – The X coordinate of the first checkpoint.

• posY1 (float) – The Y coordinate of the first checkpoint.

• posZ1 (float) – The Z coordinate of the first checkpoint.

• posX2 (float) – The X coordinate of the second checkpoint.

• posY2 (float) – The Y coordinate of the second checkpoint.

• posZ2 (float) – The Z coordinate of the second checkpoint.

• diameter (float) – The diameter of the checkpoint.

• red (int) – The red color level of the checkpoint.

• green (int) – The green color level of the checkpoint.

• blue (int) – The blue color level of the checkpoint.

• alpha (int) – The transparency level of the checkpoint.

• reserved – Special parameter

  • 0-99 – Just numbers (0-99)

  • 100-109 – Arrow (0-9)

  • 110-119 – Two arrows (0-9)

  • 120-129 – Three arrows (0-9)

  • 130-139 – Circle (0-9)

  • 140-149 – CycleArrow (0-9)

  • 150-159 – Circle (0-9)

  • 160-169 – Circle w/ pointer (0-9)

  • 170-179 – Perforated ring (0-9)

  • 180-189 – Sphere (0-9)

Checkpoint types with images here.

Returns:

• int – The handle of the checkpoint

Example:

v3CurrentCoords = player.get_coords()
v3CoordsInfront = player.get_coords_infront(100)

checkpoint = rage.graphics.create_checkpoint(42, v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 50, 255, 0, 0, 255, 120)

---

delete_checkpoint(checkpoint)

Deletes a checkpoint.

Parameters:

• checkpoint (int) – The handle of the checkpoint

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()
v3CoordsInfront = player.get_coords_infront(100)
iCheckpointHandle = rage.graphics.create_checkpoint(42, v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 50, 255, 0, 0, 255, 120)
rage.graphics.delete_checkpoint(iCheckpointHandle)

---

draw_line(x1, y1, z1, x2, y2, z2, red, green, blue, alpha)

Draws a line from x1, y1, z1 to x2, y2, z2.

Note

This has to be called every frame.

Parameters:

• x1 (float) – The X coordinate of the first point.

• y1 (float) – The Y coordinate of the first point.

• z1 (float) – The Z coordinate of the first point.

• x2 (float) – The X coordinate of the second point.

• y2 (float) – The Y coordinate of the second point.

• z2 (float) – The Z coordinate of the second point.

• red (int) – The red color level of the line.

• green (int) – The green color level of the line.

• blue (int) – The blue color level of the line.

• alpha (int) – The transparency level of the line.

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()
v3CoordsInfront = player.get_coords_infront(100)
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_line(coords1.x, coords1.y, coords1.z, coords2.x, coords2.y, coords2.z, 255, 0, 0, 255)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
return

---

draw_marker(type, posX, posY, posZ, dirX, dirY, dirZ, rotX, rotY, rotZ, scaleX, scaleY, scaleZ, red, green, blue, alpha, reserved)

Draws a marker with the specified appearance at the target location.

Note

This has to be called every frame.

Parameters:

• type (int) – The marker type to draw.

  • You can read more about marker types here.

• posX (float) – The X coordinate to draw the marker at.

• posY (float) – The Y coordinate to draw the marker at.

• posZ (float) – The Z coordinate to draw the marker at.

• dirX (float) – The X component of the direction vector for the marker, or 0.0 to use rotX/Y/Z.

• dirY (float) – The Y component of the direction vector for the marker, or 0.0 to use rotX/Y/Z.

• dirZ (float) – The Z component of the direction vector for the marker, or 0.0 to use rotX/Y/Z.

• rotX (float) – The X rotation for the marker. Only used if the direction vector is 0.0.

• rotY (float) – The Y rotation for the marker. Only used if the direction vector is 0.0.

• rotZ (float) – The Z rotation for the marker. Only used if the direction vector is 0.0.

• scaleX (float) – The scale for the marker on the X axis.

• scaleY (float) – The scale for the marker on the Y axis.

• scaleZ (float) – The scale for the marker on the Z axis.

• red (int) – The red component of the marker color, on a scale from 0-255.

• green (int) – The green component of the marker color, on a scale from 0-255.

• blue (int) – The blue component of the marker color, on a scale from 0-255.

• alpha (int) – The alpha component of the marker color, on a scale from 0-255.

• bobUpAndDown (bool) – Whether or not the marker should slowly animate up/down.

• faceCamera (bool) – Whether the marker should be a ‘billboard’, as in, should constantly face the camera.

• p19 (int) – Typically set to 2. Does not seem to matter directly.

• rotate (bool) – Rotations only apply to the heading.

• textureDict (string) – A texture dictionary to draw the marker with, or NULL. Example: ‘GolfPutting’

• textureName (string) – A texture name in textureDict to draw the marker with, or NULL. Example: ‘PuttingMarker’

• drawOnEnts (bool) – Whether or not the marker should draw on intersecting entities.

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()
v3CoordsInfront = player.get_coords_infront(100)
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_line(1, v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 255, 255, 255, 255, 5.0, 5.0, 255, 0, 0, 255, true, true, 2, true, "mpmissmarkers256", "capture_the_flag_base_icon", true)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end

---

draw_rect(x, y, width, height, red, green, blue, alpha)

Draws a rectangle on the screen. Similar to render.draw_rect()

Note

The total number of rectangles to be drawn in one frame is apparently limited to 399.

Note

This has to be called every frame.

Parameters:

• x (float) – The X coordinate of the top-left corner. (0.0 - 1.0, 0.0 is the left edge of the screen, 1.0 is the right edge of the screen)

• y (float) – The Y coordinate of the top-left corner. (0.0 - 1.0, 0.0 is the top edge of the screen, 1.0 is the bottom edge of the screen)

• width (float) – The width of the rectangle. (0.0 - 1.0, 1.0 means the whole screen width)

• height (float) – The height of the rectangle. (0.0 - 1.0, 1.0 means the whole screen height)

• red (int) – The red part of the rectangle color (0 - 255)

• green (int) – The green part of the rectangle color (0 - 255)

• blue (int) – The blue part of the rectangle color (0 - 255)

• alpha (int) – The transparency of the rectangle color (0 - 255)

Returns:

• None

Example:

bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_rect(0.5, 0.5, 0.5, 0.5, 255, 255, 255, 100)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end

---

draw_scaleform_movie(scaleformHandle, x, y, width, height, red, green, blue, alpha)

Draw scaleform in the selected dimensions

Note

This has to be called every frame.

Parameters:

• scaleformHandle (int) – The scaleform handle to draw.

• x (float) – The X coordinate to draw the scaleform at. (0.0 - 1.0, 0.0 is the left edge of the screen, 1.0 is the right edge of the screen)

• y (float) – The Y coordinate to draw the scaleform at. (0.0 - 1.0, 0.0 is the top edge of the screen, 1.0 is the bottom edge of the screen)

• width (float) – The width of the scaleform. (0.0 - 1.0, 1.0 means the whole screen width)

• height (float) – The height of the scaleform. (0.0 - 1.0, 1.0 means the whole screen height)

• red (int) – The red part of the scaleform color (0 - 255)

• green (int) – The green part of the scaleform color (0 - 255)

• blue (int) – The blue part of the scaleform color (0 - 255)

• alpha (int) – The transparency of the scaleform color (0 - 255)

For scaleform IDs and methods, go here: Decompiled Scaleforms

Returns:

• None

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie("MP_BIG_MESSAGE_FREEMODE")
rage.graphics.end_scaleform_movie_method()
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_scaleform_movie(iScaleformHandle, 0.5, 0.5, 0.5, 0.5, 255, 255, 255, 255)
   rage.graphics.begin_scaleform_movie_method(iScaleformHandle, "SHOW_SHARD_WASTED_MP_MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("BIG MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("small message")
   rage.graphics.scaleform_movie_method_add_param_int(5)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle)
return

---

draw_scaleform_movie_fullscreen(scaleformHandle, red, green, blue, alpha, unk)

Draw a scaleform in fullscreen.

Note

This has to be called every frame.

Parameters:

• scaleformHandle (int) – The scaleform handle to draw.

• red (int) – The red part of the scaleform color (0 - 255)

• green (int) – The green part of the scaleform color (0 - 255)

• blue (int) – The blue part of the scaleform color (0 - 255)

• alpha (int) – The transparency of the scaleform color (0 - 255)

• unk (int) – Unknown. Not used.

For scaleform IDs and methods, go here: Decompiled Scaleforms

Returns:

• None

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie("MP_BIG_MESSAGE_FREEMODE")
rage.graphics.end_scaleform_movie_method()
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_scaleform_movie_fullscreen(iScaleformHandle, 255, 255, 255, 255, 0)
   rage.graphics.begin_scaleform_movie_method(iScaleformHandle, "SHOW_SHARD_WASTED_MP_MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("BIG MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("small message")
   rage.graphics.scaleform_movie_method_add_param_int(5)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle)
return

---

enable_alien_blood_vfx(toggle)

Creates a motion-blur sort of effect. Doesn’t seem to work, but if you use animpostfx_play() with DrugsMichaelAliensFight animfx, you should be able to get the intended effect

Parameters:

• toggle (boolean) – Whether to enable the effect or not.

  • true – Enable the effect

  • false – Disable the effect

Returns:

• None

Example:

enable_alien_blood_vfx(true)
system.wait(1000)
enable_alien_blood_vfx(false)

---

enable_clown_blood_vfx(toggle)

Creates cartoon effect when Michel smokes the weed.

Parameters:

• toggle (boolean) – Whether to enable the effect or not.

  • true – Enable the effect

  • false – Disable the effect

Returns:

• None

Example:

enable_clown_blood_vfx(true)
system.wait(1000)
enable_clown_blood_vfx(false)

---

end_scaleform_movie_method()

Finishes all scaleforms that are currently drawn.

Parameters:

• None

Returns:

• None

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie(“MP_BIG_MESSAGE_FREEMODE”) rage.graphics.end_scaleform_movie_method() bPressed = system.is_key_pressed(“K”) while not bPressed do

rage.graphics.draw_scaleform_movie_fullscreen(iScaleformHandle, 255, 255, 255, 255, 0) rage.graphics.begin_scaleform_movie_method(iScaleformHandle, “SHOW_SHARD_WASTED_MP_MESSAGE”) rage.graphics.scaleform_movie_method_add_param_texture_name_string(“BIG MESSAGE”) rage.graphics.scaleform_movie_method_add_param_texture_name_string(“small message”) rage.graphics.scaleform_movie_method_add_param_int(5) bPressed = system.is_key_pressed(“K”) system.wait(-1)

end rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle) return

---

has_scaleform_movie_loaded(scaleformHandle)

Checks whether a scaleform was loaded.

Parameters:

• scaleformHandle (int) – The scaleform handle to check.

Returns:

• boolean – true if the scaleform was loaded, false otherwise.

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie(“MP_BIG_MESSAGE_FREEMODE”) if rage.graphics.has_scaleform_movie_loaded(iScaleformHandle) then

print(“scaleform loaded”)

else

print(“scaleform not loaded”)

end

---

remove_particle_fx(ptfxHandle, p1)

Removes a particle effect.

Parameters:

• ptfxHandle (int) – The particle effect handle to remove.

• p1 (bool) – Unknown. Seen to be false.

Returns:

• None

Note

PTFX spawning is not implemented yet, therefore no example.

---

request_scaleform_movie(scaleformName)

Request a scaleform handle.

Parameters:

• scaleformName (string) – The name of the scaleform to request.

  • You can find the names of the scaleforms in Decompiled Scaleforms

Returns:

• int – The scaleform handle.

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie(“MP_BIG_MESSAGE_FREEMODE”) system.log_debug(iScaleformHandle)

---

scaleform_movie_method_add_param_bool(value)

Pass a bool param to scaleform. The scaleform should be initialized already.

Parameters:

• value (boolean) – The value to add.

Returns:

• None

Example:

Note

I wasn’t able to come up with a good example. If somebody can, please make a pull request.

---

scaleform_movie_method_add_param_float(value)

Pass a float param to scaleform. The scaleform should be initialized already.

Parameters:

• value (float) – The value to add.

Returns:

• None

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie("MP_BIG_MESSAGE_FREEMODE")
rage.graphics.end_scaleform_movie_method()
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_scaleform_movie(iScaleformHandle, 0.5, 0.5, 0.5, 0.5, 255, 255, 255, 255)
   rage.graphics.begin_scaleform_movie_method(iScaleformHandle, "SHOW_SHARD_WASTED_MP_MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("BIG MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("small message")
   rage.graphics.scaleform_movie_method_add_param_float(5.0)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle)
return

---

scaleform_movie_method_add_param_int(value)

Pass an int param to scaleform. The scaleform should be initialized already.

Parameters:

• value (int) – The value to add.

Returns:

• None

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie("MP_BIG_MESSAGE_FREEMODE")
rage.graphics.end_scaleform_movie_method()
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_scaleform_movie(iScaleformHandle, 0.5, 0.5, 0.5, 0.5, 255, 255, 255, 255)
   rage.graphics.begin_scaleform_movie_method(iScaleformHandle, "SHOW_SHARD_WASTED_MP_MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("BIG MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("small message")
   rage.graphics.scaleform_movie_method_add_param_int(5)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle)
return

---

scaleform_movie_method_add_param_texture_name_string(value)

Pass a string param to scaleform. The scaleform should be initialized already.

Parameters:

• value (string) – The value to add.

Returns:

• None

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie("MP_BIG_MESSAGE_FREEMODE")
rage.graphics.end_scaleform_movie_method()
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_scaleform_movie(iScaleformHandle, 0.5, 0.5, 0.5, 0.5, 255, 255, 255, 255)
   rage.graphics.begin_scaleform_movie_method(iScaleformHandle, "SHOW_SHARD_WASTED_MP_MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("BIG MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("small message")
   rage.graphics.scaleform_movie_method_add_param_int(5)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle)
return

---

set_checkpoint_cylinder_height(checkpoint, nearHeight, farHeight, radius)

Set the height of the cylindrical checkpoint.

Parameters:

• checkpoint (int) – The checkpoint handle.

• nearHeight (float) – The height of the checkpoint when inside of the radius.

• farHeight (float) – The height of the checkpoint when outside of the radius.

• radius (float) – The radius of the checkpoint.

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()
v3CoordsInfront = player.get_coords_infront(100)
iCheckpointHandle = rage.graphics.create_checkpoint(45, v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 50, 255, 0, 0, 255, 120)
rage.graphics.set_checkpoint_cylinder_height(iCheckpointHandle, 0.0, 100.0, 50.0)

---

set_checkpoint_rgba(checkpoint, red, green, blue, alpha)

Set the RGBA of the checkpoint.

Parameters:

• checkpoint (int) – The checkpoint handle.

• red (int) – The red value.

• green (int) – The green value.

• blue (int) – The blue value.

• alpha (int) – The alpha value.

Returns:

• None

Example:

v3CurrentCoords = player.get_coords()
v3CoordsInfront = player.get_coords_infront(100)
iCheckpointHandle = rage.graphics.create_checkpoint(45, v3CurrentCoords.x, v3CurrentCoords.y, v3CurrentCoords.z, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 50, 255, 0, 0, 255, 120)
rage.graphics.set_checkpoint_rgba(iCheckpointHandle, 0, 255, 0, 255)

---

set_scaleform_movie_as_no_longer_needed(scaleformHandle)

Deinitializes a scaleform object.

Parameters:

• scaleformHandle (int) – The scaleform handle.

Returns:

• None

Example:

iScaleformHandle = rage.graphics.request_scaleform_movie("MP_BIG_MESSAGE_FREEMODE")
rage.graphics.end_scaleform_movie_method()
bPressed = system.is_key_pressed("K")
while not bPressed do
   rage.graphics.draw_scaleform_movie(iScaleformHandle, 0.5, 0.5, 0.5, 0.5, 255, 255, 255, 255)
   rage.graphics.begin_scaleform_movie_method(iScaleformHandle, "SHOW_SHARD_WASTED_MP_MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("BIG MESSAGE")
   rage.graphics.scaleform_movie_method_add_param_texture_name_string("small message")
   rage.graphics.scaleform_movie_method_add_param_int(5)
   bPressed = system.is_key_pressed("K")
   system.wait(-1)
end
rage.graphics.set_scaleform_movie_as_no_longer_needed(iScaleformHandle)
return

---

world_to_screen_pixels(coords)

Transforms world coords to screen pixels.

Parameters:

• coords (vector3) – The world coords.

Returns:

• vector2 – The screen coords.

Example:

plHostPlayer = lobby.get_host()
v3HostCoords = lobby.get_player_coords(plHostPlayer)
v2PlayerScreenCoords = rage.graphics.world_to_screen_pixels(v3HostCoords)

---

world_to_screen_relative(coords)

Returns how you have to move the camera for the coords to be in the center of the screen

Parameters:

• coords (vector3) – The world coords.

Returns:

• vector2 – The screen coords.

Example:

plHostPlayer = lobby.get_host()
v3HostCoords = lobby.get_player_coords(plHostPlayer)
v2PlayerScreenCoords = rage.graphics.world_to_screen_relative(v3HostCoords)

---

Time namespace

This namespace contains time-related game functions.

---

get_clock_hours()

Returns the current in-game hour

Parameters:

• None

Returns:

• int – The current hour

Example:

iCurrentHour = rage.time.get_clock_hours()
system.log_debug("Current hour: " .. iCurrentHour)

---

get_current_minutes()

Returns the current in-game minute

Parameters:

• None

Returns:

• int – The current minute

Example:

iCurrentMinute = rage.time.get_current_minutes()
system.log_debug("Current minute: " .. iCurrentMinute)

---

get_current_seconds()

Returns the current in-game second

Parameters:

• None

Returns:

• int – The current second

Example:

iCurrentSecond = rage.time.get_current_seconds()
system.log_debug("Current second: " .. iCurrentSecond)

---

set_clock_time(hour, minute, second)

Set the in-game time

Parameters:

• hour (int) – The hour

• minute (int) – The minute

• second (int) – The second

Returns:

• None

Example:

rage.time.set_clock_time(12, 30, 45) -- Sets in-game time to 12:30:45

---

Task namespace

This namespace contains task-related game functions.

---

does_scenario_group_exist(scenarioGroup)

Checks whether a scenario group exists.

Parameters:

• scenarioGroup (string) – Scenario group name

  • You can read more about scenario groups here: Scenario groups

Returns:

• bool – Scenario group status check

  • true – Scenario group exists

  • false – Scenario group does not exist

Example:

bDoesScenGroupExist = rage.task.does_scenario_group_exist("SOLOMON_GATE")

system.log_debug(tostring(bDoesScenGroupExist))

---

is_ped_active_in_scenario(ped)

Checks whether the ped is currently in any scenario.

Parameters:

• ped (Ped) – Ped object

Returns:

• bool – Check status

  • true – If the ped is currently in any scenario.

  • false – If the ped is not in any scenario.

Example:

pSelfPed = player.get_ped()

bIsPedActiveInScen = rage.task.is_ped_active_in_scenario(ped)

system.log_debug(tostring(bIsPedActiveInScen))

---

is_scenario_group_enabled(scenarioGroup)

Checks whether the scenario group is enabled.

Parameters:

• scenarioGroup (string) – Scenario group name

  • You can read more about scenario groups here: Scenario groups

Returns:

• bool – Scenario group status

  • true – Scenario group is enabled.

  • false – Scenario group is not enabled.

Example:

bIsScenGroupEnabled = rage.task.is_scenario_group_enabled("SOLOMON_GATE")

system.log_debug(tostring(bIsScenGroupEnabled))

---

is_scenario_type_enabled(scenarioType)

Checks whether the scenario type is enabled.

Parameters:

• scenarioType (string) – Scenario type name

  • You can read more about scenario groups here: Scenario types

Returns:

• bool – Scenario type status check

  • true – Scenario type is enabled.

  • false – Scenario type is not enabled.

Example:

bIsScenTypeEnabled = rage.task.is_scenario_type_enabled("WORLD_HUMAN_DRINKING")

system.log_debug(tostring(bIsScenTypeEnabled))

---

get_is_task_active(ped, taskIndex)

Checks whether the task is active.

Parameters:

• ped (Ped) – Ped object

• taskIndex (int) – Task index enum

  • You can check out possible task indexes here: Task Index

Returns:

• bool – Task status check

  • true – Task is active.

  • false – Task is not active.

Example:

bIsTaskActive = rage.task.get_is_task_active(player.get_ped(), 127)  -- Checks whether the CTaskCrouch is active
system.log_debug(tostring(bIsTaskActive))

---

play_anim_on_running_scenario(ped, animDict, animName)

Play the animation on any running scenario.

Parameters:

• ped (Ped) – Ped object

• animDict (string) – Animation dictionary

• animName (string) – Animation (clip) name

  • You can read more about animations dicts and names here: Animation types

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.play_anim_on_running_scenario(pSelfPed, "move_f@injured", "idle_intro")

---

reset_exclusive_scenario_group()

Reset the exclusive scenario group.

Parameters:

• None

Returns:

• None

Example:

rage.task.reset_exclusive_scenario_group()

---

reset_scenario_groups_enabled()

Reset all the enabled scenario groups.

Parameters:

• None

Returns:

• None

Example:

rage.task.reset_scenario_groups_enabled()

---

reset_scenario_types_enabled()

Reset all the enabled scenario types.

Parameters:

• None

Returns:

• None

Example:

rage.task.reset_scenario_types_enabled()

---

set_exclusive_scenario_group(scenarioGroup)

Set the scenario group as exclusive.

Parameters:

• scenarioGroup (string) – Scenario group name

  • You can read more about scenario groups here: Scenario groups

Returns:

• None

Example:

rage.task.set_exclusive_scenario_group("SOLOMON_GATE")

---

reset_exclusive_scenario_group()

Reset the exclusive scenario group(s).

Parameters:

• None

Returns:

• None

Example:

rage.task.reset_exclusive_scenario_group()

---

set_parachute_task_target(ped, x, y, z)

Make ped parachute to target

Parameters:

• ped (Ped) – Ped object

• x (string) – The X coordinate

• y (string) – The Y coordinate

• z (string) – The Z coordinate

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.set_parachute_task_target(pSelfPed, 60, 118, 12)

---

set_parachute_task_thrust(ped, thrust)

Set the parachute task thrust.

Parameters:

• ped (Ped) – Ped object

• thrust (float) – The thrust value

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.set_parachute_task_thrust(pSelfPed, 10)

---

set_scenario_group_enabled(scenarioGroup, p1)

Set scenario group as enabled.

Parameters:

• scenarioGroup (string) – Scenario group name

  • You can read more about scenario groups here: Scenario groups

• p1 (bool) – Unknown

Returns:

• None

Example:

rage.task.set_scenario_group_enabled("SOLOMON_GATE")

---

set_scenario_type_enabled(scenarioType, toggle)

Toggle the scenario type.

Parameters:

• scenarioType (string) – Scenario type name

  • You can read more about scenario groups here: Scenario types

• toggle (bool) – Toggle

  • true – Scenario type enabled

  • false – Scenario type not enabled

Returns:

• None

Example:

rage.task.set_scenario_type_enabled("WORLD_HUMAN_DRINKING", true)

---

stop_anim_task(ped, animDictionary, animationName, p3)

Stop animation task.

Parameters:

• ped (Ped) – Ped object

• animDictionary (string) – Animation dictionary

• animationName (string) – Animation (clip) name

  • You can read more about animations dicts and names here: Animation types

• p3 (float) – Unknown

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.stop_anim_task(pSelfPed, "move_f@injured", "sprint")

---

task_aim_gun_at_coord(ped, x, y, z, time, p5, p6)

Aim gun at coordinates.

Parameters:

• ped (Ped) – Ped object

• x (string) – The X coordinate

• y (string) – The Y coordinate

• z (string) – The Z coordinate

• time (int) – Time to aim at the coordinates

• p5 (bool) – Unknown

• p6 (bool) – Unknown

Returns:

• None

Example:

pSelfPed = player.get_ped()
v3CoordsInfront = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront, 10)

rage.task.task_aim_gun_at_coord(pSelfPed, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 5)

---

task_aim_gun_at_entity(ped, entity, duration, p3)

Aim gun at entity.

Parameters:

• ped (Ped) – Ped object

• entity (Entity) – The entity ID

• duration (int) – The duration value

• p3 (bool) – Unknown

Returns:

• None

Example:

pSelfPed = player.get_ped()

pHostPed = lobby.get_player_ped(lobby.get_host())

rage.task.task_aim_gun_at_entity(pSelfPed, pHostPed, 5)

---

task_combat_ped(ped, targetPed, p2, p3)

Makes the specified ped attack the target ped.

Parameters:

• ped (Ped) – Ped object

• targetPed (Ped) – Target ped object

• p2 (int) – The duration value

• p3 (int) – Unknown

Returns:

• None

Example:

pSelfPed = player.get_ped()
plHostPlayer = lobby.get_host()

pTargetPed = lobby.get_player_ped(plhostPlayer)

rage.task.task_combat_ped(pSelfPed, pTargetPed) -- You will attack the lobby host

---

task_enter_vehicle(ped, vehicle, timeout, seat, speed, flag, p6)

Makes the specified ped enter the vehicle.

Parameters:

• ped (Ped) – Ped object

• vehicle (Vehicle) – Vehicle ID

• timeout (int) – Animation timeout

• seat (int) – Seat type ID

  • You can read more about seat types here: Seat types

• speed (float) – Ped speed

  • 1.0 = walk

  • 2.0 = run

• flag (int) – Entering type

  • 1 = normal

  • 3 = teleport to vehicle

  • 8 = normal/carjack ped from seat

  • 16 = teleport directly into vehicle

• p6 (Any) – Always 0

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

v3CoordsInfront = player.get_coords_infront(5)
vVehicleHandle = scripting.spawn.spawn_vehicle(vehicleHash, coordsInfront, 30)

rage.task.task_enter_vehicle(pSelfPed, vVehicleHandle, 0, -1, 2.0, 1, 0) --  Ped will enter the Zentorno walking and sitting on driver seat.

---

task_follow_to_offset_of_entity(ped, entity, offsetX, offsetY, offsetZ, movementSpeed, timeout, stoppingRange, persistFollowing)

Follow to offset of the entity.

Parameters:

• ped (Ped) – Ped object

• entity (Entity) – The entity ID

• offsetX (float) – Offset X position

• offsetY (float) – Offset Y position

• offsetZ (float) – Offset Z position

• movementSpeed (float) – Movement speed

• timeout (int) – Timeout

• stoppingRange (float) – Stopping range

• persistFollowing (bool) – Toggle persist following

  • true – Persist following on

  • false – Persist following off

Returns:

• None

Example:

pSelfPed = player.get_ped()

pHostPed = lobby.get_player_ped(lobby.get_host())

rage.task.task_follow_to_offset_of_entity(pSelfPed, pHostPed, 5, 5, 1, 2, 0, 1, true)

---

task_go_to_coord_while_aiming_at_coord(ped, x, y, z, aimAtX, aimAtY, aimAtZ, moveSpeed, p8, p9, p10, p11, flags, p13, firingPattern)

Make the ped move to a coordinate while aiming (and optionally shooting) at given coordinates.

Parameters:

• ped (Ped) – Ped object

• x (float) – Destination X position

• y (float) – Destination Y position

• z (float) – Destination Z position

• aimAtX (float) – Aim at target X position

• aimAtY (float) – Aim at target Y position

• aimAtZ (float) – Aim at target Z position

• moveSpeed (float) – Movement speed

• p8 (bool) – Toggle ped shooting

  • true – Ped will shoot

  • false – Ped will not shoot

• p9 (float) – seen to be 2.0

• p10 (float) – seen to be 0.5

• p11 (bool)

  • true – ped will stay still

  • false – will not stay still

• flags (Any) – 0 / 512 / 513

• p13 (bool) – Unknown

• firingPattern (Hash) – Firing pattern hash

  • Firing patterns can be found here: Firing patterns

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_go_to_coord_while_aiming_at_coord(pSelfPed, 5, 5, 1, 10, 10, 1, 2, true)

---

task_go_to_coord_while_aiming_at_entity(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13)

Make the ped move to a coordinate while aiming (and optionally shooting) at given coordinates.

Parameters:

• p0 (Any) – Ped ID

• p1 (float) – X coordinate to go to

• p2 (float) – Y coordinate to go to

• p3 (float) – Z coordinate to go to

• p4 (Any) – Ped to aim on

• p5 (float) – Unknown always seems to be 2.0

• p6 (bool) – Unknown – seen to be both false and true

• p7 (float) – Unknown – let it be 1.5

• p8 (float) – Unknown – let it be 1.5

• p9 (bool) – Unknown – seen to be false

• p10 (Any) – Unknown – seen to be false

• p11 (bool) – Unknown – probably false?

• p12 (Any) – Firing pattern

  • Firing patterns can be found here: Firing patterns

• p13 (Any) – Unknown – let it be 20000, nobody knows what that is

Returns:

• None

Example:

Note

This example was not tested.

pSelfPed = player.get_ped()

pHostPed = lobby.get_player_ped(lobby.get_host())

rage.task.task_go_to_coord_while_aiming_at_entity(pSelfPed, 119.73, 65.30, 420.12, pHostPed, 2.0, false, 1.5, 1.5, false, false, false)

---

task_go_to_entity_while_aiming_at_entity(ped, entityToWalkTo, entityToAimAt, speed, shootatEntity, p5, p6, p7, p8, firingPattern)

Make the ped move to an entity while aiming and optionally shooting and optionally killing it.

Parameters:

• ped (Ped) – Ped object

• entityToWalkTo (Entity) – Entity to walk to

• entityToAimAt (Entity) – Entity to aim at

• speed (float) – Speed

• shootatEntity (bool) – Toggle shoot at entity

  • true – Peds will shoot at Entity till it is dead.

  • false – Peds will just walk till they reach the entity and will cease shooting.

• p5 (float) – Unknown

• p6 (float) – Unknown

• p7 (bool) – Unknown

• p8 (bool) – Unknown

• firingPattern (Hash) – Firing pattern hash

  • Firing patterns can be found here: Firing patterns

Returns:

• None

Example:

pSelfPed = player.get_ped()

pHostPed = lobby.get_player_ped(lobby.get_host())

rage.task.task_go_to_entity_while_aiming_at_entity(pSelfPed, pHostPed, 5, 5, 1, 2, 0, 1, true)

---

task_go_to_entity(entity, target, duration, distance, speed, p5, p6)

Make the entity move to a target until time is over (duration) or get in target’s range (distance).

Parameters:

• entity (Entity) – Entity object

• target (Entity) – Target object

• duration (int) – Time available to complete the task

  • duration = -1 – The task duration will be ignored

• distance (float) – Target’s range

• speed (float) – Speed

• p5 (float) – Unknown but can leave it 1073741824 or 100 or even 0 (no difference noticed)

• p6 (bool) – Unknown but can leave it 0

Returns:

• None

Example:

pSelfPed = player.get_ped()
v3CoordsInfront = player.get_coords_infront(10)
uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")

vSpawnedVehicleHandle = scripting.spawn.spawn_vehicle(uZentornoHash, v3CoordsInfront, 30.0)

rage.task.task_go_to_entity(pSelfPed, vSpawnedVehicleHandle, 5000, 4.0, 100, 1073741824, 0)
-- Ped will run towards the vehicle for 5 seconds and stop when time is over or when he Returns 4 meters(?) around the vehicle

---

task_leave_vehicle(ped, vehicle, flags)

Make the ped leave the vehicle with customizable flags.

Parameters:

• ped (Ped) – Ped object

• vehicle (Vehicle) – Vehicle ID

• flags (int) – Vehicle leaving flags

  • 0 = normal exit and closes door

  • 1 = normal exit and closes door

  • 16 = teleports outside, door kept closed. (This flag does not seem to work for the front seats in buses, NPCs continue to exit normally)

  • 64 = normal exit and closes door

  • 256 = normal exit but does not close the door

  • 4160 = ped is throwing himself out, even when the vehicle is still

  • 262144 = ped moves to passenger seat first, then exits normally

  • Others to be tried out: 320, 512, 131072

Returns:

Example:

pSelfPed = player.get_ped()

vPedVehicle = player.rage.ped.get_vehicle_ped_is_using(ped)

rage.task.task_leave_vehicle(pSelfPed, vPedVehicle, 1)

---

task_open_vehicle_door(ped, vehicle, timeOut, seat, speed)

Make the ped open the vehicle door of a specific seat, at given speed.

Parameters:

• ped (Ped) – Ped object

• vehicle (Vehicle) – Vehicle ID

• timeOut (int) – Task timeout

• seat (int) – Seat Index

  • You can read more about seat indexes here: Seat types

• speed (float) – Speed to open the door

Returns:

• None

Example:

pSelfPed = player.get_ped()

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

v3CoordsInfront = player.get_coords_infront(5)

vSpawnedVehicleHandle = scripting.spawn.spawn_vehicle(uZentornoHash, v3CoordsInfront, 30.0)

rage.task.task_open_vehicle_door(pSelfPed, vSpawnedVehicleHandle, 100, 1, 2.0)

---

task_parachute(ped, p1, p2)

Make the ped do a parachute jump

Parameters:

• ped (Ped) – Ped object

• p1 (bool) – Unknown (unused)

• p1 (bool) – Unknown

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_parachute(pSelfPed)

---

task_parachute_to_target(ped, x, y, z)

Makes the ped parachute to given coordinates.

Parameters:

• ped (Ped) – Ped object

• x (float) – The X position

• y (float) – The Y position

• z (float) – The Z position

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_parachute_to_target(pSelfPed, 69.5, 420.10, 57.91)

---

task_play_anim(ped, animDictionary, animationName, blendInSpeed, blendOutSpeed, duration, flag, playbackRate, lockX, lockY, lockZ)

Makes the ped play an animation with custom duration and flags.

Parameters:

• ped (Ped) – Ped object

• animDictionary (string) – Animation dictionary

• animationName (string) – Animation (clip) name

  • You can read more about animations dicts and names here: Animation types

• blendInSpeed (float) – Normal speed is 8.0

• blendOutSpeed (float) – Normal speed is 8.0

• duration (int) – Time in millisecond

• flag (int) – enum eAnimationFlags:

  • ANIM_FLAG_NORMAL = 0

  • ANIM_FLAG_REPEAT = 1

  • ANIM_FLAG_STOP_LAST_FRAME = 2

  • ANIM_FLAG_UPPERBODY = 16

  • ANIM_FLAG_ENABLE_PLAYER_CONTROL = 32

  • ANIM_FLAG_CANCELABLE = 120

• playbackRate (float) – Values are between 0.0 and 1.0

• lockX (bool) – 0 in most case

• lockY (bool) – 0 in most case

• lockZ (bool) – 0 for singleplayer, can be 1 in multiplayer

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_play_anim(pSelfPed, "move_f@injured", "sprint", 8.0, 8.0, 5000, 0, 0.0, 0, 0, 1)

---

task_rappel_from_heli(ped, minHeightAboveGround)

Makes the ped rappel from helicopter, with settable minimum height above the ground.

Parameters:

• ped (Ped) – Ped object

• minHeightAboveGround (float) – Minimum helicopter height above the ground

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_rappel_from_heli(pSelfPed, 100)

---

task_shoot_at_entity(entity, target, duration, firingPattern)

Make the entity shoot at an entity targeted for a given duration and with custom firing pattern.

Parameters:

• entity (Entity) – Entity object

• target (Entity) – Target entity object

• duration (int) – Duration in milliseconds

• firingPattern (Hash) – Firing pattern hash

  • Firing patterns can be found here: Firing patterns

Returns:

• None

Example:

pSelfPed = player.get_ped()

plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)

rage.task.task_shoot_at_entity(pSelfPed, pHostPed, 5000, 1)

---

task_sky_dive(ped, p1)

Makes the ped sky-dive.

Parameters:

• ped (Ped) – Ped object

• p1 (bool) – Unknown

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_sky_dive(pSelfPed)

---

task_stand_guard(ped, x, y, z, heading, scenarioName)

Makes the ped parachute to given coordinates.

Parameters:

• ped (Ped) – Ped object

• x (float) – The X position

• y (float) – The Y position

• z (float) – The Z position

• heading (float) – The heading direction

• scenarioName (string) – The scenario name

  • You can read more about scenario groups here: Scenario groups

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_parachute_to_target(pSelfPed, 69.5, 420.10, 57.91, 1, "WORLD_HUMAN_GUARD_STAND")

---

task_start_scenario_at_position(ped, scenarioName, x, y, z, heading, duration, sittingScenario, teleport)

Makes the ped start the scenario at a given position.

Parameters:

• ped (Ped) – Ped object

• scenarioName (string) – The scenario name

  • You can read more about scenario groups here: Scenario groups

• x (float) – The X position

• y (float) – The Y position

• z (float) – The Z position

• heading (float) – The heading direction

• duration (int) – Duration in milliseconds

• sittingScenario (bool) – Toggle sitting scenario

  • true – Sitting scenario on

  • false – Sitting scenario off

• teleport (bool) – Toggle teleport ped to the given position

  • true – Teleport ped to coordinates

  • false – Do not teleport ped

Returns:

• None

Example:

pSelfPed = player.get_ped()
v3CoordsInfront = player.get_coords_infront(10)

rage.task.task_start_scenario_at_position(pSelfPed, "WORLD_HUMAN_GUARD_STAND", v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 1, 5000, false, true)

---

task_start_scenario_in_place(ped, scenarioName, unkDelay, playEnterAnim)

Plays a scenario on a Ped at their current location.

Parameters:

• ped (Ped) – Ped object

• scenarioName (string) – The scenario name

  • You can read more about scenario groups here: Scenario groups

• unkDelay (int) – Usually 0 or -1, doesn’t seem to have any effect.

• playEnterAnim (bool) – Scenarios that don’t have any “Enter” anims won’t play if this is set to true.

  • true – Plays the “Enter” anim

  • false – Plays the “Exit” anim

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_start_scenario_in_place(pSelfPed, "WORLD_HUMAN_GUARD_STAND", 0, true)

---

task_stay_in_cover(ped)

Makes the ped stay in cover.

Parameters:

• ped (Ped) – Ped object

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_stay_in_cover(pSelfPed)

---

task_turn_ped_to_face_entity(ped, entity, duration)

Turn the ped to face towards the entity.

Parameters:

• ped (Ped) – Ped object

• entity (Entity) – Entity object

• duration (int) – The amount of time in milliseconds to do the task.

  • -1 will keep the task going until either another task is applied, or CLEAR_ALL_TASKS() is called with the ped

Returns:

• None

Example:

pSelfPed = player.get_ped()
plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)

rage.task.task_turn_ped_to_face_entity(pSelfPed, pHostPed, 500)

---

task_vehicle_aim_at_coord(ped, x, y, z)

Makes ped vehicle aim at given coordinates.

Parameters:

• ped (Ped) – Ped object

• x (float) – The X position

• y (float) – The Y position

• z (float) – The Z position

Returns:

• None

Example:

pSelfPed = player.get_ped()
v3CoordsInfront = player.get_coords_infront(10)

rage.task.task_vehicle_aim_at_coord(ped, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z)

---

task_vehicle_aim_at_ped(ped, target)

Makes ped vehicle aim at a given ped.

Parameters:

• ped (Ped) – Ped object

• target (Ped) – Target ped object

Returns:

• None

Example:

pSelfPed = player.get_ped()
plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)

rage.task.task_vehicle_aim_at_ped(pSelfPed, pHostPed)

---

task_vehicle_chase(driver, targetEnt)

Makes ped driver chase a target entity.

Parameters:

• driver (Ped) – Ped object (vehicle driver)

• targetEnt (Entity) – Target entity

Returns:

• None

Example:

pSelfPed = player.get_ped()
plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)

rage.task.task_vehicle_chase(pSelfPed, pHostPed)

---

task_vehicle_drive_to_coord(ped, vehicle, x, y, z, speed, p6, vehicleModel, drivingMode, stopRange, p10)

Makes ped drive the vehicle to given coordinates.

Parameters:

• driver (Ped) – Ped object (vehicle driver)

• vehicle (Vehicle) – The vehicle ID

• x (float) – The X position

• y (float) – The Y position

• z (float) – The Z position

• speed (float) – The driving speed

• p6 (Any) – Unknown

• vehicleModel (Hash) – The vehiclemde hash

• drivingMode (int) – Driving mode

• stopRange (float) – Stops in the specific range near the destination. 20.0 works fine.

• p10 (float) – Unknown

Returns:

• None

Example:

pSelfPed = player.get_ped()
v3CoordsInfront = player.get_coords_infront(5)
uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")

vSpawnedVehicleHandle = scripting.spawn.spawn_vehicle(uZentornoHash, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 0.0)
scripting.teleport.to_nearest_vehicle()

v3CoordsInfront = player.get_coords_infront(100)

rage.task.task_vehicle_drive_to_coord(pSelfPed, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 10, vSpawnedVehicleHandle, 1, 5)

---

task_vehicle_drive_to_coord_longrange(ped, vehicle, x, y, z, speed, driveMode, stopRange)

Makes ped drive to the destination at set speed and driving style.

Parameters:

• ped (Ped) – Ped object

• vehicle (Vehicle) – The vehicle ID

• x (float) – The X position

• y (float) – The Y position

• z (float) – The Z position

• speed (float) – The driving speed

• driveMode (int) – Driving mode, Driving Style calculator

• stopRange (float) – Stops in the specific range near the destination. 20.0 works fine

Returns:

• None

Example:

pSelfPed = player.get_ped()
v3CoordsInfront = player.get_coords_infront(5)
uZentornoHash = rage.gameplay.get_hash_key("ZENTORNO")

vSpawnedVehicleHandle = scripting.spawn.spawn_vehicle(uZentornoHash, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 0.0)
scripting.teleport.to_nearest_vehicle()

v3CoordsInfront = player.get_coords_infront(1000)

rage.task.task_vehicle_drive_to_coord_longrange(pSelfPed, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 50, vSpawnedVehicleHandle, 1, 5)

---

task_vehicle_drive_wander(ped, vehicle, speed, drivingStyle)

Makes ped drive randomly with no destination set.

Parameters:

• ped (Ped) – Ped object

• vehicle (Vehicle) – The vehicle ID

• speed (float) – The driving speed

• drivingStyle (int) – Driving mode, Driving Style calculator

Returns:

• None

Example:

pSelfPed = player.get_ped()

vCurrentVehicleHandle = player.get_vehicle()

rage.task.task_vehicle_drive_wander(pSelfPed, vCurrentVehicleHandle, 30, 6)

---

task_vehicle_escort(ped, vehicle, targetVehicle, mode, speed, drivingStyle, minDistance, p7, noRoadsDistance)

Makes a ped follow the targetVehicle with <minDistance> in between.

Parameters:

• ped (Ped) – Ped object

• vehicle (Vehicle) – The vehicle ID

• targetVehicle (Vehicle) – The target vehicle ID

• mode (int) – The mode defines the relative position to the targetVehicle. The ped will try to position its vehicle there.

  • -1 = behind

  • 0 = ahead

  • 1 = left

  • 2 = right

  • 3 = back left

  • 4 = back right

• speed (float) – The driving speed

• drivingStyle (int) – Driving mode, Driving Style calculator

• minDistance (float) – The minimum distance between ped vehicle and target vehicle

  • minDistance is ignored if drivingstyle is Avoiding Traffic, but Rushed is fine.

• p7 (int) – Unknown

• noRoadsDistance (float) – If the target is closer than noRoadsDistance, the driver will ignore pathing/roads and follow it direct.

Returns:

• None

Example:

Note

This example was not tested. It assumes that the host and the player are driving vehicles.

pSelfPed = player.get_ped()
vCurrentVehicleHandle = player.get_vehicle()
plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)
vTargetVehicleHandle = rage.ped.get_vehicle_ped_is_using(pedHostPed)

rage.task.task_vehicle_escort(pSelfPed, vCurrentVehicleHandle, vTargetVehicleHandle, -1, 50, 6, 100) -- player will follow host with 100m in betweentask_vehicle_escorttargetVehicle, -150, 6, 10, 20

---

task_vehicle_follow(ped, vehicle, targetEntity, speed, drivingStyle, minDistance)

Makes a ped in a vehicle follow an entity.

Parameters:

• ped (Ped) – Ped object

• vehicle (Vehicle) – The vehicle ID

• targetEntity (Entity) – The target entity ID

• speed (float) – The driving speed

• drivingStyle (int) – Driving mode, Driving Style calculator

• minDistance (float) – The minimum distance between ped vehicle and target vehicle

  • minDistance is ignored if drivingstyle is Avoiding Traffic, but Rushed is fine.

Returns:

• None

Example:

pSelfPed = player.get_ped()
plHostPlayer = lobby.get_host()
pHostPed = lobby.get_player_ped(plHostPlayer)

vCurrentVehicleHandle = player.get_vehicle()

rage.task.task_vehicle_follow(pSelfPed, vCurrentVehicleHandle, pHostPed, 100, 6, 10)

---

task_vehicle_shoot_at_coord(ped, x, y, z, p4)

Makes a ped shoot at a coord from vehicle

Parameters:

• ped (Ped) – Ped object

• x (float) – X coord

• y (float) – Y coord

• z (float) – Z coord

• p4 (int) – Unknown – seen to be 0.5

Returns:

• None

Example:

pSelfPed = player.get_ped()

v3CoordsInfront = player.get_coords_infront(10)
vSpawnedVehicleHandle = scripting.spawn.spawn_vehicle(rage.gameplay.get_hash_key("ANNIHILATOR"), v3CoordsInfront, 30)
vClonedPed = rage.ped.clone_ped(pSelfPed, true, true, false)
v3CoordsInfront = player.get_coords_infront(100)
rage.task.task_enter_vehicle(vClonedPed, vSpawnedVehicleHandle, 0, -1, 2.0, 1, 0)
rage.task.task_vehicle_shoot_at_coord(vClonedPed, v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, 0.5)

---

task_vehicle_shoot_at_ped(ped, target, p2)

Makes a ped shoot another ped from vehicle.

Parameters:

• ped (Ped) – Ped object

• target (Ped) – Target ped object

• p2 (int) – either 1101004800, 100, or 5

Returns:

• None

Example:

Note

This example was not tested.

pSelfPed = player.get_ped()
v3CoordsInfront = player.get_coords_infront(10)
vSpawnedVehicleHandle = scripting.spawn.spawn_vehicle(rage.gameplay.get_hash_key("ANNIHILATOR"), v3CoordsInfront, 30)
vClonedPed = rage.ped.clone_ped(pSelfPed, true, true, false)
rage.task.task_enter_vehicle(vClonedPed, vSpawnedVehicleHandle, 0, -1, 2.0, 1, 0)
rage.task.task_vehicle_shoot_at_ped(vClonedPed, pSelfPed, 100)

---

task_wander_standard(ped, p1, p2)

Makes ped walk around the area.

Parameters:

• ped (Ped) – Ped object

• p1 (float) – Unknown

• p2 (int) – Unknown

Note

if p1 and p2 are 10, the ped will walk around the area without a duration, anywhere.

Returns:

• None

Example:

pSelfPed = player.get_ped()

rage.task.task_wander_standard(pSelfPed, 10, 10) -- walk around the area without a duration, anywhere

---

Decorator namespace

This namespace contains decoration-related game functions

Warning

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

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

Sapienti sat

---

decor_get_bool(entity, propertyName)

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

Returns:

• bool – The value of the property

---

decor_get_float(entity, propertyName)

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

Returns:

• float – The value of the property

---

decor_get_int(entity, propertyName)

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

Returns:

• int – The value of the property

---

decor_register(propertyName, type)

Register a property with the specified name and type.

Parameters:

• propertyName (string) – Property name

• type (int) – Property type

  • You can read more about property types here: Decorator types & examples

Returns:

• None

---

decor_remove(entity, propertyName)

Remove a property.

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

Returns:

• bool – Whether the property was removed

  • true – the property was removed

  • false – the property was not found/was not removed/etc.

---

decor_set_bool(entity, propertyName, value)

Set a boolean property.

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

• value (bool) – Value to set

Returns:

• bool – Whether the value was successfully set

  • true – the value was set

  • false – the value was not set.

---

decor_set_float(entity, propertyName, value)

Set a float property.

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

• value (float) – Value to set

Returns:

• bool – Whether the value was successfully set

  • true – the value was set

  • false – the value was not set.

---

decor_set_int(entity, propertyName, value)

Set an integer property.

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

• value (int) – Value to set

Returns:

• bool – Whether the value was successfully set

  • true – the value was set

  • false – the value was not set.

---

decor_set_time(entity, propertyName, value)

Set a time property.

Parameters:

• entity (Entity) – Entity object

• propertyName (string) – Property name

• value (int) – Value to set

Returns:

• bool – Whether the value was successfully set

  • true – the value was set

  • false – the value was not set.

---

Interior namespace

This namespace contains interior-related game functions.

---

get_interior_at_coords_with_type(x, y, z, interiorType)

Returns the interior ID representing the requested interior at that location (if found?). The supplied interior string is not the same as the one used to load the interior.

Parameters:

• x (float) – The X position

• y (float) – The Y position

• z (float) – The Z position

• interiorType (string) – The interior type

  • You can read more about interior types here: Interior Types

Returns:

• int – Interior ID.

Example:

rage.interior.get_interior_at_coords_with_type(-163.3628, -2385.161, 5.999994, "v_lesters")

---

get_interior_from_entity(entity)

Gets the handle of the interior that the entity is in. Returns 0 if outside.

Parameters:

• entity (Entity) – The entity

Returns:

• int – Interior ID.

Example:

pSelfPed = player.get_ped()

rage.interior.get_interior_from_entity(pSelfPed)

---

refresh_interior(interior)

Refresh a given interior.

Parameters:

• interior (int) – The interior ID.

Returns:

• None

Example:

pSelfPed = player.get_ped()

iInteriorID = rage.interior.get_interior_from_entity(pSelfPed)

rage.interior.refresh_interior(iInteriorID) -- Refreshes interior that the self's ped is in.

---

Audio namespace

This namespace contains audio-related game functions.

---

play_sound(soundId, audioName, audioRef, p3, p4, p5)

Play a specified sound.

Parameters:

• soundId (int) – Sound ID, it seems

• audioName (string) – Sound name

• audioRef (string) – Sound reference

• p3 (bool) – Unknown

• p4 (Any) – Unknown

• p5 (bool) – Unknown

  • You can read more about audio names & refs here.

  • Also here

Returns:

• None

Example:

rage.audio.play_sound(v_18, "Garage_Open", "CAR_STEAL_2_SOUNDSET", 1, 0, 1) -- Plays garage opening sound

---

play_sound_from_coord(soundId, audioName, x, y, z, audioRef, isNetwork, range, p8)

Play a specified sound from a given position.

Parameters:

• soundId (int) – Sound ID, it seems

• audioName (string) – Sound name

• x (float) – X position

• y (float) – Y position

• z (float) – Z position

• audioRef (string) – Sound reference

• isNetwork (bool) – Make it networked so other players could also hear it (untested)

• range (int) – Range of the sound

• p8 (bool) – Unknown

Returns:

• None

Useful links:

• This

• This

Example:

v3CoordsInfront = player.get_coords_infront(100)
rage.audio.play_sound_from_coord(-1, "Gas_Explosion", v3CoordsInfront.x, v3CoordsInfront.y, v3CoordsInfront.z, "ARM_2_REPO_SOUNDS", 0, 0, 0) -- Plays gas explosion sound from 100m in front of the player.

---

play_sound_from_entity(soundId, audioName, entity, audioRef, isNetwork, p5)

Play a specified sound from a given entity.

Parameters:

• soundId (int) – Sound ID, it seems

• audioName (string) – Sound name

• entity (Entity) – Entity to play sound from

• audioRef (string) – Sound reference

• isNetwork (bool) – Make it networked so other players could also hear it (untested)

• p5 (int) – Unknown

Returns:

• None

Useful links:

• This

• This

Example:

pSelfPed = player.get_ped()
rage.audio.play_sound_from_entity(-1, "Gas_Tanker_Explosion", pSelfPed, "BIG_SCORE_3A_SOUNDS", 0, 0)

---

play_sound_frontend(soundId, audioName, audioRef, p3)

Play a specified sound from the frontend.

Parameters:

• soundId (int) – Sound ID, it seems

• audioName (string) – Sound name

• audioRef (string) – Sound reference

• p3 (bool) – Unknown

Returns:

• None

Useful links:

• This

• This

Example:

rage.audio.play_sound_frontend(-1, "Garage_Door_Open", "GTAO_Script_Doors_Faded_Screen_Sounds", true) -- Plays garage opening sound

---

stop_sound(soundId)

Stop a specified sound.

Parameters:

• soundId (int) – Sound ID, it seems

Returns:

• None

Example:

rage.audio.stop_sound(v_18) -- Stops garage opening sound

---

Rope namespace

This namespace contains rope-related game functions.

---

activate_physics(entity)

Activate physics for entity.

Parameters:

• entity (Entity) – The entity

Returns:

• None

Example:

entity = player.get_ped()

rage.rope.activate_physics(entity)

---

add_rope(x, y, z, rotX, rotY, rotZ, length, ropeType, maxLength, minLength, windingSpeed, p11, p12, rigid, p14, breakWhenShot, unkPtr)

Creates a rope at the specific position, that extends in the specified direction when not attached to any entities.

Note

Rope does NOT interact with anything you attach it to, in some cases it make interact with the world AFTER it breaks (seems to occur if you set the type to -1). Rope will sometimes contract and fall to the ground like you’d expect it to, but since it doesn’t interact with the world the effect is just jaring.

Parameters:

• x (float) – Spawn coordinate X component.

• y (float) – Spawn coordinate Y component.

• z (float) – Spawn coordinate Z component.

• rotX (float) – Rotation X component.

• rotY (float) – Rotation Y component.

• rotZ (float) – Rotation Z component.

• length (float) – The initial length of the rope.

• ropeType (int) – The rope type

  • 0 – Thick, metal rope.

  • 1 – Thin, twine rope.

  • 2 – Thick , twine rope.

  • 3 – See 0

  • 4 – Thin, metal rope.

  • 5 – Super thin, metal rope.

  • 6 – See 0

  • 7 – Game crashes

• maxLength (float) – The maximum length the rope can drop.

• minLength (float) – The minimum length the rope can be.

• windingSpeed (float) – The speed in which the rope will wind if winding is started.

• p11 (bool) – Whether the rope should have collision. In original scripts this is followed by a LoadRopeData call when set.

• p12 (bool) – If max length is zero, and this is set to false the rope will become rigid (it will force a specific distance, what ever length is, between the objects).

• p14 (float) – The speed as which physics should run at. 1.0f is normal, 2.0f is twice as fast, -1.0f is time going backwards. This can affect gravity, etc.

• breakWhenShot (bool) – Whether shooting the rope will break it.

• unkPtr (Any) – Unknown parameter, always 0 in original scripts.

Returns:

• int – Rope ID.

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

---

attach_entities_to_rope(ropeId, ent1, ent2, ent1_x, ent1_y, ent1_z, ent2_X, ent2_Y, ent2_Z, length, p10, p11, p12, p13)

Attaches entity 1 to entity 2 through a rope.

Parameters:

• ropeId (int) – The rope ID

• ent1 (Entity) – Entity 1

• ent2 (Entity) – Entity 2

• ent1_x (float) – Entity 1 X coordinate.

• ent1_y (float) – Entity 1 Y coordinate.

• ent1_z (float) – Entity 1 Z coordinate.

• ent2_x (float) – Entity 2 X coordinate.

• ent2_y (float) – Entity 2 Y coordinate.

• ent2_z (float) – Entity 2 Z coordinate.

• length (float) – The initial length of the rope.

• p10 (bool) – Unknown.

• p11 (bool) – Unknown.

• p12 (Any) – Unknown.

• p13 (Any) – Unknown.

Returns:

• None

Example:

Note

This example was not tested.

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

pSelfPed = player.get_ped()
pHostPed = lobby.get_player_ped(lobby.get_host())
rage.rope.attach_entities_to_rope(iRopeID, pSelfPed, pHostPed, 1, 1, 1, 1, 1, 1, 10)

---

delete_rope(ropeId)

Delete a rope.

Parameters:

• ropeId (int) – The rope ID to delete.

Returns:

• None

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.


rage.rope.delete_rope(iRopeID)

---

detach_rope_from_entity(ropeId, entity)

Detach a rope from entity.

Parameters:

• ropeId (int) – The rope ID to delete.

• entity (Entity) – The Entity to detach

Returns:

• None

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

pSelfPed = player.get_ped()
pHostPed = lobby.get_player_ped(lobby.get_host())
rage.rope.attach_entities_to_rope(iRopeID, pSelfPed, pHostPed, 1, 1, 1, 1, 1, 1, 10)

pToDetach = pSelfPed

rage.rope.detach_rope_from_entity(iRopeID, eToDetach)

---

does_rope_exist(ropeId)

Checks whether a rope exists.

Parameters:

• ropeId (int) – The rope ID to check.

Returns:

• bool – The status of the check:

  • true – Rope exists

  • false – Rope does not exist

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.


rage.rope.does_rope_exist(iRopeID)

---

rope_are_textures_loaded()

Checks whether rope textures are loaded.

Parameters:

• None

Returns:

• bool – The status of the check:

  • true – Rope textures are loaded

  • false – Rope textures are not loaded

Example:

rage.rope.rope_are_textures_loaded()

---

rope_force_length(ropeId, length)

Forces a rope to a certain length.

Parameters:

• ropeId (int) – The rope ID

• length (float) – The rope length

Returns:

• None

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

rage.rope.rope_force_length(iRopeID, 50) -- Reduces the rope length from 100 to 50

---

rope_load_textures()

Loads rope textures for all ropes in the current scene.

Parameters:

• None

Returns:

• None

Example:

rage.rope.rope_load_textures()

---

rope_unload_textures()

Unloads rope textures for all ropes in the current scene.

Parameters:

• None

Returns:

• None

Example:

rage.rope.rope_unload_textures()

---

start_rope_unwinding_front(ropeId)

Start rope unwinding from the front.

Parameters:

• ropeId (int) – The rope ID.

Returns:

• None

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

rage.rope.start_rope_unwinding_front(iRopeID)

---

start_rope_winding(ropeId)

Start rope winding.

Parameters:

• ropeId (int) – The rope ID.

Returns:

• None

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

rage.rope.start_rope_winding(iRopeID)

---

stop_rope_unwinding_front(ropeId)

Stop rope unwinding from the front.

Parameters:

• ropeId (int) – The rope ID.

Returns:

• None

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

rage.rope.stop_rope_unwinding_front(iRopeID)

---

stop_rope_winding(ropeId)

Stop rope winding.

Parameters:

• ropeId (int) – The rope ID.

Returns:

• None

Example:

v3CoordsInfront10 = player.get_coords_infront(10)
v3CoordsAbove = player.get_coords_above_of_coords(v3CoordsInfront10, 10)
iRopeID = rage.rope.add_rope(v3CoordsInfront10.x, v3CoordsInfront10.y, v3CoordsInfront10.z, v3CoordsAbove.x, v3CoordsAbove.y, v3CoordsAbove.z, 10, 2, 100, 5, 1, true, true, 1.0, true, 0) -- Creates a rope with a length of 100 meters, and a minimum length of 5 meters.

rage.rope.stop_rope_winding(iRopeID)

---