Description

This table contains detailed information about the progress of an asynchronous operation being carried out through the stingray.Leaderboard interface.

An operation can consist of any number of work units. The operation is done when result is gathered from all work units. When the operation is done, the result of the whole operation is presented in the work status field.

An instance of this table is returned by each call to stingray.Leaderboard.progress().

For example:

{
    transaction_status = "done",
    work_status = "succeeded",
    total_scores = 2,
    scores = {
            {
                name = "Anna",
                global_rank = 5,
                score = 10,
                data = {true, "Very", -5}
            },
            {
                name = "Lisa",
                global_rank = 6,
                score = 9,
                data = {false, "Some", 55}
            }
    }
}

Other related reference items

Data Members

scores : steam_leaderboard_ranking[]

An array of tables that contain information about each ranking.

Only present for tokens returned by stingray.Leaderboard.ranking_range().

total_scores : number

The total number of players that have been ranked.

Only present for tokens returned by stingray.Leaderboard.ranking_range().

transaction_status : string

A transaction wanders through the following states:

uncommited: The transactions are not yet committed to the Steam backend.
commited: The transactions are committed to the Steam backend and awaiting results from its work units.
done: All work units are done.

work_status : string

A transaction's work units can have the following states: