Interface NamesModule

All Superinterfaces:
ModuleLocalization, ModuleSimple
public interface NamesModule extends ModuleLocalization
Builds the name shown for a sender, including prefixes, suffixes and the invisible-player form.

  • Method Details

    • config

      Message.Format.Names config()
      Description copied from interface: ModuleSimple
      The config section this module reads its settings from.
      Specified by:
      config in interface ModuleSimple
      Returns:
      the settings

    • permission

      Permission.Message.Format.Names permission()
      Description copied from interface: ModuleSimple
      The permission that gates this module.
      Specified by:
      permission in interface ModuleSimple
      Returns:
      the permission

    • localization

      Localization.Message.Format.Names localization(FPlayer fPlayer)
      Description copied from interface: ModuleLocalization
      The localization section for a player, picked from their chosen language.
      Specified by:
      localization in interface ModuleLocalization
      Parameters:
      fPlayer - the player the text is for
      Returns:
      the localization settings

    • addTags

      MessageContext addTags(MessageContext messageContext)
      Registers the tags that render a sender's name, prefix and suffix.
      Parameters:
      messageContext - the message being formatted
      Returns:
      the context with the tags added

    • addInvisibleTag

      MessageContext addInvisibleTag(MessageContext messageContext)
      Registers the tag that hides a name when the sender should not be identified.
      Parameters:
      messageContext - the message being formatted
      Returns:
      the context with the tag added

    • isInvisible

      boolean isInvisible(FEntity entity)
      Whether this entity's name should be hidden, because it is vanished or drinking an invisibility potion.
      Parameters:
      entity - the entity
      Returns:
      true if the name is hidden

    • updateConstant

      void updateConstant(FPlayer fPlayer)
      Parses this player's constants
      Parameters:
      fPlayer - the player