Server API
Export index
Server API for REC_Core, with configuration and implementation details.
- Added
- Updated
Call these exports from a server script. playerId is a connection ID and citizenId is a persistent character ID.
Getters that return character tables provide copies; editing those copies does not update the core.
Online mutators returning true confirm acceptance, not completion of the configured database save.
| Export | Returns |
|---|---|
| isActive | boolean |
| isLoaded | boolean |
| getPlayerIds | integer[] |
| getPlayers | REC_Core.Server.Character[] |
| getPlayerData | REC_Core.Server.Character|nil |
| getCitizenIdByPlayerId | string|nil |
| getPlayerIdByCitizenId | integer|nil |
| getIdentifier | string|nil |
| getCharactersByLicense | REC_Core.Server.Character[]|nil |
| getOfflineCharacter | REC_Core.Server.Character|nil |
| deleteCharacter | boolean |
| logout | boolean |
| save | boolean |
| saveAll | integer |
| hasPermission | boolean |
| getAccounts | table<string, REC_Core.Config.Account> |
| getMoney | integer|nil |
| getMoneys | table<string, integer>|nil |
| addMoney | boolean |
| removeMoney | boolean |
| setMoney | boolean |
| addOfflineMoney | boolean |
| removeOfflineMoney | boolean |
| getJobs | table<string, REC_Core.Shared.Groups.Label> |
| getGangs | table<string, REC_Core.Shared.Groups.Label> |
| getJob | REC_Core.Shared.Character.Group|nil |
| getGang | REC_Core.Shared.Character.Group|nil |
| setJob | boolean |
| setGang | boolean |
| setDuty | boolean |
| hasJob | boolean |
| hasGang | boolean |
| countPlayersByJob | integer |
| countPlayersByGang | integer |
| setOfflineJob | boolean |
| setOfflineGang | boolean |
| getCharinfo | REC_Core.Shared.Character.Charinfo|nil |
| setCharinfo | boolean |
| getMetadata | any |
| getAllMetadata | table<string, any>|nil |
| setMetadata | boolean |
| getValue | any |
| getValues | table<string, any>|nil |
| setValue | boolean |
| setValues | boolean |
| removeValue | boolean |
| removeNamespace | boolean |
| getOfflineValue | any |
| setOfflineValue | boolean |
| getConfig | REC_Core.Shared.Config |