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.

​
Party

Represents a party that the ClientUser is not yet a part of.

​
Attributes

​
client
Client
The client instance.
​
id
str
The party’s ID.
​
members
List[PartyMember]
A copied list of the members currently in this party.
​
member_count
int
The amount of members currently in this party.
​
applicants
list
The party’s applicants.
​
leader
PartyMember
The leader of the party.
​
playlist_info
Tuple[str, str]
A tuple containing the name and session ID (if in-game) of the currently set playlist.Example output for default duos: ('Playlist_DefaultDuo', '')Example output for a creative island when player is in-game: ('0363-4024-8917', '820665c477184929aa5d0e1f56902cfd')
​
squad_fill
bool
True if squad fill is enabled, else False.
​
privacy
PartyPrivacy
The currently set privacy of this party.
​
squad_assignments
Dict[PartyMember, SquadAssignment]
The squad assignments for this party. This includes information about a member’s position and visibility.
​
region
Region
The currently set region of this party.

​
Methods

​
get_member

def get_member(user_id: str) -> Optional[PartyMember]
Attempts to get a party member from the member cache.
​
user_id
str
required
The user ID to search for.
​
return
Optional[PartyMember]
The party member if found, otherwise None.

​
join

async def join() -> ClientParty
Joins the party.
Because the client has to leave its current party before joining a new one, a new party is created if some of these errors are raised. Most of the time though this is not the case and the client will remain in its current party.
​
return
ClientParty
The party that was just joined.
Raises:
  • PartyError - You are already a member of this party.
  • NotFound - The party was not found.
  • Forbidden - You are not allowed to join this party because it’s private and you have not been a part of it before, or you were kicked.
  • HTTPException - An error occurred when requesting to join the party.

Build docs developers (and LLMs) love

Get started for freeTalk to us