[**fnlb**](../index.md) *** [fnlb](../index.md) / Party # Class: Party The Fortnite party a [Bot](Bot.md) is currently in. `meta` is the party schema (playlist, privacy, custom key). Cosmetic and matchmaking data lives on each member: `party.me.meta` or `member.meta`. `get()` with no key returns the parsed schema. Keys ending in `j` are objects, `b` are booleans, and `U` are numbers. `set()` writes one key and sends only that patch. ## Properties ### bot > `readonly` **bot**: [`Bot`](Bot.md) *** ### id? > `optional` **id?**: `string` Epic party id. *** ### members > `readonly` **members**: [`Collection`](Collection.md)\<`string`, [`PartyMember`](PartyMember.md)\> Members in the party, keyed by Epic account id. Includes the bot. *** ### playlistId? > `optional` **playlistId?**: `string` Island or playlist link id currently selected, lowercased. ## Accessors ### me #### Get Signature > **get** **me**(): [`PartyMember`](PartyMember.md) \| `undefined` The bot's own party member, once `bot.epicId` is known. ##### Returns [`PartyMember`](PartyMember.md) \| `undefined` *** ### meta #### Get Signature > **get** **meta**(): [`PartyMeta`](PartyMeta.md) Party-level meta. Use `me.meta` for the bot's own member meta. ##### Returns [`PartyMeta`](PartyMeta.md) ## Methods ### clearBackpack() > **clearBackpack**(): `Promise`\<\{ `ok`: `true`; \}\> Remove the equipped back bling. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### clearEmote() > **clearEmote**(): `Promise`\<\{ `ok`: `true`; \}\> Stop the current emote, emoji, or jam track. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### clearShoes() > **clearShoes**(): `Promise`\<\{ `ok`: `true`; \}\> Remove the equipped kicks. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### clearSidekick() > **clearSidekick**(): `Promise`\<\{ `ok`: `true`; \}\> Remove the equipped sidekick. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### fetchMembers() > **fetchMembers**(): `Promise`\<[`Collection`](Collection.md)\<`string`, [`PartyMember`](PartyMember.md)\>\> Reload members from the shard and replace `party.members`. #### Returns `Promise`\<[`Collection`](Collection.md)\<`string`, [`PartyMember`](PartyMember.md)\>\> *** ### hideMember() > **hideMember**(`targetId`, `hide?`): `Promise`\<\{ `ok`: `true`; \}\> Hide or show one member in the squad list. The bot has to be party leader. #### Parameters ##### targetId `string` Epic account id or display name. ##### hide? `boolean` = `true` When false, that member is shown again. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### hideMembers() > **hideMembers**(`hide?`): `Promise`\<\{ `ok`: `true`; \}\> Hide every other member in the squad list, or show them again. The bot has to be party leader. #### Parameters ##### hide? `boolean` = `true` When false, members are shown again. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### invite() > **invite**(`targetId`): `Promise`\<\{ `ok`: `true`; \}\> Invite a friend into this party. The bot must already be friends with them. #### Parameters ##### targetId `string` Epic account id or display name. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### kick() > **kick**(`targetId`): `Promise`\<\{ `ok`: `true`; \}\> Kick a member. The bot has to be party leader. #### Parameters ##### targetId `string` Epic account id or display name. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### leave() > **leave**(`createNew?`): `Promise`\<\{ `ok`: `true`; \}\> Leave the party. By default the bot creates a new party afterwards. #### Parameters ##### createNew? `boolean` = `true` When false, the bot stays without a party. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### promote() > **promote**(`targetId`): `Promise`\<\{ `ok`: `true`; \}\> Promote a member to party leader. #### Parameters ##### targetId `string` Epic account id or display name. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### send() > **send**(`content`): `Promise`\<\{ `ok`: `true`; \}\> Send a party chat message from this bot. #### Parameters ##### content `string` Text to send. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setBackpack() > **setBackpack**(`id`, `variants?`, `path?`): `Promise`\<\{ `ok`: `true`; \}\> Equip a back bling on this bot. `clearBackpack()` removes it. #### Parameters ##### id `string` ##### variants? [`SdkCosmeticVariant`](../interfaces/SdkCosmeticVariant.md)[] ##### path? `string` #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setBanner() > **setBanner**(`bannerId`, `color`): `Promise`\<\{ `ok`: `true`; \}\> Set the banner shown on this bot. #### Parameters ##### bannerId `string` Banner icon id. ##### color `string` Banner color id. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setBattlePass() > **setBattlePass**(`purchased`, `level`): `Promise`\<\{ `ok`: `true`; \}\> Set battle pass ownership and level shown on this bot. #### Parameters ##### purchased `boolean` Whether the pass is owned. ##### level `number` Pass level. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setCosmeticStats() > **setCosmeticStats**(`crowns`, `ranked`): `Promise`\<\{ `ok`: `true`; \}\> Set the crown count and ranked progress shown on this bot. #### Parameters ##### crowns `number` Crown count. ##### ranked `number` Ranked progression value. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setCustomMatchmakingKey() > **setCustomMatchmakingKey**(`key?`): `Promise`\<\{ `ok`: `true`; \}\> Set the custom matchmaking key. Pass an empty string to clear it. The bot has to be party leader. #### Parameters ##### key? `string` = `''` Key other parties must match to land in the same game. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setEmoji() > **setEmoji**(`id`, `path?`): `Promise`\<\{ `ok`: `true`; \}\> Play an emoji. #### Parameters ##### id `string` ##### path? `string` #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setEmote() > **setEmote**(`id`, `path?`): `Promise`\<\{ `ok`: `true`; \}\> Play an emote. #### Parameters ##### id `string` ##### path? `string` #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setLevel() > **setLevel**(`level`): `Promise`\<\{ `ok`: `true`; \}\> Set the account level shown on this bot. #### Parameters ##### level `number` Account level. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setMaxSize() > **setMaxSize**(`maxSize`): `Promise`\<\{ `ok`: `true`; \}\> Set how many members the party can hold, from 1 to 16. The bot has to be party leader. #### Parameters ##### maxSize `number` New member cap. It has to be at least the current member count. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setOutfit() > **setOutfit**(`id`, `variants?`): `Promise`\<\{ `ok`: `true`; \}\> Equip an outfit on this bot. Same as `party.me.setOutfit`. #### Parameters ##### id `string` ##### variants? [`SdkCosmeticVariant`](../interfaces/SdkCosmeticVariant.md)[] #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setPickaxe() > **setPickaxe**(`id`, `variants?`, `path?`): `Promise`\<\{ `ok`: `true`; \}\> Equip a pickaxe on this bot. #### Parameters ##### id `string` ##### variants? [`SdkCosmeticVariant`](../interfaces/SdkCosmeticVariant.md)[] ##### path? `string` #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setPlaylist() > **setPlaylist**(`playlist`, `region?`): `Promise`\<\{ `ok`: `true`; \}\> Select a playlist or island. The bot has to be party leader. #### Parameters ##### playlist `string` Link id, such as [Playlist.SQUAD](../variables/Playlist.md#squad) or an island code. ##### region? `string` Matchmaking region, such as `NAE`. Omit it to keep the current region. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setPrivacy() > **setPrivacy**(`privacy`): `Promise`\<\{ `ok`: `true`; \}\> Set party privacy. The bot has to be party leader. #### Parameters ##### privacy [`SdkPartyPrivacy`](../type-aliases/SdkPartyPrivacy.md) One of [PartyPrivacy](../variables/PartyPrivacy.md). `PUBLIC` is an open party. `PRIVATE` is invite-only. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setReady() > **setReady**(`ready`): `Promise`\<\{ `ok`: `true`; \}\> Ready up or unready. #### Parameters ##### ready `boolean` When true, the bot reads up. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setShoes() > **setShoes**(`id`, `variants?`, `path?`): `Promise`\<\{ `ok`: `true`; \}\> Equip kicks on this bot. #### Parameters ##### id `string` ##### variants? [`SdkCosmeticVariant`](../interfaces/SdkCosmeticVariant.md)[] ##### path? `string` #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setSidekick() > **setSidekick**(`id`, `variants?`, `path?`): `Promise`\<\{ `ok`: `true`; \}\> Equip a sidekick on this bot. #### Parameters ##### id `string` ##### variants? [`SdkCosmeticVariant`](../interfaces/SdkCosmeticVariant.md)[] ##### path? `string` #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setSittingOut() > **setSittingOut**(`sittingOut`): `Promise`\<\{ `ok`: `true`; \}\> Sit out of the party, or join it again. #### Parameters ##### sittingOut `boolean` When true, the bot sits out. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setSquadFill() > **setSquadFill**(`fill?`): `Promise`\<\{ `ok`: `true`; \}\> Turn squad fill on or off. The bot has to be party leader. #### Parameters ##### fill? `boolean` = `true` When true, the party fills with other players. #### Returns `Promise`\<\{ `ok`: `true`; \}\> *** ### setTrack() > **setTrack**(`id`, `path?`): `Promise`\<\{ `ok`: `true`; \}\> Play a jam track. #### Parameters ##### id `string` ##### path? `string` #### Returns `Promise`\<\{ `ok`: `true`; \}\>