Class PartyEntity

constructor

• new PartyEntity(client: RankedClient, data: Party): PartyEntity

  Instantiates a new PartyEntity.

  Parameters

  • client: RankedClient

    The active SDK client instance.

  • data: Party

    The raw party data from the API.

  Returns PartyEntity

id

leaderId

membersIds

addMember

• addMember(userId: number): Promise<PartyEntity>

  Adds a user to this party.

  Parameters

  • userId: number

    The ID of the user to add.

  Returns Promise<PartyEntity>

  A promise resolving to the updated PartyEntity.

changeLeader

• changeLeader(newLeaderId: number): Promise<PartyEntity>

  Transfers the leadership of the party to another member.

  Parameters

  • newLeaderId: number

    The ID of the new leader.

  Returns Promise<PartyEntity>

  A promise resolving to the updated PartyEntity.

disband

• disband(): Promise<void>

  Disbands the party completely, removing all members.

  Returns Promise<void>

  A promise resolving when the party is successfully disbanded.

removeMember

• removeMember(userId: number): Promise<PartyEntity | null>

  Removes a user from this party. If the party becomes empty, it will be automatically disbanded by the server.

  Parameters

  • userId: number

    The ID of the user to remove.

  Returns Promise<PartyEntity | null>

  A promise resolving to the updated PartyEntity, or null if the party was disbanded.