For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

API Reference

Every function below is called via the global Core table from any Rynex script's shared, server, or client context.

Detection

Core.GetFramework()       -- Returns 'esx', 'qbcore', 'qbox', 'oxcore', 'standalone', or nil
Core.GetInventorySystem() -- Returns 'ox_inventory', 'esx', 'qb', or nil
Core.IsLoaded()           -- Returns true once framework detection has completed
Core.Version              -- The current rx-core version string

Identity

Core.GetPlayer(src)                -- Returns a player table (or nil)
Core.GetPlayers()                  -- Returns an array of online player sources
Core.GetPlayerFromIdentifier(id)   -- Lookup by citizenid/identifier
Core.GetIdentifier(src)            -- Returns the player's primary identifier
Core.GetCitizenId(src)             -- Returns the citizen ID
Core.GetName(src)                  -- Returns the character's display name
Core.GetCoords(src)                -- Returns the player's coords as vector3
Core.GetPed(src)                   -- Returns the player's ped entity
Core.GetPlayerData(src)            -- Returns a normalized player data table

Money

Core.GetMoney(src, account)        -- account = 'cash', 'bank', or 'black_money'
Core.AddMoney(src, amount, account)
Core.RemoveMoney(src, amount, account)

Convenience wrappers:

Core.AddCash(src, amount)        Core.RemoveCash(src, amount)        Core.GetCash(src)
Core.AddBank(src, amount)        Core.RemoveBank(src, amount)        Core.GetBank(src)
Core.AddBlackMoney(src, amount)  Core.RemoveBlackMoney(src, amount)  Core.GetBlackMoney(src)

Jobs and Gangs

Core.GetJob(src)                   -- Returns { name, label, grade, gradeLabel }
Core.SetJob(src, jobName, grade)
Core.GetGang(src)                  -- Same shape as GetJob (QBCore/QBox only)
Core.SetGang(src, gangName, grade)
Core.HasJob(src, jobName, minGrade)
Core.GetPlayersByJob(jobName)      -- Returns array of sources
Core.CountPlayersByJob(jobName)

Permissions

Core.HasPermission(src, perm)
Core.GetGroup(src)

Inventory items

Core.GetItem(src, itemName)              -- Returns { name, count, label, weight, metadata } or nil
Core.GetItemCount(src, itemName)
Core.AddItem(src, itemName, count, metadata)
Core.RemoveItem(src, itemName, count, metadata)
Core.HasItem(src, itemName, count)
Core.CanCarryItem(src, itemName, count)
Core.RegisterUsableItem(itemName, callback)
Core.GetInventory(src)                   -- Returns the full inventory as an array
Core.ClearInventory(src)
Core.FindItem(src, itemName)

Weapons

Core.GetWeapons(src)
Core.HasWeapon(src, weaponName)
Core.GiveWeapon(src, weaponName, ammo)
Core.RemoveWeapon(src, weaponName)
Core.GetAmmo(src, weaponName)
Core.AddAmmo(src, weaponName, amount)
Core.SetAmmo(src, weaponName, amount)

Item metadata (ox_inventory rich; others limited)

Core.SetItemMetadata(src, slot, metadata)
Core.GetItemMetadata(src, slot)

On non-ox_inventory frameworks, these no-op and log a one-time warning.

Vehicles

Core.SpawnVehicle(coords, model, cb)
Core.DeleteVehicle(entity)

rx-core does not abstract vehicle ownership — that's per-script database logic.

Society

Core.GetSocietyMoney(society)
Core.AddSocietyMoney(society, amount)
Core.RemoveSocietyMoney(society, amount)

Callbacks

-- Server
Core.RegisterCallback(name, callback)

-- Client
Core.TriggerCallback(name, cb, ...)   -- 10s timeout, returns nil on timeout

Events

Core.OnPlayerLoaded(callback)
Core.OnPlayerDropped(callback)
Core.OnPlayerDeath(callback)
Core.OnJobUpdate(callback)

Unsupported features

When you call a function not supported by the detected framework (e.g. Core.GetGang on ESX), rx-core logs a one-time warning to the console and returns nil or false. Your script keeps running.

---

Agent Instructions

This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the ask and goal query parameters:

GET https://docs.rynexscripts.com/rx-core/api-reference.md?ask=<question>&goal=<user_goal>

ask is the immediate question: it should be specific, self-contained, and written in natural language. goal is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with ask=how do I create an API token, a goal like automate deployments from our CI pipeline lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.