NBT
Index
Namespaces
Classes
Namespaces
Templates
Templates to typofication of resulted CompoundTag.toScriptable,
which is used to determine containment of tags.
Not includes structure .nbt
, only in-game definitions.
BannerBlockEntity
Banner with ID = 28
.
Base
Index of banner color, where 0
is white; block palettes are same.
optionalPatterns
Patterns to be applied on Base color.
Type
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
BannerPatternEntry
Flattened hieracly, extendable in declarations.
Color
Index of pattern color, where 0
is white; block palettes are same.
Pattern
Pattern shortcut name, such as "gra"
, "mc"
, etc.
BarrelBlockEntity
Barrel with ID = 42
.
Findable
Exploration map can be pointed here, tract as treasure.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
optionalLootTable
Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json"
.
optionalLootTableSeed
Randomly generated seed to determine containment.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
BeaconBlockEntity
Beacon with ID = 21
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
primary
0
means none, 1
speed, 2
haste, 3
resistance, 4
jump boost and 5
strength.
secondary
0
means none, 1
regeneration and 2
boost primary effect.
x
y
z
BedBlockEntity
Bed with ID = 27
.
color
Index of bed color, where 0
is white; block palettes are same.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
BeehiveBlockEntity
Beehive (Beehive / Bee Nest) with ID = 43
.
optionalOccupants
Bees. Theoretically, any entity may enter and leave onto beehive.
ShouldSpawnBees
Naturally generated beehives summon bees inside, before player encounters them.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
BeehiveBlockEntityOccupant
Flattened hieracly, extendable in declarations.
ActorIdentifier
Typed entity identifier with tags, such as "minecraft:bee<>"
.
SaveData
Entity NBTs; properties, attributes, definitions, etc.
TicksLeftToStay
Countdown before entity left beehive in ticks.
BellBlockEntity
Bell with ID = 40
.
Direction
There is 2 surface (such as 1
), 4 on side and 1 at top (255
) locations.
Ringing
Whether sound is playing.
Ticks
Ringing counter, determines animation of bell.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
BlastFurnaceBlockEntity
BlastFurnace (Blast Furnace) with ID = 38
.
BurnDuration
Currently burning fuel (appears in slot 1
) total time in ticks (e.g. coal burns in 1600
ticks) before burning completed.
BurnTime
Counter to BurnDuration, when them equals furnace unlit.
CookTime
Currently smelting item (appears in slot 0
) progress, result will be presented in slot with index 2
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
StoredXPInt
Accumulated experience, it will be dropped when result taken or furnace digged.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
Block
Flattened hieracly, extendable in declarations.
name
states
version
Database tracking identifier (in 1.16 equals 17825808
).
BlockState
Flattened hieracly, extendable in declarations.
BrewingStandBlockEntity
BrewingStand (Brewing Stand) with ID = 8
.
CookTime
Every potion cooks on same time ticks, counter.
When next ingredient is done, every potion in slots 1
-3
obtains tag "wasJustBrewed" = true
.
FuelAmount
Fuel left of FuelTotal property, when it comes to zero
next charge from slot 4
was used.
FuelTotal
When fuel was taken from slot changes to it capacity, now availabled
only "minecraft:blaze_powder"
(name
property), which sets fuel to 20
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
CampfireBlockEntity
Campfire (Campfire / Soul Campfire) with ID = 41
.
optionalItem1
Item that will be smelted on campfire.
optionalItem2
Item that will be smelted on campfire.
optionalItem3
Item that will be smelted on campfire.
optionalItem4
Item that will be smelted on campfire.
ItemTime1
Ticks counter of smelting item.
ItemTime2
Ticks counter of smelting item.
ItemTime3
Ticks counter of smelting item.
ItemTime4
Ticks counter of smelting item.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
CauldronBlockEntity
Cauldron with ID = 16
.
optionalCustomColor
Packed RGB color, one of my favorites is -75715
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
PotionId
One of EPotionEffect enum values.
But... Maybe try <enum value> - 1
?
PotionType
Level of strength, value between 0
and 255
(more buggy to 32768
).
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
ChemistryTableBlockEntity
ChemistryTable (Chemistry Equipment) with ID = 34
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
optionalitemAux
Brewing item data, that will be transpiled into materials, such as 17
, etc.
optionalitemId
Brewing item numeric ID, that will be transpiled into materials, such as 583
, etc.
optionalitemStack
Brewing item count, that will be transpiled into materials, such as 1
, etc.
x
y
z
ChestBlockEntity
Chest (Chest / Trapped Chest) with ID = 0
.
Findable
Exploration map can be pointed here, tract as treasure.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
optionalLootTable
Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json"
.
optionalLootTableSeed
Randomly generated seed to determine containment.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
optionalpairlead
If there's sometime created connection with double-chest.
optionalpairx
optionalpairz
x
y
z
CommandBlockEntity
CommandBlock (Command Block) with ID = 26
.
Command
Command to be executed here, such as /playanimation \@e[type=!minecraft:player] animation.humanoid.celebrating null 20
.
CustomName
Like nametag, but above command block; hovering text.
ExecuteOnFirstTick
When LPCommandMode is set to cycled and conditions are done, first command executes without TickDelay.
LPCommandMode
0
means impulse (single activation), 1
chain (activation when pointed to chain command block executed) and 2
cycled (forever execution between delay with condition checking).
LPConditionalMode
0
means statement, 1
doesn't care about result.
LPRedstoneMode
0
means always active, 1
requires redstone.
LastExecution
When last execution has been performed.
LastOutput
Message recorded with last execution, requires TrackOutput to be set to true
.
LastOutputParams
Splitted to command parts without first slash (or symbol if slash is not provided), requires TrackOutput to be set to true
.
SuccessCount
TickDelay
Delay in ticks between executions (cycled blocks) or before starting it.
TrackOutput
Save last execution command results.
Version
Database tracking identifier (in 1.16 equals 13
).
auto
conditionMet
Condition right now is true
?
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
powered
Redstone signal found?
x
y
z
ComparatorBlockEntity
Comparator (Redstone Comparator) with ID = 12
.
OutputSignal
Redstone power, value between 0
and 15
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
ConduitBlockEntity
Conduit with ID = 35
.
Active
Whether conduit constructed or not, underwater monument blocks come out to help.
Target
Entity UID to protect players in water nearest, attacks monsters when fully constructed.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
DaylightDetectorBlockEntity
DaylightDetector (Daylight Sensor) with ID = 10
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
DispenserBlockEntity
Dispenser with ID = 13
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
DropperBlockEntity
Dropper with ID = 14
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
EnchantTableBlockEntity
EnchantTable (Enchanting Table) with ID = 9
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
rott
Rotation angle in radians between -Math.PI
and Math.PI
.
x
y
z
EndGatewayBlockEntity
EndGateway (End Gateway) with ID = 24
.
Age
Counter, that drops when entity moves through portal. Used to display purple beacon in portal for few hundred ticks.
ExitPortal
XYZ coordinates of place portal transfers to.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
EndPortalBlockEntity
EndPortal (End Portal) with ID = 22
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
EnderChestBlockEntity
EnderChest (Ender Chest) with ID = 23
.
Findable
Exploration map can be pointed here, tract as treasure.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
optionalLootTable
Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json"
.
optionalLootTableSeed
Randomly generated seed to determine containment.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
Entity
Flattened hieracly, extendable in declarations.
optionalAge
Countdown in ticks before entity become adult.
Air
Countdown in ticks before entity start drowning.
Armor
Helmet, Chestplate, Leggings, Boots. Accessible by index, not marked with Slot
property.
AttackTime
Last attack tick, determines time between attacks.
Attributes
Entity attributes, such as "minecraft:health"
, "minecraft:follow_range"
, etc.
BodyRot
Entity body yaw rotation in degrees, with offset of Rotation.
Chested
Llama or mule equipped chests.
Color
Color2
Dead
Entity is dead, which is required to visualize animation of dying.
DeathTime
Tick when entity become dead (health <= 0).
FallDistance
Last synchronized distance between ground and entity.
Fire
Fire ticks before burning stopped, alternative of Entity.setFire.
HasExecuted
HomeDimensionId
HomePos
HurtTime
Last hurt tick, determines entity panic/attack state.
Invulnerable
Immune to in-game damage types, such as NPCs and Agents.
IsAngry
Normally, entity become angry when attacked.
IsAutonomous
Entity can move, alternative of Entity.setMobile.
IsBaby
Entity is not adult, so when Age reaches 0
it is not baby.
IsEating
Entity is eating Mainhand item, displays particles around.
IsGliding
Entity is using elytra (to glide).
IsGlobal
IsIllagerCaptain
Patrols of pillagers following their leader.
IsOrphaned
IsOutOfControl
IsPregnant
Entity breeded and prepared to duplicate itself, such as turtles.
IsRoaring
IsScared
Entity sees dangerous thing around, such as villagers flee.
IsStunned
IsSwimming
Entity is standing on water.
IsTamed
Entity is tamed, such as cats or dogs.
IsTrusting
Entity is trusting player (do not panic when it came), such as foxes childs breeded by someone.
LastDimensionId
Dimension from entity transfered when is going to portal, last saved state when loaded into dimension.
LeasherID
Leashed with knot entity (normally, player).
LootDropped
Required on first death tick, drops loot again if set to false
.
LoveCause
Mainhand
Item set by Entity.setCarriedItem, entities uses it for attack and other AI-related things.
MarkVariant
Motion
Velocity of physics in-world, vector of moving target.
NaturalSpawn
Entity is naturally spawned, not breeded or summoned.
Offhand
Item set by Entity.setOffhandItem, in common cases entities ignores it, but players or extra-powered items (Totem of Undying fully restores non-player entities health) are useful.
OnGround
Entity is standing on landing.
OwnerNew
Projectile shooter entity UID.
Persistent
Entity can not be despawned.
PortalCooldown
Ticks before entity can move through portal again.
Pos
XYZ absolute coordinates, alternative of Entity.setPosition.
Rotation
Yaw (horizontal rotation angle) and pitch (vertical rotation angle) respectively in degrees, alternative of Entity.setLookAngle.
Saddled
When pig or strider is saddled (excludes horses or not?).
Sheared
When sheep or snow golem is sheared.
ShowBottom
Sitting
Entity is sitting, such as players or foxes.
SkinID
Strength
StrengthMax
Surface
Tags
TargetID
Following, attacking or anything else targeted entity.
TimeStamp
Tick when entity is born, used to limitedLife property.
TradeExperience
TradeTier
UniqueID
Entity UID, which is passed to Inner Core callbacks.
Variant
boundX
boundY
boundZ
canPickupItems
Entity may equip, take or replace containing item from drop.
definitions
Set of rules applied (starts with +
) or excluded (starts with -
)
from entity; it includes properties, tasks, etc.
hasBoundOrigin
hasSetCanPickupItems
identifier
Typed entity identifier without tags, such as "minecraft:cow"
.
limitedLife
Ticks after TimeStamp when entity become Dead.
EntityAttribute
Flattened hieracly, extendable in declarations.
Base
Current
DefaultMax
DefaultMin
Max
Min
Name
One of Entity.Attribute or your custom one.
FlowerPotBlockEntity
FlowerPot (Flower Pot) with ID = 7
.
optionalPlantBlock
Anything in particular, my cat preferr "minecraft:brown_mushroom"
(name
property).
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
FurnaceBlockEntity
Furnace with ID = 1
.
BurnDuration
Currently burning fuel (appears in slot 1
) total time in ticks (e.g. coal burns in 1600
ticks) before burning completed.
BurnTime
Counter to BurnDuration, when them equals furnace unlit.
CookTime
Currently smelting item (appears in slot 0
) progress, result will be presented in slot with index 2
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
StoredXPInt
Accumulated experience, it will be dropped when result taken or furnace digged.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
HopperBlockEntity
Hopper with ID = 2
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
TransferCooldown
Ticks counter before transfering to watching side or down if hoppers unlocked.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
IBlockEntity
Flattened hieracly, extendable in declarations.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
IContainerBlockEntity
Flattened hieracly, extendable in declarations.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
IFurnaceBlockEntity
Flattened hieracly, extendable in declarations.
BurnDuration
Currently burning fuel (appears in slot 1
) total time in ticks (e.g. coal burns in 1600
ticks) before burning completed.
BurnTime
Counter to BurnDuration, when them equals furnace unlit.
CookTime
Currently smelting item (appears in slot 0
) progress, result will be presented in slot with index 2
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
StoredXPInt
Accumulated experience, it will be dropped when result taken or furnace digged.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
ILootableBlockEntity
Flattened hieracly, extendable in declarations.
Findable
Exploration map can be pointed here, tract as treasure.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
optionalLootTable
Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json"
.
optionalLootTableSeed
Randomly generated seed to determine containment.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
Item
optionalBlock
Count
Amount of item in slot.
Damage
Dealed damage, when it comes to Item.getMaxDamage item will be broken.
Name
Typed identifier, such as "minecraft:stick"
.
optionalSlot
Indexed slot, required in containers with more than one slots.
WasPickedUp
Picked up by entity, denies despawn it naturally.
optionaltag
Additional data, such as nametags, enchantments, etc.
ItemFilledMapTag
Flattened hieracly, extendable in declarations.
optionalench
List of applied enchantments in index-numeral sorting.
map_display_players
Whether map should display compasses for players or not.
map_name_index
Displayed for players map number, starts with 1
.
map_uuid
UID to be taken from world NBT.
ItemFrameBlockEntity
ItemFrame (Item Frame) with ID = 17
.
optionalItem
Item to be displayed in frame, tag doesn't exist by default.
optionalItemDropChance
Percent value between 0
and 1
; everything just cool when elytra
drops with chance 0.01
.
optionalItemRotation
Rotation angle in degress between 0
and 315
(with in-game step 45
).
Also changes comparator strength, triggers observers.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
ItemTag
Flattened hieracly, extendable in declarations.
optionalench
List of applied enchantments in index-numeral sorting.
ItemTagEnchantment
Flattened hieracly, extendable in declarations.
id
One of EEnchantment enum values.
lvl
Level of strength, value between 0
and 255
(more buggy up to 32768
).
ItemWritableBookTag
Flattened hieracly, extendable in declarations.
optionalauthor
Written book author, assigned when signing book.
optionalench
List of applied enchantments in index-numeral sorting.
optionalgeneration
Number of written copy, 0
means original.
pages
List of created pages in index-numeral sorting.
optionaltitle
Written book title, assigned when signing book.
optionalxuid
Linked teacher book, especially for Education Edition.
ItemWritableBookTagPage
Flattened hieracly, extendable in declarations.
photoname
Screenshot shotted on server (appears in pause menu), specially based on Education Edition.
text
Text placed on page as-is (with new lines \n
).
JigsawBlockEntity
JigsawBlock (Jigsaw Block) with ID = 36
.
final_state
Typed block identifier (includes state support such as [facing=east]
) to be replaced when jigsaw activated.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
joint
Connection between jigsaw nodes, as-is.
name
Associated structure name, jigsaw identifier, such as "template:bundle"
.
target
Required structure subset to be aligned with, such as, such as "template:pipe"
.
target_pool
Pool in which jigsaws will be connected with each others, such as "template:bundle/pipe"
.
x
y
z
JukeboxBlockEntity
Jukebox with ID = 33
.
optionalRecordItem
Record disc that will be played, what about "minecraft:music_disc_strad"
(name
property).
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
LecternBlockEntity
Lectern with ID = 37
.
optionalbook
Standing book item, tag determines book placement.
optionalhasBook
If book is placed, observer detects changed block.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
optionalpage
Index of page opened on lectern, redstone comparator obtains power page / totalPages * 15
.
optionaltotalPages
Total pages counted in book.
x
y
z
LodestoneBlockEntity
Lodestone with ID = 44
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
trackingHandle
Compass points to this lodestone.
x
y
z
MobSpawnerBlockEntity
MobSpawner (Spawner) with ID = 5
.
Delay
Ticks before spawning next entity.
DisplayEntityHeight
Placeholder animation in spawner height, constant.
DisplayEntityScale
Placeholder animation in spawner size relative to block itself.
DisplayEntityWidth
Placeholder animation in spawner width, constant.
EntityIdentifier
Typed entity identifier, such as "minecraft:enderman"
.
MaxNearbyEntities
Maximum containment mobs in SpawnRange, if here are more spawner just emitting particles.
MaxSpawnDelay
Maximum time in ticks between mob spawing.
MinSpawnDelay
Minimum time in ticks between mob spawing.
RequiredPlayerRange
Anyone (of players) must be near to spawner, otherwise spawner hides placeholder animation and stops.
SpawnCount
Maximum spawning limit, not everyone may spawned with each other when place above comes to zero.
SpawnRange
Ranged AABB box where entities became.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
MovingBlockEntity
MovingBlock (Moving Block) with ID = 19
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
movingBlock
Block to be rendered as moving, let give a try with a "minecraft:cake"
(name
property).
movingBlockExtra
Block to be rendered as moving above movingBlock, let give a try with a "minecraft:flowing_lava"
(name
property).
pistonPosX
If block connected with a sticky piston, it will appears here.
pistonPosY
If block connected with a sticky piston, it will appears here.
pistonPosZ
If block connected with a sticky piston, it will appears here.
x
y
z
MusicBlockEntity
Music (Note Block) with ID = 11
.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
note
Number between 0
and 24
, which changes note tone.
x
y
z
NetherReactorBlockEntity
NetherReactor (Nether Reactor Core) with ID = 3
.
HasFinished
IsInitialized
Progress
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
PistonArmBlockEntity
PistonArm (Piston) with ID = 18
.
AttachedBlocks
Blocks attached to piston (excluding head) with slime and honey blocks.
BreakBlocks
Blocks prevents piston from moving, such as obsidian.
LastProgress
Latest successfully changed state progress, which determine piston movement.
NewState
Required by redstone state, if nothing blocking way, piston moves.
Progress
Percent between 0
and 1
(with in-game step 0.5
), where 1
means activated.
State
Currently state, 0
means pulled, 1
moving and 2
pushed.
Sticky
Whether piston crafted with slime and can transfer blocks back.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
ShulkerBoxBlockEntity
ShulkerBox (Shulker Box) with ID = 25
.
Findable
Exploration map can be pointed here, tract as treasure.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
optionalLootTable
Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json"
.
optionalLootTableSeed
Randomly generated seed to determine containment.
facing
One of EBlockSide enum values.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
SignBlockEntity
Sign with ID = 4
.
optionalColor
Basic text color, EColor.RESET restores it.
Text
Written text, delimited with newlines (\n
, it may be more than 4 lines, but not rendered in-world).
TextOwner
No. Owners. Constant.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
SkullBlockEntity
Skull (Mob Head) with ID = 6
.
MouthMoving
Whether dragon mouth powered by redstone.
MouthTickCount
Cycling time in ticks, between full-cycled move down and up.
Rotation
Rotation angle in degrees, value between 22.5
and 180
(with in-game step 22.5
).
SkullType
0
means skeleton, 1
wither skeleton, 2
zombie, 3
player, 4
creeper and 5
ender dragon.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
SmokerBlockEntity
Smoker with ID = 39
.
BurnDuration
Currently burning fuel (appears in slot 1
) total time in ticks (e.g. coal burns in 1600
ticks) before burning completed.
BurnTime
Counter to BurnDuration, when them equals furnace unlit.
CookTime
Currently smelting item (appears in slot 0
) progress, result will be presented in slot with index 2
.
Items
Contained slots, which is stored in numeral-index sorting starting with zero.
StoredXPInt
Accumulated experience, it will be dropped when result taken or furnace digged.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
x
y
z
StructureBlockEntity
StructureBlock (Structure Block) with ID = 32
.
data
Mode of structure block; 0
means load, 1
data (consumed by pools), 2
save.
dataField
Metadata to be passed when data is set to data mode.
id
Typed identifier, such as "Chest"
, "Beacon"
, etc.
ignoreEntities
Load or save NBT data of entities contained in bounds, existing data will be omitted.
includePlayers
Load or save NBT data of players contained in bounds.
integrity
Lower values destructs more random selected blocks.
isMovable
Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).
isPowered
Powered by redstone signal?
mirror
0
means no mirroring, 1
mirror above x, 2
mirror above y, 3
mirror above z
redstoneSaveMode
0
means save signal power (lit lamps, redstone itself, etc.), 1
forget (unlit sources will be updated when structure is placed).
removeBlocks
Blocks will be merged (with structure air as real air) or pasted as-is.
rotation
0
means no rotation, 1
90 degress, 2
180 degress, 3
270 degress.
seed
Seed to be passed when configuring integrity
showBoundingBox
Display bounds of structure in-world, includes vertex frame above.
structureName
Vanilla or behavior pack namespaced (first directory determines namespace, subfolders joined with .
) relative path to structure, try something like "minecraft:endcity.ship"
.
x
xStructureOffset
xStructureSize
y
yStructureOffset
yStructureSize
z
zStructureOffset
zStructureSize
Classes
CompoundTag
List tags represent NBT map-like data structure (key-value pairs). it's values may be of any type, so check the type before calling the appropriate getter.
constructor
Creates a new compound tag.
Returns CompoundTag
clear
Removes all the tags from the compound tags.
Returns void
contains
Parameters
key: string
Returns boolean
true
if specified key exists in compound tag.
containsValueOfType
Parameters
key: string
key to verify for the type
type: number
tag type to verify for, one of the ENbtDataType constants
Returns boolean
true
if specified key exists in compound tag and it's value is of specified type.
getAllKeys
Returns Array<string>
Java-array containing all the keys of the compound tag.
getByte
Parameters
key: string
Returns number
NBT tag of byte type by it's key.
getCompoundTag
Parameters
key: string
Returns CompoundTag
NBT tag of compound type by it's key. Note that a copy of existing compound tag is created so you cannot edit it directly. Use setCompoundTag method to apply changes or use getCompoundTagNoClone to edit it directly.
getCompoundTagNoClone
Parameters
key: string
Returns CompoundTag
Directly editable NBT tag of byte type by it's key. Don't save reference for future usage since they get destroyed when the parent object is destroyed.
getDouble
Parameters
key: string
Returns number
NBT tag of double type by it's key.
getFloat
Parameters
key: string
Returns number
NBT tag of float type by it's key.
getInt
Parameters
key: string
Returns number
NBT tag of 32-bit integer type by it's key.
getInt64
Parameters
key: string
Returns number
NBT tag of 64-bit integer type by it's key.
getListTag
Parameters
key: string
Returns ListTag
NBT tag of list type by it's key. Note that a copy of existing list tag is created so you cannot edit it directly. Use setCompoundTag method to apply changes or use getListTagNoClone to edit it directly.
getListTagNoClone
Parameters
key: string
Returns ListTag
Directly editable NBT tag of byte type by it's key. Don't save reference for future usage since they get destroyed when the parent object is destroyed.
getShort
Parameters
key: string
Returns number
NBT tag of short type by it's key.
getString
Parameters
key: string
Returns string
NBT tag of string type by it's key.
getValueType
Parameters
key: string
Returns number
Value type for the specified key. One of the ENbtDataType constants.
putByte
Puts value of byte type into compound tag.
Parameters
key: string
value: number
Returns void
putCompoundTag
Puts value of compound type into compound tag.
Parameters
key: string
value: CompoundTag
Returns void
putDouble
Puts value of double type into compound tag.
Parameters
key: string
value: number
Returns void
putFloat
Puts value of float type into compound tag.
Parameters
key: string
value: number
Returns void
putInt
Puts value of 32-bit integer type into compound tag.
Parameters
key: string
value: number
Returns void
putInt64
Puts value of 64-bit integer type into compound tag.
Parameters
key: string
value: number
Returns void
putListTag
Puts value of list type into compound tag.
Parameters
key: string
value: ListTag
Returns void
putShort
Puts value of short type into compound tag.
Parameters
key: string
value: number
Returns void
putString
Puts value of string type into compound tag.
Parameters
key: string
value: string
Returns void
remove
Removes tag by it's key.
Parameters
key: string
Returns void
toScriptable
Converts compound tag to JavaScript object for easier reading.
Returns Scriptable
Valid JavaScript representation of compound tag.
ListTag
List tags represent NBT array-like indexed data structure. it's values may be of any type, so check the type before calling the appropriate getter.
constructor
Creates a new list tag.
Returns ListTag
clear
Removes all the tags from the compound tags.
Returns void
getByte
Parameters
index: number
Returns number
NBT tag of byte type by it's index.
getCompoundTag
Parameters
index: number
Returns CompoundTag
NBT tag of compound type by it's index. Note that a copy of existing compound tag is created so you cannot edit it directly. Use setCompoundTag method to apply changes or use getCompoundTagNoClone to edit it directly.
getCompoundTagNoClone
Parameters
index: number
Returns CompoundTag
Directly editable NBT tag of byte type by it's index. Don't save reference for future usage since they get destroyed when the parent object is destroyed.
getDouble
Parameters
index: number
Returns number
NBT tag of double type by it's index.
getFloat
Parameters
index: number
Returns number
NBT tag of float type by it's index.
getInt
Parameters
index: number
Returns number
NBT tag of 32-bit integer type by it's index.
getInt64
Parameters
index: number
Returns number
NBT tag of 64-bit integer type by it's index.
getListTag
Parameters
index: number
Returns ListTag
NBT tag of list type by it's index. Note that a copy of existing list tag is created so you cannot edit it directly. Use setCompoundTag method to apply changes or use getListTagNoClone to edit it directly.
getListTagNoClone
Parameters
index: number
Returns ListTag
Directly editable NBT tag of byte type by it's index. Don't save reference for future usage since they get destroyed when the parent object is destroyed.
getShort
Parameters
index: number
Returns number
NBT tag of short type by it's index.
getString
Parameters
index: number
Returns string
NBT tag of string type by it's index.
getValueType
Parameters
index: number
Returns number
Value type for the specified index. One of the ENbtDataType constants.
length
Returns number
Count of the tags in the list tag.
putByte
Puts value of byte type into list tag.
Parameters
index: number
value: number
Returns void
putCompoundTag
Puts value of compound type into list tag.
Parameters
index: number
value: CompoundTag
Returns void
putDouble
Puts value of double type into list tag.
Parameters
index: number
value: number
Returns void
putFloat
Puts value of float type into list tag.
Parameters
index: number
value: number
Returns void
putInt
Puts value of 32-bit integer type into list tag.
Parameters
index: number
value: number
Returns void
putInt64
Puts value of 64-bit integer type into list tag.
Parameters
index: number
value: number
Returns void
putListTag
Puts value of list type into list tag.
Parameters
index: number
value: ListTag
Returns void
putShort
Puts value of short type into list tag.
Parameters
index: number
value: number
Returns void
putString
Puts value of string type into list tag.
Parameters
index: number
value: string
Returns void
toScriptable
Converts list tag to JavaScript object for easier reading.
Returns any[]
Valid JavaScript representation of list tag.
NBT (Named Binary Tag) is a tag based binary format designed to carry large amounts of binary data with smaller amounts of additional data. You can get or set nbt tags of entities, native tile entities (such as chests or beacons) and items. To get more information about these data structures, see page.