Module: nintendo.nex.ranking2

Provides a client and server for the Ranking2Protocol. This page was generated automatically from ranking2.proto.

class Ranking2Client
The client for the Ranking2Protocol.

class Ranking2Server
The server for the Ranking2Protocol.

class RankingMode

class Ranking2CategorySetting(Structure)
class Ranking2ChartInfo(Structure)
class Ranking2ChartInfoInput(Structure)
class Ranking2CommonData(Structure)
class Ranking2EstimateScoreRankInput(Structure)
class Ranking2EstimateScoreRankOutput(Structure)
class Ranking2GetByListParam(Structure)
class Ranking2GetParam(Structure)
class Ranking2Info(Structure)
class Ranking2RankData(Structure)
class Ranking2ScoreData(Structure)

Ranking2Client

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

async def put_score(socres: list[Ranking2ScoreData], unique_id: int) -> None
Calls method 1 on the server.

async def get_common_data(option_flags: int, pid: int, unique_id: int) -> Ranking2CommonData
Calls method 2 on the server.

async def put_common_data(data: Ranking2CommonData, unique_id: int) -> None
Calls method 3 on the server.

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

async def get_ranking(param: Ranking2GetParam) -> Ranking2Info
Calls method 5 on the server.

async def get_ranking_by_principal_id(param: Ranking2GetByListParam, pids: list[int]) -> Ranking2Info
Calls method 6 on the server.

async def get_category_setting(category: int) -> Ranking2CategorySetting
Calls method 7 on the server.

async def get_ranking_chart(input: Ranking2ChartInfoInput) -> Ranking2ChartInfo
Calls method 8 on the server.

async def get_ranking_charts(inputs: list[Ranking2ChartInfoInput]) -> list[Ranking2ChartInfo]
Calls method 9 on the server.

async def get_estimate_score_rank(input: Ranking2EstimateScoreRankInput) -> Ranking2EstimateScoreRankOutput
Calls method 10 on the server.

Ranking2Server

def __init__()
Creates a new Ranking2Server.

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

async def put_score(client: RMCClient, socres: list[Ranking2ScoreData], unique_id: int) -> None
Handler for method 1. This method should be overridden by a subclass.

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

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

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

async def get_ranking(client: RMCClient, param: Ranking2GetParam) -> Ranking2Info
Handler for method 5. This method should be overridden by a subclass.

async def get_ranking_by_principal_id(client: RMCClient, param: Ranking2GetByListParam, pids: list[int]) -> Ranking2Info
Handler for method 6. This method should be overridden by a subclass.

async def get_category_setting(client: RMCClient, category: int) -> Ranking2CategorySetting
Handler for method 7. This method should be overridden by a subclass.

async def get_ranking_chart(client: RMCClient, input: Ranking2ChartInfoInput) -> Ranking2ChartInfo
Handler for method 8. This method should be overridden by a subclass.

async def get_ranking_charts(client: RMCClient, inputs: list[Ranking2ChartInfoInput]) -> list[Ranking2ChartInfo]
Handler for method 9. This method should be overridden by a subclass.

async def get_estimate_score_rank(client: RMCClient, input: Ranking2EstimateScoreRankInput) -> Ranking2EstimateScoreRankOutput
Handler for method 10. This method should be overridden by a subclass.

RankingMode

This class defines the following constants:
GLOBAL_AROUND_SELF = 1
GLOBAL = 2
FRIENDS = 3

Ranking2CategorySetting

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

The following fields are defined in this class:
min_score: int
max_score: int
lowest_rank: int
reset_month: int
reset_day: int
reset_hour: int
reset_mode: int
max_seasons_to_go_back: int
score_order: bool

Ranking2ChartInfo

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

The following fields are defined in this class:
create_time: DateTime
index: int
category: int
season: int
bins_size: int
sampling_rate: int
score_order: bool
estimate_length: int
estimate_highest_score: int
estimate_lowest_score: int
estimate_median_score: int
estimate_average_score: float
highest_bins_score: int
lowest_bins_score: int
bins_width: int
attribute1: int
attribute2: int
quantities: list[int]

Ranking2ChartInfoInput

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

The following fields are defined in this class:
chart_index: int
seasons_to_go_back: int

Ranking2CommonData

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

The following fields are defined in this class:
username: str
mii: bytes
binary_data: bytes

Ranking2EstimateScoreRankInput

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

The following fields are defined in this class:
category: int
seasons_to_go_back: int
score: int

Ranking2EstimateScoreRankOutput

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

The following fields are defined in this class:
rank: int
length: int
score: int
category: int
season: int
sampling_rate: int

Ranking2GetByListParam

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

The following fields are defined in this class:
category: int
offset: int
length: int
sort_flags: int
option_flags: int
seasons_to_go_back: int

Ranking2GetParam

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

The following fields are defined in this class:
unique_id: int = 0
pid: int = 0
category: int
offset: int = 0
count: int = 10
sort_flags: int = 0
option_flags: int = 0
mode: int = 2
seasons_to_go_back: int = 0

Ranking2Info

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

The following fields are defined in this class:
data: list[Ranking2RankData]
lowest_rank: int
num_entries: int
season: int

Ranking2RankData

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

The following fields are defined in this class:
misc: int
unique_id: int
pid: int
rank: int
score: int
common_data: Ranking2CommonData = Ranking2CommonData()

Ranking2ScoreData

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

The following fields are defined in this class:
misc: int
category: int
score: int