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

Interface NucleusRTPService.RTPOptions

Enclosing interface:

NucleusRTPService

public static interface NucleusRTPService.RTPOptions

The RTP options to pass to the routines

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusRTPService.RTPOptions.Builder

Method Summary

Modifier and Type	Method and Description
int	maxHeight() The maximum height for the RTP.
int	maxRadius() The maximum radius for the RTP.
int	minHeight() The minimum height for the RTP.
int	minRadius() The minimum radius for the RTP.
java.util.Set<org.spongepowered.api.world.biome.BiomeType>	prohibitedBiomes() A set of biomes that RTP should not teleport a player into.

Method Detail

maxRadius

int maxRadius()

The maximum radius for the RTP.

Returns:

the max radius

minRadius

int minRadius()

The minimum radius for the RTP.

Returns:

the min radius

minHeight

int minHeight()

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

Returns:

The minimum height

maxHeight

int maxHeight()

The maximum height for the RTP. Must be greater than the min height.

Returns:

The maximum height.

prohibitedBiomes

java.util.Set<org.spongepowered.api.world.biome.BiomeType> prohibitedBiomes()

A set of biomes that RTP should not teleport a player into.

Returns:

The set of biomes