Package io.papermc.paper.event.world
Class WorldGameRuleChangeEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.world.WorldEvent
io.papermc.paper.event.world.WorldGameRuleChangeEvent
- All Implemented Interfaces:
Cancellable
Called when a world's gamerule is changed, either by command or by api.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Constructor Summary
ConstructorsConstructorDescriptionWorldGameRuleChangeEvent(@NotNull World world, @Nullable CommandSender commandSender, @NotNull GameRule<?> gameRule, @NotNull String value)
-
Method Summary
Modifier and TypeMethodDescriptionGets the command sender associated with this event.Gets the game rule associated with this event.static @NotNull HandlerList
getValue()
Gets the new value of the gamerule.boolean
Gets the cancellation state of this event.void
setCancelled(boolean cancel)
Sets the cancellation state of this event.void
Sets the new value of this gamerule.Methods inherited from class org.bukkit.event.world.WorldEvent
getWorld
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
WorldGameRuleChangeEvent
-
-
Method Details
-
getCommandSender
Gets the command sender associated with this event.- Returns:
null
if the gamerule was changed via api, otherwise theCommandSender
.
-
getGameRule
Gets the game rule associated with this event.- Returns:
- the gamerule being changed.
-
getValue
Gets the new value of the gamerule.- Returns:
- the new value of the gamerule.
-
setValue
Sets the new value of this gamerule.- Parameters:
value
- the new value of the gamerule.
-
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
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-