org.spongepowered.api

Interface GameDictionary.Entry

All Known Subinterfaces:

ItemType

Enclosing interface:

GameDictionary

public static interface GameDictionary.Entry

Method Summary

Modifier and Type	Method and Description
ItemStackSnapshot	getTemplate() Returns an item stack snapshot for plugins to inspect this entry.
ItemType	getType() Returns the type of item contained by this entry.
boolean	isSpecific() Returns whether this entry checks against the item type and extra data associated with the stack.
boolean	matches(ItemStack stack) Tests whether the provided item stack matches this entry's specifications.

Method Detail

getType

ItemType getType()

Returns the type of item contained by this entry.

Returns:

The item type

matches

boolean matches(ItemStack stack)

Tests whether the provided item stack matches this entry's specifications.

Parameters:

stack - The item stack to test

Returns:

true if the stack matches this entry

isSpecific

boolean isSpecific()

Returns whether this entry checks against the item type and extra data associated with the stack. If this returns true, any ItemStack whose ItemType and manipulators match those of the template will match this entry; however, not all manipulators present in the template are required to match those in the item stack to cause them to match. If this returns false, any item stack whose ItemType matches that of the entry will match this entry.

Returns:

true if the entry checks extra data on the stack

getTemplate

ItemStackSnapshot getTemplate()

Returns an item stack snapshot for plugins to inspect this entry. The returned snapshot will match this entry. The size of the snapshot will always be 1.

Returns:

A snapshot that matches this entry