net.risingworld.api.events.player

Class PlayerChatEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerChatEvent

All Implemented Interfaces:

Cancellable

public final class PlayerChatEvent
extends PlayerEvent
implements Cancellable

Called when a player sends a chat message.

See Also:

PlayerPrivateMessageEvent, PlayerCommandEvent

Example: Show chat messages only in player proximity

1	// our chat method in our event listener
2	@EventMethod
3	public void onChat(PlayerChatEvent event){
4	// cancel the event (so it will not be sent to other players)
5	event.setCancelled(true);
6
7	// now check all players and if they're close enough (15), send the chat message to them
8	for(Player player : getServer().getAllPlayers()){
9	if(player.getPosition().distance(event.getPlayer().getPosition()) < 15){
10	// we can get the chat message and chat name from the event
11	player.sendTextMessage(event.getPlayerChatName()+": "+event.getChatMessage());
12	}
13	}
14	}

Constructor Summary

Constructors

Constructor and Description
PlayerChatEvent(Player player, java.lang.String chatName, java.lang.String chatMessage)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChatMessage() Gets the chat message.
java.lang.String	getPlayerChatName() Gets the full player name (including all prefixes and color codes [if set]) in the chat.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setChatMessage(java.lang.String message) Sets the chat message.
void	setPlayerChatName(java.lang.String newName) Sets the player name in chat.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerChatEvent

public PlayerChatEvent(Player player,
                       java.lang.String chatName,
                       java.lang.String chatMessage)

Method Detail

setChatMessage

public void setChatMessage(java.lang.String message)

Sets the chat message.

Parameters:

message - the new message.

getChatMessage

public java.lang.String getChatMessage()

Gets the chat message.

Returns:

the chat message.

setPlayerChatName

public void setPlayerChatName(java.lang.String newName)

Sets the player name in chat. This only affects this chat message. To get the full player chat name (which includes all prefixes and color codes [if set]), see getPlayerChatName()

Parameters:

newName - the new player chat name (only relevant for this chat message / event)

getPlayerChatName

public java.lang.String getPlayerChatName()

Gets the full player name (including all prefixes and color codes [if set]) in the chat.

Returns:

the full player chat name. If no prefix is set or the colors have not been changed by permissions, this returns the regular player name.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.