Class PlayerCommandPreprocessEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
PlayerSignCommandPreprocessEvent
setMessage(String)
)
will be shown in the behavior.
Many plugins will have no use for this event, and you should attempt to avoid using it if it is not necessary.
Some examples of valid uses for this event are:
- Logging executed commands to a separate file
- Variable substitution. For example, replacing
${nearbyPlayer}
with the name of the nearest other player, or simulating the@a
and@p
decorators used by Command Blocks in plugins that do not handle it. - Conditionally blocking commands belonging to other plugins. For
example, blocking the use of the
/home
command in a combat arena. - Per-sender command aliases. For example, after a player runs the
command
/calias cr gamemode creative
, the next time they run/cr
, it gets replaced into/gamemode creative
. (Global command aliases should be done by registering the alias.)
Examples of incorrect uses are:
- Using this event to run command logic
If the event is cancelled, processing of the command will halt.
The state of whether or not there is a slash (/
) at the
beginning of the message should be preserved. If a slash is added or
removed, unexpected behavior may result.
-
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 TypeMethodDescriptionstatic @NotNull HandlerList
Gets the command that the player is attempting to send.Deprecated, for removal: This API element is subject to removal in a future version.This is simply the online players.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setMessage
(@NotNull String command) Sets the command that the player will send.void
Deprecated, for removal: This API element is subject to removal in a future version.Only works for sign commands; usePlayer.performCommand(String)
, including those casesMethods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerCommandPreprocessEvent
-
PlayerCommandPreprocessEvent
-
-
Method Details
-
isCancelled
public boolean isCancelled()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) 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
Gets the command that the player is attempting to send.All commands begin with a special character; implementations do not consider the first character when executing the content.
- Returns:
- Message the player is attempting to send
-
setMessage
Sets the command that the player will send.All commands begin with a special character; implementations do not consider the first character when executing the content.
- Parameters:
command
- New message that the player will send- Throws:
IllegalArgumentException
- if command is null or empty
-
setPlayer
@Deprecated(forRemoval=true) public void setPlayer(@NotNull @NotNull Player player) throws IllegalArgumentException Deprecated, for removal: This API element is subject to removal in a future version.Only works for sign commands; usePlayer.performCommand(String)
, including those casesSets the player that this command will be executed as.- Parameters:
player
- New player which this event will execute as- Throws:
IllegalArgumentException
- if the player provided is null
-
getRecipients
Deprecated, for removal: This API element is subject to removal in a future version.This is simply the online players. Modifications have no effectGets a set of recipients that this chat message will be displayed to.The set returned is not guaranteed to be mutable and may auto-populate on access. Any listener accessing the returned set should be aware that it may reduce performance for a lazy set implementation. Listeners should be aware that modifying the list may throw
UnsupportedOperationException
if the event caller provides an unmodifiable set.- Returns:
- All Players who will see this chat message
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-