Package xaero.pac.client.parties.party.api

Interface IClientPartyStorageAPI

public interface IClientPartyStorageAPI
API for the party storage on the client side

  • Method Details

    • getParty

      @Nullable IClientPartyAPI getParty()
      Gets the local client player's party.
      Returns:
      the player's party, null if not in one

    • getPartyName

      @Nullable String getPartyName()
      Gets the name of the local client player's party.
      Returns:
      the name of the party, null if not in a party

    • getAllyInfoStorage

      @Nonnull IClientPartyAllyInfoStorageAPI getAllyInfoStorage()
      Gets the party ally info storage.
      Returns:
      ally info storage, not null

    • getPartyMemberDynamicInfoSyncableStorage

      @Nonnull IClientPartyMemberDynamicInfoSyncableStorageAPI getPartyMemberDynamicInfoSyncableStorage()
      Gets the party/ally player dynamic info storage.

      The dynamic info includes locations of some party members and allies.

      Returns:
      the party/ally player dynamic info storage, not null

    • isLoading

      boolean isLoading()
      Checks whether the party data sync is still in progress.

      Party data starts loading in the background when you join the server.

      Returns:
      true if party data is loading, otherwise false

    • getUIMemberCount

      int getUIMemberCount()
      Gets the number of members in the local client player's party, meant for the UI.

      This value is updated before individual member info starts syncing and doesn't necessarily represent the real number of member info currently loaded. It should mainly be used for displaying the member count on the UI.

      Returns:
      the member count for the party meant for the UI

    • getUIAllyCount

      int getUIAllyCount()
      Gets the number of ally parties for the local client player's party, meant for the UI.

      This value is updated before individual ally info starts syncing and doesn't necessarily represent the real number of ally info currently loaded. It should mainly be used for displaying the ally count on the UI.

      Returns:
      the ally count for the party meant for the UI

    • getUIInviteCount

      int getUIInviteCount()
      Gets the number of active invitations for the local client player's party, meant for the UI.

      This value is updated before individual invitation info starts syncing and doesn't necessarily represent the real number of invites currently loaded. It should mainly be used for displaying the invite count on the UI.

      Returns:
      the invite count for the party meant for the UI

    • getMemberLimit

      int getMemberLimit()
      Gets the maximum number of members allowed in a party.
      Returns:
      the maximum allowed number of members

    • getAllyLimit

      int getAllyLimit()
      Gets the maximum number of ally parties allowed for a party.
      Returns:
      the maximum allowed number of allies

    • getInviteLimit

      int getInviteLimit()
      Gets the maximum number of active invitations allowed for a party.
      Returns:
      the maximum allowed number of invites