Skip to main content

    TagsAPI

      TagsAPI é a interface principal para integração com o plugin LeafTags. Ele fornece métodos completos para gerenciamento de tags, sufixos, name tags e customização visual.

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


      Obtendo API​

      LeafTagsAPI api = LeafTagsAPI.getApi();


      Informações da API​

      getName()​

      Retorna o nome do plugin LeafTags carregado no servidor.

      • Retorno: String

      getVersion()​

      Retorna a versão atual da API LeafTags.

      • Retorno: String

      isPremium()​

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

      • Retorno: boolean


      Tags​

      getTags()​

      Retorna todas as tags disponíveis no sistema.

      • Retorno: List<Tag>

      getTag(String value)​

      Busca uma tag específica pelo identificador ou valor.

      • Parâmetros:

        • value (String)

      • Retorno: Tag


      getTags(Player player)​

      Retorna todas as tags disponíveis para um jogador específico.

      • Parâmetros:

        • player (Player)

      • Retorno: List<Tag>


      getMaxTag(Player player)​

      Obtém a tag de maior prioridade do jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: Tag


      getCurrentTag(Player player)​

      Obtém a tag atualmente ativa do jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: CurrentTag


      getLastTagFromDatabase(UUID uuid, boolean nullable)​

      Recupera a última tag salva no banco de dados.

      • Parâmetros:

        • uuid (UUID)

        • nullable (boolean)

      • Retorno: Tag



      Sufixos​

      getCustomSuffixes()​

      Retorna todos os sufixos customizados disponíveis.

      • Retorno: List<CustomSuffix>

      getCustomSuffix(String value)​

      Busca um sufixo customizado pelo identificador.

      • Parâmetros:

        • value (String)

      • Retorno: CustomSuffix


      getSuffixes(Player player)​

      Retorna todos os sufixos disponíveis para o jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: List<CustomSuffix>


      getMaxSuffix(Player player)​

      Obtém o sufixo de maior prioridade do jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: CustomSuffix


      getCurrentSuffix(Player player)​

      Obtém o sufixo atualmente ativo do jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: CurrentSuffix


      getLastSuffixFromDatabase(UUID uuid)​

      Recupera o último sufixo salvo no banco de dados.

      • Parâmetros:

        • uuid (UUID)

      • Retorno: CustomSuffix



      Informações Visuais do Jogador​

      getCurrentPrefix(Player player)​

      Retorna o prefixo atual do jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: String


      getCurrentAboveName(Player player)​

      Retorna o texto acima do nome do jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: String


      getCustomName(Player player) @Nullable​

      Retorna o nome customizado do jogador (pode ser null).

      • Parâmetros:

        • player (Player)

      • Retorno: String


      getCurrentName(Player player) @Nonnull​

      Retorna o nome atual completo do jogador.

      • Parâmetros:

        • player (Player)

      • Retorno: String



      Gerenciamento de Tags​

      createTag(String id)​

      Cria um novo TagBuilder para uma tag.

      • Parâmetros:

        • id (String)

      • Retorno: TagBuilder


      buildTag(TagBuilder tagBuilder)​

      Constrói uma tag a partir do builder.

      • Parâmetros:

        • tagBuilder (TagBuilder)

      • Retorno: Tag


      registerTag(Tag tag)​

      Registra uma nova tag no sistema.

      • Parâmetros:

        • tag (Tag)

      unregisterTag(String id)​

      Remove uma tag do sistema.

      • Parâmetros:

        • id (String)


      Aplicação de NameTags​

      applyNameTag(Player player, Tag tag)​

      Aplica uma tag completa ao jogador.

      • Parâmetros:

        • player (Player)

        • tag (Tag)


      applyNameTag(Player player, String prefix, String suffix, int sortPriority)​

      Aplica prefixo, sufixo e prioridade manualmente.

      • Parâmetros:

        • player (Player)

        • prefix (String)

        • suffix (String)

        • sortPriority (int)


      setPrefix(Player player, String prefix)​

      Define apenas o prefixo do jogador.

      • Parâmetros:

        • player (Player)

        • prefix (String)


      setSuffix(Player player, String suffix)​

      Define apenas o sufixo do jogador.

      • Parâmetros:

        • player (Player)

        • suffix (String)


      setSortPriority(Player player, int position)​

      Define a prioridade de ordenação do jogador.

      • Parâmetros:

        • player (Player)

        • position (int)


      setCustomName(Player player, String customName)​

      Define um nome customizado para o jogador.

      • Parâmetros:

        • player (Player)

        • customName (String)



      Controle de Nametag​

      hideNametag(Player player)​

      Esconde a nametag do jogador.

      • Parâmetros:

        • player (Player)

      showNametag(Player player)​

      Mostra a nametag do jogador.

      • Parâmetros:

        • player (Player)

      refreshNametag(Player player)​

      Atualiza/força refresh da nametag do jogador.

      • Parâmetros:

        • player (Player)

      enableNametagUpdate(Player player)​

      Habilita atualizações automáticas da nametag.

      • Parâmetros:

        • player (Player)

      cancelNametagUpdate(Player player)​

      Cancela atualizações automáticas da nametag.

      • Parâmetros:

        • player (Player)

      Dicas de uso

      Use applyNameTag() para aplicação completa e refreshNametag() após mudanças para garantir que todos os clientes vejam as atualizações imediatamente.