Skip to main content

​
ClientParty

Represents the ClientUser’s party.

​
Attributes

​
client
Client
The client instance.
​
id
str
The party’s ID.
​
me
ClientPartyMember
The client’s party member object.
​
members
List[PartyMember]
A copied list of the members currently in this party.
​
member_count
int
The amount of members currently in this party.
​
leader
PartyMember
The leader of the party.
​
privacy
PartyPrivacy
The currently set privacy of this party.
​
region
Region
The currently set region of this party.
​
squad_fill
bool
True if squad fill is enabled, else False.

​
Methods

​
send

async def send(content: str) -> None
Sends a message to this party’s chat.
​
content
str
required
The content of the message, up to 256 characters.
Raises:
  • ChatError - Content is longer than 256 characters or the client is in a party on its own.

​
edit

async def edit(*coros: List[Union[Awaitable, functools.partial]]) -> None
Edits multiple meta parts at once.
​
*coros
Union[Awaitable, functools.partial]
required
A list of coroutines that should be included in the edit.
Example: 
from functools import partial

async def edit_party():
    party = client.party
    await party.edit(
        party.set_privacy(rebootpy.PartyPrivacy.PRIVATE),
        partial(party.set_custom_key, 'myawesomekey')
    )
Raises:
  • HTTPException - Something went wrong while editing.

​
edit_and_keep

async def edit_and_keep(*coros: List[functools.partial]) -> None
Edits multiple meta parts at once and keeps the changes for when new parties are created.
​
*coros
functools.partial
required
A list of partials of coroutines that should be included in the edit.
Example: 
from functools import partial

async def edit_and_keep_party():
    party = client.party
    await party.edit_and_keep(
        partial(party.set_custom_key, 'myawesomekey'),
        partial(party.set_playlist, 'Playlist_PlaygroundV2')
    )
Raises:
  • HTTPException - Something went wrong while editing.

​
invite

async def invite(user_id: str) -> SentPartyInvitation
Invites a user to the party.
​
user_id
str
required
The ID of the user to invite.
​
return
SentPartyInvitation
Object representing the sent party invitation.
Raises:
  • PartyError - User is already in your party or the party is full.
  • Forbidden - The invited user is not friends with the client.
  • HTTPException - Something else went wrong when trying to invite the user.

​
fetch_invites

async def fetch_invites() -> List[SentPartyInvitation]
Fetches all active invitations sent from the party.
Because of an error on Fortnite’s end, this method only returns invites sent from other party members if the party is private. However it will always return invites sent from the client regardless of party privacy.
​
return
List[SentPartyInvitation]
A list of all sent invites from the party.
Raises:
  • HTTPException - An error occurred while requesting from Fortnite’s services.

​
set_privacy

async def set_privacy(privacy: PartyPrivacy) -> None
Sets the privacy of the party.
​
privacy
PartyPrivacy
required
The privacy setting to apply.
Raises:
  • Forbidden - The client is not the leader of the party.

​
set_region

async def set_region(region: Region) -> None
Sets the current region of the party.
​
region
Region
required
The region to use.
Example: 
await party.set_region(region=rebootpy.Region.EUROPE)
Raises:
  • Forbidden - The client is not the leader of the party.

​
set_custom_key

async def set_custom_key(key: str) -> None
Sets the custom key of the party.
​
key
str
required
The key to set.
Raises:
  • Forbidden - The client is not the leader of the party.

​
set_fill

async def set_fill(value: bool) -> None
Sets the fill status of the party.
​
value
bool
required
What to set the fill status to. True sets it to ‘Fill’, False sets it to ‘NoFill’.
Raises:
  • Forbidden - The client is not the leader of the party.

​
set_max_size

async def set_max_size(size: int) -> None
Sets a new max size of the party.
​
size
int
required
The size to set. Must be more than the current member count, more than or equal to 1 or less than or equal to 16.
Raises:
  • Forbidden - The client is not the leader of the party.
  • PartyError - The new size was lower than the current member count.
  • PartyError - The new size was not within valid range (1-16).

​
set_playlist

async def set_playlist(playlist: str = "", version: int = -1) -> None
Sets the current playlist of the party.
​
playlist
str
The playlist ID or island code. Defaults to empty string.
​
version
int
The version of the playlist/island. Defaults to -1 which is latest.
Examples: 
# Set to Duos
await party.set_playlist(playlist='Playlist_DefaultDuo')

# Set to a creative island
await party.set_playlist(playlist='0363-4024-8917')

​
set_squad_assignments

async def set_squad_assignments(assignments: Dict[PartyMember, SquadAssignment]) -> None
Sets squad assignments for members of the party.
​
assignments
Dict[PartyMember, SquadAssignment]
required
Pre-defined assignments to set. If a member is missing from this dict, they will be automatically added to the final request.
Example: 
{
    member1: rebootpy.SquadAssignment(position=5),
    member2: rebootpy.SquadAssignment(hidden=True)
}
Raises:
  • ValueError - Duplicate positions were set in the assignments.
  • Forbidden - You are not the leader of the party.
  • HTTPException - An error occurred while requesting.