net.amigocraft.mglib

Class MGUtil

java.lang.Object

net.amigocraft.mglib.MGUtil

public class MGUtil
extends java.lang.Object

Utility methods for use within MGLib. Developers are advised not to use them in a separate plugin, since this isn't an API class and as such is subject to removals and refactors.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
MGUtil()

Method Summary

Modifier and Type	Method and Description
static void	callEvent(MGLibEvent event) Calls an event, but sends it only to the appropriate plugin.
static void	deleteFolder(java.io.File folder) Deletes a folder recursively.
static Location3D	fromBukkitLocation(org.bukkit.Location location) Converts a Bukkit Location to a Location3D.
static Location3D	fromBukkitLocation(org.bukkit.Location location, boolean copyOrientation) Converts a Bukkit Location to a Location3D.
static org.bukkit.block.Block	getAttachedSign(org.bukkit.block.Block block) Retrieves the sign attached to a given block, or null if ones does not exist.
static org.bukkit.World.Environment	getEnvironment(java.lang.String world) Determines the environment of the given world based on its folder structure.
static Main	getPlugin() Returns the JavaPlugin instance for MGLib.
static boolean	isInteger(java.lang.String s) Determines whether the provided string can be parsed to an integer.
static MGYamlConfiguration	loadArenaYaml(java.lang.String plugin) Loads and returns the given plugin's arenas.yml file.
static void	log(java.lang.String message, java.lang.String prefix, LogLevel level) Logs the given message if verbose logging is enabled.
static void	saveArenaYaml(java.lang.String plugin, org.bukkit.configuration.file.YamlConfiguration y) Saves the given plugin's arenas.yml file.
static org.bukkit.Location	toBukkitLocation(Location3D location) Converts a Location3D to a Bukkit Location.
static void	verifyDisablingStatus() Throws an UnsupportedOperationException if MGLib is not disabling.

Methods inherited from class java.lang.Object

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

Constructor Detail

MGUtil

public MGUtil()

Method Detail

getPlugin

public static Main getPlugin()

Returns the JavaPlugin instance for MGLib.

This should not be called from a hooking plugin under any circumstance.

Returns:

the JavaPlugin instance for MGLib.

Since:

0.4.0

loadArenaYaml

public static MGYamlConfiguration loadArenaYaml(java.lang.String plugin)

Loads and returns the given plugin's arenas.yml file.

Parameters:

plugin - The plugin to load the YAML file from.

Returns:

The loaded YamlConfiguration object.

Since:

0.1.0

saveArenaYaml

public static void saveArenaYaml(java.lang.String plugin,
                                 org.bukkit.configuration.file.YamlConfiguration y)

Saves the given plugin's arenas.yml file.

Parameters:

plugin - the plugin to save the given YamlConfiguration to

y - the YamlConfiguration to save

isInteger

public static boolean isInteger(java.lang.String s)

Determines whether the provided string can be parsed to an integer.

Parameters:

s - the string to check

Returns:

whether the provided string can be parsed to an integer

log

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

Logs the given message if verbose logging is enabled.

Parameters:

message - the message to log

prefix - the prefix to place in front of the message. This will automatically be placed within brackets

level - the level at which to log the message

Since:

0.3.0

callEvent

public static void callEvent(MGLibEvent event)

Calls an event, but sends it only to the appropriate plugin. Please do not call this from your pluginv unless you are aware of the implications.

Parameters:

event - the event to call

Since:

0.3.0

getAttachedSign

public static org.bukkit.block.Block getAttachedSign(org.bukkit.block.Block block)

Retrieves the sign attached to a given block, or null if ones does not exist.

Parameters:

block - the block to check for an attached sign

Returns:

the sign attached to a given block, or null if ones does not exist

getEnvironment

public static org.bukkit.World.Environment getEnvironment(java.lang.String world)

Determines the environment of the given world based on its folder structure.

Parameters:

world - the name of the world to determine the environment of

Returns:

the environment of the given world

Since:

0.3.0

deleteFolder

public static void deleteFolder(java.io.File folder)

Deletes a folder recursively.

Parameters:

folder - the folder to delete

Since:

0.3.0

verifyDisablingStatus

public static void verifyDisablingStatus()
                                  throws java.lang.UnsupportedOperationException

Throws an UnsupportedOperationException if MGLib is not disabling.

Throws:

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

Since:

0.4.0

fromBukkitLocation

public static Location3D fromBukkitLocation(org.bukkit.Location location)

Converts a Bukkit Location to a Location3D.

Parameters:

location - the Location to convert

Returns:

the new Location3D

Since:

0.4.0

fromBukkitLocation

public static Location3D fromBukkitLocation(org.bukkit.Location location,
                                            boolean copyOrientation)

Converts a Bukkit Location to a Location3D.

Parameters:

location - the Location to convert

copyOrientation - whether the pitch and yaw of location will be stored in the new Location3D (defaults to false if omitted).

Returns:

the new Location3D

Since:

0.4.0

toBukkitLocation

public static org.bukkit.Location toBukkitLocation(Location3D location)

Converts a Location3D to a Bukkit Location.

Parameters:

location - the Location3D to convert (defaults to false if omitted).

Returns:

the new Location

Since:

0.4.0