UgCore.Identity

Identifiers and bans.

Server Required module. Proxied to ug-core.

The primary identifier type comes from primaryIdentifier in config/identity.lua. It defaults to license.

GetIdentifiers

UgCore.Identity.GetIdentifiers(source) -> identifiers

identifiers · string[]

Every identifier, such as license:abc and discord:123.

Works for connected and connecting players.

GetPrimary

UgCore.Identity.GetPrimary(source) -> identifier?

IsBanned

UgCore.Identity.IsBanned(target) -> banned, ban, errorCode

MUST run in a thread.

target · integer | string | string[] · required

A source, an identifier, or a list of identifiers.

ban · UgBan?

The active ban that lasts longest.

Show fields

id · integer

reason · string?

expiresAt · integer?

Unix seconds. nil for permanent bans.

createdAt · integer

Unix seconds.

errorCode · UgErrorCode?

internal_error when the database failed.

Ban

UgCore.Identity.Ban(target, options?) -> ok, banId, errorCode

MUST run in a thread. Bans every identifier of the target. When the player already dropped, pass identifiers instead of a source.

options.reason · string

Up to 255 characters. Stored in ug_bans and server logs.

options.duration · integer

Seconds. Permanent when nil.

options.by · string

Who banned. Up to 64 characters.

options.kick · boolean · default: "true"

Drops an online target.

Banned players are refused while connecting with a generic message.

Unban

UgCore.Identity.Unban(target) -> ok, count, errorCode

MUST run in a thread. Lifts every active ban covering the target.

Example

CreateThread(function()
    local ok, banId = UgCore.Identity.Ban(source, {
        reason = 'Exploiting the bank robbery',
        duration = 7 * 24 * 3600,
        by = 'admin:jane',
    })
end)