Exports
- Added
- Updated
These let your own scripts ask who is online and act on it.
Server side
getPlayersMetaData
Gives you every loaded character, keyed by citizenId.
Takes no arguments. Returns table<string, MetaData>?:
| Field | Type | Description |
|---|---|---|
playerId | integer | |
citizenId | string | |
name | string | |
firstName | string | |
lastName | string | |
job | string |
exports.REC_PlayerManager:getPlayersMetaData()
getPlayerMetaDataByPlayerId
Gives you one player's details.
| Argument | Type | Description |
|---|---|---|
playerId | integer |
Returns MetaData? — nil if no character is loaded for them.
exports.REC_PlayerManager:getPlayerMetaDataByPlayerId(playerId)
getCitizenIdByPlayerId
Gives you the citizenId behind a player id.
| Argument | Type | Description |
|---|---|---|
playerId | integer |
Returns string?.
exports.REC_PlayerManager:getCitizenIdByPlayerId(playerId)
getPlayerIdByCitizenId
Gives you the player id a character is connected on right now.
| Argument | Type | Description |
|---|---|---|
citizenId | string |
Returns integer? — nil if they are offline.
exports.REC_PlayerManager:getPlayerIdByCitizenId(citizenId)
getAllPlayers
Gives you every managed player object.
Takes no arguments. Returns table<integer, Player>? — the REC_Library player class, keyed by player id.
exports.REC_PlayerManager:getAllPlayers()
isPlayerLoaded
Tells you whether a character is loaded for this player yet.
| Argument | Type | Description |
|---|---|---|
playerId | integer |
Returns boolean.
exports.REC_PlayerManager:isPlayerLoaded(playerId)
getPlayersInBucket
Gives you everyone sitting in one routing bucket.
| Argument | Type | Description |
|---|---|---|
bucket | integer |
Returns integer[], sorted.
exports.REC_PlayerManager:getPlayersInBucket(0)
refreshPlayerMeta
Re-reads one player's character. Call it after a job or name change.
| Argument | Type | Description |
|---|---|---|
playerId | integer |
Returns boolean.
exports.REC_PlayerManager:refreshPlayerMeta(playerId)
isMaintenance
Tells you whether maintenance mode is on.
Takes no arguments. Returns boolean.
exports.REC_PlayerManager:isMaintenance()
setMaintenance
Turns maintenance mode on or off. Shows up in the admin log under your script's name.
| Argument | Type | Description |
|---|---|---|
enabled | boolean |
Returns boolean — the state afterwards.
exports.REC_PlayerManager:setMaintenance(true)
RegisterCommand("deploy", function()
exports.REC_PlayerManager:setMaintenance(true)
-- ... do the deploy ...
exports.REC_PlayerManager:setMaintenance(false)
end, true)
Client side
getSession
Gives you the session of the player running the script.
Takes no arguments. Returns SessionConfigBuilder.
exports.REC_PlayerManager:getSession()
getCitizenId
Gives you the citizenId of the player running the script.
Takes no arguments. Returns string?.
exports.REC_PlayerManager:getCitizenId()
getPlayersMetaData
Gives you every loaded character, keyed by citizenId.
Takes no arguments. Returns table<string, MetaData>. The client's copy is kept up to date for you — the full list when you join, then one entry at a time as people come and go.
exports.REC_PlayerManager:getPlayersMetaData()