io.github.nucleuspowered.nucleus.api.module.rtp

Interface NucleusRTPService.RTPOptions.Builder

Enclosing interface:

NucleusRTPService.RTPOptions

public static interface NucleusRTPService.RTPOptions.Builder

Method Summary

Modifier and Type	Method and Description
NucleusRTPService.RTPOptions	build() Creates a NucleusRTPService.RTPOptions from the state of this builder.
NucleusRTPService.RTPOptions.Builder	from(NucleusRTPService.RTPOptions options) Sets this builder state from the specified NucleusRTPService.RTPOptions
NucleusRTPService.RTPOptions.Builder	prohibitedBiome(org.spongepowered.api.world.biome.BiomeType biomeType) Adds a BiomeType to the prohibited biomes set.
NucleusRTPService.RTPOptions.Builder	reset() Resets this builder to the default state.
NucleusRTPService.RTPOptions.Builder	setMaxHeight(int min) Sets the maximum height for the RTP.
NucleusRTPService.RTPOptions.Builder	setMaxRadius(int max) Sets the maximum radius for the RTP.
NucleusRTPService.RTPOptions.Builder	setMinHeight(int max) Sets the minimum height for the RTP.
NucleusRTPService.RTPOptions.Builder	setMinRadius(int min) Sets the minimum radius for the RTP.

Method Detail

setMaxRadius

NucleusRTPService.RTPOptions.Builder setMaxRadius(int max)

Sets the maximum radius for the RTP.

Parameters:

max - the max radius

Returns:

This builder, for chaining

setMinRadius

NucleusRTPService.RTPOptions.Builder setMinRadius(int min)

Sets the minimum radius for the RTP.

Parameters:

min - the min radius

Returns:

This builder, for chaining

setMinHeight

NucleusRTPService.RTPOptions.Builder setMinHeight(int max)
                                           throws java.lang.IllegalArgumentException

Sets the minimum height for the RTP. Must be greater than zero.

Parameters:

max - the minimum height

Returns:

This builder, for chaining

Throws:

java.lang.IllegalArgumentException - if the height is not acceptable

setMaxHeight

NucleusRTPService.RTPOptions.Builder setMaxHeight(int min)
                                           throws java.lang.IllegalArgumentException

Sets the maximum height for the RTP. Must be greater than zero.

Parameters:

min - the max height

Returns:

This builder, for chaining

Throws:

java.lang.IllegalArgumentException - if the height to too high

prohibitedBiome

NucleusRTPService.RTPOptions.Builder prohibitedBiome(org.spongepowered.api.world.biome.BiomeType biomeType)

Adds a BiomeType to the prohibited biomes set.

Parameters:

biomeType - The BiomeType to add.

Returns:

This builder, for chaining.

from

NucleusRTPService.RTPOptions.Builder from(NucleusRTPService.RTPOptions options)

Sets this builder state from the specified NucleusRTPService.RTPOptions

Parameters:

options - The optiosn

Returns:

This builder, for chaining

build

NucleusRTPService.RTPOptions build()
                            throws java.lang.IllegalStateException

Creates a NucleusRTPService.RTPOptions from the state of this builder.

Returns:

The NucleusRTPService.RTPOptions

Throws:

java.lang.IllegalStateException - if the builder is not in the correct state

reset

NucleusRTPService.RTPOptions.Builder reset()

Resets this builder to the default state.

Returns:

This builder, for chaining