Module: nintendo.nex.friends_3ds

Provides a client and server for the FriendsProtocolV1. This page was generated automatically from friends_3ds.proto.

class FriendsClientV1
The client for the FriendsProtocolV1.

class FriendsServerV1
The server for the FriendsProtocolV1.

class FriendMii(Structure)
class FriendMiiList(Structure)
class FriendMiiRequest(Structure)
class FriendPersistentInfo(Structure)
class FriendPicture(Structure)
class FriendPresence(Structure)
class FriendRelationship(Structure)
class GameKey(Data)
class Mii(Structure)
class MiiList(Structure)
class MyProfile(Structure)
class NintendoPresence(Structure)
class PlayedGame(Structure)

FriendsClientV1

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

async def update_profile(profile_data: MyProfile) -> None
Calls method 1 on the server.

async def update_mii(mii: Mii) -> None
Calls method 2 on the server.

async def update_mii_list(mii_list: MiiList) -> None
Calls method 3 on the server.

async def update_played_games(played_games: list[PlayedGame]) -> None
Calls method 4 on the server.

async def update_preference(unk1: bool, unk2: bool, unk3: bool) -> None
Calls method 5 on the server.

async def get_friend_mii(friends: list[FriendMiiRequest]) -> list[FriendMii]
Calls method 6 on the server.

async def get_friend_mii_list(friends: list[FriendMiiRequest]) -> list[FriendMiiList]
Calls method 7 on the server.

async def get_friend_relationships(unk: list[int]) -> list[FriendRelationship]
Calls method 10 on the server.

async def add_friend_by_principal_id(unk: int, pid: int) -> FriendRelationship
Calls method 11 on the server.

async def get_all_friends() -> list[FriendRelationship]
Calls method 15 on the server.

async def sync_friend(unk1: int, unk2: list[int], unk3: list[int]) -> list[FriendRelationship]
Calls method 17 on the server.

async def update_presence(presence_info: NintendoPresence, unk: bool) -> None
Calls method 18 on the server.

async def update_favorite_game_key(game_key: GameKey) -> None
Calls method 19 on the server.

async def update_comment(comment: str) -> None
Calls method 20 on the server.

async def get_friend_presence(unk: list[int]) -> list[FriendPresence]
Calls method 22 on the server.

async def get_friend_picture(unk: list[int]) -> list[FriendPicture]
Calls method 24 on the server.

async def get_friend_persistent_info(unk: list[int]) -> list[FriendPersistentInfo]
Calls method 25 on the server.

async def send_invitation(unk: list[int]) -> None
Calls method 26 on the server.

FriendsServerV1

def __init__()
Creates a new FriendsServerV1.

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

async def update_profile(client: RMCClient, profile_data: MyProfile) -> None
Handler for method 1. This method should be overridden by a subclass.

async def update_mii(client: RMCClient, mii: Mii) -> None
Handler for method 2. This method should be overridden by a subclass.

async def update_mii_list(client: RMCClient, mii_list: MiiList) -> None
Handler for method 3. This method should be overridden by a subclass.

async def update_played_games(client: RMCClient, played_games: list[PlayedGame]) -> None
Handler for method 4. This method should be overridden by a subclass.

async def update_preference(client: RMCClient, unk1: bool, unk2: bool, unk3: bool) -> None
Handler for method 5. This method should be overridden by a subclass.

async def get_friend_mii(client: RMCClient, friends: list[FriendMiiRequest]) -> list[FriendMii]
Handler for method 6. This method should be overridden by a subclass.

async def get_friend_mii_list(client: RMCClient, friends: list[FriendMiiRequest]) -> list[FriendMiiList]
Handler for method 7. This method should be overridden by a subclass.

async def get_friend_relationships(client: RMCClient, unk: list[int]) -> list[FriendRelationship]
Handler for method 10. This method should be overridden by a subclass.

async def add_friend_by_principal_id(client: RMCClient, unk: int, pid: int) -> FriendRelationship
Handler for method 11. This method should be overridden by a subclass.

async def get_all_friends(client: RMCClient) -> list[FriendRelationship]
Handler for method 15. This method should be overridden by a subclass.

async def sync_friend(client: RMCClient, unk1: int, unk2: list[int], unk3: list[int]) -> list[FriendRelationship]
Handler for method 17. This method should be overridden by a subclass.

async def update_presence(client: RMCClient, presence_info: NintendoPresence, unk: bool) -> None
Handler for method 18. This method should be overridden by a subclass.

async def update_favorite_game_key(client: RMCClient, game_key: GameKey) -> None
Handler for method 19. This method should be overridden by a subclass.

async def update_comment(client: RMCClient, comment: str) -> None
Handler for method 20. This method should be overridden by a subclass.

async def get_friend_presence(client: RMCClient, unk: list[int]) -> list[FriendPresence]
Handler for method 22. This method should be overridden by a subclass.

async def get_friend_picture(client: RMCClient, unk: list[int]) -> list[FriendPicture]
Handler for method 24. This method should be overridden by a subclass.

async def get_friend_persistent_info(client: RMCClient, unk: list[int]) -> list[FriendPersistentInfo]
Handler for method 25. This method should be overridden by a subclass.

async def send_invitation(client: RMCClient, unk: list[int]) -> None
Handler for method 26. This method should be overridden by a subclass.

FriendMii

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

The following fields are defined in this class:
unk1: int
mii: Mii = Mii()
unk2: DateTime

FriendMiiList

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

The following fields are defined in this class:
unk1: int
mii: MiiList = MiiList()
unk2: DateTime

FriendMiiRequest

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

The following fields are defined in this class:
unk1: int
unk2: DateTime

FriendPersistentInfo

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

The following fields are defined in this class:
pid: int
region: int
country: int
area: int
language: int
platform: int
game_key: GameKey = GameKey()
message: str
message_updated: DateTime
friended: DateTime
unk: DateTime

FriendPicture

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

The following fields are defined in this class:
unk: int
data: bytes
datetime: DateTime

FriendPresence

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

The following fields are defined in this class:
unk: int
presence: NintendoPresence = NintendoPresence()

FriendRelationship

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

The following fields are defined in this class:
unk1: int
unk2: int
unk3: int

GameKey

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

The following fields are defined in this class:
title_id: int = 0
title_version: int = 0

Mii

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

The following fields are defined in this class:
unk1: str
unk2: bool
unk3: int
mii_data: bytes

MiiList

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

The following fields are defined in this class:
unk1: str
unk2: bool
unk3: int
mii_datas: list[bytes]

MyProfile

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

The following fields are defined in this class:
region: int
country: int
area: int
language: int
platform: int
unk1: int
unk2: str
unk3: str

NintendoPresence

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

The following fields are defined in this class:
changed_bit_flag: int
game_key: GameKey = GameKey()
game_mode_description: str
join_availability_flag: int
matchmake_system_type: int
join_game_id: int
join_game_mode: int
owner_pid: int
join_group_id: int
application_data: bytes

PlayedGame

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

The following fields are defined in this class:
game_key: GameKey = GameKey()
datetime: DateTime