org.spongepowered.api.world

Interface WorldBorder.Builder

All Superinterfaces:

ResettableBuilder<WorldBorder,WorldBorder.Builder>

Enclosing interface:

WorldBorder

public static interface WorldBorder.Builder
extends ResettableBuilder<WorldBorder,WorldBorder.Builder>

Method Summary

Modifier and Type	Method and Description
WorldBorder	build() Builds the world border from the information given.
WorldBorder.Builder	center(double x, double z) Sets the centre of this world border.
WorldBorder.Builder	damageAmount(double damage) Sets the damage amount of this world border.
WorldBorder.Builder	damageThreshold(double distance) Sets the damage threshold of this world border.
WorldBorder.Builder	diameter(double diameter) Sets the diameter of this world border.
WorldBorder.Builder	from(WorldBorder border) Copies the required data from the passed WorldBorder.
WorldBorder.Builder	warningDistance(int distance) Sets the warning distance of this world border.
WorldBorder.Builder	warningTime(int time) Sets the warning time of this world border.

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

reset

Method Detail

from

WorldBorder.Builder from(WorldBorder border)

Copies the required data from the passed WorldBorder.

Specified by:

from in interface ResettableBuilder<WorldBorder,WorldBorder.Builder>

Parameters:

border - The world border whose data is to be copied

Returns:

The builder, for chaining

diameter

WorldBorder.Builder diameter(double diameter)

Sets the diameter of this world border.

Parameters:

diameter - The diameter that this border will have.

Returns:

The builder, for chaining.

See Also:

WorldBorder.setDiameter(double)

center

WorldBorder.Builder center(double x,
                           double z)

Sets the centre of this world border.

Parameters:

x - The x-coordinate of the new centre

z - The z-coordinate of the new centre

Returns:

The builder, for chaining

See Also:

WorldBorder.setCenter(double, double)

warningTime

WorldBorder.Builder warningTime(int time)

Sets the warning time of this world border.

Parameters:

time - Warning time in seconds

Returns:

The builder, for chaining

See Also:

WorldBorder.setWarningTime(int)

warningDistance

WorldBorder.Builder warningDistance(int distance)

Sets the warning distance of this world border.

Parameters:

distance - The warning distance in blocks

Returns:

The builder, for chaining

See Also:

WorldBorder.setWarningDistance(int)

damageThreshold

WorldBorder.Builder damageThreshold(double distance)

Sets the damage threshold of this world border.

Parameters:

distance - The damage threshold in blocks

Returns:

The builder, for chaining

See Also:

WorldBorder.setDamageThreshold(double)

damageAmount

WorldBorder.Builder damageAmount(double damage)

Sets the damage amount of this world border.

Parameters:

damage - The damage amount

Returns:

The builder, for chaining

See Also:

WorldBorder.setDamageAmount(double)

build

WorldBorder build()

Builds the world border from the information given. If no information is given, a WorldBorder with default properties is built.

Returns:

The built world border