Package com.ninjaguild.dragoneggdrop.api

Enum PortalCrystal

java.lang.Object

java.lang.Enum<PortalCrystal>

com.ninjaguild.dragoneggdrop.api.PortalCrystal

All Implemented Interfaces:

Serializable, Comparable<PortalCrystal>

public enum PortalCrystal
extends Enum<PortalCrystal>

Represents all possible locations in which an end crystal may be spawned in regards to the End Portal found in The End.

Author:

Parker Hawke - 2008Choco

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST_CRYSTAL	The End Crystal located on the east side of the portal (positive X axis).
NORTH_CRYSTAL	The End Crystal located on the north side of the portal (negative Z axis).
SOUTH_CRYSTAL	The End Crystal located on the south side of the portal (positive Z axis).
WEST_CRYSTAL	The End Crystal located on the west side of the portal (negative X axis).

Method Summary

Modifier and Type	Method	Description
org.bukkit.entity.EnderCrystal	get(org.bukkit.World world)	Get the current crystal relative to the world's portal location.
static Set<org.bukkit.entity.EnderCrystal>	getAllSpawnedCrystals(org.bukkit.World world)	Get all crystals that have been spawned on the portal in the given world.
org.bukkit.Location	getRelativeTo(org.bukkit.Location location)	Get a Location representing the crystal's expected location relative to a given location.
org.bukkit.Location	getRelativeToPortal(org.bukkit.World world)	Get a Location representing the crystal's expected location relative to the provided world's portal.
int	getXOffset()	Get the offset on the x axis to be applied for this crystal
int	getZOffset()	Get the offset on the z axis to be applied for this crystal
boolean	isPresent(org.bukkit.World world)	Check whether this crystal is spawned on the portal or not.
org.bukkit.entity.EnderCrystal	spawn(org.bukkit.World world)	Spawn a crystal on the portal in the given world and set it as invulnerable.
org.bukkit.entity.EnderCrystal	spawn(org.bukkit.World world, boolean invulnerable)	Spawn a crystal on the portal in the given world and optionally set its invulnerability state.
static PortalCrystal	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PortalCrystal[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH_CRYSTAL

public static final PortalCrystal NORTH_CRYSTAL

The End Crystal located on the north side of the portal (negative Z axis).

EAST_CRYSTAL

public static final PortalCrystal EAST_CRYSTAL

The End Crystal located on the east side of the portal (positive X axis).

SOUTH_CRYSTAL

public static final PortalCrystal SOUTH_CRYSTAL

The End Crystal located on the south side of the portal (positive Z axis).

WEST_CRYSTAL

public static final PortalCrystal WEST_CRYSTAL

The End Crystal located on the west side of the portal (negative X axis).

Method Detail

values

public static PortalCrystal[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PortalCrystal c : PortalCrystal.values())
    System.out.println(c);

Returns:

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

valueOf

public static PortalCrystal valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getXOffset

public int getXOffset()

Get the offset on the x axis to be applied for this crystal

Returns:

the x offset

getZOffset

public int getZOffset()

Get the offset on the z axis to be applied for this crystal

Returns:

the z offset

getRelativeTo

public org.bukkit.Location getRelativeTo(org.bukkit.Location location)

Get a Location representing the crystal's expected location relative to a given location. The passed location assumes the top of the portal (3 blocks above the base of the portal). See DragonBattle.getEndPortalLocation().

Parameters:

location - the location starting point

Returns:

the relative crystal location

getRelativeToPortal

public org.bukkit.Location getRelativeToPortal(org.bukkit.World world)

Get a Location representing the crystal's expected location relative to the provided world's portal.

Parameters:

world - the world containing the portal

Returns:

the relative crystal location. null if world is not (@link Environment#THE_END)

spawn

public org.bukkit.entity.EnderCrystal spawn(org.bukkit.World world,
                                            boolean invulnerable)

Spawn a crystal on the portal in the given world and optionally set its invulnerability state.

Parameters:

world - the world to spawn the crystal in

invulnerable - the crystal's invulnerable state

Returns:

the spawned crystal. null if unsuccessfully spawned

spawn

public org.bukkit.entity.EnderCrystal spawn(org.bukkit.World world)

Spawn a crystal on the portal in the given world and set it as invulnerable.

Parameters:

world - the world to spawn the crystal in

Returns:

the spawned crystal. null if unsuccessfully spawned

See Also:

spawn(World, boolean)

get

public org.bukkit.entity.EnderCrystal get(org.bukkit.World world)

Get the current crystal relative to the world's portal location.

Parameters:

world - the world to reference

Returns:

the crystal positioned at the crystal location. null if none

isPresent

public boolean isPresent(org.bukkit.World world)

Check whether this crystal is spawned on the portal or not.

Parameters:

world - the world to check

Returns:

true if a crystal is spawned. false otherwise

getAllSpawnedCrystals

public static Set<org.bukkit.entity.EnderCrystal> getAllSpawnedCrystals(org.bukkit.World world)

Get all crystals that have been spawned on the portal in the given world.

Parameters:

world - the world to check

Returns:

all spawned ender crystals