Exports

Export	Internal / helper name
`GetPlayer`	`GetPlayer`
`GetId`	`GetId`
`GetSource`	`GetSource`
`GetUserId`	`GetUserId`
`GetPersistId`	`GetPersistId`
`GetIdMap`	`GetIdMap`
`GetAllIds`	`GetAllIds`
`GetAllPlayers`	`GetAll`
`GetPlayersByUserId`	`GetPlayersByUserId`
`GetPlayersByPersistId`	`GetPlayersByPersistId`
`GetPlayerName`	`GetName`
`GetPlayerIdentifiers`	`GetIdentifiers`
`GetPlayerIdentifier`	`GetIdentifier`

Behavior matches lib.player where the names line up; object shape for GetPlayer is the same as GetPlayer.

`GetPlayer`

local p = exports['dc_lib']:GetPlayer(source)

Parameters: source — number | string
Returns: player object or nil if not connected (see GetPlayer).

local p = exports['dc_lib']:GetPlayer(source)
if not p then return end
print(p.getUserId())

`GetId`

local dataId = exports['dc_lib']:GetId(source)

Parameters: source — number | string
Returns: data id (integer?).

`GetSource`

local source = exports['dc_lib']:GetSource(dataId)

Parameters: dataId — integer
Returns: player id string or nil.

`GetUserId`

local userId = exports['dc_lib']:GetUserId(source)

Parameters: source — number | string
Returns: integer?.

`GetPersistId`

local persistId = exports['dc_lib']:GetPersistId(source)

Parameters: source — number | string
Returns: integer?.

`GetIdMap`

local map = exports['dc_lib']:GetIdMap()

Returns: table<string, integer> — sources that have a data id.

`GetAllIds`

local ids = exports['dc_lib']:GetAllIds()

Returns: integer[] — data ids currently online.

`GetAllPlayers`

local sources = exports['dc_lib']:GetAllPlayers()

Returns: string[] — same as internal GetAll (typically all player id strings).

for _, src in ipairs(exports['dc_lib']:GetAllPlayers() or {}) do
    print(src)
end

`GetPlayersByUserId`

local sources = exports['dc_lib']:GetPlayersByUserId(userId)

Parameters: userId — integer
Returns: string[] — player ids.

`GetPlayersByPersistId`

local sources = exports['dc_lib']:GetPlayersByPersistId(persistId)

Parameters: persistId — integer
Returns: string[] — player ids.

`GetPlayerName`

local name = exports['dc_lib']:GetPlayerName(source)

Parameters: source — number | string
Returns: display name (string?) — same as internal GetName.

`GetPlayerIdentifiers`

local ids = exports['dc_lib']:GetPlayerIdentifiers(source)

Parameters: source — number | string
Returns: identifier list — same as internal GetIdentifiers.

`GetPlayerIdentifier`

local license = exports['dc_lib']:GetPlayerIdentifier(source, 'license')

Parameters: source — number | string; type — string (e.g. 'license', 'discord')
Returns: full identifier string or nil — same as internal GetIdentifier.

Exports

On this page