Exports & Events

Taken from the shipped source for version 1.0.1.

🖥️ Server exports

Export	Arguments	Description
`GetFramework`	`()`	Detected framework name (qb, qbox, esx or standalone).
`GetPlayer`	`(src)`	Framework player object.
`GetIdentifier`	`(src)`	Stable per-character identifier.
`Notify`	`(src, message, type, duration, title)`	Send a notification to a player.
`PhoneNotify`	`(src, data)`	Send a phone notification.
`GetPlayerSummary`	`(src)`	Summary of the player (name, job and similar).
`SetPlayerJob`	`(src, jobName, grade)`	Set a player job.
`AddMoney`	`(src, account, amount, reason)`	Add money to an account.
`RemoveMoney`	`(src, account, amount, reason)`	Remove money; returns false if not enough.
`GetBalance`	`(src, account)`	Read an account balance.
`GetIdentityMetadata`	`(src, documentType)`	Identity document metadata.
`OpenClothing`	`(src)`	Open the configured clothing or appearance menu.
`SetVehicleStored`	`(plate, stored)`	Mark a vehicle as stored or out in the garage system.
`SetVehicleGarage`	`(plate, garage)`	Move a vehicle to a garage.
`AddItem`	`(src, item, amount, metadata)`	Give an item through the detected inventory.
`RemoveItem`	`(src, item, amount, metadata)`	Remove an item.
`GetItemCount`	`(src, item)`	Count of an item.
`HasItem`	`(src, item, amount)`	Whether the player has enough of an item.
`CanCarryItem`	`(src, item, amount)`	Whether the player can carry more of an item.
`Progress`	`(data)`	Progress bar through the configured UI.
`ShowTextUI`	`(text, options)`	Show text UI.
`HideTextUI`	`()`	Hide text UI.


local result = exports['orion-core']:GetFramework(...)

Export	Arguments	Description
`Notify`	`(message, type, duration, title)`	Show a notification.
`PhoneNotify`	`(data)`	Show a phone notification.
`GetPhoneSystem`	`()`	Name of the detected phone resource.
`GetTargetSystem`	`()`	Name of the detected target system.
`AddTargetBoxZone`	`(name, data)`	Add a box target zone.
`RemoveTargetZone`	`(name)`	Remove a target zone.
`GiveVehicleKeys`	`(vehicle, plate)`	Give the player keys.
`RemoveVehicleKeys`	`(vehicle, plate)`	Remove keys.
`HasVehicleKeys`	`(vehicle, plate)`	Check for keys.
`Progress`	`(data)`	Progress bar.
`ShowTextUI`	`(text, options)`	Show text UI.
`HideTextUI`	`()`	Hide text UI.

Event	Side	Description
`orion-core:client:notify`	client	Server to client notification (message, type, duration, title).
`orion-core:client:phoneNotify`	client	Server to client phone notification.
`orion-core:server:giveVehicleKeys`	server	Client asks the server to give vehicle keys (vehicleNetId, plate).
`orion-core:server:removeVehicleKeys`	server	Client asks the server to remove vehicle keys.
`orion-core:server:removeRenewedVehicleKeys`	server	Removes a key through Renewed-Vehiclekeys (plate).