Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xmistt/rebootpy/llms.txt

Use this file to discover all available pages before exploring further.

​
PartyMember

Represents a party member.

​
Attributes

​
client
Client
The client instance.
​
party
Union[Party, ClientParty]
The party this member is a part of.
​
joined_at
datetime.datetime
The UTC time of when this member joined its party.
​
leader
bool
True if member is the leader, else False.
​
position
int
This member’s position in the party (0-15). This position defines which team you’re a part of:
  • 0-3 = Team 1
  • 4-7 = Team 2
  • 8-11 = Team 3
  • 12-15 = Team 4
​
hidden
bool
Whether or not the member is currently hidden in the party.
​
platform
Platform
The platform this user currently uses.
​
ready
ReadyState
The member’s ready state.
​
input
str
The input type this user is currently using.
​
outfit
str
The CID of the outfit this user currently has equipped.
​
backpack
str
The BID of the backpack this member currently has equipped. None if no backpack is equipped.
​
pet
str
The ID of the pet this member currently has equipped. None if no pet is equipped.
​
pickaxe
str
The pickaxe ID of the pickaxe this member currently has equipped.
​
contrail
str
The contrail ID of the contrail this member currently has equipped.
​
kicks
str
The kicks (shoes) ID this member currently has equipped.
​
outfit_variants
List[Dict[str, str]]
A list containing the raw variants data for the currently equipped outfit.
​
backpack_variants
List[Dict[str, str]]
A list containing the raw variants data for the currently equipped backpack.
​
pickaxe_variants
List[Dict[str, str]]
A list containing the raw variants data for the currently equipped pickaxe.
​
kicks_variants
List[Dict[str, str]]
A list containing the raw variants data for the currently equipped kicks.
​
contrail_variants
List[Dict[str, str]]
A list containing the raw variants data for the currently equipped contrail.
​
enlightenments
List[Tuple[int, int]]
A list of tuples containing the enlightenments of this member.
​
corruption
Optional[float]
The corruption value this member is using. None if no corruption value is set.
​
has_crown
bool
Whether this member currently has a crown or not.
​
victory_crowns
int
The current crown wins of this member.
​
rank
int
The current rank of this member.
​
emote
Optional[str]
The EID of the emote this member is currently playing. None if no emote is currently playing.
​
emoji
Optional[str]
The ID of the emoji this member is currently playing. None if no emoji is currently playing.
​
banner
Tuple[str, str, int]
A tuple consisting of the icon ID, color ID, and the season level. Example: ('standardbanner15', 'defaultcolor15', 50)
​
battlepass_info
Tuple[bool, int]
A tuple consisting of has purchased and battlepass level. Example: (True, 30)
​
match_started_at
Optional[datetime.datetime]
The time in UTC that the member’s match started. None if not in a match.
​
match_players_left
int
How many players there are left in this player’s match. Defaults to 0 if not in a match.
​
lobby_map_marker_coordinates
Tuple[float, float]
A tuple containing the x and y coordinates of this member’s current lobby map marker. The coordinates range is roughly -135000.0 <= coordinate <= 135000.
​
playlist_selection
str
The last playlist that this member selected. Example: experience_reload

​
Methods

​
in_match

def in_match() -> bool
Whether or not this member is currently in a match.
​
return
bool
True if this member is in a match, else False.

​
is_ready

def is_ready() -> bool
Whether or not this member is ready.
​
return
bool
True if this member is ready, else False.

​
is_zombie

def is_zombie() -> bool
Whether or not this member is in a zombie mode (XMPP connection disconnected and not responding).
​
return
bool
True if this member is a zombie, else False.

​
lobby_map_marker_is_visible

def lobby_map_marker_is_visible() -> bool
Whether or not this member’s lobby map marker is currently visible.
​
return
bool
True if this member’s lobby map marker is currently visible, else False.

​
kick

async def kick() -> None
Kicks this member from the party. Raises:
  • Forbidden - You are not the leader of the party.
  • PartyError - You attempted to kick yourself.
  • HTTPException - Something else went wrong when trying to kick this member.

​
promote

async def promote() -> None
Promotes this user to party leader. Raises:
  • Forbidden - You are not the leader of the party.
  • PartyError - You are already party leader.
  • HTTPException - Something else went wrong when trying to promote this member.

​
swap_position

async def swap_position() -> None
Swaps the client’s party position with this member. Raises:
  • HTTPException - An error occurred while requesting.

​
create_variant

@staticmethod
def create_variant(
    *,
    config_overrides: Dict[str, str] = {},
    **kwargs: Any
) -> List[Dict[str, Union[str, int]]]
Creates the variants list by the variants you set.
​
config_overrides
Dict[str, str]
A config that overrides the default config for the variant backend names.
​
pattern
Optional[int]
The pattern number you want to use.
​
numeric
Optional[int]
The numeric number you want to use.
​
clothing_color
Optional[int]
The clothing color you want to use.
​
jersey_color
Optional[str]
The jersey color you want to use. For soccer skins this is the country you want the jersey to represent.
​
parts
Optional[int]
The parts number you want to use.
​
progressive
Optional[int]
The progressing number you want to use.
​
particle
Optional[int]
The particle number you want to use.
​
material
Optional[int]
The material number you want to use.
​
emissive
Optional[int]
The emissive number you want to use.
​
profile_banner
Optional[str]
The profile banner to use. The value should almost always be ProfileBanner.
​
return
List[Dict[str, Union[str, int]]]
List of dictionaries including all variants data.
Example: 
# Set the outfit to soccer skin with Norwegian jersey and jersey number 99
async def set_soccer_skin():
    me = client.party.me
    
    variants = me.create_variant(
        pattern=0,
        numeric=99,
        jersey_color='Norway'
    )
    
    await me.set_outfit(
        asset='CID_149_Athena_Commando_F_SoccerGirlB',
        variants=variants
    )

Build docs developers (and LLMs) love

Get started for freeTalk to us