Home

Plugin : Scoreboard

Author:Rex.Rainbow

Download

Properties

ID

  • The numeric ID of the scoreboard.

Lines

  • Line count of each page for loading scores.

Period

  • The time-frame to pull scores from.
    • Options : ["Current day","Current week","Current month","Current year","All-time"]

Tag

  • A tag that can be used to filter scores. Set "" to ignore this feature.

Actions

Configuration

Action:Set board ID

  • Set board ID and clean all.
    • ID ( number ) : The numeric ID of the scoreboard.

Action:Set tag

  • Set filter tag.
    • Tag ( string ) : A tag that can be used to filter scores. Set "" to ignore this feature.

Get scores

Action:Request in a range

  • Get scores in a range.
    • Start ( number ) : Start index, 0-based.
    • Lines ( number ) : Count of lines

Get scores - page

Action:Turn to page

  • Turn to scores page.
    • Index ( number ) : Page index, 0-based.

Action:Update current page

  • Update current scores page.

Action:Turn to next page

  • Update turn to next scores page.

Action:Turn to previous page

  • Update turn to previous scores page.

Get scores - period

Action:Set period

  • Set period.
    • Period ( Combo ) : The time-frame to pull scores from.
      • Options : ["Current day","Current week","Current month","Current year","All-time"]

Action:Set period by code

  • Set period.
    • Period ( string ) : The time-frame to pull scores from. D=current day, W=current week , M=current month, Y=current year, A=all-time

Get scores - social

Action:All users

  • Show scores of all users.

Action:Set user

  • Show scores of user and their friends.
    • ID or name ( number or string ) : User ID (number) or user name (string).

ScoreBoard

Action:Get boards

  • Returns a list of available scoreboards.

Action:Post score

  • Posts a score to the specified scoreboard.
    • Value ( number ) : The int value of the score.
    • Tag ( string ) : A tag that can be used to filter scores. Set "" to ignore this feature.

Expressions

For each - index

Expression:LoopIndex

  • Get loop index in for each loop.

Get boards

Expression:BoardsAsJSON

  • Get received boards as JSON.

Expression:BoardsCount

  • Get amount of boards.

Get boards - for each

Expression:CurBoardID

  • The numeric ID of the scoreboard in a For Each loop.

Expression:CurBoardName

  • The name of the scoreboard in a For Each loop.

Get boards - index

Expression:Index2BoardID

  • The numeric ID of the scoreboard by index.

Expression:Index2BoardName

  • The name of the scoreboard by index.

Get scores

Expression:ScoresAsJSON

  • Get received scores as JSON.

Expression:ScoresCount

  • Get ranking count in current received scores.

Get scores - for each

Expression:CurFormattedValue

  • Current formatted value of a score in for each loop.

Expression:CurUserName

  • Current user name of a score in for each loop.

Expression:CurUserID

  • Current user ID of a score in for each loop.

Expression:CurValue

  • Current integer value of the score in for each loop.

Get scores - for each - index

Expression:CurStartIndex

  • Get start index in current received scores.

Get scores - index

Expression:Index2FormattedValue

  • Formatted value of a score by array index.

Expression:Index2UserName

  • User name of a score by array index.

Expression:Index2UserID

  • User ID of a score by array index.

Expression:Index2Value

  • User ID of a score by array index.

Get scores - page

Expression:PageIndex

  • Get page index.

Get/Post score

Expression:BoardID

  • Get board ID.

Expression:Period

  • Get period. D=current day, W=current week , M=current month, Y=current year, A=all-time

Expression:Tag

  • Get tag.

Result

Expression:ErrorMessage

  • Get last error message from last result.

Conditions

Get boards

Condition:On get boards

  • Triggered when get boards success.

Condition:On get boards error

  • Triggered when get boards error.

Condition:For each board

  • Repeat the event for each board.

Get scores

Condition:On get scores

  • Triggered when get scores success.

Condition:On get scores error

  • Triggered when get scores error.

Condition:For each score

  • Repeat the event for each score.

Condition:For each score in range

  • Repeat the event for each score in a range.
    • Start ( number ) : Start from rank index (0-based).
    • End ( number ) : End to rank index (0-based). This value should larger than Start.

Post score

Condition:On post score

  • Triggered when post score success.

Condition:On post score error

  • Triggered when post score error.