me.leoko.advancedgui.utils

Class GuiWallInstance

java.lang.Object

me.leoko.advancedgui.utils.GuiInstance

me.leoko.advancedgui.utils.GuiWallInstance

public class GuiWallInstance
extends GuiInstance

The GuiWallInstance is a GuiInstance that displays a layout in a ItemFrame grid on a wall.

Nested Class Summary

Nested classes/interfaces inherited from class me.leoko.advancedgui.utils.GuiInstance

GuiInstance.GuiType

Field Summary

Fields inherited from class me.leoko.advancedgui.utils.GuiInstance

interactions, lastCursorPosition, lastState, layout, renderTask, sendCount, showCursor, type

Constructor Summary

Constructors

Constructor and Description
GuiWallInstance(int id, Layout layout, int activationRadius, GuiLocation location) Instantiates a new GuiWallInstance.
GuiWallInstance(int id, Layout layout, int activationRadius, GuiLocation location, int[] mapIDs) Instantiates a new GuiWallInstance.

Method Summary

Modifier and Type	Method and Description
void	displayStandbyScreen(Collection<org.bukkit.entity.Player> players) Sends the standby-screen to all selected players.
void	endInteraction(org.bukkit.entity.Player player) Ends an interaction with this instance.
int	getActivationRadius() Gets the squared activation radius.
BoundingBox	getBoundingBox() Gets bounding box of the full blocks of the ItemFrames and the blocks behind them.
org.bukkit.Location	getCenter() Gets center.
GuiPoint	getCursor(org.bukkit.entity.Player player) Gets the cursor of a player.
int	getId() Gets instance id.
GuiLocation	getLocation() Gets location.
boolean	isInArea(org.bukkit.Location check) Returns whether the location is within the getActivationRadius().
boolean	isInSight(org.bukkit.Location check) Returns whether the location is within the GuiWallManager.SIGHT_RADIUS.
void	populateFrames() Populates the ItemFrames with the correct map items.
List<FrameContainer>	queryItemFrames() Query the item frames for the instance.
void	startInteraction(org.bukkit.entity.Player player) Start an interaction with this instance.

Methods inherited from class me.leoko.advancedgui.utils.GuiInstance

dispose, generateMapID, getInteraction, getLayout, getMapIDs, getType, isInteracting, sendRenderData, setMapIdConverter, setMapIDs, startRendering

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiWallInstance

public GuiWallInstance(int id,
                       Layout layout,
                       int activationRadius,
                       GuiLocation location)

Instantiates a new GuiWallInstance. The id should be obtained from the GuiWallManager. And the location should be the location of the top left ItemFrame.

Parameters:

id - the id,

layout - the layout

location - the location

GuiWallInstance

public GuiWallInstance(int id,
                       Layout layout,
                       int activationRadius,
                       GuiLocation location,
                       int[] mapIDs)

Instantiates a new GuiWallInstance. The id should be obtained from the GuiWallManager. And the location should be the location of the top left ItemFrame.

Parameters:

id - the id

layout - the layout

location - the location

mapIDs - the map i ds

Method Detail

populateFrames

public void populateFrames()

Populates the ItemFrames with the correct map items.

displayStandbyScreen

public void displayStandbyScreen(Collection<org.bukkit.entity.Player> players)

Sends the standby-screen to all selected players. (Managed by the GuiWallManager if registered)

Parameters:

players - the player

getBoundingBox

public BoundingBox getBoundingBox()

Gets bounding box of the full blocks of the ItemFrames and the blocks behind them.

Returns:

the bounding box

getLocation

public GuiLocation getLocation()

Gets location.

Returns:

the location

getCenter

public org.bukkit.Location getCenter()

Gets center.

Returns:

the center

getId

public int getId()

Gets instance id.

Returns:

the id

getActivationRadius

public int getActivationRadius()

Gets the squared activation radius.

Returns:

the squared activation radius

getCursor

public GuiPoint getCursor(org.bukkit.entity.Player player)

Description copied from class: GuiInstance

Gets the cursor of a player.

Specified by:

getCursor in class GuiInstance

Parameters:

player - the player

Returns:

the cursor

queryItemFrames

public List<FrameContainer> queryItemFrames()

Query the item frames for the instance. Might be empty or partial if chunk is unloaded.

Returns:

the list

isInArea

public boolean isInArea(org.bukkit.Location check)

Returns whether the location is within the getActivationRadius().

Parameters:

check - the location to check

Returns:

the boolean

isInSight

public boolean isInSight(org.bukkit.Location check)

Returns whether the location is within the GuiWallManager.SIGHT_RADIUS.

Parameters:

check - the location to check

Returns:

the boolean

startInteraction

public void startInteraction(org.bukkit.entity.Player player)

Description copied from class: GuiInstance

Start an interaction with this instance. This is automatically managed for instances registered in GuiWallManager or GuiItemManager.

Overrides:

startInteraction in class GuiInstance

Parameters:

player - the player

endInteraction

public void endInteraction(org.bukkit.entity.Player player)

Description copied from class: GuiInstance

Ends an interaction with this instance. This is automatically managed for instances registered in GuiWallManager or GuiItemManager.

Overrides:

endInteraction in class GuiInstance

Parameters:

player - the player