UgCore.Characters

Server Optional module. Proxied to ug-core. ug-core stores and loads characters. A multicharacter resource such as ug-multicharacter shows the menu and calls this API.

Without this module, players are loaded at join and there is no character data.

GetAll

UgCore.Characters.GetAll(source) -> ok, characters, errorCode

UgCharacter[]

Ordered by creation.

Show UgCharacter

integer

string

Display name.

table

Fields such as first name and birth date, set by your character creator.

integer

Unix seconds.

integer?

Unix seconds.

Create

UgCore.Characters.Create(source, { name, data? }) -> ok, characterId, errorCode

string

required

1 to 64 characters.

table

JSON data, up to 16 KB encoded.

Invalid input returns invalid_args instead of raising, since it usually comes from a player. Returns no_permission when maxCharacters is reached or Characters:BeforeCreate cancelled.

Load

UgCore.Characters.Load(source, characterId) -> ok, errorCode

Loads an owned character. A loaded character is unloaded first. Sets ug-core:Loaded, restores death state when persisted, and loads accounts, job and gang.

Unload

UgCore.Characters.Unload(source) -> ok, errorCode

Saves and unloads. The player goes back to not loaded and alive.

Delete

UgCore.Characters.Delete(source, characterId) -> ok, errorCode

Soft delete. The loaded character cannot be deleted. Characters:BeforeDelete MAY cancel.

GetActive

UgCore.Characters.GetActive(source) -> UgCharacter?

Example

UgCore.Callback.Register('Select', {
    schema = UgCore.Schema.Define({ UgCore.Schema.Integer({ min = 1, max = 2147483647 }) }),
    rate = { max = 2, per = 2000 },
}, function(source, characterId)
    local ok, err = UgCore.Characters.Load(source, characterId)
    return { ok = ok, error = err }
end)

Overview

Core

Networking and security

Modules

Reference

UgCore.Characters

GetAll

Create

Load

Unload

Delete

GetActive

Example

​GetAll

​Create

​Load

​Unload

​Delete

​GetActive

​Example

GetAll

Create

Load

Unload

Delete

GetActive

Example