Package io.papermc.paper.event.world.border

Class WorldBorderBoundsChangeEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.world.WorldEvent

io.papermc.paper.event.world.border.WorldBorderEvent

io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class WorldBorderBoundsChangeEvent
extends WorldBorderEvent
implements Cancellable

Called when a world border changes its bounds, either over time, or instantly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorldBorderBoundsChangeEvent.Type

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class io.papermc.paper.event.world.border.WorldBorderEvent

worldBorder

Fields inherited from class org.bukkit.event.world.WorldEvent

world

Constructor Summary

Constructors

Constructor	Description
WorldBorderBoundsChangeEvent(World world, WorldBorder worldBorder, WorldBorderBoundsChangeEvent.Type type, double oldSize, double newSize, long duration)

Method Summary

Modifier and Type	Method	Description
@org.checkerframework.checker.index.qual.NonNegative long	getDuration()	Deprecated, for removal: This API element is subject to removal in a future version. in favor of getDurationTicks()
@org.jetbrains.annotations.Range(from=0L, to=2147483647L) long	getDurationTicks()	Gets the time in ticks for the change.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
double	getNewSize()	Gets the new size of the world border.
double	getOldSize()	Gets the old size or the world border.
WorldBorderBoundsChangeEvent.Type	getType()	Gets if this change is an instant change or over-time change.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setDuration(@org.checkerframework.checker.index.qual.NonNegative long duration)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of setDurationTicks(long)
void	setDurationTicks(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) long duration)	Sets the time in ticks for the change.
void	setNewSize(double newSize)	Sets the new size of the world border.

Methods inherited from class io.papermc.paper.event.world.border.WorldBorderEvent

getWorldBorder

Methods inherited from class org.bukkit.event.world.WorldEvent

getWorld

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorldBorderBoundsChangeEvent

@Internal
public WorldBorderBoundsChangeEvent(World world,
 WorldBorder worldBorder,
 WorldBorderBoundsChangeEvent.Type type,
 double oldSize,
 double newSize,
 long duration)

Method Details

getType

public WorldBorderBoundsChangeEvent.Type getType()

Gets if this change is an instant change or over-time change.

Returns:

the change type

getOldSize

public double getOldSize()

Gets the old size or the world border.

Returns:

the old size

getNewSize

public double getNewSize()

Gets the new size of the world border.

Returns:

the new size

setNewSize

public void setNewSize(double newSize)

Sets the new size of the world border.

Parameters:

newSize - the new size

getDurationTicks

public @org.jetbrains.annotations.Range(from=0L, to=2147483647L) long getDurationTicks()

Gets the time in ticks for the change. Will be 0 if instant.

Returns:

the time in ticks for the change

setDurationTicks

public void setDurationTicks(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) long duration)

Sets the time in ticks for the change. Will change getType() to return WorldBorderBoundsChangeEvent.Type.STARTED_MOVE.

Parameters:

duration - the time in ticks for the change

getDuration

@Deprecated(forRemoval=true,
            since="1.21.11")
public @org.checkerframework.checker.index.qual.NonNegative long getDuration()

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of getDurationTicks()

Gets the time in milliseconds for the change. Will be 0 if instant.

Returns:

the time in milliseconds for the change

setDuration

@Deprecated(forRemoval=true,
            since="1.21.11")
public void setDuration(@org.checkerframework.checker.index.qual.NonNegative long duration)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of setDurationTicks(long)

Sets the time in milliseconds for the change. Will change getType() to return WorldBorderBoundsChangeEvent.Type.STARTED_MOVE.

Parameters:

duration - the time in milliseconds for the change

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 interface Cancellable

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 interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()