feat(ranking): Add RankingModes constants for GetRanking.rankingMode #79
Conversation
This will allow downstream callers to disambiguate between the different rank request types
| type rankingModes struct { | ||
| // Global leaderboards | ||
| Global uint8 | ||
| // Ranks close to caller on global leaderboards | ||
| NearbyGlobal uint8 | ||
| // Friends of caller only | ||
| Friends uint8 | ||
| // Ranks close to caller on friends leaderboards | ||
| NearbyFriends uint8 | ||
| // Rank of caller only | ||
| Self uint8 | ||
| } | ||
|
|
||
| // RankingModes is an enum of all the types of ranking request that can be made in the GetRanking method | ||
| var RankingModes = rankingModes{ | ||
| Global: 0, | ||
| NearbyGlobal: 1, | ||
| Friends: 2, | ||
| NearbyFriends: 3, | ||
| Self: 4, | ||
| } |
There was a problem hiding this comment.
Not sure if this should be on the same file as the GetRanking handling? Maybe on a different file named ranking_modes.go?
There was a problem hiding this comment.
I agree with Dani. Having it in it's own file would make it line up with all of our other constants definition files, like those in nex-go and https://github.com/PretendoNetwork/nex-protocols-go/blob/master/match-making/gathering_flags.go
| Global: 0, | ||
| NearbyGlobal: 1, | ||
| Friends: 2, | ||
| NearbyFriends: 3, | ||
| Self: 4, |
There was a problem hiding this comment.
For cases like this where we emulate an enum where each value is sequential, we can avoid defining each value manually by using iota (which defaults to 0). See https://github.com/PretendoNetwork/nex-go/tree/master/constants for examples
However that only applies to cases where each value is defined as its own variable, it's not applicable in this case. How you have it is fine, but wanted to give you all the options 👍
Part of PretendoNetwork/nex-protocols-common-go#34
Changes:
Add RankingModes enum for the different GetRanking request modes. This allows downstreams like nex-protocols-common-go to implement things like Friends and Nearby leaderboards.