org.spongepowered.api.event.world

Interface ChangeWorldBorderEvent

All Superinterfaces:

Cancellable, Event

All Known Subinterfaces:

ChangeWorldBorderEvent.TargetPlayer, ChangeWorldBorderEvent.TargetWorld

public interface ChangeWorldBorderEvent
extends Event, Cancellable

Fired when the world border changes for a Player or a World.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ChangeWorldBorderEvent.TargetPlayer An event that is fired when a player's world border is changed.
static interface	ChangeWorldBorderEvent.TargetWorld An event that is fired when a world's border is changed.

Method Summary

Modifier and Type	Method and Description
Optional<WorldBorder>	getNewBorder() Gets the border that will be used as an Optional.
Optional<WorldBorder>	getPreviousBorder() Gets the border that was previously used as an Optional.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getPreviousBorder

Optional<WorldBorder> getPreviousBorder()

Gets the border that was previously used as an Optional. There may be no border set for the target (especially, if it is a player), in which case, an empty Optional is returned.

Returns:

The border that was previously in use, if there was one.

getNewBorder

Optional<WorldBorder> getNewBorder()

Gets the border that will be used as an Optional. For some targets, the border may be unset and therefore they may not always have a border. It is in these instances that an empty Optional is returned.

Returns:

The border that will be in use, if there is one.