Progression and settings

These tables read the player’s progress in the game and the game’s own settings. Both are read only: nothing here changes the profile or a setting.

reskate.progression.get needs the progression.read permission.
reskate.settings.game and reskate.settings.names need the settings.read permission.

Calling a function without its permission raises an error. See permissions.

Progression

`reskate.progression.get()`

The local player’s progress, as their profile has it.

table or nil

nil when the profile’s progress cannot be read now.

Show fields

table

A list of districts. Each has id (string), name (string) and rank (integer): the player’s rank there.

table

A list of challenges. Each has:

Show fields

string

The challenge’s id.

string

Its type.

string

The id of the district it is in; may be empty.

integer

How many times the player tried it.

integer

How many of its goals the player completed.

integer

How many goals it has.

number

The player’s score.

number

The score’s cap.

integer

The player’s score level.

local progress = reskate.progression.get()
if progress then
    local done = 0
    for _, c in progress.challenges do
        if c.goal_count > 0 and c.completed_goals == c.goal_count then done += 1 end
    end
    reskate.log(string.format("%d of %d challenges complete", done, #progress.challenges))
    for _, d in progress.districts do
        reskate.log(d.name .. ": rank " .. d.rank)
    end
end

Needs the progression.read permission.

Settings

The game’s engine settings, by name, as the console shows them.

`reskate.settings.game(name)`

A setting’s value now.

string

required

The setting’s name, as names() lists it. At most 120 characters; longer raises an error.

string or nil

The value as the console shows it, or nil for a name there is none of, or a value that cannot be read now. Numbers come back as text: use tonumber.

for _, name in reskate.settings.names() do
    if string.find(name, "Fov", 1, true) then
        reskate.log(name .. " = " .. tostring(reskate.settings.game(name)))
    end
end

Needs the settings.read permission.

`reskate.settings.names()`

Every setting name known so far: those listed from the engine’s settings this session, and those remembered from earlier ones.

table

A list of strings.

Needs the settings.read permission.

Get started

Core API

Interface

The skater and the world

Multiplayer

Game

Guides

Progression and settings

Progression

`reskate.progression.get()`

Settings

`reskate.settings.game(name)`

`reskate.settings.names()`

​Progression

​reskate.progression.get()

​Settings

​reskate.settings.game(name)

​reskate.settings.names()

Progression

`reskate.progression.get()`

Settings

`reskate.settings.game(name)`

`reskate.settings.names()`