Skip to main content

    MedalsAPI

      O MedalsAPI é a interface principal para integração com o plugin LeafMedals. Ele fornece métodos para gerenciamento de medalhas, slots de medalhas, ícones visuais e consultas de medalhas atuais.

        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 LeafMedals estar totalmente inicializado.


      Obtendo API​

      LeafMedalsAPI api = LeafMedalsAPI.getApi();


      Informações da API​

      getName()​

      Retorna o nome do plugin LeafMedals carregado no servidor.

      • Retorno: String

      getVersion()​

      Retorna a versão atual da API LeafMedals.

      • Retorno: String

      isPremium()​

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

      • Retorno: boolean


      Medalhas Disponíveis​

      getMedals()​

      Retorna todas as medalhas disponíveis no sistema.

      • Retorno: List<Medal>

      getMedal(String value)​

      Busca uma medalha específica pelo identificador ou valor.

      • Parâmetros:

        • value (String)
      • Retorno: Medal


      getMaxMedals()​

      Retorna o número máximo de medalhas que um jogador pode equipar.

      • Retorno: int


      Medalhas do Jogador​

      getCurrentMedals(Player player)​

      Retorna todas as medalhas atualmente equipadas pelo jogador (por slot).

      • Parâmetros:

        • player (Player)
      • Retorno: HashMap<Integer, CurrentMedal>


      getCurrentMedal(Player player, int slot)​

      Obtém a medalha equipada em um slot específico.

      • Parâmetros:

        • player (Player)

        • slot (int)

      • Retorno: CurrentMedal


      getCurrentMedalsIcons(Player player, boolean space)​

      Gera uma string com os ícones das medalhas atuais do jogador.

      • Parâmetros:

        • player (Player)

        • space (boolean) – se deve incluir espaços entre ícones

      • Retorno: String


      getCurrentMedalsIcons(Player player)​

      Versão simplificada sem espaços entre ícones.

      • Parâmetros:

        • player (Player)
      • Retorno: String


      getLastMedalsFromDatabase(UUID uuid)​

      Recupera as últimas medalhas salvas no banco de dados do jogador.

      • Parâmetros:

        • uuid (UUID)
      • Retorno: HashMap<Integer, String>



      Gerenciamento de Medalhas​

      setMedal(Player player, int slot, Medal medal)​

      Equipa uma medalha em um slot específico do jogador.

      • Parâmetros:

        • player (Player)

        • slot (int)

        • medal (Medal)


      removeMedal(Player player, int slot)​

      Remove a medalha de um slot específico do jogador.

      • Parâmetros:

        • player (Player)

        • slot (int)


      Dicas de uso

      Sempre verifique getMaxMedals() antes de equipar medalhas e utilize getCurrentMedalsIcons() para exibir medalhas em chat, tablist ou scoreboards.