net.amigocraft.mglib.api

Class Minigame

java.lang.Object

net.amigocraft.mglib.api.Minigame

public class Minigame
extends java.lang.Object

The primary API class. Contains necessary methods to create a minigame plugin from the library.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
void	createArena(java.lang.String name, org.bukkit.Location spawn) Deprecated. Use createArena(String, Location3D)
void	createArena(java.lang.String name, Location3D spawn) Creates an arena for use with MGLib.
ArenaFactory	createArena(java.lang.String name, Location3D spawn, Location3D corner1, Location3D corner2) Creates an arena for use with MGLib.
ArenaFactory	createArena(java.lang.String name, org.bukkit.Location spawn, org.bukkit.Location corner1, org.bukkit.Location corner2) Deprecated. Use createArena(String, Location3D, Location3D, Location3D)
Round	createRound(java.lang.String arena) Creates and stores a new round with the given parameters.
void	debug(java.lang.String message) Logs the given message at LogLevel.DEBUG.
void	deleteArena(java.lang.String name) Removes an arena from the plugin's config, effectively deleting it.
ArenaFactory	getArenaFactory(java.lang.String arena) Retrieves an ArenaFactory for the arena of the specified name.
ConfigManager	getConfigManager() Retrieves this minigame's config manager.
LobbyManager	getLobbyManager() Retrieves this minigame's lobby manager.
Locale	getLocale() Returns the Locale for this minigame.
MGPlayer	getMGPlayer(java.lang.String player) Returns the MGPlayer associated with the given username.
static Minigame	getMinigameInstance(org.bukkit.plugin.java.JavaPlugin plugin) Deprecated. Use getMinigameInstance(String)
static Minigame	getMinigameInstance(java.lang.String plugin) Finds the instance of the MGLib API associated with a given plugin.
static java.util.List<Minigame>	getMinigameInstances() Retrieves a list of all registered minigame instances.
static java.util.HashMap<java.lang.String,java.util.UUID>	getOnlineUUIDs() Retrieves a hashmap mapping the names of online players to their respective UUIDs.
org.bukkit.plugin.java.JavaPlugin	getPlugin() Deprecated. Depends on Bukkit
RollbackManager	getRollbackManager() Retrieves this minigame's rollback manager.
Round	getRound(java.lang.String name) Retrieves the instance of the round associated with the given arena.
java.util.List<Round>	getRoundList() Retrieves a list containing all rounds associated with the instance which registered this API instance.
java.util.HashMap<java.lang.String,Round>	getRounds() Retrieves a hashmap containing all rounds associated with the instance which registered this API instance.
void	info(java.lang.String message) Logs the given message at LogLevel.INFO.
static boolean	isMGLibCompatible(java.lang.String minReqVersion) Determines whether this version of MGLib is compatibile with the specified minimum required version.
boolean	isPlayer(java.lang.String p) Convenience method for checking if an MGPlayer is associated with the given username.
void	log(java.lang.String message, LogLevel level) Logs the given message at the specified logging level.
static Minigame	registerPlugin(org.bukkit.plugin.java.JavaPlugin plugin) Registers a plugin with the MGLib API.
void	severe(java.lang.String message) Logs the given message at LogLevel.SEVERE.
static void	uninitialize() Unsets all static objects in this class.
static boolean	unregisterPlugin(java.lang.String plugin) Unregisters the Minigame associated with the plugin by the given name.
void	verbose(java.lang.String message) Logs the given message at LogLevel.VERBOSE.
void	warning(java.lang.String message) Logs the given message at LogLevel.WARNING.

Methods inherited from class java.lang.Object

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

Method Detail

registerPlugin

public static Minigame registerPlugin(org.bukkit.plugin.java.JavaPlugin plugin)

Registers a plugin with the MGLib API.

Parameters:

plugin - an instance of your plugin (can be substituted with this if called from your main class)

Returns:

a minigame object which may be used for most core API methods, with the exception of some pertaining exclusively to players or rounds.

Since:

0.1.0

unregisterPlugin

public static boolean unregisterPlugin(java.lang.String plugin)

Unregisters the Minigame associated with the plugin by the given name.

Parameters:

plugin - The name of the plugin to unregister

Returns:

Whether the plugin was successfully unregistered

Since:

0.4.3

getPlugin

@Deprecated
public org.bukkit.plugin.java.JavaPlugin getPlugin()

Deprecated. Depends on Bukkit

Retrieves the JavaPlugin associated with this Minigame instance.

Returns:

the JavaPlugin associated with this Minigame instance

Since:

0.1.0

getMinigameInstances

public static java.util.List<Minigame> getMinigameInstances()

Retrieves a list of all registered minigame instances.

Returns:

a list of all registered minigame instances

Since:

0.1.0

getMinigameInstance

public static Minigame getMinigameInstance(java.lang.String plugin)

Finds the instance of the MGLib API associated with a given plugin.

Parameters:

plugin - the name of the plugin to search for

Returns:

the instance of the MGLib API (Minigame.class) associated with the given plugin

Since:

0.1.0

getMinigameInstance

@Deprecated
public static Minigame getMinigameInstance(org.bukkit.plugin.java.JavaPlugin plugin)

Deprecated. Use getMinigameInstance(String)

Finds the instance of the MGLib API associated with a given plugin.

Parameters:

plugin - the plugin to search for

Returns:

the instance of the MGLib API (Minigame.class) associated with the given plugin

Since:

0.1.0

getRounds

public java.util.HashMap<java.lang.String,Round> getRounds()

Retrieves a hashmap containing all rounds associated with the instance which registered this API instance.

Returns:

a hashmap containing all rounds associated with the instance which registered this API instance

Since:

0.1.0

getRoundList

public java.util.List<Round> getRoundList()

Retrieves a list containing all rounds associated with the instance which registered this API instance.

Returns:

a list containing all rounds associated with the instance which registered this API instance

Since:

0.1.0

createRound

public Round createRound(java.lang.String arena)
                  throws NoSuchArenaException

Creates and stores a new round with the given parameters.

Parameters:

arena - the name of the arena to create the round in

Returns:

the created round

Throws:

NoSuchArenaException - if the given arena does not exist

Since:

0.1.0

getRound

public Round getRound(java.lang.String name)

Retrieves the instance of the round associated with the given arena.

Parameters:

name - the name of the round to retrieve

Returns:

the instance of the round associated with the given arena, or null if it does not exist

Since:

0.1.0

createArena

public ArenaFactory createArena(java.lang.String name,
                                Location3D spawn,
                                Location3D corner1,
                                Location3D corner2)
                         throws InvalidLocationException,
                                ArenaExistsException

Creates an arena for use with MGLib.

Parameters:

name - the name of the arena (used to identify it)

spawn - the initial spawn point of the arena (more may be added later)

corner1 - a corner of the arena

corner2 - the corner of the arena opposite corner1

Returns:

the new arena's ArenaFactory

Throws:

InvalidLocationException - if the given locations are not in the same world

ArenaExistsException - if an arena of the same name already exists

Since:

0.4.0

createArena

@Deprecated
public ArenaFactory createArena(java.lang.String name,
                                             org.bukkit.Location spawn,
                                             org.bukkit.Location corner1,
                                             org.bukkit.Location corner2)
                                      throws InvalidLocationException,
                                             ArenaExistsException

Deprecated. Use createArena(String, Location3D, Location3D, Location3D)

Creates an arena for use with MGLib.

Parameters:

name - the name of the arena (used to identify it)

spawn - the initial spawn point of the arena (more may be added later)

corner1 - a corner of the arena

corner2 - the corner of the arena opposite corner1

Returns:

the new arena's ArenaFactory

Throws:

InvalidLocationException - if the given locations are not in the same world

ArenaExistsException - if an arena of the same name already exists

Since:

0.1.0

createArena

public void createArena(java.lang.String name,
                        Location3D spawn)
                 throws ArenaExistsException

Creates an arena for use with MGLib.

Parameters:

name - the name of the arena (used to identify it)

spawn - the initial spawn point of the arena (more may be added later)

Throws:

ArenaExistsException - if an arena of the same name already exists

Since:

0.4.0

createArena

@Deprecated
public void createArena(java.lang.String name,
                                     org.bukkit.Location spawn)
                              throws ArenaExistsException

Deprecated. Use createArena(String, Location3D)

Creates an arena for use with MGLib.

Parameters:

name - the name of the arena (used to identify it)

spawn - the initial spawn point of the arena (more may be added later)

Throws:

ArenaExistsException - if an arena of the same name already exists

Since:

0.1.0

deleteArena

public void deleteArena(java.lang.String name)
                 throws NoSuchArenaException

Removes an arena from the plugin's config, effectively deleting it.

Parameters:

name - the arena to delete

Throws:

NoSuchArenaException - if an arena by the specified name does not exist

Since:

0.1.0

getMGPlayer

public MGPlayer getMGPlayer(java.lang.String player)

Returns the MGPlayer associated with the given username.

Parameters:

player - the username to search for

Returns:

the MGPlayer associated with the given username, or null if none is found

Since:

0.1.0

isPlayer

public boolean isPlayer(java.lang.String p)

Convenience method for checking if an MGPlayer is associated with the given username.

This method simply checks if Minigame#getMGPlayer(p) is null.

Parameters:

p - the username to search for

Returns:

Whether an associated MGPlayer was found

Since:

0.1.0

getArenaFactory

public ArenaFactory getArenaFactory(java.lang.String arena)
                             throws NoSuchArenaException

Retrieves an ArenaFactory for the arena of the specified name.

Parameters:

arena - the name of the arena to retrieve an ArenaFactory for

Returns:

the arena's ArenaFactory

Throws:

NoSuchArenaException - if the given arena does not exist. In this case, you should instead use ArenaFactory.createArenaFactory(String, String, String).

Since:

0.1.0

getRollbackManager

public RollbackManager getRollbackManager()

Retrieves this minigame's rollback manager.

Returns:

this minigame's rollback manager

Since:

0.1.0

getLobbyManager

public LobbyManager getLobbyManager()

Retrieves this minigame's lobby manager.

Returns:

this minigame's lobby manager

Since:

0.1.0

getConfigManager

public ConfigManager getConfigManager()

Retrieves this minigame's config manager.

Returns:

this minigame's config manager

Since:

0.1.0

getLocale

public Locale getLocale()

Returns the Locale for this minigame.

Returns:

the Locale for this minigame

Since:

0.3.0

log

public void log(java.lang.String message,
                LogLevel level)

Logs the given message at the specified logging level.

Parameters:

message - the message to log

level - the level at which to log the message

Since:

0.3.0

severe

public void severe(java.lang.String message)

Logs the given message at LogLevel.SEVERE.

Parameters:

message - the message to log

Since:

0.3.0

warning

public void warning(java.lang.String message)

Logs the given message at LogLevel.WARNING.

Parameters:

message - the message to log

Since:

0.3.0

info

public void info(java.lang.String message)

Logs the given message at LogLevel.INFO.

Parameters:

message - the message to log

Since:

0.3.0

debug

public void debug(java.lang.String message)

Logs the given message at LogLevel.DEBUG.

Parameters:

message - the message to log

Since:

0.3.0

verbose

public void verbose(java.lang.String message)

Logs the given message at LogLevel.VERBOSE.

Parameters:

message - the message to log

Since:

0.3.0

getOnlineUUIDs

public static java.util.HashMap<java.lang.String,java.util.UUID> getOnlineUUIDs()

Retrieves a hashmap mapping the names of online players to their respective UUIDs.

Returns:

a hashmap mapping the names of online players to their respective UUIDs

Since:

0.3.0

uninitialize

public static void uninitialize()

Unsets all static objects in this class.

Throws:

java.lang.UnsupportedOperationException - if MGLib is not currently disabling

Since:

0.1.0

isMGLibCompatible

public static boolean isMGLibCompatible(java.lang.String minReqVersion)

Determines whether this version of MGLib is compatibile with the specified minimum required version.

Parameters:

minReqVersion - the minimum required version of MGLib

Returns:

whether this version of MGLib is compatibile with the specified minimum required version

Since:

0.3.0