Package org.bukkit.event.player
Class PlayerChatEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerChatEvent
- All Implemented Interfaces:
Cancellable
Deprecated.
Holds information for player chat and commands
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Gets the format to use to display this chat messagestatic @NotNull HandlerList
Deprecated.Deprecated.Deprecated.Gets the message that the player is attempting to sendDeprecated.Gets a set of recipients that this chat message will be displayed toboolean
Deprecated.Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Deprecated.Sets the cancellation state of this event.void
Deprecated.Sets the format to use to display this chat messagevoid
setMessage
(@NotNull String message) Deprecated.Sets the message that the player will sendvoid
Deprecated.Sets the player that this message will display as, or command will be executed asMethods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
Method Details
-
isCancelled
public boolean isCancelled()Deprecated.Description copied from interface:Cancellable
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Deprecated.Description copied from interface:Cancellable
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getMessage
Deprecated.Gets the message that the player is attempting to send- Returns:
- Message the player is attempting to send
-
setMessage
Deprecated.Sets the message that the player will send- Parameters:
message
- New message that the player will send
-
setPlayer
Deprecated.Sets the player that this message will display as, or command will be executed as- Parameters:
player
- New player which this event will execute as
-
getFormat
Deprecated.Gets the format to use to display this chat message- Returns:
- String.Format compatible format string
-
setFormat
Deprecated.Sets the format to use to display this chat message- Parameters:
format
- String.Format compatible format string
-
getRecipients
Deprecated.Gets a set of recipients that this chat message will be displayed to- Returns:
- All Players who will see this chat message
-
getHandlers
Deprecated.- Specified by:
getHandlers
in classEvent
-
getHandlerList
Deprecated.
-
AsyncChatEvent
instead, wherever possible.