me.leoko.advancedgui.utils

Class GuiItemInstance

java.lang.Object

me.leoko.advancedgui.utils.GuiInstance

me.leoko.advancedgui.utils.GuiItemInstance

public class GuiItemInstance
extends GuiInstance

The GuiItemInstance is a handheld GuiInstance using a map item to display a 1x1 Layout and the players gaze to control the cursor.

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
GuiItemInstance(Layout layout) Instantiates a new GuiItemInstance.
GuiItemInstance(Layout layout, Integer mapID) Instantiates a new GuiItemInstance.

Method Summary

Modifier and Type	Method and Description
org.bukkit.inventory.ItemStack	createItem() Creates a map item for this instance.
void	endInteraction(org.bukkit.entity.Player player) Ends an interaction with this instance.
GuiPoint	getCursor(org.bukkit.entity.Player player) Gets the cursor of a player.
int	getMapID() Gets the Map ID used by this instance.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiItemInstance

public GuiItemInstance(Layout layout)

Instantiates a new GuiItemInstance.

Parameters:

layout - the 1x1 layout

GuiItemInstance

public GuiItemInstance(Layout layout,
                       Integer mapID)

Instantiates a new GuiItemInstance.

Parameters:

layout - the 1x1 layout

mapID - the map id

Method Detail

getMapID

public int getMapID()

Gets the Map ID used by this instance.

Returns:

the map id

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

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

createItem

public org.bukkit.inventory.ItemStack createItem()

Creates a map item for this instance.

Returns:

the item stack