Scoreboard API playdate.scoreboards.addScore requires boardID, not boardName

SDK Bug Reports
1

Platform: Mac

I'm implementing a high score in my game and I see the API call for add score:

playdate.scoreboards.addScore(boardName, value, callback)

Here is what my board looks like for reference:

{
	[boards] = {
		{
			[boardID] = leaderboard,
			[name] = Speedrun Leaderboard,
		},
	},
	[lastUpdated] = 762169436,
}

When using the board name as the first argument to the addScore API call (in my case "Speedrun Leaderboard"), this returns an error.

However, when using the BoardID ("leaderboard") this works without any issues.
playdate.scoreboards.addScore("leaderboard", game_time, <callbackfunction>)

{
	[code] = OK,
}
Result: 
{
	[player] = Drew-Lo,
	[rank] = 1,
	[value] = 3355550,
}

I believe the documentation should be updated to use "boardID" as the first argument.

4 Likes
2

I also used Board Name, and thought how it's odd that it's not BoardID. When name failed, I tried boardID, and it worked.

I agree, the docs should be updated to reflect this as it's plainly wrong.

3

Thanks for catching that! I've got it filed and we'll try and get that fixed soon.

3 Likes