Package org.bukkit.event.player
Class PlayerGameModeChangeEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerGameModeChangeEvent
- All Implemented Interfaces:
Cancellable
Called when the GameMode of the player is changed.
NOTE: When getCause()
is PlayerGameModeChangeEvent.Cause.DEFAULT_GAMEMODE
,
the Player from PlayerEvent.getPlayer()
might not be fully online at
the time this event is fired. Plugins should use OfflinePlayer.isOnline()
to check before changing player state.
-
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
ConstructorDescriptionPlayerGameModeChangeEvent
(@NotNull Player player, @NotNull GameMode newGameMode) Deprecated.PlayerGameModeChangeEvent
(@NotNull Player player, @NotNull GameMode newGameMode, @NotNull PlayerGameModeChangeEvent.Cause cause, Component cancelMessage) -
Method Summary
Modifier and TypeMethodDescriptionOnly valid if the cause of the gamemode change was directly due to a command..void
cancelMessage
(Component message) Sets the message shown to the command user if the event was cancelled.getCause()
Gets the cause of this gamemode change.static @NotNull HandlerList
Gets the GameMode the player is switched to.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.Methods 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()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
-
getNewGameMode
Gets the GameMode the player is switched to.- Returns:
- player's new GameMode
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
getCause
Gets the cause of this gamemode change.- Returns:
- the cause
-
cancelMessage
Only valid if the cause of the gamemode change was directly due to a command.. Gets the message shown to the command user if the event is cancelled as a notification that a player's gamemode was not changed.This returns
null
if the gamemode change was due to a plugin, or a player joining the game with a gamemode not equal to the server default gamemode andforce-gamemode
is set to true.- Returns:
- the error message shown to the command user, null if not directly caused by a command
-
cancelMessage
Sets the message shown to the command user if the event was cancelled. The message is only shown to cancelled events that are directly called by a command not by a plugin or a player joining with the wrong gamemode.- Parameters:
message
- the error message shown to the command user, null to show no message.
-