com.comphenix.xp.messages

Class MessagePlayerQueue

java.lang.Object

com.comphenix.xp.messages.MessagePlayerQueue

All Implemented Interfaces:

PlayerCleanupListener

public class MessagePlayerQueue
extends java.lang.Object
implements PlayerCleanupListener

Constructor Summary

Constructors

Constructor and Description
MessagePlayerQueue(long messageDelay, ChannelProvider channelProvider, Debugger debugger)

Method Summary

Methods

Modifier and Type	Method and Description
MessagePlayerQueue	createView() Creates a shallow copy of this queue.
void	enqueue(org.bukkit.entity.Player player, Action action, MessageFormatter formatter) Enqueues a message transmitted by a player (or environment, in which case player should be NULL), ensuring that there aren't too many messages sent at once.
ChannelProvider	getChannelProvider()
Debugger	getDebugger()
long	getMessageDelay() Gets the current message delay in milliseconds.
void	onTick()
void	removePlayerCache(org.bukkit.entity.Player player) Removes a given player from being referenced by any preset node.
void	setChannelProvider(ChannelProvider channelProvider)
void	setMessageDelay(long messageDelay) Sets the message delay in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagePlayerQueue

public MessagePlayerQueue(long messageDelay,
                  ChannelProvider channelProvider,
                  Debugger debugger)

Method Detail

getDebugger

public Debugger getDebugger()

getChannelProvider

public ChannelProvider getChannelProvider()

setChannelProvider

public void setChannelProvider(ChannelProvider channelProvider)

enqueue

public void enqueue(org.bukkit.entity.Player player,
           Action action,
           MessageFormatter formatter)

Enqueues a message transmitted by a player (or environment, in which case player should be NULL), ensuring that there aren't too many messages sent at once.

Parameters:

player - - a player (or NULL) that sent this message.

action - - the action that contains the sent message.

formatter - - a message formatter that contains all the parameters.

getMessageDelay

public long getMessageDelay()

Gets the current message delay in milliseconds.

Returns:

Message delay in milliseconds.

setMessageDelay

public void setMessageDelay(long messageDelay)

Sets the message delay in milliseconds.

Parameters:

messageDelay - The new message delay in milliseconds.

createView

public MessagePlayerQueue createView()

Creates a shallow copy of this queue. Enqueued messages are not copied.

Returns:

A copy of the current queue.

onTick

public void onTick()

removePlayerCache

public void removePlayerCache(org.bukkit.entity.Player player)

Description copied from interface: PlayerCleanupListener

Removes a given player from being referenced by any preset node. Must be called when a player logs out.

Specified by:

removePlayerCache in interface PlayerCleanupListener

Parameters:

player - - player to remove.