Skip to main content

    GuildsAPI

      O GuildsAPI é a interface principal para integração com o plugin LeafGuilds. Ela fornece métodos para gerenciamento de guildas, membros, cargos (roles) e ícones.

        Atenção

        Todos os métodos lançam APINotLoadedException caso a API ainda não esteja carregada. Sempre utilize a API após o plugin LeafGuilds estar totalmente inicializado.


      Obtendo API​

      LeafGuildsAPI api = LeafGuildsAPI.getApi();


      Informações da API​

      getName()​

      Retorna o nome do plugin LeafGuilds carregado no servidor.

      • Retorno: String

      getVersion()​

      Retorna a versão atual da API LeafGuilds.

      • Retorno: String

      isPremium()​

      Verifica se o plugin está rodando em uma versão Premium.

      • Retorno: boolean


      Guildas​

      getGuild(String guildId)​

      Obtém uma guilda pelo seu identificador.

      • Parâmetros:

        • guildId (String)

      • Retorno: Guild


      getGuild(UUID uuid)​

      Obtém uma guilda pelo UUID do jogador líder ou membro.

      • Parâmetros:

        • uuid (UUID)

      • Retorno: Guild


      getStoredGuilds()​

      Retorna todas as guildas armazenadas no sistema.

      • Retorno: Collection<Guild>


      Membros​

      getMember(UUID uuid)​

      Obtém o membro de guilda pelo UUID do jogador.

      • Parâmetros:

        • uuid (UUID)

      • Retorno: Member



      Cargos e Ícones​

      getStoredRoles()​

      Retorna todos os cargos (roles) disponíveis no sistema.

      • Retorno: List<Role>

      getStoredIcons()​

      Retorna todos os ícones disponíveis para guildas.

      • Retorno: Collection<Icon>

      Dicas de uso

      Utilize getApi() estático para acesso singleton garantido e aguarde a inicialização completa do LeafGuilds antes de acessar a API.