Package org.spongepowered.api.util

Class RespawnLocation.Builder

java.lang.Object

org.spongepowered.api.data.persistence.AbstractDataBuilder<RespawnLocation>

org.spongepowered.api.util.RespawnLocation.Builder

All Implemented Interfaces:

AbstractBuilder<RespawnLocation>, DataBuilder<RespawnLocation>, Builder<RespawnLocation,RespawnLocation.Builder>, CopyableBuilder<RespawnLocation,RespawnLocation.Builder>, ResettableBuilder<RespawnLocation,RespawnLocation.Builder>

Enclosing class:

RespawnLocation

public static final class RespawnLocation.Builder
extends AbstractDataBuilder<RespawnLocation>
implements Builder<RespawnLocation,RespawnLocation.Builder>, CopyableBuilder<RespawnLocation,RespawnLocation.Builder>

A helper class to build RespawnLocations.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a new RespawnLocation.Builder.

Method Summary

Modifier and Type	Method	Description
RespawnLocation	build()	Creates a new RespawnLocation from this builder.
protected Optional<RespawnLocation>	buildContent(DataView container)	Builds the currently AbstractDataBuilder.supportedVersion variant of the intended DataSerializable, such that all content upgrades have already been handled by AbstractDataBuilder.build(DataView).
RespawnLocation.Builder	forceSpawn(boolean isForced)	Sets whether the position to respawn at is forced or can be varied for safety.
RespawnLocation.Builder	from(RespawnLocation value)	Resets this builder to the values of the given built object.
RespawnLocation.Builder	location(ServerLocation location)	Sets the key of the location's provided world, and the position to respawn at.
RespawnLocation.Builder	position(Vector3d position)	Sets the Vector3d position of where to respawn at.
RespawnLocation.Builder	reset()	Resets this builder to a "default" state such that there is no remaining data to set.
RespawnLocation.Builder	world(ResourceKey key)	Sets the key tied to the desired ServerWorld.
RespawnLocation.Builder	world(ServerWorld world)	Sets the key of the provided ServerWorld onto this builder.

Methods inherited from class org.spongepowered.api.data.persistence.AbstractDataBuilder

build

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Creates a new RespawnLocation.Builder.

Method Details

world

public RespawnLocation.Builder world(ServerWorld world)

Sets the key of the provided ServerWorld onto this builder.

Parameters:

world - The world

Returns:

This builder, for chaining

world

public RespawnLocation.Builder world(ResourceKey key)

Sets the key tied to the desired ServerWorld.

Parameters:

key - The key

Returns:

This builder, for chaining

location

public RespawnLocation.Builder location(ServerLocation location)

Sets the key of the location's provided world, and the position to respawn at.

Parameters:

location - The location desired

Returns:

This builder, for chaining

position

public RespawnLocation.Builder position(Vector3d position)

Sets the Vector3d position of where to respawn at.

Parameters:

position - The position to respawn at

Returns:

This builder, for chaining

forceSpawn

public RespawnLocation.Builder forceSpawn(boolean isForced)

Sets whether the position to respawn at is forced or can be varied for safety.

Parameters:

isForced - If the respawn position is forced

Returns:

This builder, for chaining

buildContent

protected Optional<RespawnLocation> buildContent(DataView container)
                                          throws InvalidDataException

Description copied from class: AbstractDataBuilder

Builds the currently AbstractDataBuilder.supportedVersion variant of the intended DataSerializable, such that all content upgrades have already been handled by AbstractDataBuilder.build(DataView). This otherwise follows the same contract as DataBuilder.build(DataView).

Specified by:

buildContent in class AbstractDataBuilder<RespawnLocation>

Parameters:

container - The container with data to build from

Returns:

The deserialized data serializable, if possible

Throws:

InvalidDataException - If there's issues of invalid data formats or invalid data

reset

public RespawnLocation.Builder reset()

Description copied from interface: Builder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface Builder<RespawnLocation,RespawnLocation.Builder>

Specified by:

reset in interface ResettableBuilder<RespawnLocation,RespawnLocation.Builder>

Returns:

This builder, for chaining

from

public RespawnLocation.Builder from(RespawnLocation value)

Description copied from interface: CopyableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface CopyableBuilder<RespawnLocation,RespawnLocation.Builder>

Parameters:

value - The built object

Returns:

This builder, for chaining

build

public RespawnLocation build()

Creates a new RespawnLocation from this builder.

Specified by:

build in interface AbstractBuilder<RespawnLocation>

Returns:

The new respawn location