Class endstone::ItemMeta¶
ClassList > endstone > ItemMeta
Represents the metadata of a generic item.
#include <endstone/inventory/meta/item_meta.h>
Inherited by the following classes: endstone::MapMeta
Public Types¶
Type | Name |
---|---|
enum | Type |
Public Functions¶
Type | Name |
---|---|
ItemMeta (const ItemMeta * meta) |
|
bool | addEnchant (const std::string & id, int level, bool force=false) Adds the specified enchantment to this item meta. |
T * | as () |
const T * | as () const |
virtual std::unique_ptr< ItemMeta > | clone () const Creates a clone of the current metadata. |
int | getDamage () const Gets the damage. |
std::string | getDisplayName () const Gets the display name that is set. |
int | getEnchantLevel (const std::string & id) const Checks for the level of the specified enchantment. |
std::unordered_map< std::string, int > | getEnchants () const Returns a copy the enchantments in this ItemMeta . |
std::vector< std::string > | getLore () const Gets the lore that is set. |
int | getRepairCost () const Gets the repair penalty. |
virtual Type | getType () const Gets the type of this item meta. |
bool | hasDamage () const Checks to see if this item has damage. |
bool | hasDisplayName () const Checks for existence of a display name. |
bool | hasEnchant (const std::string & id) const Checks for existence of the specified enchantment. |
bool | hasEnchants () const Checks for the existence of any enchantments. |
bool | hasLore () const Checks for existence of lore. |
bool | hasRepairCost () const Checks to see if this has a repair penalty. |
virtual bool | isEmpty () const Checks if the item metadata is empty. |
bool | isUnbreakable () const Return if the unbreakable tag is true. An unbreakable item will not lose durability. |
bool | removeEnchant (const std::string & id) Removes the specified enchantment from this item meta. |
void | removeEnchants () Removes all enchantments from this item meta. |
void | setDamage (int damage) Sets the damage. |
void | setDisplayName (std::optional< std::string > name) Sets the display name. |
void | setLore (std::optional< std::vector< std::string > > lore) Sets the lore for this item or removes lore when given std::nullopt. |
void | setRepairCost (int cost) Sets the repair penalty. |
void | setUnbreakable (bool unbreakable) Sets the unbreakable tag. An unbreakable item will not lose durability. |
virtual | ~ItemMeta () = default |
Public Types Documentation¶
enum Type¶
Public Functions Documentation¶
function ItemMeta¶
function addEnchant¶
Adds the specified enchantment to this item meta.
Parameters:
id
Enchantment id to addlevel
Level for the enchantmentforce
this indicates the enchantment should be applied, ignoring the level limit
Returns:
true if the item meta changed as a result of this call, false otherwise
function as [½]¶
function as [2/2]¶
function clone¶
Creates a clone of the current metadata.
Returns:
A copy of the metadata containing the same state as the original.
function getDamage¶
Gets the damage.
Returns:
the damage
function getDisplayName¶
Gets the display name that is set.
Returns:
the display name that is set
function getEnchantLevel¶
Checks for the level of the specified enchantment.
Parameters:
id
enchantment id to check
Returns:
The level that the specified enchantment has, or 0 if none
function getEnchants¶
Returns a copy the enchantments in this ItemMeta .
Returns an empty map if none.
Returns:
An immutable copy of the enchantments
function getLore¶
Gets the lore that is set.
Returns:
a list of lore that is set
function getRepairCost¶
Gets the repair penalty.
Returns:
the repair penalty
function getType¶
Gets the type of this item meta.
Returns:
type of this item meta
function hasDamage¶
Checks to see if this item has damage.
Returns:
true if this has damage
function hasDisplayName¶
Checks for existence of a display name.
Returns:
true if this has a display name
function hasEnchant¶
Checks for existence of the specified enchantment.
Parameters:
id
enchantment id to check
Returns:
true if this enchantment exists for this meta
function hasEnchants¶
Checks for the existence of any enchantments.
Returns:
true if an enchantment exists on this meta
function hasLore¶
Checks for existence of lore.
Returns:
true if this has lore
function hasRepairCost¶
Checks to see if this has a repair penalty.
Returns:
true if this has a repair penalty
function isEmpty¶
Checks if the item metadata is empty.
Returns:
true if the metadata is empty, false otherwise.
function isUnbreakable¶
Return if the unbreakable tag is true. An unbreakable item will not lose durability.
Returns:
true if the unbreakable tag is true
function removeEnchant¶
Removes the specified enchantment from this item meta.
Parameters:
id
Enchantment id to remove
Returns:
true if the item meta changed as a result of this call, false otherwise
function removeEnchants¶
Removes all enchantments from this item meta.
function setDamage¶
Sets the damage.
Parameters:
damage
item damage
function setDisplayName¶
Sets the display name.
Parameters:
name
the name to set
function setLore¶
Sets the lore for this item or removes lore when given std::nullopt.
Parameters:
lore
the lore that will be set
function setRepairCost¶
Sets the repair penalty.
Parameters:
cost
repair penalty
function setUnbreakable¶
Sets the unbreakable tag. An unbreakable item will not lose durability.
Parameters:
unbreakable
true if set unbreakable
function ~ItemMeta¶
The documentation for this class was generated from the following file include/endstone/inventory/meta/item_meta.h