me.leoko.advancedgui.utils

Class GuiInstance

java.lang.Object

me.leoko.advancedgui.utils.GuiInstance

Direct Known Subclasses:

GuiItemInstance, GuiWallInstance

public abstract class GuiInstance
extends Object

A GuiInstance manages Interactions of Players with a Layout and renders and sends the corresponding frames.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GuiInstance.GuiType

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentMap<org.bukkit.entity.Player,Interaction>	interactions
protected Map<org.bukkit.entity.Player,GuiPoint>	lastCursorPosition
protected Map<org.bukkit.entity.Player,String>	lastState
protected Layout	layout
protected org.bukkit.scheduler.BukkitTask	renderTask
static int	sendCount
protected boolean	showCursor
protected GuiInstance.GuiType	type

Constructor Summary

Constructors

Constructor and Description
GuiInstance(Layout layout, int[] mapIDs, boolean showCursor, GuiInstance.GuiType type) Instantiates a new GuiInstance.

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose this instance.
void	endInteraction(org.bukkit.entity.Player player) Ends an interaction with this instance.
protected int	generateMapID()
abstract GuiPoint	getCursor(org.bukkit.entity.Player player) Gets the cursor of a player.
Interaction	getInteraction(org.bukkit.entity.Player player) Get a players interaction with this instance.
Layout	getLayout() Gets layout.
int[]	getMapIDs() Get the Minecraft Map IDs used by this GUI instance.
GuiInstance.GuiType	getType() Gets GUI type.
boolean	isInteracting(org.bukkit.entity.Player player) Check whether a play is currently interacting with this instance.
protected void	sendRenderData(org.bukkit.entity.Player player, byte[][] renderData, byte[][] cachedRenderData, GuiPoint cursorPosition, boolean cursorPositionChanged)
void	setMapIdConverter(BiFunction<Integer,org.bukkit.entity.Player,Integer> mapIdConverter)
protected void	setMapIDs(int[] mapIDs)
void	startInteraction(org.bukkit.entity.Player player) Start an interaction with this instance.
protected void	startRendering()

Methods inherited from class java.lang.Object

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

Field Detail

sendCount

public static int sendCount

layout

protected final Layout layout

interactions

protected final ConcurrentMap<org.bukkit.entity.Player,Interaction> interactions

lastState

protected final Map<org.bukkit.entity.Player,String> lastState

lastCursorPosition

protected final Map<org.bukkit.entity.Player,GuiPoint> lastCursorPosition

renderTask

protected org.bukkit.scheduler.BukkitTask renderTask

showCursor

protected final boolean showCursor

type

protected GuiInstance.GuiType type

Constructor Detail

GuiInstance

public GuiInstance(Layout layout,
                   int[] mapIDs,
                   boolean showCursor,
                   GuiInstance.GuiType type)

Instantiates a new GuiInstance.

Parameters:

layout - the layout

mapIDs - the map i ds

showCursor - the show cursor

Method Detail

getCursor

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

Gets the cursor of a player.

Parameters:

player - the player

Returns:

the cursor

getMapIDs

public int[] getMapIDs()

Get the Minecraft Map IDs used by this GUI instance.

Returns:

the int [ ]

setMapIDs

protected void setMapIDs(int[] mapIDs)

setMapIdConverter

public void setMapIdConverter(BiFunction<Integer,org.bukkit.entity.Player,Integer> mapIdConverter)

getLayout

public Layout getLayout()

Gets layout.

Returns:

the layout

getType

public GuiInstance.GuiType getType()

Gets GUI type.

Returns:

the type

startInteraction

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

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

Parameters:

player - the player

endInteraction

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

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

Parameters:

player - the player

startRendering

protected void startRendering()

sendRenderData

protected void sendRenderData(org.bukkit.entity.Player player,
                              byte[][] renderData,
                              byte[][] cachedRenderData,
                              GuiPoint cursorPosition,
                              boolean cursorPositionChanged)

generateMapID

protected int generateMapID()

isInteracting

public boolean isInteracting(org.bukkit.entity.Player player)

Check whether a play is currently interacting with this instance.

Parameters:

player - the player

Returns:

the boolean

getInteraction

public Interaction getInteraction(org.bukkit.entity.Player player)

Get a players interaction with this instance.

Parameters:

player - the player

Returns:

the interaction

dispose

public void dispose()

Dispose this instance.