me.leoko.advancedgui.manager

Class GuiWallManager

java.lang.Object

me.leoko.advancedgui.manager.GuiWallManager

public class GuiWallManager
extends Object

The GuiWallManager manages available GuiWallInstances and renders their standby interaction.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIGHT_RADIUS The constant SIGHT_RADIUS defines the squared radius a player has to be in, in order to see the standby-screen

Constructor Summary

Constructors

Constructor and Description
GuiWallManager()

Method Summary

Modifier and Type	Method and Description
GuiWallInstance	getActiveInstance(int id) Gets the instance for the given id
GuiWallInstance	getActiveInstance(org.bukkit.Location location) Gets the instance at that location.
List<GuiWallInstance>	getActiveInstances() Gets all registered instances.
List<GuiWallInstance>	getActiveInstances(org.bukkit.Location location) Gets all instances that can be interacted with at that location.
List<GuiWallInstance>	getActiveInstances(org.bukkit.entity.Player player) Gets all instances the player is interacting with.
List<GuiWallInstance>	getInSightInstances(org.bukkit.Location location) Gets in sight instances.
static GuiWallManager	getInstance() Gets GuiWallManager instance.
int	getNextId() Gets the next available GuiWallInstance ID.
void	registerInstance(GuiWallInstance instance, boolean save) Registers a new wall instance allowing players to interact with it and to see the standby screen.
void	setup() Sets up the manager.
void	shutdown() Shuts down the manager.
void	unregisterInstance(GuiWallInstance instance, boolean delete) Unregisters the instance reverting the registerInstance(GuiWallInstance, boolean) method.

Methods inherited from class java.lang.Object

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

Field Detail

SIGHT_RADIUS

public static final int SIGHT_RADIUS

The constant SIGHT_RADIUS defines the squared radius a player has to be in, in order to see the standby-screen

See Also:

Constant Field Values

Constructor Detail

GuiWallManager

public GuiWallManager()

Method Detail

getInstance

public static GuiWallManager getInstance()

Gets GuiWallManager instance.

Returns:

the instance

setup

public void setup()

Sets up the manager.

This method should not be called manually. AdvancedGUI makes sure that the Manager is always setup.

shutdown

public void shutdown()

Shuts down the manager.

registerInstance

public void registerInstance(GuiWallInstance instance,
                             boolean save)

Registers a new wall instance allowing players to interact with it and to see the standby screen. When save is set to true then the instance will be saved to file and automatically be loaded from now on.

Parameters:

instance - the instance

save - whether to save the instance

unregisterInstance

public void unregisterInstance(GuiWallInstance instance,
                               boolean delete)

Unregisters the instance reverting the registerInstance(GuiWallInstance, boolean) method.

Parameters:

instance - the instance

delete - whether to delete the instance from file

getActiveInstances

public List<GuiWallInstance> getActiveInstances(org.bukkit.entity.Player player)

Gets all instances the player is interacting with.

Parameters:

player - the player

Returns:

the active instances

getActiveInstances

public List<GuiWallInstance> getActiveInstances(org.bukkit.Location location)

Gets all instances that can be interacted with at that location.

Parameters:

location - the location

Returns:

the nearby instances

getInSightInstances

public List<GuiWallInstance> getInSightInstances(org.bukkit.Location location)

Gets in sight instances. (see SIGHT_RADIUS)

Parameters:

location - the location

Returns:

the in sight instances

getNextId

public int getNextId()

Gets the next available GuiWallInstance ID.

Returns:

the next id

getActiveInstances

public List<GuiWallInstance> getActiveInstances()

Gets all registered instances.

Returns:

the active instances

getActiveInstance

public GuiWallInstance getActiveInstance(int id)

Gets the instance for the given id

Parameters:

id - the id

Returns:

the active instance

getActiveInstance

public GuiWallInstance getActiveInstance(org.bukkit.Location location)

Gets the instance at that location.

Parameters:

location - the location

Returns:

the active instance