me.ryandw11.ultrachat.api.events

Class UltraChatEvent

java.lang.Object

org.bukkit.event.Event

me.ryandw11.ultrachat.api.events.UltraChatEvent

public class UltraChatEvent
extends org.bukkit.event.Event

The UltraChatEvent is used when a player chats. This event gives you more information than the normal AsyncChatEvent.

Note: Since API Version 2.5 this event is only needed when you want specific ultraChat information.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor and Description
UltraChatEvent(org.bukkit.entity.Player p, java.lang.String chat, java.util.Set<org.bukkit.entity.Player> recipients, ChatType ct, ChatProperties properties)

Method Summary

Modifier and Type	Method and Description
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
java.lang.String	getMessage()
org.bukkit.entity.Player	getPlayer()
ChatProperties	getProperties() Get the properties.
java.util.Set<org.bukkit.entity.Player>	getRecipients() Grab the recipients.
ChatType	getType() Get the type of the chat used.
boolean	isCancelled()
void	setCancelled(boolean cancel)
void	setMessage(java.lang.String message) Set the message
void	setRecipients(java.util.Set<org.bukkit.entity.Player> recipients) Set the recipients.

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Detail

UltraChatEvent

public UltraChatEvent(org.bukkit.entity.Player p,
                      java.lang.String chat,
                      java.util.Set<org.bukkit.entity.Player> recipients,
                      ChatType ct,
                      ChatProperties properties)

Method Detail

getRecipients

public java.util.Set<org.bukkit.entity.Player> getRecipients()

Grab the recipients.

Returns:

The recipients.

setRecipients

public void setRecipients(java.util.Set<org.bukkit.entity.Player> recipients)

Set the recipients.

Parameters:

recipients - The set of recipients.

getPlayer

public org.bukkit.entity.Player getPlayer()

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

Set the message

Parameters:

message - The message.

isCancelled

public boolean isCancelled()

setCancelled

public void setCancelled(boolean cancel)

getType

public ChatType getType()

Get the type of the chat used.

Returns:

The type of chat used.

getProperties

public ChatProperties getProperties()

Get the properties.

Returns:

Get the information for a certain chat event.

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()