cx_leaderboard

v0.1.0

cx_leaderboard v0.1.0 CxLeaderboard.Entry View Source

Entry is the tuple-based structure that you send into the leaderboard.

Link to this section Summary

Types

id()

Must uniquely identify a record in the leaderboard

key()
payload()

Allows storing any free-form data with each leaderboard record

score()

A term on which the leaderboard should be ranked. Any term can work, but numeric ones make the most sense

t()

Use this format when sending your entries to a leaderboard. See below for breakdowns of each type

tiebreaker()

Determines which of the scores appears first if scores are equal. The entry_id is always implied as the final tiebreaker, regardless of any other tiebreakers provided

Functions

format(input)
get_id(arg)
get_payload(arg)
get_score(arg)
get_tiebreak(arg)

Link to this section Types

Link to this type id() View Source 
id() :: term()

Must uniquely identify a record in the leaderboard.

Link to this type key() View Source 
key() :: {score(), id()} | {score(), tiebreaker(), id()}
Link to this type payload() View Source 
payload() :: term()

Allows storing any free-form data with each leaderboard record.

Link to this type score() View Source 
score() :: term()

A term on which the leaderboard should be ranked. Any term can work, but numeric ones make the most sense.

Link to this type t() View Source 
t() :: {key(), payload()}

Use this format when sending your entries to a leaderboard. See below for breakdowns of each type.

Link to this type tiebreaker() View Source 
tiebreaker() :: term()

Determines which of the scores appears first if scores are equal. The entry_id is always implied as the final tiebreaker, regardless of any other tiebreakers provided.

Link to this section Functions