WorldBorder (SpongeAPI 7.3.0 API)

```
public interface WorldBorder
```
A world border is a square boundary, extending through the entire y-axis.
It can gradually grow or shrink to a radius over a period of time. A warning is displayed when a contracting world border will reach the player in a certain amount of time, or when the player is a certain number of blocks away.

In Minecraft, a warning is displayed in the form of a reddish tint.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface WorldBorder.Builder

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`WorldBorder.Builder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static WorldBorder.Builder`	`builder()` Creates a new `WorldBorder.Builder` instance for making `WorldBorder`s.
`default void`	`copyPropertiesFrom(WorldBorder border)` Copies the properties of the passed border onto this border.
`com.flowpowered.math.vector.Vector3d`	`getCenter()` Gets the center of the world border.
`double`	`getDamageAmount()` Gets the damage done to a player per block per tick when outside the buffer.
`double`	`getDamageThreshold()` Gets the distance a player may be outside the world border before taking damage.
`double`	`getDiameter()` Gets the diameter of the world border.
`double`	`getNewDiameter()` Gets the diameter the world border is expanding or contracting to.
`long`	`getTimeRemaining()` Gets the time remaining until the world border stops expanding or contracting.
`int`	`getWarningDistance()` Gets the distance when a contracting world border will warn a player for whom the world border is `distance` blocks away.
`int`	`getWarningTime()` Gets the time when a contracting world border will warn a player for whom the world border will reach in `time` seconds.
`ChunkPreGenerate.Builder`	`newChunkPreGenerate(World world)` Returns a new builder for creating a task to pre-generate the chunks inside the border.
`void`	`setCenter(double x, double z)` Sets the center of the world border.
`void`	`setDamageAmount(double damage)` Sets the damage done to a player per block per tick when outside the buffer.
`void`	`setDamageThreshold(double distance)` Sets the distance a player may be be outside the world border before taking damage.
`void`	`setDiameter(double diameter)` Sets the diameter of the world border.
`void`	`setDiameter(double startDiameter, double endDiameter, long time)` Sets the starting diameter and the ending diameter of the world border, over the given period of time.
`void`	`setDiameter(double diameter, long time)` Sets the diameter of the world border, over the given period of time.
`void`	`setWarningDistance(int distance)` Sets the distance when a contracting world border will warn a player for whom the world border is `distance` blocks away.
`void`	`setWarningTime(int time)` Sets the time when a contracting world border will warn a player for whom the world border will reach in `time` seconds.

- Method Detail
  - builder
```
static WorldBorder.Builder builder()
```
    Creates a new WorldBorder.Builder instance for making WorldBorders.
    
    Returns:
    
    The builder
  - getNewDiameter
```
double getNewDiameter()
```
    Gets the diameter the world border is expanding or contracting to.
    This will return the same value as getDiameter() unless getTimeRemaining() is greater than 0.
    
    Returns:
    
    The diameter being changed to
  - getDiameter
```
double getDiameter()
```
    Gets the diameter of the world border.
    The returned diameter applies to the x and z axis. The world border extends over the entire y-axis.
    
    Returns:
    
    The diameter
  - setDiameter
```
void setDiameter(double diameter)
```
    Sets the diameter of the world border.
    The specified diameter applies to the x and z axis. The world border extends over the entire y-axis.
    
    Parameters:
    
    diameter - The diameter
  - setDiameter
```
void setDiameter(double diameter,
                 long time)
```
    Sets the diameter of the world border, over the given period of time.
    The world border diameter increases/decrease linearly over the specified time. The specified diameter applies to the x and z axis. The world border extends over the entire y-axis.
    
    Parameters:
    
    diameter - The diameter where the border will expand/contract to
    
    time - The time over which to change, in milliseconds
  - setDiameter
```
void setDiameter(double startDiameter,
                 double endDiameter,
                 long time)
```
    Sets the starting diameter and the ending diameter of the world border, over the given period of time.
    The world border diameter increases/diameter linearly over the specified time. The specified diameter applies to the x and z axis. The world border extends over the entire y-axis.
    
    Parameters:
    
    startDiameter - The diameter where the border will start
    
    endDiameter - The diameter where the border will end
    
    time - The time over which to change, in milliseconds
  - getTimeRemaining
```
long getTimeRemaining()
```
    Gets the time remaining until the world border stops expanding or contracting.
    
    Returns:
    
    The time remaining, in milliseconds
  - setCenter
```
void setCenter(double x,
               double z)
```
    Sets the center of the world border.
    
    Parameters:
    
    x - The x-axis center of the world border
    
    z - The z-axis center of the world border
  - getCenter
```
com.flowpowered.math.vector.Vector3d getCenter()
```
    Gets the center of the world border.
    The returned position is three-dimensional. As the world border extends over the entire y-axis, the returned position will always have a y set to 0.
    
    Returns:
    
    The center
  - getWarningTime
```
int getWarningTime()
```
    Gets the time when a contracting world border will warn a player for whom the world border will reach in time seconds.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Returns:
    
    The time, in seconds
  - setWarningTime
```
void setWarningTime(int time)
```
    Sets the time when a contracting world border will warn a player for whom the world border will reach in time seconds.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Parameters:
    
    time - The time, in seconds
  - getWarningDistance
```
int getWarningDistance()
```
    Gets the distance when a contracting world border will warn a player for whom the world border is distance blocks away.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Returns:
    
    The distance, in blocks
  - setWarningDistance
```
void setWarningDistance(int distance)
```
    Sets the distance when a contracting world border will warn a player for whom the world border is distance blocks away.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Parameters:
    
    distance - The distance, in blocks
  - getDamageThreshold
```
double getDamageThreshold()
```
    Gets the distance a player may be outside the world border before taking damage.
    
    Returns:
    
    The distance
  - setDamageThreshold
```
void setDamageThreshold(double distance)
```
    Sets the distance a player may be be outside the world border before taking damage.
    
    Parameters:
    
    distance - The distance
  - getDamageAmount
```
double getDamageAmount()
```
    Gets the damage done to a player per block per tick when outside the buffer.
    
    Returns:
    
    The damage amount
  - setDamageAmount
```
void setDamageAmount(double damage)
```
    Sets the damage done to a player per block per tick when outside the buffer.
    
    Parameters:
    
    damage - The damage amount
  - newChunkPreGenerate
```
ChunkPreGenerate.Builder newChunkPreGenerate(World world)
```
    Returns a new builder for creating a task to pre-generate the chunks inside the border. The current state of the border is "snapshotted" for the builder. It is not backed by this instance. If the border size is changing then the target size is used.
    
    Parameters:
    
    world - The target world
    
    Returns:
    
    The builder for the chunk pre-generate task
    
    See Also:
    
    ChunkPreGenerate
  - copyPropertiesFrom
```
default void copyPropertiesFrom(WorldBorder border)
```
    Copies the properties of the passed border onto this border.
    
    Parameters:
    
    border - The border whose properties are to be copied

Interface WorldBorder

Nested Class Summary

Method Summary

Method Detail

builder

getNewDiameter

getDiameter

setDiameter

setDiameter

setDiameter

getTimeRemaining

setCenter

getCenter

getWarningTime

setWarningTime

getWarningDistance

setWarningDistance

getDamageThreshold

setDamageThreshold

getDamageAmount

setDamageAmount

newChunkPreGenerate

copyPropertiesFrom