Package io.github.alextmjugador.khron.gestorbarraaccion

Class Mensaje

  • All Implemented Interfaces:
    Comparable<Mensaje>
    final class Mensaje
extends Object
implements Comparable<Mensaje>
    Modela un mensaje a mostrar en la barra de acción de un jugador.
    Author:
    AlexTMjugador

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int duracion
      La duración de este mensaje en pantalla, en milisegundos.
      static int DURACION_PREDET
      La duración predeterminada del mensaje, si se omite, en milisegundos.
      private String mensaje
      El texto del mensaje.
      private org.bukkit.plugin.Plugin plugin
      El plugin al nombre del cual se ha creado este mensaje.
      private byte prioridad
      La prioridad de este mensaje.
      static byte PRIORIDAD_PREDET
      La prioridad predeterminada del mensaje, si se omite.

    • Constructor Summary

      Constructors 
      Constructor Description
      Mensaje​(String mensaje, int duracion, byte prioridad, org.bukkit.plugin.Plugin plugin)
      Crea un mensaje a mostrar en la barra de acciones.
      Mensaje​(String mensaje, int duracion, org.bukkit.plugin.Plugin plugin)
      Crea un mensaje a mostrar en la barra de acciones, con la prioridad predeterminada.
      Mensaje​(String mensaje, org.bukkit.plugin.Plugin plugin)
      Crea un mensaje a mostrar en la barra de acciones, con la duración y prioridad predeterminadas.

    • Field Detail

      • mensaje

        private final String mensaje
        El texto del mensaje. Puede contener caracteres de formato, como §.

      • duracion

        private final int duracion
        La duración de este mensaje en pantalla, en milisegundos.

      • prioridad

        private final byte prioridad
        La prioridad de este mensaje. Un valor numérico mayor significa más prioridad.

      • plugin

        private final org.bukkit.plugin.Plugin plugin
        El plugin al nombre del cual se ha creado este mensaje.

      • DURACION_PREDET

        public static final int DURACION_PREDET
        La duración predeterminada del mensaje, si se omite, en milisegundos.
        See Also:
        Constant Field Values

      • PRIORIDAD_PREDET

        public static final byte PRIORIDAD_PREDET
        La prioridad predeterminada del mensaje, si se omite.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Mensaje

        public Mensaje​(String mensaje,
               int duracion,
               byte prioridad,
               org.bukkit.plugin.Plugin plugin)
        throws IllegalArgumentException
        Crea un mensaje a mostrar en la barra de acciones.
        Parameters:
        mensaje - El mensaje a mostrar. Puede contener caracteres de formato, como §.
        duracion - La duración de ese mensaje, en milisegundos.
        prioridad - La prioridad de este mensaje. Un valor numérico mayor significa mayor prioridad. Se mostrarán primero los mensajes de mayor prioridad.
        plugin - El plugin responsable de la emisión de este mensaje.
        Throws:
        IllegalArgumentException - Si la duración es menor que 100, o el plugin es nulo o está detenido.

      • Mensaje

        public Mensaje​(String mensaje,
               int duracion,
               org.bukkit.plugin.Plugin plugin)
        throws IllegalArgumentException
        Crea un mensaje a mostrar en la barra de acciones, con la prioridad predeterminada.
        Parameters:
        mensaje - El mensaje a mostrar. Puede contener caracteres de formato, como §.
        duracion - La duración de ese mensaje, en milisegundos.
        plugin - El plugin responsable de la emisión de este mensaje.
        Throws:
        IllegalArgumentException - Si la duración es menor que 100, o el plugin es nulo o está detenido.

      • Mensaje

        public Mensaje​(String mensaje,
               org.bukkit.plugin.Plugin plugin)
        throws IllegalArgumentException
        Crea un mensaje a mostrar en la barra de acciones, con la duración y prioridad predeterminadas.
        Parameters:
        mensaje - El mensaje a mostrar. Puede contener caracteres de formato, como §.
        plugin - El plugin responsable de la emisión de este mensaje.
        Throws:
        IllegalArgumentException - Si el plugin es nulo o está detenido.

    • Method Detail

      • getMensaje

        public String getMensaje()
        Obtiene el texto del mensaje. Puede contener caracteres de formato, como §.
        Returns:
        El texto del mensaje.

      • getDuracion

        public int getDuracion()
        Obtiene la duración de este mensaje en pantalla, en milisegundos.
        Returns:
        La duración del mensaje en milisegundos.

      • getPrioridad

        public byte getPrioridad()
        Obtiene la prioridad de este mensaje. Un valor numérico mayor significa más prioridad.
        Returns:
        La prioridad de este mensaje.

      • getPlugin

        public org.bukkit.plugin.Plugin getPlugin()
        Obtiene el plugin al nombre del cual se ha creado este mensaje.
        Returns:
        El plugin al nombre del cual se ha creado este mensaje.

      • mostrar

        public void mostrar​(org.bukkit.entity.Player p)
             throws IllegalArgumentException
        Muestra este mensaje a un determinado jugador.
        Parameters:
        p - El mensaje a mostrar.
        Throws:
        IllegalArgumentException - Si el jugador es nulo o no está conectado.

      • compareTo

        public int compareTo​(Mensaje msg)
        Compara el mensaje actual con el especificado, en lo que a prioridades se refiere.
        Specified by:
        compareTo in interface Comparable<Mensaje>
        Parameters:
        msg - El mensaje a comparar con el actual.
        Returns:
        Un entero negativo, igual a cero o positivo si msg es menor, igual o mayor que el mensaje actual, respectivamente.