me.leoko.advancedgui.utils

Class Interaction

java.lang.Object

me.leoko.advancedgui.utils.Interaction

public class Interaction
extends Object

This class describes an interaction between players and a layout. In most cases an interaction will only have one player. It holds some state information and is used by various components to distinguish rendering behaviour. Interactions are highly temporal and therefore not meant to keep track of any long-term state.

Interactions with multiple players can be used so that when one player triggers an action that for example changes the view of a ViewComponent then this change is visible to all other players in the interaction.

Constructor Summary

Constructors

Constructor and Description
Interaction(Layout layout, Function<Interaction,GroupComponent> componentTreeGenerator) Instantiates a new default Interaction.
Interaction(Layout layout, GroupComponent templateComponentTree) Instantiates a new Interaction.

Method Summary

Modifier and Type	Method and Description
void	click(org.bukkit.entity.Player player, GuiPoint cursor) Performs a click for the player at the given cursor position.
boolean	contains(org.bukkit.entity.Player player) Checks whether a player is taking part in this interaction.
GroupComponent	getComponentTree() Gets component tree.
Layout	getLayout() Gets the layout.
boolean	isDefaultInteraction() Check whether the interaction is a default interaction
void	join(org.bukkit.entity.Player player) Add a player to this interaction.
void	quit(org.bukkit.entity.Player player) Remove a player from this interaction.
void	runAfterClick(Runnable task)

Methods inherited from class java.lang.Object

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

Constructor Detail

Interaction

public Interaction(Layout layout,
                   GroupComponent templateComponentTree)

Instantiates a new Interaction.

Parameters:

layout - the layout

templateComponentTree - the template component tree

Interaction

public Interaction(Layout layout,
                   Function<Interaction,GroupComponent> componentTreeGenerator)

Instantiates a new default Interaction.

Parameters:

layout - the layout

componentTreeGenerator - the component tree generator

Method Detail

getLayout

public Layout getLayout()

Gets the layout.

Returns:

the layout

join

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

Add a player to this interaction.

Parameters:

player - the player

quit

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

Remove a player from this interaction.

Parameters:

player - the player

contains

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

Checks whether a player is taking part in this interaction.

Parameters:

player - the player

Returns:

the result

runAfterClick

public void runAfterClick(Runnable task)

isDefaultInteraction

public boolean isDefaultInteraction()

Check whether the interaction is a default interaction

Returns:

the boolean

getComponentTree

public GroupComponent getComponentTree()

Gets component tree.

Returns:

the component tree

click

public void click(org.bukkit.entity.Player player,
                  GuiPoint cursor)

Performs a click for the player at the given cursor position.

Parameters:

player - the player

cursor - the cursor