Filtering leaderboards by friends

I just thought of one possible reason SetUserFilter() isn't working as I expected: I'm using userNames (not long ID number) for the list I pass to SetUserFilter(). I changed it to use the id instead of userName, but it still didn't work to call SetUserFilter() first, then LoadScores().  I also tried calling SetUserFilter() after LoadScores() and that didn't work either.

Ah ha! I discovered the Leaderboard.userScope field, and by assigning UserScope.FriendsOnly, it worked!  Which leaves me with just one more question:

In the results, the .rank field of each score entry seems to be the rank of that score in the filtered results.  Is there a way to easily and efficiently get the global rank?  So for example, the results when displayed would look something like:

Global Rank    Friend    Score
11             Guy       1,000
23             John        750
53             Sarah       523

Is that possible without doing a lot of separate requests?

Unfortunately it isn't currently possible, the query to get it is a bit complex, I'll eventually try to optimize the query in a future update (but no ETA, may be it's not a trivial task; if you find a viable query I'll be glad to check it out, unfortunately I still didn't succeed).

For now you could optimize the loading of the global rank with a small trick through a coroutine:

foreach (var score in leaderboard.scores)
{
   bool loaded = false;
   int rank = 0;
   leaderboard.LoadScoresByUser(long.Parse(score.userID), eLeaderboardInterval.Total, 10, (Score friendScore, int friendPage, string error) =>
   {
      rank = friendScore.rank;
      loaded = true;
   });
   while (!loaded)
      yield return new WaitForFixedUpdate();
   // do what you need with "rank"
}

This way you make only one call at time instead of multiple concurrent calls (which would hit your web server queue). The number "10" should be the same you use to paginate the leaderboard scores (that is your leaderboard.range.count used in leaderboard.LoadScores).

@skaredcreations thanks!  I can see how it would be non-trivial to implement. Thanks again!

I've run into an additional issue trying to do this. I may not have tested the above solution thoroughly enough.

I had test data for a single leaderboard, and I'm using string codes to identify leaderboards, rather than the integer ID.  Here's what I'm doing:

        var board = CombuManager.platform.CreateLeaderboard();
        board.id = leaderboardCode;
        board.timeScope = UnityEngine.SocialPlatforms.TimeScope.AllTime;
        board.range = new UnityEngine.SocialPlatforms.Range(1, 1000);
        board.userScope = UserScope.FriendsOnly;
        ...
        board.LoadScores(...);

That seemed to work when I was just testing with the one leaderboard that had test data.  However, now I'm testing with a different leadeboardCode for a leaderboard that has no records in it yet.  Strangely, when doing that, the scores array has all my test friend scores from the one leaderboard that has data, even though that's not the leaderboard I queried!

When looking at the score records themselves, it even says "leaderboardID = 55" (which is the integer ID of the leaderboard I DID intend to query, but there shouldn't be any records in that leaderboard, and if I look at it through the Combu admin web interface, it is indeed empty.  Also, the leaderboardCode field is an empty string, rather than my string code ("ft_exp_addicted").

So in other words, it looks like it is returning a bunch of records from the wrong leaderboard, but saying they are from leaderboardID 55, which is the ID of the correct leaderboard -- which is empty.

I tried just manually assigning "55" to board.id to see if that would give the correct result (an empty score list), but it didn't.  No matter what I try, it gives me the scores from the one and only leaderboard I have that has test scores in it, which also happens to be the first leaderboard in the list (with ID 1). I don't know if that is a clue or not.

The local player score (board.localUserScore) appears to be correct (0 - since there shouldn't be any scores on that leaderboard). My best guess is there is a bug in leaderboards.php:wsHighscore()?

@skaredcreations I guess it may be something with how the query is being built in LeaderboarBoard.php. But I can't quite tell.

I found the bug in the query, it's pretty strange that nobody reported it before (this make me think that the others never used the FriendsOnly feature):

at line 261 of Leaderboard.php replace this:

$where = sprintf("(IdAccount IN (%s))", implode(",", $filterId));

with this:

$where .= sprintf(" AND (IdAccount IN (%s))", implode(",", $filterId));

@skaredcreations thanks so much! I'll apply this change ASAP.

Just wanted to report success!  Thanks again!