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.

​
DefaultPartyConfig

Data class for the default party configuration used when a new party is created.

​
Parameters

​
privacy
Optional[PartyPrivacy]
The party privacy that should be used. Defaults to PartyPrivacy.PUBLIC.
​
max_size
Optional[int]
The maximum party size. Valid party sizes must use a value between 1 and 16. Defaults to 16.
​
chat_enabled
Optional[bool]
Whether or not the party chat should be enabled for the party. Defaults to True.
​
team_change_allowed
bool
Whether or not players should be able to manually swap party team with another player. This setting only works if the client is the leader of the party. Defaults to True.
​
default_squad_assignment
SquadAssignment
The default squad assignment to use for new members. Squad assignments hold information about a party member’s current position and visibility. Note that setting a position in the default squad assignment doesn’t actually do anything and it will just be overridden. Defaults to SquadAssignment(hidden=False).
​
position_priorities
List[int]
A list of exactly 16 ints all ranging from 0-15. When a new member joins the party or a member is not defined in a squad assignment request, it will automatically give the first available position in this list. Defaults to a list of 0-15 in order.
​
reassign_positions_on_size_change
bool
Whether or not positions should be automatically reassigned if the party size changes. Set this to False if you want members to keep their positions unless manually changed. The reassignment is done according to the position priorities. Defaults to True.
​
joinability
Optional[PartyJoinability]
The joinability configuration that should be used. Defaults to PartyJoinability.OPEN.
​
discoverability
Optional[PartyDiscoverability]
The discoverability configuration that should be used. Defaults to PartyDiscoverability.ALL.
​
invite_ttl
Optional[int]
How many seconds the invite should be valid for before automatically becoming invalid. Defaults to 14400.
​
intention_ttl
Optional[int]
How many seconds an intention should last. Defaults to 60.
​
sub_type
Optional[str]
The sub type the party should use. Defaults to 'default'.
​
party_type
Optional[str]
The type of the party. Defaults to 'DEFAULT'.
​
cls
Type[ClientParty]
The default party object to use for the client’s party. Here you can specify all class objects that inherit from ClientParty.
​
meta
List[functools.partial]
A list of coroutines in the form of partials. This config will be automatically equipped by the party when a new party is created by the client.
Example: 
from rebootpy import ClientParty
from functools import partial

default_config = DefaultPartyConfig(
    meta=[
        partial(ClientParty.set_custom_key, 'myawesomekey'),
        partial(ClientParty.set_playlist, 'Playlist_PlaygroundV2')
    ]
)

​
Attributes

​
team_change_allowed
bool
Whether or not players are able to manually swap party team with another player.
​
default_squad_assignment
SquadAssignment
The default squad assignment to use for new members and members not specified in manual squad assignments requests.
​
position_priorities
List[int]
A list containing exactly 16 integers ranging from 0-16 with no duplicates. This is used for position assignments.
​
reassign_positions_on_size_change
bool
Whether or not positions will be automatically reassigned when the party size changes.
​
cls
Type[ClientParty]
The default party object used to represent the client’s party.

​
Methods

​
update

def update(config: Dict[str, Any]) -> None
Updates the configuration with new values.
​
config
Dict[str, Any]
required
Dictionary of configuration values to update.

​
update_meta

def update_meta(meta: List[functools.partial]) -> None
Updates the meta configuration.
​
meta
List[functools.partial]
required
List of partials to update the meta with.

​
DefaultPartyMemberConfig

Data class for the default party member configuration used when the client joins a party.

​
Parameters

​
cls
Type[ClientPartyMember]
The default party member object to use to represent the client as a party member. Here you can specify all classes that inherit from ClientPartyMember. Defaults to ClientPartyMember.
​
yield_leadership
bool
Whether or not the client should promote another member automatically whenever there is a chance to. Defaults to False.
​
offline_ttl
int
How long the client should stay in the party disconnected state before expiring when the XMPP connection is lost. Defaults to 30.
​
meta
List[functools.partial]
A list of coroutines in the form of partials. This config will be automatically equipped by the bot when joining new parties.
Example: 
from rebootpy import ClientPartyMember
from functools import partial

default_config = DefaultPartyMemberConfig(
    meta=[
        partial(ClientPartyMember.set_outfit, 'CID_175_Athena_Commando_M_Celestial'),
        partial(ClientPartyMember.set_banner, icon="OtherBanner28", season_level=100)
    ]
)

​
Attributes

​
cls
Type[ClientPartyMember]
The default party member object used when representing the client as a party member.
​
yield_leadership
bool
Whether or not the client promotes another member automatically whenever there is a chance to.
​
offline_ttl
int
How long the client will stay in the party disconnected state before expiring when the XMPP connection is lost.

​
Methods

​
update_meta

def update_meta(meta: List[functools.partial]) -> None
Updates the meta configuration.
​
meta
List[functools.partial]
required
List of partials to update the meta with.

​
SquadAssignment

Represents a party member’s squad assignment. A squad assignment is basically a piece of information about which position a member has in the party, which is directly related to party teams.

​
Parameters

​
position
Optional[int]
The position a member should have in the party. If no position is passed, a position will be automatically given according to the position priorities set.
​
hidden
bool
Whether or not the member should be hidden in the party.
Being hidden is not a native Fortnite feature so be careful when using this. It might lead to undesirable results.

​
Attributes

​
position
Optional[int]
The position of the member in the party.
​
hidden
bool
Whether the member is hidden in the party.

​
Methods

​
copy

@classmethod
def copy(cls, assignment: SquadAssignment) -> SquadAssignment
Creates a copy of a squad assignment.
​
assignment
SquadAssignment
required
The squad assignment to copy.
​
return
SquadAssignment
A new SquadAssignment instance with the same values.

Build docs developers (and LLMs) love

Get started for freeTalk to us