io.github.portlek.bukkitlocation

Class Cuboid

java.lang.Object

io.github.portlek.bukkitlocation.Cuboid

public final class Cuboid
extends Object

Constructor Summary

Constructors

Constructor and Description
Cuboid(@NotNull org.bukkit.Location minimumLocation, @NotNull org.bukkit.Location maximumLocation) ctor.

Method Summary

Modifier and Type	Method and Description
@NotNull List<org.bukkit.block.Block>	blocks() obtains blocks inside the cuboid.
@NotNull org.bukkit.Location	center() obtains center of the cuboid.
@NotNull org.bukkit.Location	centerBottom() obtains center bottom of the cuboid.
@NotNull org.bukkit.Location	getMaximumLocation() obtains the maximum location of this.
@NotNull org.bukkit.Location	getMinimumLocation() obtains the minimum location of this.
boolean	isIn(@NotNull org.bukkit.Location location) checks if the given location is in the cuboid.
@NotNull List<org.bukkit.Location>	locations() obtains locations inside the cuboid.
@NotNull List<org.bukkit.block.Block>	randomBlocks(int limit, boolean duplicate) obtains a random block list from the given limit.
@NotNull List<org.bukkit.Location>	randomLocations(int limit, boolean duplicate) obtains a random location list from the given limit.
void	removeAll() removes all blocks where are in the cuboid.
void	set(@NotNull org.bukkit.Material material) sets all blocks inside the cuboid.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cuboid

public Cuboid(@NotNull
              @NotNull org.bukkit.Location minimumLocation,
              @NotNull
              @NotNull org.bukkit.Location maximumLocation)

ctor.

Parameters:

minimumLocation - the minimum location.

maximumLocation - the maximum location.

Method Detail

getMinimumLocation

@NotNull
public @NotNull org.bukkit.Location getMinimumLocation()

obtains the minimum location of this.

Returns:

the minimum location.

getMaximumLocation

@NotNull
public @NotNull org.bukkit.Location getMaximumLocation()

obtains the maximum location of this.

Returns:

the maximum location.

blocks

@NotNull
public @NotNull List<org.bukkit.block.Block> blocks()

obtains blocks inside the cuboid.

Returns:

the block list within the cuboid.

locations

@NotNull
public @NotNull List<org.bukkit.Location> locations()

obtains locations inside the cuboid.

Returns:

the location list within the cuboid.

set

public void set(@NotNull
                @NotNull org.bukkit.Material material)

sets all blocks inside the cuboid.

Parameters:

material - the material to set.

centerBottom

@NotNull
public @NotNull org.bukkit.Location centerBottom()

obtains center bottom of the cuboid.

Returns:

center bottom of the cuboid.

center

@NotNull
public @NotNull org.bukkit.Location center()

obtains center of the cuboid.

Returns:

center of the cuboid.

isIn

public boolean isIn(@NotNull
                    @NotNull org.bukkit.Location location)

checks if the given location is in the cuboid.

Parameters:

location - the location to check.

Returns:

true if the given location is in the cuboid.

removeAll

public void removeAll()

removes all blocks where are in the cuboid.

randomBlocks

@NotNull
public @NotNull List<org.bukkit.block.Block> randomBlocks(int limit,
                                                                   boolean duplicate)

obtains a random block list from the given limit.

Parameters:

limit - the limit to choose.

duplicate - the duplicate to check if the block is already in the result list.

Returns:

a random block list.

randomLocations

@NotNull
public @NotNull List<org.bukkit.Location> randomLocations(int limit,
                                                                   boolean duplicate)

obtains a random location list from the given limit.

Parameters:

limit - the limit to choose.

duplicate - the duplicate to check if the location is already in the result list.

Returns:

a random location list.