Skip to content

Commit 75366d4

Browse files
PseudoKnightPseudoKnight
committed
Update item meta documentation
1 parent 55c3e49 commit 75366d4

File tree

1 file changed

+148
-81
lines changed

1 file changed

+148
-81
lines changed

‎src/main/resources/functionDocs/get_itemmeta‎

Lines changed: 148 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,219 @@
11
array {[player,] slot} Returns an associative array of known item meta for the slot given, or null if there isn't any. ----
22

3-
Below are the available fields in the item meta array. Fields can be null when the item meta doesn't have that value.
4-
Some Minecraft NBT is not yet supported in item meta, and should be documented below.
3+
Below are the available fields in the item meta array. Most fields can be null when the item meta doesn't have that value.
4+
Some data is not yet supported in item meta, and should be documented below. In addition, as of 1.20.5, many of the new
5+
data components are not yet supported:
6+
7+
From 1.20.5+: "enchantment_glint_override", "food", "hide_tooltip", "instrument", "intangible_projectile", "item_name",
8+
"lock", "lodestone_tracker", "max_damage", "max_stack_size", "note_block_sound", "ominous_bottle_amplifier", "rarity",
9+
and "tool".
10+
11+
From 1.21.0+: "jukebox_playable".
12+
13+
From 1.21.2+: "consumable", "damage_resistant", "death_protection", "enchantable", "equippable", "item_model", "glider",
14+
"repairable", "tooltip_style", "use_cooldown", and "use_remainder".
15+
16+
From 1.21.4+: "custom_model_data" for anything other than a single float.
517

618
{| width="80%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
719
|-
8-
! scope="col" width="15%" | Item Type
9-
! scope="col" width="85%" | Meta
10-
|-
11-
| All
12-
|
13-
* '''display''' : (string) The display name seen when renamed in an anvil.
14-
* '''lore''' : (array) An array of strings that is displayed when hovering the item. As lines are plain text, they do not yet support some advanced text components.
15-
* '''enchants''' : (array) An associative array of enchantments with the vanilla name of enchantment as the key, and value being an enchantment array with the key '''"elevel"''' for the level of the enchantment.
16-
* '''model''' : (int) Represents vanilla's CustomModelData tag for use with resource packs.
17-
* '''flags''' : (array) A list of flags used to hide meta in the item tooltip: ''%ITEM_FLAGS%''.
18-
* '''repair''' : (int) The cost to repair or combine this item in an anvil.
19-
* '''modifiers''' : (array) An array of attribute modifier arrays, each with keys: '''"attribute"''', '''"operation"''', '''"amount"''' (double), '''"id"''' (optional), and '''"slot"''' (optional). Possible attributes: %ATTRIBUTES%. Possible operations: %OPERATIONS%. Possible slots are %SLOTS% or one of the slot groups %SLOTGROUPS%. An item can only have one modifier with the same id.
20-
* '''tags''' : (array) An associative array of custom tags used by plugins (or null). A tag's key is namespaced (e.g. "commandhelper:mytag") and the value is an associative array containing the '''"type"''' and '''"value"''' of the tag. Possible types: ''%TAG_TYPES%''.
21-
The "CanPlaceOn" tag for blocks and "CanDestroy" tag for tools are not yet supported.
22-
|-
23-
| All Damageable Items
20+
! scope="col" width="14%" | Item Type
21+
! scope="col" width="86%" | Meta
22+
|-
23+
! All
24+
|
25+
* '''display''' : (string) The display name seen when renamed in an anvil (or null).
26+
* '''lore''' : (array) An array of strings that is displayed when hovering the item (or null). As lines are plain text, they do not yet support some advanced text components, but color codes are supported.
27+
* '''enchants''' : (associative array) Defines enchantments with the vanilla name of enchantment as the key, and value being an enchantment array with the key "elevel" for the level of the enchantment. An integer for the level can be used as the value instead.
28+
* '''model''' : (int) Represents vanilla's CustomModelData tag for use with resource packs (or null). Is converted to a float for the custom_model_data component in 1.21.4+.
29+
* '''flags''' : (array) Flags used to hide meta in the item tooltip: %ITEM_FLAGS%.
30+
* '''repair''' : (int) The additional cost to repair or combine this item in an anvil.
31+
* '''modifiers''' : (array) An array of attribute modifier arrays (or null).
32+
* (associative array)
33+
* '''attribute''' : (string) One of %ATTRIBUTES%.
34+
* '''operation''' : (string) One of %OPERATIONS%.
35+
* '''amount''' : (double) The value used in the modifier operation.
36+
* '''id''' : (string) An item can only have one modifier with the same id.
37+
* '''slot''' : (string) Possible slots are %SLOTS% or one of the slot groups %SLOTGROUPS%.
38+
* '''tags''' : (associative array) Custom tags used by plugins (or null).
39+
* '''<custom_key>''' : (associative array) Each tag's key is namespaced (e.g. "commandhelper:mytag").
40+
* '''type''' : (string) Possible types: %TAG_TYPES%.
41+
* '''value''' : (mixed) A valid value for the given tag type.
42+
The "CanPlaceOn" tag for blocks and "CanDestroy" tag for tools in adventure mode are not yet supported.
43+
|-
44+
| Damageable Items
2445
|
2546
* '''damage''' : (int) The amount of damage on the item. 0 is undamaged. Maximum is determined by each item type's max durability.
2647
* '''unbreakable''' : (boolean) Whether or not the item can be damaged.
2748
|-
28-
| Armor Trim
49+
! Armor
2950
|
30-
* '''trim''' : (array) An array that contains the keys '''"pattern"''' and '''"material"'''. Pattern can be %TRIM_PATTERNS%. Material can be %TRIM_MATERIALS%. (MC 1.20+)
51+
* '''trim''' : (associative array) Defines an armor trim. (MC 1.20+)
52+
* '''pattern''' : Pattern can be %TRIM_PATTERNS%.
53+
* '''material''' : Material can be %TRIM_MATERIALS%.
3154
|-
32-
| AxolotlBucket
55+
! AxolotlBucket
3356
|
34-
* '''variant''' : (string) The type of axolotl, one of ''%AXOLOTL_TYPES%''. (MC 1.17+)
35-
The entity's custom name is derived from the item '''"display"''' string. All other axolotl NBT is not yet supported.
57+
* '''variant''' : (string) The type of axolotl, one of %AXOLOTL_TYPES%. (MC 1.17+)
58+
The entity's custom name is derived from the item "display" string. All other axolotl NBT is not yet supported.
3659
|-
37-
| Banners
60+
! Banners
3861
|
39-
* '''patterns''' : (array) An array of pattern arrays. Each can contain the keys '''"color"''' (one of ''%DYE_COLORS%'') and '''"shape"''' (one of ''%PATTERN_SHAPES%'').
62+
* '''patterns''' : (array) An array of pattern associative arrays for each layer.
63+
* (associative array)
64+
* '''color''' : One of %DYE_COLORS%.
65+
* '''shape''' : One of %PATTERN_SHAPES%.
4066
|-
41-
| Bee Hives/Nests
67+
! Bee Hives/Nests
4268
|
4369
* '''beecount''' : (int) The number of bees stored in this hive or nest (0 - 3). (requires MC 1.20.6+ to set)
4470
Stored Bee NBT is not yet supported.
4571
|-
46-
| BlockData
72+
! BlockData
4773
|
48-
* '''blockdata''' : (array) An array of blockdata (known as block states in vanilla) like is returned from get_blockdata(), or null if none.
74+
* '''blockdata''' : (associative array) Block data, also known as block states in vanilla, like is returned from get_blockdata() (or null).
75+
* '''block''' : (string) Block material name
76+
* '''<state_name>''' : (int, boolean, string) The state value.
77+
Only returns specified states as of 1.20.6. Prior versions return all states. Can only set specific states without defaults as of 1.21.3.
4978
|-
50-
| Books
79+
! Books
5180
|
5281
* '''title''' : (string) The title of the book. (32 character limit)
5382
* '''author''' : (string) The author of the book.
5483
* '''pages''' : (array) An array of pages as strings. New lines supported. (100 page limit)
5584
* '''generation''' : (string) The generation of the book. Can be ORIGINAL, COPY_OF_ORIGINAL, COPY_OF_COPY, or TATTERED (the last two cannot be copied).
5685
As pages are plain text, they do not yet support some advanced text components.
5786
|-
58-
| Brewing Stands
87+
! Brewing Stands
5988
|
6089
* '''brewtime''' : (int) The amount of time left in ticks before brewing completes.
6190
* '''fuel''' : (int) The amount of fuel left.
62-
* '''inventory''' : (array) An associative array with the slots for '''"fuel"''', '''"ingredient"''', '''"leftbottle"''', '''"middlebottle"''', and '''"rightbottle"'''.
91+
* '''inventory''' : (associative array) Defines items in each slot
92+
* '''fuel''' : (item array) The item that will consumed when brewing stand fuel is empty. Typically blaze powder or null.
93+
* '''ingredient''' : (item array) The top slot item ingredient or null.
94+
* '''leftbottle''' : (item array) Bottle slots are typically a type of potion or null, but can also be a glass bottle.
95+
* '''middlebottle''' : (item array)
96+
* '''rightbottle''' : (item array)
6397
|-
64-
| Bundle
98+
! Bundle
6599
|
66100
* '''items''' : (array) An array of item arrays that exist in this bundle. (MC 1.17+)
67101
|-
68-
| CommandBlocks
102+
! CommandBlocks
69103
|
70104
* '''command''' : (string) The command set for this commandblock.
71105
* '''customname''' : (string) The name of this commandblock. (default: '@')
72106
The remaining tags are not yet supported.
73107
|-
74-
| Compass
108+
! Compass
75109
|
76-
* '''target''' : (array) The location this compass will point to, or null to use normal compass target.
110+
* '''target''' : (associative array) The location this compass will point to, or null to use normal compass target.
77111
* '''lodestone''' : (boolean) If the target location is a tracked lodestone. If true, compass spins if no lodestone exists there.
78112
|-
79-
| Crossbows
113+
! Crossbows
80114
|
81115
* '''projectiles''' : (array) An array of item arrays that are loaded in the crossbow. Items must be arrows or fireworks. When fired, the first item is the middle projectile. (maximum of three projectiles)
82116
|-
83-
| Decorated Pots
117+
! Decorated Pots
84118
|
85-
* '''sherds''' : (array) An associative array of pottery sherds for the '''"front"''', '''"back"''', '''"left"''', and '''"right"''' sides of the decorated pot. Brick is used for empty sides.
86-
* '''item''' : (array) An item array for the stack contained in the decorated pot, or null if empty. (MC 1.20.4+)
119+
* '''sherds''' : (associative array) Pottery sherds for each side of the decorated pot.
120+
* '''front''' : (string) Can only be a sherd material name or brick if empty.
121+
* '''back''' : (string)
122+
* '''left''' : (string)
123+
* '''right''' : (string)
124+
* '''item''' : (associative array) An item array for the stack contained in the decorated pot, or null if empty. (MC 1.20.4+)
87125
|-
88-
| Enchanted Books
126+
! Enchanted Books
89127
|
90-
* '''stored''' : (array) An associative array of enchantments, just like "enchants".
128+
* '''stored''' : (associative array) An array of enchantments, in the same format as "enchants".
91129
|-
92-
| Firework Charges
130+
! Firework Star
93131
|
94-
* '''effect''' : (array) A firework effect array, can have the keys '''"flicker"''' (boolean), '''"trail"''' (boolean), '''"type"''' (one of ''%FIREWORK_TYPES%''), '''"colors"''' (array of color names or color arrays), and '''"fade"''' (array of color names or color arrays).
132+
* '''effect''' : (associative array) A firework star effect that can be used to craft fireworks
133+
* '''flicker''' : (boolean) Whether the sparks twinkle and pop. (default: false)
134+
* '''trail''' : (boolean) Whether the sparks leave particle trails. (default: false)
135+
* '''type''' : (string) One of %FIREWORK_TYPES%. (default: BALL)
136+
* '''colors''' : (array) The starting colors of the sparks as multiple color arrays. (can use color names; can be set to one color) (default: WHITE)
137+
* '''fade''' : (array) The ending colors of the sparks as multiple color arrays. (can use color names; can be set to one color)
95138
|-
96-
| Fireworks
139+
! Firework Rockets
97140
|
98-
* '''firework''' : (array) An array with the keys '''"strength"''' (int), how long in seconds the rocket will last, and '''"effects"''', an array of effect arrays (see Firework Charges).
141+
* '''firework''' : (associative array) A firework rocket's attributes.
142+
* '''strength''' : (int) How long in seconds the rocket will last. (-1 for instant detonation)
143+
* '''effects''' : (array) Multiple firework star effect arrays. (see Firework Star above)
99144
|-
100-
| Furnaces
145+
! Furnaces
101146
|
102147
* '''burntime''' : (int) The amount of time left in ticks before the furnace extinguishes.
103148
* '''cooktime''' : (int) The amount of time in ticks the item has been cooking for.
104-
* '''inventory''' : (array) An associative array with the slots for '''"result"''', '''"fuel"''', and '''"smelting"'''.
149+
* '''inventory''' : (associative array) Defines items in each slot
150+
* '''result''' : (associative array) The resulting smelted item, or null.
151+
* '''fuel''' : (associative array) The item stack that will be consumed when "burntime" reaches zero, or null.
152+
* '''smelting''' : (associative array) The current item stack being smelted, or null.
105153
|-
106-
| GoatHorns
154+
! GoatHorns
107155
|
108156
* '''instrument''' : (string) The instrument name (can be ponder_goat_horn, sing_goat_horn, seek_goat_horn, feel_goat_horn, admire_goat_horn, call_goat_horn, yearn_goat_horn, dream_goat_horn). (MC 1.19.3+)
109157
|-
110-
| Inventory Blocks
158+
! Inventory Blocks
111159
|
112-
* '''inventory''' : (array) An array of item arrays, where each index is an inventory slot. (exceptions exist for furnaces and brewing stands)
160+
* '''inventory''' : (associative array) An array of item arrays, where each existing index is an inventory slot. (exceptions exist for furnaces and brewing stands)
113161
|-
114-
| Knowledge Books
162+
! Knowledge Books
115163
|
116164
* '''recipes''' : (array) A list of namespaced recipe keys. (or null)
117165
|-
118-
| Leather Armor
166+
! Leather Armor
119167
|
120-
* '''color''' : (array) A color array, with '''"r"''', '''"g"''', and '''"b"''' keys that have values ranging from 0 to 255.
168+
* '''color''' : (associative array) An RGB color array for the dye in the leather armor.
169+
* '''r''' : (int) Red value ranging from 0 to 255
170+
* '''g''' : (int) Green value
171+
* '''b''' : (int) Blue value
121172
|-
122-
| Maps
173+
! Filled Maps
123174
|
124175
* '''mapid''' : (int) The unique id for a map on the server.
125-
* '''color''' : (array) An array of the map item's color, with '''"r"''', '''"g"''', and '''"b"''' keys that have values ranging from 0 to 255.
176+
* '''color''' : (associative array) An RGB color array for the ink used on the map item.
177+
* '''r''' : (int) Red value ranging from 0 to 255
178+
* '''g''' : (int) Green value
179+
* '''b''' : (int) Blue value
126180
|-
127-
| Player Heads
181+
! Player Heads
128182
|
129183
* '''owner''' : (string) The user name. Can be null if there is no owner.
130184
* '''owneruuid''' : (string) The user UUID. Can be null if there is no owner.
131185
* '''texture''' : (string) The texture property value used for custom heads. This is a base64 encoded JSON object seen under the "Value" key in vanilla. It contains the skin texture URL among other things. Requires an owner. (Paper only)
132186
|-
133-
| Potions
134-
|
135-
* '''potiontype'''' : (string) The base potion type, which can be one of: ''%POTION_TYPES%''. (MC 1.20.6+)
136-
* '''base''' : (array) Defined a base potion. Had the keys '''"extended"''', '''"upgraded"''', and '''"type"'''. This was used prior to MC 1.20.6 and is converted in later versions.
137-
* '''potions''' : (array) An associative array of custom potion effect arrays, where each key is the vanilla potion effect name. Each effect array can contain the keys: '''"id"''' (int), '''"strength"''' (int), '''"seconds"''' remaining (int), whether the effect is '''"ambient"''', whether '''"particles"''' are enabled, and whether the '''"icon"''' is shown to the player.
138-
* '''color''' : (array) A color array, with '''"r"''', '''"g"''', and '''"b"''' keys that have values ranging from 0 to 255.
139-
|-
140-
| Suspicious Stew
141-
|
142-
* '''potions''' : (array) An associative array identical to the one for potion meta.
143-
|-
144-
| Shields
145-
|
146-
* '''basecolor''' : (string) A color name, one of ''%DYE_COLORS%''.
187+
! Potions
188+
|
189+
* '''potiontype''' : (string) The base potion type, which can be one of: %POTION_TYPES%. (MC 1.20.6+)
190+
* '''base''' : (associative array) Legacy base potion effect. This was used prior to MC 1.20.6 and is converted in later versions. Use "potiontype" on later versions.
191+
* '''extended''' : (boolean)
192+
* '''upgraded''' : (boolean)
193+
* '''type''' : (string)
194+
* '''potions''' : (associative array) A list of effects that get applied with this potion.
195+
* '''<effect_name>''' : (associative array)
196+
* '''id''' : (int) Legacy effect id. Only used if potions array is not associative.
197+
* '''strength''' : (int) The level of the potion effect, starting with zero. (default: 0)
198+
* '''seconds''' : (int) The number of seconds the effect lasts for. (default: 30)
199+
* '''ambient''' : (boolean) Whether the particles are more transparent. (default: false)
200+
* '''particles''' : (boolean) Whether the particles are visible at all. (default: true)
201+
* '''icon''' : (boolean) Whether the effect icon is visible for the player. (default: true)
202+
* '''color''' : (array) An RGB color array for the tint of the potion item.
203+
* '''r''' : (int) Red value ranging from 0 to 255
204+
* '''g''' : (int) Green value
205+
* '''b''' : (int) Blue value
206+
|-
207+
! Suspicious Stew
208+
|
209+
* '''potions''' : (associative array) See potion meta.
210+
|-
211+
! Shields
212+
|
213+
* '''basecolor''' : (string) A color name, one of %DYE_COLORS%.
147214
* '''patterns''' : (array) See Banner "patterns".
148215
|-
149-
| Signs
216+
! Signs
150217
|
151218
* '''signtext''' : (array) An array of 4 strings, one for each line of text on the front.
152219
* '''color''' : (string) The dye color for the text on the front. (default: 'BLACK')
@@ -156,26 +223,26 @@ The remaining tags are not yet supported.
156223
* '''backglowing''' : (boolean) Whether the sign has glowing text on the back. (MC 1.20+)
157224
* '''waxed''' : (boolean) Whether the sign is waxed. (MC 1.20.1+)
158225
|-
159-
| Spawn Eggs
226+
! Spawn Eggs
160227
|
161-
The entity's custom name is derived from the item '''"display"''' string. Additional NBT for the entity spawned is not supported.
228+
The entity's custom name is derived from the item "display" string. Additional NBT for the entity spawned is not supported.
162229
|-
163-
| Spawners
230+
! Spawners
164231
|
165-
* '''spawntype''' : (string) May be one of ''%ENTITY_TYPES%''. Not all entity types will spawn from spawners, and some require special conditions.
232+
* '''spawntype''' : (string) May be one of %ENTITY_TYPES%. Not all entity types will spawn from spawners, and some require special conditions.
166233
* '''delay''' : (int) The time in ticks until the spawner will spawn the next batch of entities.
167-
* '''mindelay''' : (int) The lower bounds of a new random delay chosen after each batch of entities spawn. (must be <= 'maxdelay')
234+
* '''mindelay''' : (int) The lower bounds of a new random delay chosen after each batch of entities spawn. (must be <= "maxdelay")
168235
* '''maxdelay''' : (int) The upper bounds of a new random delay. (must be above zero and >= mindelay)
169236
* '''spawncount''' : (int) The number of entities to attempt to spawn in each batch.
170-
* '''maxnearbyentities''' : (int) The number of 'spawntype' entities within just over 'spawnrange' distance that'll prevent further spawns.
237+
* '''maxnearbyentities''' : (int) The number of "spawntype" entities within just over "spawnrange" distance that'll prevent further spawns.
171238
* '''spawnrange''' : (int) The maximum distance in the x or z axis new entities will spawn from the spawner.
172239
* '''playerrange''' : (int) The maximum distance a player must be within to cause the spawner to spawn.
173240
NBT for spawn potentials other than entity type is not yet supported.
174241
|-
175-
| Tropical Fish Bucket
242+
! Tropical Fish Bucket
176243
|
177-
* '''fishcolor''' : (string) The color of the fish, can be one of ''%DYE_COLORS%''.
244+
* '''fishcolor''' : (string) The color of the fish, can be one of %DYE_COLORS%.
178245
* '''fishpatterncolor''' : (string) The color of the pattern on the fish.
179-
* '''fishpattern''' : (string) The pattern type on the fish, can be one of ''%FISH_PATTERNS%''.
180-
The entity's custom name is derived from the item '''"display"''' string. All other tropical fish NBT is not yet supported.
246+
* '''fishpattern''' : (string) The pattern type on the fish, can be one of %FISH_PATTERNS%.
247+
The entity's custom name is derived from the item "display" string. All other tropical fish NBT is not yet supported.
181248
|}

0 commit comments

Comments
 (0)