com.codelanx.codelanxlib.inventory.iinterface

Class MenuIcon

java.lang.Object

com.codelanx.codelanxlib.inventory.iinterface.MenuIcon

public class MenuIcon
extends Object

Represents an ItemStack in an InventoryPanel's inventory that will execute code when clicked.

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected ItemStack	item The ItemStack that this instance uses
protected Execution	onExec The Execution function to run when clicked
protected Map<String,Object>	options A mapping of metadata options
protected List<String>	perms Permissions required to see this icon
protected long	seed A seed representing this object

Method Summary

Modifier and Type	Method and Description
Object	addOption(String key, Object value) Adds a metadata option
void	addPermission(String permission) Adds a permission node that a player will need in order to see this icon.
boolean	equals(Object obj)
ItemStack	getItem() Returns the ItemStack that is displayed when a user opens the InventoryInterface
Object	getOption(String key) Returns a metadata option
Map<String,Object>	getOptions() Returns a Map of all the metadata options
int	hashCode()
boolean	hasPermission(Player p) Returns whether or not a Player has permission to view this icon
boolean	requiresPerms() Returns true if any permissions are required to see this icon
void	setExecutable(Execution onExec) Sets the Execution function that is called when this icon is clicked.

Methods inherited from class java.lang.Object

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

Field Detail

options

protected Map<String,Object> options

A mapping of metadata options

seed

protected final long seed

A seed representing this object

item

protected final ItemStack item

The ItemStack that this instance uses

onExec

protected Execution onExec

The Execution function to run when clicked

perms

protected final List<String> perms

Permissions required to see this icon

Method Detail

getItem

public ItemStack getItem()

Returns the ItemStack that is displayed when a user opens the InventoryInterface

Returns:

The ItemStack to display

Since:

0.1.0

setExecutable

public void setExecutable(Execution onExec)

Sets the Execution function that is called when this icon is clicked. Can be set to null to not execute anything

Parameters:

onExec - The Execution to be used

Since:

0.1.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

Since:

0.1.0

getOptions

public Map<String,Object> getOptions()

Returns a Map of all the metadata options

Returns:

A Map of metadata values

Since:

0.1.0

addOption

public Object addOption(String key,
                        Object value)

Adds a metadata option

Parameters:

key - The String key to retrieve the option

value - The value of the option

Returns:

The previous value associated with the key, or null if there was no previous mapping using the key

Since:

0.1.0

getOption

public Object getOption(String key)

Returns a metadata option

Parameters:

key - The key that maps to the value

Returns:

The stored metadata value, or null if none is set

Since:

0.1.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj -

Returns:

Since:

0.1.0

addPermission

public void addPermission(String permission)

Adds a permission node that a player will need in order to see this icon. If no permissions are set, everyone is capable of seeing the icon. If multiple permissions are set, only one of the permission nodes is needed

Parameters:

permission - A string representing a permission node

Since:

0.1.0

requiresPerms

public boolean requiresPerms()

Returns true if any permissions are required to see this icon

Returns:

true if a permission is needed to see the icon

Since:

0.1.0

hasPermission

public boolean hasPermission(Player p)

Returns whether or not a Player has permission to view this icon

Parameters:

p - The Player to check

Returns:

true if the player has permission to view the icon

Since:

0.1.0