Skip to content

Leaderboard player filter docs#57

Merged
tudddorrr merged 1 commit intomainfrom
leaderboard-player-filter
Feb 25, 2026
Merged

Leaderboard player filter docs#57
tudddorrr merged 1 commit intomainfrom
leaderboard-player-filter

Conversation

@tudddorrr
Copy link
Contributor

No description provided.

@tudddorrr tudddorrr force-pushed the leaderboard-player-filter branch from 6d67152 to fb5a2d7 Compare February 24, 2026 23:56
@claude
Copy link

claude bot commented Feb 24, 2026

Documentation Review

This PR clearly improves the leaderboard docs by exposing the player_id/playerId option and separating it from the alias-scoped filter. The added code examples are well-structured and the distinction between player-level and alias-level filtering is a good clarification.


✅ Accuracy & Completeness

🟡 Cache section leaves player_id users without guidance (both files)

The new cache text reads:

The same logic applies for entries fetched with alias_id set, using get_cached_entries_for_current_player(). Note that player_id is not supported by get_cached_entries_for_current_player().

The note is correct to flag the limitation, but stops there. A developer who fetched entries using player_id will be left wondering: "So what do I use for the cache?" The docs should answer that question directly.

Suggested fix (Godot):

The same logic applies for entries fetched with `alias_id` set, using `get_cached_entries_for_current_player()`. Note that `player_id` filtering is not supported by `get_cached_entries_for_current_player()` — use `get_cached_entries()` instead and filter client-side.

Suggested fix (Unity):

The same logic applies for entries fetched with `aliasId` set, using `GetCachedEntriesForCurrentPlayer()`. Note that `playerId` filtering is not supported by `GetCachedEntriesForCurrentPlayer()` — use `GetCachedEntries()` instead and filter client-side.

💻 Code Examples

🔵 Minor — Godot example uses undocumented Talo.current_alias

The new alias_id example references Talo.current_alias.id:

options.alias_id = Talo.current_alias.id

The player_id example references Talo.current_player.id, which matches how the player is used elsewhere in Talo docs. If Talo.current_alias is the correct accessor for the current alias object, that's fine — but it's worth verifying this is the actual API property name, since it isn't introduced or explained anywhere in the section. The same applies to Talo.CurrentAlias.id in the Unity sample.


📖 Clarity & Readability

No issues found. The section heading "Getting entries for the current player" still fits, and the two-step explanation (player-wide → alias-specific) flows logically.

🎯 Structure & Organization

No issues found.

⚡ Developer Experience

No issues found beyond the cache gap noted above.

🔗 Links & References

No issues found.

@tudddorrr tudddorrr force-pushed the leaderboard-player-filter branch from fb5a2d7 to e4d2146 Compare February 25, 2026 00:25
@tudddorrr tudddorrr merged commit f846e83 into main Feb 25, 2026
1 check passed
@tudddorrr tudddorrr deleted the leaderboard-player-filter branch February 25, 2026 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant