com.bgsoftware.superiorskyblock.api.events

Class SendMessageEvent

java.lang.Object

org.bukkit.event.Event

com.bgsoftware.superiorskyblock.api.events.SendMessageEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

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

SendMessageEvent is called when a message is sent to CommandSender

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor and Description
SendMessageEvent(org.bukkit.command.CommandSender receiver, java.lang.String messageType, IMessageComponent messageComponent, java.lang.Object[] args) The constructor for the event.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getArgument(int index) Get an argument of the message.
int	getArgumentsLength() Get the length of the arguments array.
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
IMessageComponent	getMessageComponent() Get the message component that is sent.
java.lang.String	getMessageType() Get the name of the message, similar to the one from lang file.
org.bukkit.command.CommandSender	getReceiver() Get the receiver of the message.
boolean	isCancelled()
void	setArgument(int index, java.lang.Object value) Set an argument for the message.
void	setCancelled(boolean cancelled)
void	setMessageComponent(IMessageComponent messageComponent) Set the message component to be sent.

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 Detail

SendMessageEvent

public SendMessageEvent(org.bukkit.command.CommandSender receiver,
                        java.lang.String messageType,
                        IMessageComponent messageComponent,
                        java.lang.Object[] args)

The constructor for the event.

Parameters:

receiver - The receiver of the message.

messageType - The name of the message, similar to the one from lang file.

messageComponent - The message component that is being sent.

Method Detail

getReceiver

public org.bukkit.command.CommandSender getReceiver()

Get the receiver of the message.

getMessageType

public java.lang.String getMessageType()

Get the name of the message, similar to the one from lang file.

getArgument

public java.lang.Object getArgument(int index)

Get an argument of the message.

Parameters:

index - The index of the argument.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If is out of bounds.

setArgument

public void setArgument(int index,
                        java.lang.Object value)

Set an argument for the message.

Parameters:

index - The index of the argument.

value - The value to be set.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If is out of bounds.

getArgumentsLength

public int getArgumentsLength()

Get the length of the arguments array.

getMessageComponent

public IMessageComponent getMessageComponent()

Get the message component that is sent.

setMessageComponent

public void setMessageComponent(IMessageComponent messageComponent)

Set the message component to be sent.

Parameters:

messageComponent - The new component to be sent.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

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