Package org.bukkit.event.world
Class TimeSkipEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.world.WorldEvent
org.bukkit.event.world.TimeSkipEvent
- All Implemented Interfaces:
Cancellable
Called when the time skips in a world.
If the event is cancelled the time will not change.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
An enum specifying the reason the time skipped.Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Constructor Summary
ConstructorDescriptionTimeSkipEvent
(@NotNull World world, @NotNull TimeSkipEvent.SkipReason skipReason, long skipAmount) -
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull HandlerList
long
Gets the amount of time that was skipped.Gets the reason why the time has skipped.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setSkipAmount
(long skipAmount) Sets the amount of time to skip.Methods inherited from class org.bukkit.event.world.WorldEvent
getWorld
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
TimeSkipEvent
-
-
Method Details
-
getSkipReason
Gets the reason why the time has skipped.- Returns:
- a SkipReason value detailing why the time has skipped
-
getSkipAmount
public long getSkipAmount()Gets the amount of time that was skipped.- Returns:
- Amount of time skipped
-
setSkipAmount
public void setSkipAmount(long skipAmount) Sets the amount of time to skip.- Parameters:
skipAmount
- Amount of time to skip
-
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
-