Package net.sacredlabyrinth.phaed.simpleclans.events

Class ChatEvent

java.lang.Object

org.bukkit.event.Event

net.sacredlabyrinth.phaed.simpleclans.events.ChatEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class ChatEvent
extends org.bukkit.event.Event
implements org.bukkit.event.Cancellable

Author:

RoinujNosde

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChatEvent.Type

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
ChatEvent(String message, ClanPlayer sender, List<ClanPlayer> receivers, ChatEvent.Type type)

Method Summary

Modifier and Type	Method	Description
void	addPlaceholder(String placeholderName, String value)	Adds a placeholder and its value to the chat message
static org.bukkit.event.HandlerList	getHandlerList()
@NotNull org.bukkit.event.HandlerList	getHandlers()
String	getMessage()	Gets the message to be sent
Map<String,String>	getPlaceholders()	Gets the placeholders
List<ClanPlayer>	getReceivers()	Gets the message receivers
ClanPlayer	getSender()	Gets the message sender
ChatEvent.Type	getType()	Gets the chat type
boolean	isCancelled()
void	removePlaceholder(String placeholderName)	Removes a placeholder from the chat message
void	setCancelled(boolean cancel)
void	setMessage(String message)	Changes the chat message

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

ChatEvent

public ChatEvent(String message,
 ClanPlayer sender,
 List<ClanPlayer> receivers,
 ChatEvent.Type type)

Method Details

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

getType

public ChatEvent.Type getType()

Gets the chat type

Returns:

the chat type

getPlaceholders

public Map<String,String> getPlaceholders()

Gets the placeholders

Returns:

an unmodifiable map of the placeholders

addPlaceholder

public void addPlaceholder(String placeholderName,
 String value)

Adds a placeholder and its value to the chat message

Parameters:

placeholderName - the placeholder name

value - the String to be replaced

Throws:

IllegalArgumentException - if one of the args are null; if one of the args are empty; if the placeholder name equals "clan", "nick-color", "player", "rank" or "message"

removePlaceholder

public void removePlaceholder(String placeholderName)

Removes a placeholder from the chat message

Parameters:

placeholderName - the placeholder name

getReceivers

public List<ClanPlayer> getReceivers()

Gets the message receivers

Returns:

the receivers

setMessage

public void setMessage(String message)

Changes the chat message

Parameters:

message - the new message

getMessage

public String getMessage()

Gets the message to be sent

Returns:

the message

getSender

public ClanPlayer getSender()

Gets the message sender

Returns:

the sender

getHandlers

@NotNull
public @NotNull org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

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