Spawn: exports, events & commands
Generated from the Lua in the release. Descriptions are the comments above each definition. Event names and export names are public contracts: they do not change between versions.
Exports
Call them as exports['lumo-spawn']:Name(...) from the side named in each table.
Client
| Export | Description |
|---|---|
GetPlayerData() | |
IsLoggedIn() |
Server
| Export | Description |
|---|---|
DeleteCharacter(src, id) | |
GetCharacters(src) | |
GetCitizenId(src) | |
GetFramework() | |
GetLicenses(src) | |
GetLoggedInPlayers() | |
GetPlayer(src) | |
GetPlayerByCitizenId(id) | |
GetPlayerData(src) | Exports for third-party scripts and for other Lumo resources running standalone. PlayerData is QB-shaped; see docs/STANDALONE.md. |
GetSkin(id) | |
HasPermission(src, groups) | |
IsLoggedIn(src) | |
Login(src, id, data) | |
Logout(src) | |
Notify(src, msg, t) | |
SetMetaData(src, key, value) |
Events
- Client events are triggered on the player:
TriggerClientEvent(name, src, ...)from the server, orTriggerEvent(name, ...)on the client. - Server events are triggered with
TriggerServerEvent(name, ...). The server checks the player, distance and amounts itself; never rely on a client to do it.
Client
| Event | Arguments | Description |
|---|---|---|
esx:onPlayerLogout | ||
esx:playerLoaded | xPlayer, isNew, skin | |
esx:setPlayerData | ||
housing:initHouses | houseConfig | |
qb-houses:client:setHouseConfig | houseConfig | |
qb-spawn:client:openEditor | ||
qb-spawn:client:openUI | value | |
qb-spawn:client:setupSpawns | cData, new, apps, houses |
Server
| Event | Arguments | Description |
|---|---|---|
qb-spawn:server:saveSpawnLocations | locations |