eu.wauz.wauzcore.system.instances

Class InstanceManager

java.lang.Object

eu.wauz.wauzcore.system.instances.InstanceManager

public class InstanceManager
extends java.lang.Object

Used for managing multiplayer instances.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private static WauzCore	core A direct reference to the main class.

Constructor Summary

Constructors

Constructor and Description
InstanceManager()

Method Summary

Modifier and Type	Method and Description
static void	closeInstance(org.bukkit.World world) Unloads the world of an instance and deletes the folder.
private static void	createSpawnCircle(org.bukkit.World world, org.bukkit.Location location) Creates a circle out of obsidian and glowstone at the given location.
static boolean	enter(org.bukkit.entity.Player player, java.lang.String instanceName) Creates an instance for the given player.
static void	enterArcade(org.bukkit.entity.Player player) Lets the player enter the arcade lobby.
static void	enterGuild(org.bukkit.entity.Player player) Lets the player enter their guildhall.
static void	enterSurvival(org.bukkit.entity.Player player, java.lang.String instanceName) Creates an instance for the given player.
private static void	openInstance(java.io.File source, java.io.File target) Creates a new instance from a template.
private static void	placeExitSign(org.bukkit.block.Block block, org.bukkit.block.BlockFace blockFace) Places a exit sign on the given block.
static void	removeInactiveInstances() Removes all instance folders.

Methods inherited from class java.lang.Object

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

Field Detail

core

private static WauzCore core

A direct reference to the main class.

Constructor Detail

InstanceManager

public InstanceManager()

Method Detail

enter

public static boolean enter(org.bukkit.entity.Player player,
                            java.lang.String instanceName)

Creates an instance for the given player. If the instance name contains "Survival", a Survival instance is opened, otherwise a MMORPG one. Specified by the instance folder in the /WauzCore/Worlds folder and the configuration in the /WauzCore/InstanceData folder. Also initializes stuff like instance keys and setup commands. Handles the teleportation of the player afterwards.

Parameters:

player - The player who opened the instance.

instanceName - The name of the instance.

Returns:

If the playere entered the instance successfully.

See Also:

openInstance(File, File)

enterGuild

public static void enterGuild(org.bukkit.entity.Player player)

Lets the player enter their guildhall. Only works if the player is in a guild. If there is no guildhall already open, a new instance is created. Handles the teleportation of the player afterwards.

Parameters:

player - The player who opened the instance.

See Also:

openInstance(File, File)

enterArcade

public static void enterArcade(org.bukkit.entity.Player player)

Lets the player enter the arcade lobby. If there is no lobby already open, a new instance is created. Handles the teleportation of the player afterwards.

Parameters:

player - The player who opened the instance.

See Also:

openInstance(File, File)

enterSurvival

public static void enterSurvival(org.bukkit.entity.Player player,
                                 java.lang.String instanceName)

Creates an instance for the given player. Specified by the instance name: "Survival Nether" opens a nether world. "Survival End" opens a nether world. Otherwise a normal world should be created. A circle with exit signs is created around the spawn. Handles the teleportation of the player afterwards.

Parameters:

player - The player who opened the instance.

instanceName - The name of the instance.

See Also:

createSpawnCircle(World, Location)

createSpawnCircle

private static void createSpawnCircle(org.bukkit.World world,
                                      org.bukkit.Location location)

Creates a circle out of obsidian and glowstone at the given location. Exit signs are placed on the circle edges. Used for survival instance spawns.

Parameters:

world - The world on which the circle should be created.

location - The center location of the circle.

See Also:

placeExitSign(Block, BlockFace)

placeExitSign

private static void placeExitSign(org.bukkit.block.Block block,
                                  org.bukkit.block.BlockFace blockFace)

Places a exit sign on the given block. Used for instance exits.

Parameters:

block - The block where the sign should be placed.

blockFace - The direction thr sign should face.

openInstance

private static void openInstance(java.io.File source,
                                 java.io.File target)

Creates a new instance from a template. Is called recursively to copy files into the new world.

Parameters:

source - The instance template.

target - The new instance folder.

closeInstance

public static void closeInstance(org.bukkit.World world)

Unloads the world of an instance and deletes the folder. Only works if given world is an instance.

Parameters:

world - The instance world.

See Also:

WauzActiveInstancePool.unregisterInstance(String), WauzFileUtils.removeFilesRecursive(File)

removeInactiveInstances

public static void removeInactiveInstances()

Removes all instance folders. WARNING: There is no check if the instance is loaded!

See Also:

WauzActiveInstancePool.unregisterInstance(String), WauzFileUtils.removeFilesRecursive(File)