com.gravypod.PersonalWorlds

Class PluginUtil

java.lang.Object

com.gravypod.PersonalWorlds.PluginUtil

public class PluginUtil
extends java.lang.Object

From src in AntiX

Author:

ElgarL

Constructor Summary

Constructors

Constructor and Description
PluginUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	borderTest(org.bukkit.Location destination) Checks if the the player is outside of the personal world border.
static void	deleteFile(java.io.File file) Delete file, or if path represents a directory, recursively delete it's contents beforehand.
static void	deleteWorld(java.lang.String player) Delete a world that is matched to a player name.
static org.bukkit.entity.Player[]	getOnlinePlayers() Gets a Array of online players.
static org.bukkit.Chunk	getPlayerChunk(java.lang.String name) Get the chunk the player is in.
static boolean	hasWorld(java.lang.String playerName) Tests if the player has a personal world.
static void	init(PersonalWorlds init) Initiation of the static class.
static java.lang.Boolean	isPlayerWorld(java.lang.String playerName) Finds if a world name is a player owned world.
static boolean	isWorldLoaded(java.lang.String playerName) Checks if a world is loaded
static void	kickPlayersOut(java.lang.String worldOwner, boolean kickall, java.lang.String kickMessage) Kicks all the players to the main world spawn.
static org.bukkit.World	loadWorld(java.lang.String playerName) Loads a world from a player name.
static java.lang.String	matchOfflinePlayer(java.lang.String name) Matches an String to an off-line player
static java.lang.String	matchPlayer(java.lang.String name) Match a player with a player name you give
static org.bukkit.Location	safeSpawnLoc(org.bukkit.Location spawnLocation) Makes a safe spawn location.
static java.lang.String	worldName(java.lang.String name) Returns a String with path formating.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginUtil

public PluginUtil()

Method Detail

init

public static void init(PersonalWorlds init)

Initiation of the static class.

Parameters:

init -

matchPlayer

public static java.lang.String matchPlayer(java.lang.String name)

Match a player with a player name you give

Parameters:

name -

Returns:

String of the Players name online or off-line

matchOfflinePlayer

public static java.lang.String matchOfflinePlayer(java.lang.String name)

Matches an String to an off-line player

Parameters:

name -

Returns:

player name or null if there is no player

getPlayerChunk

public static org.bukkit.Chunk getPlayerChunk(java.lang.String name)

Get the chunk the player is in.

Parameters:

name - must match a player, no error checking. Use

Returns:

Chunk

getOnlinePlayers

public static org.bukkit.entity.Player[] getOnlinePlayers()

Gets a Array of online players.

Returns:

Array of player objects

worldName

public static java.lang.String worldName(java.lang.String name)

Returns a String with path formating.

Parameters:

name -

Returns:

String containing personal world path and name

isPlayerWorld

public static java.lang.Boolean isPlayerWorld(java.lang.String playerName)

Finds if a world name is a player owned world.

Parameters:

playerName -

Returns:

True if this is a player world.

safeSpawnLoc

public static org.bukkit.Location safeSpawnLoc(org.bukkit.Location spawnLocation)

Makes a safe spawn location.

Parameters:

spawnLocation -

Returns:

Modified location so you are not buried.

hasWorld

public static boolean hasWorld(java.lang.String playerName)

Tests if the player has a personal world.

Parameters:

playerName -

Returns:

True if they own a world

isWorldLoaded

public static boolean isWorldLoaded(java.lang.String playerName)

Checks if a world is loaded

Parameters:

playerName -

Returns:

True if the world is loaded

loadWorld

public static org.bukkit.World loadWorld(java.lang.String playerName)

Loads a world from a player name.

Parameters:

playerName -

Returns:

World object that has been loaded

borderTest

public static boolean borderTest(org.bukkit.Location destination)

Checks if the the player is outside of the personal world border.

Parameters:

destination -

Returns:

True if they are out of bounds

deleteWorld

public static void deleteWorld(java.lang.String player)

Delete a world that is matched to a player name. This delayed one tick after the world is unloaded to fully delete.

Parameters:

player -

kickPlayersOut

public static void kickPlayersOut(java.lang.String worldOwner,
                  boolean kickall,
                  java.lang.String kickMessage)

Kicks all the players to the main world spawn.

Parameters:

worldOwner -

kickall - is for if you want to kick everyone, event the owner, out of the world.

kickMessage - is the message players that are kicked are send after the kick.

deleteFile

public static void deleteFile(java.io.File file)

Delete file, or if path represents a directory, recursively delete it's contents beforehand.

Parameters:

file -