Module: nintendo.nex.ranking_mk8

Provides a client and server for the RankingProtocolMK8. This page was generated automatically from ranking_mk8.proto.

class RankingClientMK8
The client for the RankingProtocolMK8.

class RankingServerMK8
The server for the RankingProtocolMK8.

class RankingMode
class RankingOrderCalc
class RankingStatFlags

class CompetitionRankingInfo(Structure)
class CompetitionRankingInfoGetParam(Structure)
class CompetitionRankingUploadScoreParam(Structure)
class RankingCachedResult(RankingResult)
class RankingChangeAttributesParam(Structure)
class RankingOrderParam(Structure)
class RankingRankData(Structure)
class RankingResult(Structure)
class RankingScoreData(Structure)
class RankingStats(Structure)

RankingClientMK8

def __init__(client: RMCClient / HppClient)
Creates a new RankingClientMK8.

async def upload_score(score_data: RankingScoreData, unique_id: int) -> None
Calls method 1 on the server.

async def delete_score(category: int, unique_id: int) -> None
Calls method 2 on the server.

async def delete_all_scores(unique_id: int) -> None
Calls method 3 on the server.

async def upload_common_data(common_data: bytes, unique_id: int) -> None
Calls method 4 on the server.

async def delete_common_data(unique_id: int) -> None
Calls method 5 on the server.

async def get_common_data(unique_id: int) -> bytes
Calls method 6 on the server.

async def change_attributes(category: int, param: RankingChangeAttributesParam, unique_id: int) -> None
Calls method 7 on the server.

async def change_all_attributes(param: RankingChangeAttributesParam, unique_id: int) -> None
Calls method 8 on the server.

async def get_ranking(mode: int, category: int, order: RankingOrderParam, unique_id: int, pid: int) -> RankingResult
Calls method 9 on the server.

async def get_approx_order(category: int, order: RankingOrderParam, score: int, unique_id: int, pid: int) -> int
Calls method 10 on the server.

async def get_stats(category: int, order: RankingOrderParam, flags: int) -> RankingStats
Calls method 11 on the server.

async def get_ranking_by_pid_list(pids: list[int], mode: int, category: int, order: RankingOrderParam, unique_id: int) -> RankingResult
Calls method 12 on the server.

async def get_ranking_by_unique_id_list(ids: list[int], mode: int, category: int, order: RankingOrderParam, unique_id: int) -> RankingResult
Calls method 13 on the server.

async def upload_competition_ranking_score(param: CompetitionRankingUploadScoreParam) -> bool
Calls method 15 on the server.

async def get_competition_info(param: CompetitionRankingInfoGetParam) -> list[CompetitionRankingInfo]
Calls method 16 on the server.

RankingServerMK8

def __init__()
Creates a new RankingServerMK8.

async def logout(client: RMCClient) -> None
Called whenever a client is disconnected. May be overridden by a subclass.

async def upload_score(client: RMCClient, score_data: RankingScoreData, unique_id: int) -> None
Handler for method 1. This method should be overridden by a subclass.

async def delete_score(client: RMCClient, category: int, unique_id: int) -> None
Handler for method 2. This method should be overridden by a subclass.

async def delete_all_scores(client: RMCClient, unique_id: int) -> None
Handler for method 3. This method should be overridden by a subclass.

async def upload_common_data(client: RMCClient, common_data: bytes, unique_id: int) -> None
Handler for method 4. This method should be overridden by a subclass.

async def delete_common_data(client: RMCClient, unique_id: int) -> None
Handler for method 5. This method should be overridden by a subclass.

async def get_common_data(client: RMCClient, unique_id: int) -> bytes
Handler for method 6. This method should be overridden by a subclass.

async def change_attributes(client: RMCClient, category: int, param: RankingChangeAttributesParam, unique_id: int) -> None
Handler for method 7. This method should be overridden by a subclass.

async def change_all_attributes(client: RMCClient, param: RankingChangeAttributesParam, unique_id: int) -> None
Handler for method 8. This method should be overridden by a subclass.

async def get_ranking(client: RMCClient, mode: int, category: int, order: RankingOrderParam, unique_id: int, pid: int) -> RankingResult
Handler for method 9. This method should be overridden by a subclass.

async def get_approx_order(client: RMCClient, category: int, order: RankingOrderParam, score: int, unique_id: int, pid: int) -> int
Handler for method 10. This method should be overridden by a subclass.

async def get_stats(client: RMCClient, category: int, order: RankingOrderParam, flags: int) -> RankingStats
Handler for method 11. This method should be overridden by a subclass.

async def get_ranking_by_pid_list(client: RMCClient, pids: list[int], mode: int, category: int, order: RankingOrderParam, unique_id: int) -> RankingResult
Handler for method 12. This method should be overridden by a subclass.

async def get_ranking_by_unique_id_list(client: RMCClient, ids: list[int], mode: int, category: int, order: RankingOrderParam, unique_id: int) -> RankingResult
Handler for method 13. This method should be overridden by a subclass.

async def upload_competition_ranking_score(client: RMCClient, param: CompetitionRankingUploadScoreParam) -> bool
Handler for method 15. This method should be overridden by a subclass.

async def get_competition_info(client: RMCClient, param: CompetitionRankingInfoGetParam) -> list[CompetitionRankingInfo]
Handler for method 16. This method should be overridden by a subclass.

RankingMode

This class defines the following constants:
GLOBAL = 0
GLOBAL_AROUND_SELF = 1
SELF = 4

RankingOrderCalc

This class defines the following constants:
STANDARD = 0
ORDINAL = 1

RankingStatFlags

This class defines the following constants:
RANKING_COUNT = 1
TOTAL_SCORE = 2
LOWEST_SCORE = 4
HIGHEST_SCORE = 8
AVERAGE_SCORE = 16
ALL = 31

CompetitionRankingInfo

def __init__()
Creates a new CompetitionRankingInfo instance. Required fields must be filled in manually.

The following fields are defined in this class:
id: int
num_participants: int
team_scores: list[int]

CompetitionRankingInfoGetParam

def __init__()
Creates a new CompetitionRankingInfoGetParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
rank_order: int
range: ResultRange = ResultRange()

CompetitionRankingUploadScoreParam

def __init__()
Creates a new CompetitionRankingUploadScoreParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
id: int
season_id: int
unk3: int
score: int
team_id: int
team_score: int
is_first_upload: bool
metadata: bytes

RankingCachedResult

def __init__()
Creates a new RankingCachedResult instance. Required fields must be filled in manually.

The following fields are defined in this class:
created_time: DateTime
expired_time: DateTime
max_length: int

RankingChangeAttributesParam

def __init__()
Creates a new RankingChangeAttributesParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
flags: int
groups: list[int]
param: int

RankingOrderParam

def __init__()
Creates a new RankingOrderParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
order_calc: int = 0
group_index: int = 255
group_num: int = 0
time_scope: int = 2
offset: int = 0
count: int = 10

RankingRankData

def __init__()
Creates a new RankingRankData instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
unique_id: int
rank: int
category: int
score: int
groups: list[int]
param: int
common_data: bytes
If nex.version >= 40000:
update_time: DateTime

RankingResult

def __init__()
Creates a new RankingResult instance. Required fields must be filled in manually.

The following fields are defined in this class:
data: list[RankingRankData]
total: int
since_time: DateTime

RankingScoreData

def __init__()
Creates a new RankingScoreData instance. Required fields must be filled in manually.

The following fields are defined in this class:
category: int
score: int
order: int
update_mode: int
groups: list[int]
param: int

RankingStats

def __init__()
Creates a new RankingStats instance. Required fields must be filled in manually.

The following fields are defined in this class:
stats: list[float]