Package de.eldoria.eldoutilities.messages

Class MessageSender

java.lang.Object
de.eldoria.eldoutilities.messages.MessageSender
Direct Known Subclasses:
PaperMessageSender, SpigotMessageSender
public abstract class MessageSender extends Object
A message sender to manage message sending.

Allows definition of a plugin prefix, Message color, Error color.

Allows sending of messages, error messages, titles.

Allows sending of automatically localized messages in combination with a created localizer.

Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    MessageSender(org.bukkit.plugin.Plugin plugin, net.kyori.adventure.text.minimessage.MiniMessage miniMessage, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver messageTagResolver, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver errorTagResolver, net.kyori.adventure.text.Component prefix)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected net.kyori.adventure.text.Component
    applyPrefix(net.kyori.adventure.text.Component component)
     
    abstract net.kyori.adventure.audience.Audience
    asAudience(org.bukkit.entity.Player player)
     
    abstract void
    broadcast(String message)
     
    static MessageSenderBuilder
    builder(org.bukkit.plugin.Plugin plugin)
     
    protected net.kyori.adventure.text.minimessage.tag.resolver.TagResolver
    errorTagResolver()
     
    static MessageSender
    getPluginMessageSender(@NotNull Class<? extends org.bukkit.plugin.Plugin> plugin)
    Get the message sender created for this plugin.
    static MessageSender
    getPluginMessageSender(@NotNull org.bukkit.plugin.Plugin plugin)
    Get the message sender created for this plugin.
    abstract void
    hideBossBar(org.bukkit.entity.Player player, net.kyori.adventure.bossbar.BossBar bossBar)
     
    boolean
    isAnonymous()
     
    protected net.kyori.adventure.text.minimessage.tag.resolver.TagResolver
    messageTagResolver()
     
    net.kyori.adventure.text.minimessage.MiniMessage
    miniMessage()
     
    protected org.bukkit.plugin.Plugin
    plugin()
     
    net.kyori.adventure.text.Component
    prefix()
     
    static void
    register(MessageSender messageSender)
     
    abstract void
    sendActionBar(org.bukkit.entity.Player player, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
    Send a localized action bar to a player
    abstract net.kyori.adventure.bossbar.BossBar
    sendBossBar(org.bukkit.entity.Player player, String message, float progress, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay, Set<net.kyori.adventure.bossbar.BossBar.Flag> flags)
     
    abstract void
    sendBossBar(org.bukkit.entity.Player player, net.kyori.adventure.bossbar.BossBar bossBar)
     
    void
    sendError(org.bukkit.command.CommandSender sender, IMessageComposer composer)
    Sends an error to a sender
    void
    sendError(org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
    Sends an error to a sender
    abstract void
    sendErrorActionBar(org.bukkit.entity.Player player, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
    Send a localized action bar to a player
    void
    sendMessage(org.bukkit.command.CommandSender sender, IMessageComposer composer)
    Send a message to a sender
    void
    sendMessage(org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
    Send a message to a sender
    abstract void
    sendMessage(org.bukkit.command.CommandSender sender, net.kyori.adventure.text.Component component)
     
    void
    sendTitle(org.bukkit.entity.Player player, String title, String subtitle, net.kyori.adventure.title.Title.Times times, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
    Send a localized title to a player
    abstract void
    sendTitle(org.bukkit.entity.Player player, net.kyori.adventure.title.Title title)
    Send a title to a player
    protected net.kyori.adventure.text.Component
    serialize(org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver resolver, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
     
    net.kyori.adventure.text.Component
    serializeError(@Nullable org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
     
    net.kyori.adventure.text.Component
    serializeError(String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
     
    net.kyori.adventure.text.Component
    serializeMessage(@Nullable org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
     
    net.kyori.adventure.text.Component
    serializeMessage(String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
     
    String
    translatePlain(@Nullable org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... replacements)
     
    String
    translatePlain(String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... replacements)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MessageSender

      public MessageSender(org.bukkit.plugin.Plugin plugin, net.kyori.adventure.text.minimessage.MiniMessage miniMessage, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver messageTagResolver, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver errorTagResolver, net.kyori.adventure.text.Component prefix)

  • Method Details

    • register

      public static void register(MessageSender messageSender)

    • getPluginMessageSender

      public static MessageSender getPluginMessageSender(@NotNull @NotNull org.bukkit.plugin.Plugin plugin)
      Get the message sender created for this plugin.
      Parameters:
      plugin - plugin
      Returns:
      message sender of plugin or default sender if plugin is null

    • builder

      public static MessageSenderBuilder builder(org.bukkit.plugin.Plugin plugin)

    • getPluginMessageSender

      public static MessageSender getPluginMessageSender(@NotNull @NotNull Class<? extends org.bukkit.plugin.Plugin> plugin)
      Get the message sender created for this plugin.
      Parameters:
      plugin - plugin
      Returns:
      message sender of plugin or default sender if plugin is null

    • sendMessage

      public void sendMessage(org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
      Send a message to a sender

      The message will be localized if a localizer is available and a locale code is detected.

      The message can be a simple locale code in the format "code.code....".

      Parameters:
      sender - receiver of the message
      message - message with optional color codes

    • sendMessage

      public void sendMessage(org.bukkit.command.CommandSender sender, IMessageComposer composer)
      Send a message to a sender

      The message will be localized if a localizer is available and a locale code is detected.

      The message can be a simple locale code in the format "code.code....".

      Parameters:
      sender - receiver of the message
      composer - message composer

    • sendError

      public void sendError(org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
      Sends an error to a sender

      The message will be localized if a localizer is available and a locale code is detected.

      The message can be a simple locale code in the format "code.code....".

      Parameters:
      sender - receiver of the message
      message - message with optional color codes

    • sendError

      public void sendError(org.bukkit.command.CommandSender sender, IMessageComposer composer)
      Sends an error to a sender

      The message will be localized if a localizer is available and a locale code is detected.

      The message can be a simple locale code in the format "code.code....".

      Parameters:
      sender - receiver of the message
      composer - message composer

    • sendMessage

      public abstract void sendMessage(org.bukkit.command.CommandSender sender, net.kyori.adventure.text.Component component)

    • broadcast

      public abstract void broadcast(String message)

    • sendTitle

      public void sendTitle(org.bukkit.entity.Player player, String title, String subtitle, net.kyori.adventure.title.Title.Times times, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
      Send a localized title to a player
      Parameters:
      player - player to send
      title - title to send

    • sendTitle

      public abstract void sendTitle(org.bukkit.entity.Player player, net.kyori.adventure.title.Title title)
      Send a title to a player
      Parameters:
      player - player to send
      title - title to send

    • sendActionBar

      public abstract void sendActionBar(org.bukkit.entity.Player player, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
      Send a localized action bar to a player
      Parameters:
      player - player to send
      message - message to send

    • sendErrorActionBar

      public abstract void sendErrorActionBar(org.bukkit.entity.Player player, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)
      Send a localized action bar to a player
      Parameters:
      player - player to send
      message - message to send

    • sendBossBar

      public abstract void sendBossBar(org.bukkit.entity.Player player, net.kyori.adventure.bossbar.BossBar bossBar)

    • sendBossBar

      public abstract net.kyori.adventure.bossbar.BossBar sendBossBar(org.bukkit.entity.Player player, String message, float progress, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay, Set<net.kyori.adventure.bossbar.BossBar.Flag> flags)

    • hideBossBar

      public abstract void hideBossBar(org.bukkit.entity.Player player, net.kyori.adventure.bossbar.BossBar bossBar)

    • serialize

      protected net.kyori.adventure.text.Component serialize(org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver resolver, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)

    • prefix

      public net.kyori.adventure.text.Component prefix()

    • applyPrefix

      protected net.kyori.adventure.text.Component applyPrefix(net.kyori.adventure.text.Component component)

    • translatePlain

      public String translatePlain(String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... replacements)

    • translatePlain

      public String translatePlain(@Nullable @Nullable org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... replacements)

    • serializeMessage

      public net.kyori.adventure.text.Component serializeMessage(String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)

    • serializeMessage

      public net.kyori.adventure.text.Component serializeMessage(@Nullable @Nullable org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)

    • serializeError

      public net.kyori.adventure.text.Component serializeError(String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)

    • serializeError

      public net.kyori.adventure.text.Component serializeError(@Nullable @Nullable org.bukkit.command.CommandSender sender, String message, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... placeholder)

    • miniMessage

      public net.kyori.adventure.text.minimessage.MiniMessage miniMessage()

    • isAnonymous

      public boolean isAnonymous()

    • messageTagResolver

      protected net.kyori.adventure.text.minimessage.tag.resolver.TagResolver messageTagResolver()

    • errorTagResolver

      protected net.kyori.adventure.text.minimessage.tag.resolver.TagResolver errorTagResolver()

    • plugin

      protected org.bukkit.plugin.Plugin plugin()

    • asAudience

      public abstract net.kyori.adventure.audience.Audience asAudience(org.bukkit.entity.Player player)