rc_runtime_activate_lboard

Loads a leaderboard into the runtime.

Syntax

int rc_runtime_activate_lboard(
    rc_runtime_t* runtime,
    unsigned id,
    const char* memaddr,
    lua_State* L,
    int funcs_idx
);

Parameters

runtime

Pointer to the runtime object that will contain the leaderboard definition.

id

A unique identifier for the leaderboard.

memaddr

A null-terminated string that defines the leaderboard.

L (NOT USED)

A pointer to a lua_State that contains the LUA functions needed by the leaderboard. May be NULL if the leaderboard does not use LUA functions.

funcs_index (NOT USED)

The index to the functions table in the lua_State.

Return value

If the function succeeds, the return value is RC_OK. Otherwise, the error code can be converted to a string using rc_error_str.

Remarks

Only one leaderboard may exist for a given unique identifier. Calling this function with an existing identifier will overwrite the previous definition.

An activated leaderboard starts in the "waiting" state. The start condition must evaluate true for the leaderboard to become active.

Minimum version: 9.0.0

See also

rc_runtime_init

rc_runtime_deactivate_lboard

rc_runtime_get_lboard

rc_runtime_do_frame

rc_runtime_reset