Class AirshipPartyController

This controller provides information about the users current party.

Index

Methods

GetParty InviteToParty RemoveFromParty

Methods

GetParty

GetParty(): Promise<PartySnapshot>
Gets the users current party data.

Returns Promise<PartySnapshot>

InviteToParty

InviteToParty(user): Promise<void>
Invites the provided user to the local player's party. This call will throw an error if the local client is not the leader of their party.
Parameters
- user: string | Player
  Player object or userId of the player to invite.
Returns Promise<void>

RemoveFromParty

RemoveFromParty(user): Promise<void>
Removes the provided user from the local player's party. This call can also be used to remove the local player from their current party by providing the local player's userId.

Removing a player that has not yet joined will remove the invite for that player if it exists.

This call will throw an error if the local client is not the leader of their party and they attempt to remove a player that is not themself.
Parameters
- user: string | Player
  Player object or userId of the player to remove.
Returns Promise<void>