Package io.github.alextmjugador.khron.gestorbarraaccion

Class PluginGestorBarraAccion

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

io.github.alextmjugador.khron.gestorbarraaccion.PluginGestorBarraAccion

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.event.Listener, org.bukkit.plugin.Plugin

public final class PluginGestorBarraAccion
extends org.bukkit.plugin.java.JavaPlugin
implements org.bukkit.event.Listener

Implementa un plugin que muestra mensajes en la barra de acción de manera no intrusiva con otros plugins, permitiéndoles abstraerse de lo que ellos realicen.

Author:

AlexTMjugador

Field Summary

Fields

Modifier and Type	Field	Description
private static PluginGestorBarraAccion	estePlugin	La instancia en ejecución del plugin.
private static Map<org.bukkit.entity.Player,PilaMensajes>	MENSAJES_PENDIENTES	El mapa de pilas de mensajes pendientes por jugadores.

Constructor Summary

Constructors

Constructor	Description
PluginGestorBarraAccion()

Method Summary

Modifier and Type	Method	Description
private void	borrarJugadorEvento(org.bukkit.event.player.PlayerEvent e)	Reacciona a un evento de expulsión o desconexión de un jugador, parando y borrando su pila de mensajes pendientes.
static boolean	borrarMensajes(org.bukkit.entity.Player p)	Borra todos los mensajes pendientes de mostrarle a un jugador en la barra de acciones.
static boolean	borrarMensajes(org.bukkit.plugin.Plugin plugin, org.bukkit.entity.Player p)	Borra los mensajes pendientes de mostrarle a un jugador en la barra de acciones creados por un determinado plugin.
private static boolean	mostrarArray(org.bukkit.entity.Player p, Mensaje[] arr)	Inserta los mensajes contenidos en el array en la pila de mensajes pendientes del jugador especificado.
static boolean	mostrarMensaje(org.bukkit.plugin.Plugin plugin, org.bukkit.entity.Player p, String... msg)	Muestra uno o varios mensajes en la barra de acciones de un jugador, con duración y prioridades predeterminadas.
static boolean	mostrarMensaje(org.bukkit.plugin.Plugin plugin, org.bukkit.entity.Player p, String msg, int duracion)	Muestra un mensaje en la barra de acciones de un jugador, con la prioridad predeterminada.
static boolean	mostrarMensaje(org.bukkit.plugin.Plugin plugin, org.bukkit.entity.Player p, String msg, int duracion, byte prioridad)	Muestra un mensaje en la barra de acciones de un jugador.
void	onEnable()	Inicializa el atributo estático estePlugin.
void	onPlayerKick(org.bukkit.event.player.PlayerKickEvent e)
void	onPlayerQuit(org.bukkit.event.player.PlayerQuitEvent e)

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onDisable, onLoad, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MENSAJES_PENDIENTES

private static final Map<org.bukkit.entity.Player,PilaMensajes> MENSAJES_PENDIENTES

El mapa de pilas de mensajes pendientes por jugadores. Es null hasta que el plugin se activa.

estePlugin

private static PluginGestorBarraAccion estePlugin

La instancia en ejecución del plugin.

Constructor Detail

PluginGestorBarraAccion

public PluginGestorBarraAccion()

Method Detail

onEnable

public void onEnable()

Inicializa el atributo estático estePlugin.

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

mostrarMensaje

public static boolean mostrarMensaje(org.bukkit.plugin.Plugin plugin,
                                     org.bukkit.entity.Player p,
                                     String msg,
                                     int duracion,
                                     byte prioridad)

Muestra un mensaje en la barra de acciones de un jugador.

Parameters:

plugin - El plugin al nombre del cual se creará el mensaje.

p - El jugador al que mostrarle el mensaje.

msg - El mensaje a mostrar.

duracion - La duración del mensaje, en milisegundos.

prioridad - La prioridad del mensaje. Ver implementación de Mensaje para más información sobre su significado numérico.

Returns:

Verdadero si el mensaje se ha podido mostrar, falso en caso contrario.

mostrarMensaje

public static boolean mostrarMensaje(org.bukkit.plugin.Plugin plugin,
                                     org.bukkit.entity.Player p,
                                     String msg,
                                     int duracion)

Muestra un mensaje en la barra de acciones de un jugador, con la prioridad predeterminada.

Parameters:

plugin - El plugin al nombre del cual se creará el mensaje.

p - El jugador al que mostrarle el mensaje.

msg - El mensaje a mostrar.

duracion - La duración del mensaje, en milisegundos.

Returns:

Verdadero si el mensaje se ha podido mostrar, falso en caso contrario.

mostrarMensaje

public static boolean mostrarMensaje(org.bukkit.plugin.Plugin plugin,
                                     org.bukkit.entity.Player p,
                                     String... msg)

Muestra uno o varios mensajes en la barra de acciones de un jugador, con duración y prioridades predeterminadas.

Parameters:

plugin - El plugin al nombre del cual se creará el mensaje.

p - El jugador al que mostrarle el/los mensaje/s.

msg - Los mensajes a mostrar.

Returns:

Verdadero si el/los mensaje/s se ha/n podido mostrar, falso en caso contrario.

borrarMensajes

public static boolean borrarMensajes(org.bukkit.entity.Player p)

Borra todos los mensajes pendientes de mostrarle a un jugador en la barra de acciones. El jugador seguirá viendo el mensaje actual hasta que su duración expire. Para forzar una limpieza de la barra de acciones, llamar a este método y enviar un mensaje en blanco, o bien enviar un mensaje en blanco con máxima prioridad (asumiendo que no hay otros de igual prioridad en la pila).

Parameters:

p - El jugador al que borrarle los mensajes pendientes.

Returns:

Verdadero si se han borrado mensajes pendientes del jugador, falso en caso contrario.

borrarMensajes

public static boolean borrarMensajes(org.bukkit.plugin.Plugin plugin,
                                     org.bukkit.entity.Player p)

Borra los mensajes pendientes de mostrarle a un jugador en la barra de acciones creados por un determinado plugin. El jugador seguirá viendo el mensaje actual hasta que su duración expire. Para forzar una limpieza de la barra de acciones, llamar a este método y enviar un mensaje en blanco, o bien enviar un mensaje en blanco con máxima prioridad (asumiendo que no hay otros de igual prioridad en la pila).

Parameters:

plugin - El plugin al nombre del cual se han creado los mensajes.

p - El jugador al que borrarle los mensajes pendientes.

Returns:

Verdadero si se han borrado mensajes pendientes del jugador, falso en caso contrario.

mostrarArray

private static boolean mostrarArray(org.bukkit.entity.Player p,
                                    Mensaje[] arr)

Inserta los mensajes contenidos en el array en la pila de mensajes pendientes del jugador especificado.

Parameters:

p - El jugador al que insertarle los mensajes en la pila.

arr - El array de mensajes a insertar.

Returns:

Verdadero si se han insertado y podido mostrar los mensajes de la pila, falso en caso contrario.

onPlayerQuit

public void onPlayerQuit(org.bukkit.event.player.PlayerQuitEvent e)

onPlayerKick

public void onPlayerKick(org.bukkit.event.player.PlayerKickEvent e)

borrarJugadorEvento

private void borrarJugadorEvento(org.bukkit.event.player.PlayerEvent e)

Reacciona a un evento de expulsión o desconexión de un jugador, parando y borrando su pila de mensajes pendientes.

Parameters:

e - El evento del jugador en cuestión.