Package dev.aurelium.slate.item

Class TemplateItem<C>

java.lang.Object

dev.aurelium.slate.item.MenuItem

dev.aurelium.slate.item.TemplateItem<C>

public class TemplateItem<C>
extends MenuItem

Field Summary

Fields inherited from class dev.aurelium.slate.item.MenuItem

slate

Constructor Summary

Constructors

Constructor

Description

TemplateItem(Slate slate, String name, Class<C> contextClass, Map<C,org.bukkit.inventory.ItemStack> baseItems, org.bukkit.inventory.ItemStack defaultBaseItem, String displayName, List<LoreLine> lore, Map<C,String> contextualDisplayNames, Map<C,List<LoreLine>> contextualLore, Map<ClickAction,List<Action>> actions, Map<C,PositionProvider> positions, SlotPos defaultPosition, Map<String,Object> options, Map<String,ContextGroup> contextGroups)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getActiveDisplayName(C context)	Gets the active display name for the given context.
@Nullable List<LoreLine>	getActiveLore(C context)	Gets the active lore for the given context.
Map<C,org.bukkit.inventory.ItemStack>	getBaseItems()
Class<C>	getContextClass()
Map<String,ContextGroup>	getContextGroups()
@Nullable String	getContextualDisplayName(C context)
@Nullable List<LoreLine>	getContextualLore(C context)
@Nullable org.bukkit.inventory.ItemStack	getDefaultBaseItem()
@Nullable SlotPos	getDefaultPosition()
PositionProvider	getPosition(C context)
Map<C,PositionProvider>	getPositionsMap()

Methods inherited from class dev.aurelium.slate.item.MenuItem

getActions, getDisplayName, getLore, getName, getOptions

Methods inherited from class java.lang.Object

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

Constructor Details

TemplateItem

public TemplateItem(Slate slate,
 String name,
 Class<C> contextClass,
 Map<C,org.bukkit.inventory.ItemStack> baseItems,
 org.bukkit.inventory.ItemStack defaultBaseItem,
 String displayName,
 List<LoreLine> lore,
 Map<C,String> contextualDisplayNames,
 Map<C,List<LoreLine>> contextualLore,
 Map<ClickAction,List<Action>> actions,
 Map<C,PositionProvider> positions,
 SlotPos defaultPosition,
 Map<String,Object> options,
 Map<String,ContextGroup> contextGroups)

Method Details

getContextClass

public Class<C> getContextClass()

getPosition

public PositionProvider getPosition(C context)

getPositionsMap

public Map<C,PositionProvider> getPositionsMap()

getBaseItems

public Map<C,org.bukkit.inventory.ItemStack> getBaseItems()

getDefaultBaseItem

@Nullable
public @Nullable org.bukkit.inventory.ItemStack getDefaultBaseItem()

getDefaultPosition

@Nullable
public @Nullable SlotPos getDefaultPosition()

getContextualDisplayName

@Nullable
public @Nullable String getContextualDisplayName(C context)

getActiveDisplayName

@Nullable
public @Nullable String getActiveDisplayName(C context)

Gets the active display name for the given context. If the context has a contextual display name, it will be returned. Otherwise, the default display name will be returned.

Parameters:

context - The context

Returns:

The active display name

getContextualLore

@Nullable
public @Nullable List<LoreLine> getContextualLore(C context)

getActiveLore

@Nullable
public @Nullable List<LoreLine> getActiveLore(C context)

Gets the active lore for the given context. If the context has contextual lore, it will be returned. Otherwise, the default lore will be returned.

Parameters:

context - The context

Returns:

The active lore

getContextGroups

public Map<String,ContextGroup> getContextGroups()