ClientPartyMember

Represents the client’s party member. Inherits all attributes and methods from PartyMember.

Additional Methods

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_client_member():
    member = client.party.me
    await member.edit(
        member.set_outfit('CID_175_Athena_Commando_M_Celestial'),
        partial(member.set_banner, icon="OtherBanner28", season_level=100)
    )

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 the bot joins other parties.

*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_client_member():
    member = client.party.me
    await member.edit_and_keep(
        partial(member.set_outfit, 'CID_175_Athena_Commando_M_Celestial'),
        partial(member.set_banner, icon="OtherBanner28", season_level=100)
    )

Raises:

HTTPException - Something went wrong while editing.

leave

async def leave() -> ClientParty

Leaves the party.

return

ClientParty

The new party the client is connected to after leaving.

Raises:

HTTPException - An error occurred while requesting to leave the party.

set_ready

async def set_ready(state: ReadyState) -> None

Sets the readiness of the client.

state

ReadyState

required

The ready state you wish to set.

set_outfit

async def set_outfit(
    asset: Optional[str] = None,
    *,
    key: Optional[str] = None,
    variants: Optional[List[Dict[str, str]]] = None,
    enlightenment: Optional[Union[List, Tuple]] = None,
    corruption: Optional[float] = None
) -> None

Sets the outfit of the client.

asset

Optional[str]

The CID of the outfit. Defaults to the last set outfit. You don’t have to include the full path - the CID is enough.

key

Optional[str]

The encryption key to use for this skin.

variants

Optional[List[Dict[str, str]]]

The variants to use for this outfit. Defaults to None which resets variants.

enlightenment

Optional[Union[List, Tuple]]

A list/tuple containing exactly two integer values describing the season and level you want to enlighten the current loadout with. Example: (1, 300) for season 1, level 300.

corruption

Optional[float]

The corruption value to use for the loadout.

Raises:

HTTPException - An error occurred while requesting.

set_backpack

async def set_backpack(
    asset: Optional[str] = None,
    *,
    key: Optional[str] = None,
    variants: Optional[List[Dict[str, str]]] = None,
    enlightenment: Optional[Union[List, Tuple]] = None,
    corruption: Optional[float] = None
) -> None

Sets the backpack of the client.

asset

Optional[str]

The BID of the backpack. Defaults to the last set backpack.

key

Optional[str]

The encryption key to use for this backpack.

variants

Optional[List[Dict[str, str]]]

The variants to use for this backpack. Defaults to None which resets variants.

enlightenment

Optional[Union[List, Tuple]]

A list/tuple containing exactly two integer values describing the season and level.

corruption

Optional[float]

The corruption value to use for the loadout.

Raises:

HTTPException - An error occurred while requesting.

clear_backpack

async def clear_backpack() -> None

Clears the currently set backpack. Raises:

HTTPException - An error occurred while requesting.

set_pet

async def set_pet(
    asset: Optional[str] = None,
    *,
    key: Optional[str] = None,
    variants: Optional[List[Dict[str, str]]] = None
) -> None

Sets the pet of the client.

asset

Optional[str]

The ID of the pet. Defaults to the last set pet.

key

Optional[str]

The encryption key to use for this pet.

variants

Optional[List[Dict[str, str]]]

The variants to use for this pet. Defaults to None which resets variants.

Raises:

HTTPException - An error occurred while requesting.

clear_pet

async def clear_pet() -> None

Clears the currently set pet. Raises:

HTTPException - An error occurred while requesting.

set_pickaxe

async def set_pickaxe(
    asset: Optional[str] = None,
    *,
    key: Optional[str] = None,
    variants: Optional[List[Dict[str, str]]] = None
) -> None

Sets the pickaxe of the client.

asset

Optional[str]

The PID of the pickaxe. Defaults to the last set pickaxe.

key

Optional[str]

The encryption key to use for this pickaxe.

variants

Optional[List[Dict[str, str]]]

The variants to use for this pickaxe. Defaults to None which resets variants.

Raises:

HTTPException - An error occurred while requesting.

set_contrail

async def set_contrail(
    asset: Optional[str] = None,
    *,
    key: Optional[str] = None,
    variants: Optional[List[Dict[str, str]]] = None
) -> None

Sets the contrail of the client.

asset

Optional[str]

The ID of the contrail. Defaults to the last set contrail.

key

Optional[str]

The encryption key to use for this contrail.

variants

Optional[List[Dict[str, str]]]

The variants to use for this contrail. Defaults to None which resets variants.

Raises:

HTTPException - An error occurred while requesting.

clear_contrail

async def clear_contrail() -> None

Clears the currently set contrail. Raises:

HTTPException - An error occurred while requesting.

set_kicks

async def set_kicks(
    asset: Optional[str] = None,
    *,
    key: Optional[str] = None,
    variants: Optional[List[Dict[str, str]]] = None
) -> None

Sets the kicks (shoes) of the client.

asset

Optional[str]

The ID of the kicks. Defaults to the last set of kicks.

key

Optional[str]

The encryption key to use for these kicks.

variants

Optional[List[Dict[str, str]]]

The variants to use for these kicks.

Raises:

HTTPException - An error occurred while requesting.

clear_kicks

async def clear_kicks() -> None

Clears the currently set kicks. Raises:

HTTPException - An error occurred while requesting.

equip_crown

async def equip_crown(hold_crown: int = True) -> None

Set whether the user is wearing a crown or not.

hold_crown

bool

Whether you want the user to wear a crown or not. Defaults to True.

Raises:

HTTPException - An error occurred while requesting.

set_victory_crowns

async def set_victory_crowns(crowns: int = 0) -> None

Set the amount of victory crowns the user has (must use the ‘Crowning Achievement’ emote to show).

crowns

int

Amount of crowns the user has. Defaults to 0 to clear crowns.

Raises:

HTTPException - An error occurred while requesting.

set_emote

async def set_emote(
    asset: str,
    *,
    run_for: Optional[float] = None,
    key: Optional[str] = None,
    section: Optional[int] = None
) -> None

Sets the emote of the client.

asset

str

required

The EID of the emote.

run_for

Optional[float]

Seconds the emote should run for before being cancelled. None (default) means it will run indefinitely.

key

Optional[str]

The encryption key to use for this emote.

section

Optional[int]

The section.

Raises:

HTTPException - An error occurred while requesting.

set_jam_emote

async def set_jam_emote(
    asset: str,
    *,
    run_for: Optional[float] = None,
    key: Optional[str] = None,
    section: Optional[int] = None
) -> None

Sets the jam emote of the client.

asset

str

required

The EID of the jam emote.

run_for

Optional[float]

Seconds the jam emote should run for before being cancelled. None (default) means it will run indefinitely.

key

Optional[str]

The encryption key to use for this emote.

section

Optional[int]

The section.

If you only have the Jam Track ID of the jam track you want to play, you can replace sid with eid and then add either _vox, _drum, _lead, or _bass to the end depending on what instrument you want to use. e.g., sid_placeholder_10 becomes eid_placeholder_10_vox.

Raises:

HTTPException - An error occurred while requesting.

set_emoji

async def set_emoji(
    asset: str,
    *,
    run_for: Optional[float] = 2,
    key: Optional[str] = None,
    section: Optional[int] = None
) -> None

Sets the emoji of the client.

asset

str

required

The ID of the emoji.

run_for

Optional[float]

Seconds the emoji should run for before being cancelled. None means it will run indefinitely. Defaults to 2 seconds which is roughly the time an emoji naturally plays for.

key

Optional[str]

The encryption key to use for this emoji.

section

Optional[int]

The section.

Raises:

HTTPException - An error occurred while requesting.

clear_emote

async def clear_emote() -> None

Clears/stops the emote currently playing. Raises:

HTTPException - An error occurred while requesting.

set_banner

async def set_banner(
    icon: Optional[str] = None,
    color: Optional[str] = None,
    season_level: Optional[int] = None
) -> None

Sets the banner of the client.

icon

Optional[str]

The icon to use. Defaults to standardbanner15.

color

Optional[str]

The color to use. Defaults to defaultcolor15.

season_level

Optional[int]

The season level. Defaults to 1.

Raises:

HTTPException - An error occurred while requesting.

set_battlepass_info

async def set_battlepass_info(
    has_purchased: Optional[bool] = None,
    level: Optional[int] = None
) -> None

Sets the battlepass info of the client.

None of this is shown visually in-game anymore, including level (you will need to use the season_level parameter in set_banner() to show visual level) but will be kept in the library since it is still set by the real game client.

has_purchased

Optional[bool]

Whether or not you have purchased the battle pass. Defaults to False.

level

Optional[int]

Sets the battle pass level (not the shown level). Defaults to 1.

Raises:

HTTPException - An error occurred while requesting.

set_position

async def set_position(position: int) -> None

Sets the client’s party position.

position

int

required

An integer ranging from 0-15. If a position is already held by someone else, then the client and the existing holder will swap positions.

Raises:

ValueError - The passed position is out of bounds.
HTTPException - An error occurred while requesting.

set_in_match

async def set_in_match() -> None

Sets the client’s party member in a visible match state.

This is only visual in the party and is not a method for joining a match.

Raises:

HTTPException - An error occurred while requesting.

clear_in_match

async def clear_in_match() -> None

Clears the client’s “in match” state. Raises:

HTTPException - An error occurred while requesting.

set_lobby_map_marker

async def set_lobby_map_marker(x: float, y: float) -> None

Sets the client’s lobby map marker.

float

required

The horizontal x coordinate. The x range is roughly -135000.0 <= x <= 135000.

float

required

The vertical y coordinate. The y range is roughly -135000.0 <= y <= 135000.

Raises:

HTTPException - An error occurred while requesting.

clear_lobby_map_marker

async def clear_lobby_map_marker() -> None

Clears and hides the client’s current lobby map marker. Raises:

HTTPException - An error occurred while requesting.

request_playlist

async def request_playlist(playlist_id: str) -> None

Request a playlist to update the party to. A real client should always grant this request.

playlist_id

str

required

The playlist ID to request.

Raises:

HTTPException - An error occurred while requesting.

set_instruments

async def set_instruments(
    bass: Optional[str] = None,
    bass_variants: Optional[str] = None,
    guitar: Optional[str] = None,
    guitar_variants: Optional[str] = None,
    drums: Optional[str] = None,
    drums_variants: Optional[str] = None,
    keytar: Optional[str] = None,
    keytar_variants: Optional[str] = None,
    microphone: Optional[str] = None,
    microphone_variants: Optional[str] = None
) -> None

Sets the client’s instruments for use in jam emotes.

bass

Optional[str]

The ID of the bass instrument.

bass_variants

Optional[dict]

The raw variants for the bass instrument.

guitar

Optional[str]

The ID of the guitar instrument.

guitar_variants

Optional[dict]

The raw variants for the guitar instrument.

drums

Optional[str]

The ID of the drums instrument.

drums_variants

Optional[dict]

The raw variants for the drums instrument.

keytar

Optional[str]

The ID of the keytar instrument.

keytar_variants

Optional[dict]

The raw variants for the keytar instrument.

microphone

Optional[str]

The ID of the microphone instrument.

microphone_variants

Optional[dict]

The raw variants for the microphone instrument.

Raises:

HTTPException - An error occurred while requesting.

Core

Authentication

Social

Party

Messaging

Stats & Data

Utilities

Enums

Exceptions

Commands Extension

Documentation Index