net.amigocraft.mglib

Class LobbyManager

java.lang.Object

net.amigocraft.mglib.LobbyManager

public class LobbyManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
LobbyManager(java.lang.String plugin) Creates a new lobby manager instance.

Method Summary

Modifier and Type	Method and Description
void	add(org.bukkit.Location l, java.lang.String arena, LobbyType type, int index) Creates a new LobbySign to be managed.
LobbySign	getSign(Location3D location) Retrieves the lobby sign at the specified location, or null if it does not exist.
java.util.List<LobbySign>	getSignList() Retrieves a list of lobby signs registered with this lobby manager.
java.util.HashMap<Location3D,LobbySign>	getSigns() Retrieves a hashmap mapping locations to lobby signs registered with this lobby manager.
void	loadSigns() Loads lobby signs from disk.
void	remove(LobbySign s) Removes the given lobby sign.
void	reset() Resets all lobby signs to their default state (waiting stage for status signs, blank for player signs).
int	save(LobbySign l) Saves a lobby sign's data to disk.
void	update(java.lang.String arena) Updates all lobby signs linked to a specific arena.

Methods inherited from class java.lang.Object

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

Constructor Detail

LobbyManager

public LobbyManager(java.lang.String plugin)

Creates a new lobby manager instance.

Parameters:

plugin - The plugin to create the manager for.

Since:

0.1.0

Method Detail

getSigns

public java.util.HashMap<Location3D,LobbySign> getSigns()

Retrieves a hashmap mapping locations to lobby signs registered with this lobby manager.

Returns:

a hashmap of signs registered with this lobby manager

Since:

0.1.0

getSignList

public java.util.List<LobbySign> getSignList()

Retrieves a list of lobby signs registered with this lobby manager.

Returns:

a list of lobby signs registered with this lobby manager

Since:

0.1.0

add

public void add(org.bukkit.Location l,
                java.lang.String arena,
                LobbyType type,
                int index)
         throws NoSuchArenaException,
                InvalidLocationException,
                java.lang.IllegalArgumentException

Creates a new LobbySign to be managed.

Parameters:

l - the location to create the sign at

arena - the name of the arena the sign will be linked to

type - the type of the sign ("status" or "players")

index - the number of the sign (applicable only for "players" signs)

Throws:

NoSuchArenaException - if the specified arena does not exist

InvalidLocationException - if the specified location does not contain a sign

java.lang.IllegalArgumentException - if the specified index for a player sign is less than 1

Since:

0.1.0

update

public void update(java.lang.String arena)

Updates all lobby signs linked to a specific arena.

Parameters:

arena - the arena to update signs for

Since:

0.1.0

reset

public void reset()

Resets all lobby signs to their default state (waiting stage for status signs, blank for player signs).

Since:

0.1.0

remove

public void remove(LobbySign s)

Removes the given lobby sign.

Parameters:

s - the lobby sign to remove

Since:

0.1.0

save

public int save(LobbySign l)

Saves a lobby sign's data to disk.

Parameters:

l - the lobby sign to save to disk

Returns:

the index of the sign in the YAML file used for storage

Since:

0.1.0

getSign

public LobbySign getSign(Location3D location)

Retrieves the lobby sign at the specified location, or null if it does not exist.

Parameters:

location - the location to search for a lobby sign at

Returns:

the lobby sign at the specified location, or null if it does not exist

Since:

0.1.0

loadSigns

public void loadSigns()

Loads lobby signs from disk.

Since:

0.1.0