App Leaderboard

Overview

The kills, points, and other key indices acquired in gameplay can be converted into score and upload to WorldRankService’s leaderboard.

Uploaded score and rank can be checked from both the app (out-game) and in-game (world). Players can compete each other with this and significantly boosts world participation and overall activeness.

How to Use

Feature List

The following feature can only be used in server script and cannot be called from client.

Feature	Description
WorldRankService:IncrementScore(player, delta)	Uploads the score variance of a specified player to the leaderboard. Score must be an integer, and variance must be a positive number. The maximum allowed variance is 100,000. Any request with a variance exceeding this limit will not be processed.
WorldRankService:GetScore(player)	Returns the current score of the player listed on the leaderboard.

Score Sorting

The scores in the leaderboard are always listed in descending order. This cannot be changed.

Full Code Example

The following code is an example of uploading the bonus score player earned during gameplay to the WorldRankService leaderboard when game is over and retrieving and displaying the uploaded final score to ResultUI.

Please be mindful that the IncrementScore function passes variance of increased score instead of the final score to the leaderboard.

local WorldRankService = game:GetService("WorldRankService")
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local UIRemoteEvent = ReplicatedStorage :WaitForChild("UIRemoteEvent")

local function EndRound(player, eventName, delta)
    print(player, eventName)	
	
		WorldRankService:IncrementScore(player, delta)
		
		local score = WorldRankService:GetScore(player)
		UIRemoteEvent:FireClient(player, "SendMyScoreToResultUI", score)
end

Difference Between Actions in Published and Test Environments

Saves and loads data to and from actual server in mobile environment after game is published. Note that this feature does not work in studio test environment and when called, the WorldRank API is not available in the editor. It only works in the live game environment. log will be displayed.

Ranking and Score Display

If player score is uploaded to the leaderboard, current ranking and score are displayed on top of character.

If score is changed, player must reconnect to world to see the updated information.

The Top Scorer section is exposed on the world detail screen of the app (out-game); player rankings and scores of the world are displayed as a list.

Usage Examples

• Convert kills into score and upload it to the leaderboard to fortify competitiveness.

• Provide a goal to players by letting them know that “the top players of this world have achieved this and that score” through the out-game Top Scorer section displayed before players enter their world.

• Build an economic structure in which players are rewarded with skins/costumes based on their accumulated score to promote longer gameplay time.

• Aggregate points in time-limited events to reward top rankers to increase world participation.

Note

• The value passed to the leaderboard is the variance of score increase, not the final score.

• The score uploaded to the leaderboard cannot be subtracted nor deleted (reset).