FiveM Lua API

Scooby · Current in-app native example catalog

PLAYER · PlayerId
int PlayerId()
local id = PlayerId()
print(id)
PLAYER · PlayerPedId
Ped PlayerPedId()
local ped = PlayerPedId()
PLAYER · GetPlayerPed
Ped GetPlayerPed(Player p)
local ped = GetPlayerPed(PlayerId())
PLAYER · GetPlayerName
string GetPlayerName(Player p)
print(GetPlayerName(PlayerId()))
PLAYER · SetPlayerWantedLevel
void SetPlayerWantedLevel(Player p, int level, bool disableNoMission)
SetPlayerWantedLevel(PlayerId(), 0, false)
SetPlayerWantedLevelNow(PlayerId(), false)
PED · SetPedArmour
void SetPedArmour(Ped ped, int amount)
SetPedArmour(PlayerPedId(), 100)
PED · SetEntityHealth
void SetEntityHealth(Entity e, int hp)
SetEntityHealth(PlayerPedId(), 200)
PED · GetEntityCoords
Vector3 GetEntityCoords(Entity e, bool alive)
local p = GetEntityCoords(PlayerPedId(), true)
print(p.x, p.y, p.z)
PED · SetEntityCoords
void SetEntityCoords(Entity e, float x,y,z, bool xAx, bool yAx, bool zAx, bool clrArea)
SetEntityCoords(PlayerPedId(), 0.0, 0.0, 70.0, false, false, false, true)
VEHICLE · CreateVehicle
Vehicle CreateVehicle(Hash model, float x, y, z, float heading, bool isNetwork, bool netMission)
local h = `adder`
RequestModel(h)
while not HasModelLoaded(h) do Wait(10) end
local p = GetEntityCoords(PlayerPedId())
local v = CreateVehicle(h, p.x, p.y, p.z, 0.0, true, false)
VEHICLE · SetPedIntoVehicle
void SetPedIntoVehicle(Ped p, Vehicle v, int seat)
SetPedIntoVehicle(PlayerPedId(), vehicle, -1)
WEAPON · GiveWeaponToPed
void GiveWeaponToPed(Ped p, Hash weapon, int ammo, bool hidden, bool equipNow)
GiveWeaponToPed(PlayerPedId(), `WEAPON_PISTOL`, 100, false, true)
MISC · GetHashKey
Hash GetHashKey(string s)
local h = GetHashKey('WEAPON_PISTOL')
MISC · NetworkOverrideClockTime
void NetworkOverrideClockTime(int h, int m, int s)
NetworkOverrideClockTime(12, 0, 0)
MISC · TriggerEvent
void TriggerEvent(string name, …)
TriggerEvent('chat:addMessage', { args = { 'Scooby', 'hi' } })
MISC · TriggerServerEvent
void TriggerServerEvent(string name, …)
TriggerServerEvent('myEvent', 'arg1', 42)
CITIZEN · Citizen.CreateThread
void Citizen.CreateThread(function body)
Citizen.CreateThread(function()
  while true do
    Wait(0)
  end
end)
CITIZEN · Citizen.Wait
void Citizen.Wait(int ms)
Citizen.Wait(100)