net.amigocraft.mglib.api

Class ArenaFactory

java.lang.Object

net.amigocraft.mglib.api.ArenaFactory

public class ArenaFactory
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
ArenaFactory	addSpawn(double x, double y, double z) Adds a spawn to the given arena with the given coordinates.
ArenaFactory	addSpawn(double x, double y, double z, float pitch, float yaw) Adds a spawn to the given arena with the given coordinates, pitch, and yaw.
ArenaFactory	addSpawn(org.bukkit.Location location) Deprecated. Use addSpawn(Location3D)
ArenaFactory	addSpawn(Location3D location) Adds a spawn to the given arena with the given Location.
ArenaFactory	addSpawn(Location3D location, boolean saveOrientation) Adds a spawn to the given arena with the given Location3D.
ArenaFactory	addSpawn(org.bukkit.Location location, boolean saveOrientation) Deprecated. Use addSpawn(Location3D, boolean)
static ArenaFactory	createArenaFactory(java.lang.String plugin, java.lang.String arena, java.lang.String world) Creates a new arena object, used to modify an arena's assets.
ArenaFactory	deleteSpawn(double x, double y, double z) Deletes a spawn from the given arena at the given coordinates.
ArenaFactory	deleteSpawn(int index) Deletes a spawn from the given arena at the given Location.
ArenaFactory	deleteSpawn(org.bukkit.Location location) Deprecated. Use deleteSpawn(Location3D)
ArenaFactory	deleteSpawn(Location3D location) Deletes a spawn from the given arena at the given Location3D.
void	destroy() Destroys this arena factory.
java.lang.String	getArena() Retrieves the name of the arena associated with this ArenaFactory.
java.lang.String	getDisplayName() Retrieves the display name of the arena associated with this ArenaFactory.
java.lang.String	getPlugin() Retrieves the name of the plugin associated with this ArenaFactory.
java.lang.String	getWorld() Retrieves the name of the world associated with this ArenaFactory's arena.
boolean	isNewArena() Determines whether this arena is newly created.
boolean	isNewInstance() Determines whether this instance is newly created for the server session.
ArenaFactory	setData(java.lang.String key, java.lang.Object value) Attaches an arbitrary key-value pair to the arena.
ArenaFactory	setMaxBound(double x, double y, double z) Sets the maximum boundary of this arena.
ArenaFactory	setMaxBound(org.bukkit.Location location) Deprecated. Use setMinBound(Location3D)
ArenaFactory	setMaxBound(Location3D location) Sets the maximum boundary of this arena.
ArenaFactory	setMinBound(double x, double y, double z) Sets the minimum boundary of this arena.
ArenaFactory	setMinBound(org.bukkit.Location location) Deprecated. Use setMinBound(Location3D)
ArenaFactory	setMinBound(Location3D location) Sets the minimum boundary of this arena.

Methods inherited from class java.lang.Object

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

Method Detail

createArenaFactory

public static ArenaFactory createArenaFactory(java.lang.String plugin,
                                              java.lang.String arena,
                                              java.lang.String world)

Creates a new arena object, used to modify an arena's assets.

Parameters:

plugin - the plugin this arena is owned by

arena - the name of the arena

world - the world containing the arena

Returns:

the created ArenaFactory, or the existing one if present

Since:

0.1.0

getPlugin

public java.lang.String getPlugin()

Retrieves the name of the plugin associated with this ArenaFactory.

Returns:

the name of the plugin associated with this ArenaFactory

Since:

0.1.0

getArena

public java.lang.String getArena()

Retrieves the name of the arena associated with this ArenaFactory.

Returns:

the name of the arena associated with this ArenaFactory

Since:

0.1.0

getDisplayName

public java.lang.String getDisplayName()

Retrieves the display name of the arena associated with this ArenaFactory.

Returns:

the display name of the arena associated with this ArenaFactory

Since:

0.1.0

getWorld

public java.lang.String getWorld()

Retrieves the name of the world associated with this ArenaFactory's arena.

Returns:

the name of the world associated with this ArenaFactory's arena

Since:

0.1.0

addSpawn

public ArenaFactory addSpawn(double x,
                             double y,
                             double z,
                             float pitch,
                             float yaw)

Adds a spawn to the given arena with the given coordinates, pitch, and yaw.

Parameters:

x - the x-coordinate of the new spawn

y - the y-coordinate of the new spawn

z - the z-coordinate of the new spawn

pitch - the pitch (x- and z-rotation) of the new spawn

yaw - the yaw (y-rotation) of the new spawn

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.1.0

addSpawn

public ArenaFactory addSpawn(double x,
                             double y,
                             double z)

Adds a spawn to the given arena with the given coordinates.

Note: it is recommended that you use addSpawn(Location) if an instance of a Location at these coordinates already exists.

Parameters:

x - the x-coordinate of the new spawn

y - the y-coordinate of the new spawn

z - the z-coordinate of the new spawn

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.1.0

addSpawn

public ArenaFactory addSpawn(Location3D location,
                             boolean saveOrientation)
                      throws InvalidLocationException

Adds a spawn to the given arena with the given Location3D.

Parameters:

location - the location of the new spawn

saveOrientation - whether to save the Location3D's pitch and yaw to the spawn (Defaults to false if omitted).

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.1.0

addSpawn

@Deprecated
public ArenaFactory addSpawn(org.bukkit.Location location,
                                          boolean saveOrientation)
                                   throws InvalidLocationException

Deprecated. Use addSpawn(Location3D, boolean)

Adds a spawn to the given arena with the given Location.

Parameters:

location - the location of the new spawn

saveOrientation - whether to save the Location's pitch and yaw to the spawn (Defaults to false if omitted).

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.4.0

addSpawn

public ArenaFactory addSpawn(Location3D location)
                      throws InvalidLocationException

Adds a spawn to the given arena with the given Location.

Parameters:

location - the location of the new spawn

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.1.0

addSpawn

@Deprecated
public ArenaFactory addSpawn(org.bukkit.Location location)
                                   throws InvalidLocationException

Deprecated. Use addSpawn(Location3D)

Adds a spawn to the given arena with the given Location.

Parameters:

location - the location of the new spawn

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.1.0

deleteSpawn

public ArenaFactory deleteSpawn(double x,
                                double y,
                                double z)

Deletes a spawn from the given arena at the given coordinates.

Parameters:

x - the x-coordinate of the spawn to delete

y - the y-coordinate of the spawn to delete

z - the z-coordinate of the spawn to delete

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.1.0

deleteSpawn

public ArenaFactory deleteSpawn(Location3D location)

Deletes a spawn from the given arena at the given Location3D.

Parameters:

location - the Location3D of the spawn to delete

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.4.0

deleteSpawn

@Deprecated
public ArenaFactory deleteSpawn(org.bukkit.Location location)

Deprecated. Use deleteSpawn(Location3D)

Deletes a spawn from the given arena at the given Location.

Parameters:

location - the Location of the spawn to delete

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.1.0

deleteSpawn

public ArenaFactory deleteSpawn(int index)

Deletes a spawn from the given arena at the given Location.

Parameters:

index - the internal index of the spawn to delete

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.1.0

setMinBound

public ArenaFactory setMinBound(double x,
                                double y,
                                double z)

Sets the minimum boundary of this arena.

Parameters:

x - the minimum x-value

y - the minimum y-value

z - the minimum z-value

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.1.0

setMinBound

public ArenaFactory setMinBound(Location3D location)
                         throws InvalidLocationException

Sets the minimum boundary of this arena.

Parameters:

location - the Location3D representing the maximum boundary

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.4.0

setMinBound

@Deprecated
public ArenaFactory setMinBound(org.bukkit.Location location)
                                      throws InvalidLocationException

Deprecated. Use setMinBound(Location3D)

Sets the minimum boundary of this arena.

Parameters:

location - the Location representing the maximum boundary

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.1.0

setMaxBound

public ArenaFactory setMaxBound(double x,
                                double y,
                                double z)

Sets the maximum boundary of this arena.

Parameters:

x - the maximum x-value

y - the maximum y-value

z - the maximum z-value

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.1.0

setMaxBound

public ArenaFactory setMaxBound(Location3D location)
                         throws InvalidLocationException

Sets the maximum boundary of this arena.

Parameters:

location - the Location3D representing the maximum boundary

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.4.0

setMaxBound

@Deprecated
public ArenaFactory setMaxBound(org.bukkit.Location location)
                                      throws InvalidLocationException

Deprecated. Use setMinBound(Location3D)

Sets the maximum boundary of this arena.

Parameters:

location - the Location representing the maximum boundary

Returns:

the instance of ArenaFactory which this method was called from

Throws:

InvalidLocationException - if the provided location's world does not match the arena's world

Since:

0.1.0

setData

public ArenaFactory setData(java.lang.String key,
                            java.lang.Object value)

Attaches an arbitrary key-value pair to the arena.

Parameters:

key - the key to set for the arena

value - the value to associate with the key

Returns:

the instance of ArenaFactory which this method was called from

Since:

0.3.0

isNewInstance

public boolean isNewInstance()

Determines whether this instance is newly created for the server session. This will return false for the rest of the session after the createArenaFactory() method is called a second time.

Returns:

whether this instance is newly created

Since:

0.1.0

isNewArena

public boolean isNewArena()

Determines whether this arena is newly created. This will permanently return false until the arena is deleted.

Returns:

whether this arena is newly created

Since:

0.3.0

destroy

public void destroy()

Destroys this arena factory.

Since:

0.1.0