RDR3 Natives

Natives are the game engine functions you call from Lua. In RedM almost everything that touches the world (peds, horses, entities, UI, audio, tasks, weapons, map) is a native.

How natives are called#

1. By name. The common ones are available as global Lua functions, so you write them like any other function:

local ped = PlayerPedId()
local coords = GetEntityCoords(ped)

2. By hash. Natives without a name in the runtime are called with their 64 bit hash through Citizen.InvokeNative. The hash is written as a Lua integer (0x...):

-- Citizen.InvokeNative(<hash>, <arguments...>)

3. Return values. For hash calls you tell the runtime what to expect back: Citizen.ResultAsInteger(), Citizen.ResultAsFloat(), Citizen.ResultAsString(), Citizen.ResultAsVector() or Citizen.ResultAsLong(). Natives that fill a variable use pointer helpers such as Citizen.PointerValueInt(), Citizen.PointerValueFloat() and Citizen.PointerValueVector().

Good habits#

• Cache values you use every frame (local ped = PlayerPedId() once per loop, not per call).
• Never call natives in a Wait(0) loop when a longer Wait is enough. Idle loops should sleep 250 to 1000 ms.
• Request assets before use (models, anim dictionaries, textures) and wait with a timeout; release them when done.
• A native that creates something (ped, object, blip, prompt) must be cleaned up when the resource stops (onResourceStop).
• Entity handles are local numbers. Use network ids to refer to an entity across clients and the server.

Natives used by JRS Core (603 named, 467 by hash only)#

Built from the code of 159 scripts. Scripts is the number of different scripts that call it, Calls the number of call sites. Use the filter box to search by name, namespace, hash or script.

Called by hash only (467)#

These are called as Citizen.InvokeNative(0x...) and are not named in the lookup list. The last column shows one real call from the code.