Package net.tnemc.menu.core.icon.impl

Class StateIcon

java.lang.Object

net.tnemc.menu.core.icon.Icon

net.tnemc.menu.core.icon.impl.StateIcon

All Implemented Interfaces:

ConstraintHolder

public class StateIcon
extends Icon

The StateIcon class represents an icon with a dynamic state that is determined by a state handler.

Since:

1.5.0.0

Author:

creatorfromhell

See Also:

• Icon

Field Summary

Fields

Modifier and Type	Field	Description
private final String	defaultState
protected final Function<String,String>	stateHandler	The function responsible for determining the state of the icon based on its current state.
private final String	stateID
private final Map<String,net.tnemc.item.AbstractItemStack<?>>	states

Fields inherited from class net.tnemc.menu.core.icon.Icon

actions, click, constraints, item, itemProvider, slot

Constructor Summary

Constructors

Constructor	Description
StateIcon(@NotNull net.tnemc.item.AbstractItemStack<?> item, @Nullable Function<MenuPlayer,net.tnemc.item.AbstractItemStack<?>> itemProvider, String stateID, String defaultState, @NotNull Function<String,String> stateHandler)

Method Summary

Modifier and Type	Method	Description
void	addState(String stateID, net.tnemc.item.AbstractItemStack<?> item)
net.tnemc.item.AbstractItemStack<?>	getItem(@Nullable MenuPlayer player)	Retrieves the current item of the icon by applying the state handler.
Map<String,net.tnemc.item.AbstractItemStack<?>>	getStates()
boolean	onClick(MenuClickHandler handler)

Methods inherited from class net.tnemc.menu.core.icon.Icon

addAction, constraints, getActions, getClick, setClick, setSlot, setSlot, slot

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.tnemc.menu.core.constraints.ConstraintHolder

addConstraint, getConstraint, removeConstraint

Field Details

states

private final Map<String,net.tnemc.item.AbstractItemStack<?>> states

stateID

private final String stateID

defaultState

private final String defaultState

stateHandler

protected final Function<String,String> stateHandler

The function responsible for determining the state of the icon based on its current state.

Constructor Details

StateIcon

public StateIcon(@NotNull
 @NotNull net.tnemc.item.AbstractItemStack<?> item,
 @Nullable
 @Nullable Function<MenuPlayer,net.tnemc.item.AbstractItemStack<?>> itemProvider,
 String stateID,
 String defaultState,
 @NotNull
 @NotNull Function<String,String> stateHandler)

Method Details

getStates

public Map<String,net.tnemc.item.AbstractItemStack<?>> getStates()

addState

public void addState(String stateID,
 net.tnemc.item.AbstractItemStack<?> item)

onClick

public boolean onClick(MenuClickHandler handler)

Overrides:

onClick in class Icon

getItem

public net.tnemc.item.AbstractItemStack<?> getItem(@Nullable
 @Nullable MenuPlayer player)

Retrieves the current item of the icon by applying the state handler.

Overrides:

getItem in class Icon

Parameters:

player - The player that is viewing the menu.

Returns:

The item representing the current state of the icon.