Package com.marcusslover.plus.lib.region

Enum Class IRegion.DefaultVectorStrategy

java.lang.Object

java.lang.Enum<IRegion.DefaultVectorStrategy>

com.marcusslover.plus.lib.region.IRegion.DefaultVectorStrategy

All Implemented Interfaces:

IRegion.IVectorStrategy, Serializable, Comparable<IRegion.DefaultVectorStrategy>, Constable

Enclosing interface:

IRegion

public static enum IRegion.DefaultVectorStrategy
extends Enum<IRegion.DefaultVectorStrategy>
implements IRegion.IVectorStrategy

All default strategies for the vector check.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE_X	Checking if the y and z-axis are within the region.
EXCLUDE_Y	Checking if the x and z-axis are within the region.
EXCLUDE_Z	Checking if the x and y-axis are within the region.
FULL	Checking if all the axis is within the region.
ONLY_X	Checking if only the x-axis is within the region.
ONLY_Y	Checking if only the y-axis is within the region.
ONLY_Z	Checking if only the z-axis is within the region.

Method Summary

Modifier and Type	Method	Description
static IRegion.DefaultVectorStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IRegion.DefaultVectorStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
boolean	within(org.bukkit.util.Vector vector, org.bukkit.util.Vector min, org.bukkit.util.Vector max)	Check if the given vector is within the region.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FULL

public static final IRegion.DefaultVectorStrategy FULL

Checking if all the axis is within the region.

EXCLUDE_Y

public static final IRegion.DefaultVectorStrategy EXCLUDE_Y

Checking if the x and z-axis are within the region.

EXCLUDE_Z

public static final IRegion.DefaultVectorStrategy EXCLUDE_Z

Checking if the x and y-axis are within the region.

EXCLUDE_X

public static final IRegion.DefaultVectorStrategy EXCLUDE_X

Checking if the y and z-axis are within the region.

ONLY_X

public static final IRegion.DefaultVectorStrategy ONLY_X

Checking if only the x-axis is within the region.

ONLY_Y

public static final IRegion.DefaultVectorStrategy ONLY_Y

Checking if only the y-axis is within the region.

ONLY_Z

public static final IRegion.DefaultVectorStrategy ONLY_Z

Checking if only the z-axis is within the region.

Method Details

values

public static IRegion.DefaultVectorStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static IRegion.DefaultVectorStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

within

public boolean within(org.bukkit.util.Vector vector,
 org.bukkit.util.Vector min,
 org.bukkit.util.Vector max)

Description copied from interface: IRegion.IVectorStrategy

Check if the given vector is within the region.

Specified by:

within in interface IRegion.IVectorStrategy

Parameters:

vector - The vector to check.

min - The minimum vector.

max - The maximum vector.

Returns:

True if the vector is within the region.