Перейти к основному содержанию

NBT

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.

Index

Namespaces

Templates

Templates:

Templates to typofication of resulted CompoundTag.toScriptable, which is used to determine containment of tags. Not includes structure .nbt, only in-game definitions.

@remarks

Booleans still "bytes", which means it just omitted when comparing <obj>.property == false nor <obj>.property === false.

BannerBlockEntity

BannerBlockEntity:

Banner with ID = 28.

Base

Base: number = 0

Index of banner color, where 0 is white; block palettes are same.

optionalPatterns

Patterns?: BannerPatternEntry[]

Patterns to be applied on Base color.

Type

Type: number = 0

id

id: Banner

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

BannerPatternEntry

BannerPatternEntry:

Flattened hieracly, extendable in declarations.

Color

Color: number = 0

Index of pattern color, where 0 is white; block palettes are same.

Pattern

Pattern: string

Pattern shortcut name, such as "gra", "mc", etc.

BarrelBlockEntity

BarrelBlockEntity:

Barrel with ID = 42.

Findable

Findable: boolean = false

Exploration map can be pointed here, tract as treasure.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

optionalLootTable

LootTable?: string

Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json".

optionalLootTableSeed

LootTableSeed?: number

Randomly generated seed to determine containment.

id

id: Barrel

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

BeaconBlockEntity

BeaconBlockEntity:

Beacon with ID = 21.

@remarks

Primary effect requires just one-level platform, meanwhile secondary works only when four-level built, otherwise fallbacks to primary.

id

id: Beacon

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

primary

primary: number = 0

0 means none, 1 speed, 2 haste, 3 resistance, 4 jump boost and 5 strength.

secondary

secondary: number = 0

0 means none, 1 regeneration and 2 boost primary effect.

x

x: number

y

y: number

z

z: number

BedBlockEntity

BedBlockEntity:

Bed with ID = 27.

color

color: number = 0

Index of bed color, where 0 is white; block palettes are same.

id

id: Bed

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

BeehiveBlockEntity

BeehiveBlockEntity:

Beehive (Beehive / Bee Nest) with ID = 43.

optionalOccupants

Occupants?: BeehiveBlockEntityOccupant[]

Bees. Theoretically, any entity may enter and leave onto beehive.

ShouldSpawnBees

ShouldSpawnBees: boolean = false

Naturally generated beehives summon bees inside, before player encounters them.

id

id: Beehive

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

BeehiveBlockEntityOccupant

BeehiveBlockEntityOccupant:

Flattened hieracly, extendable in declarations.

ActorIdentifier

ActorIdentifier: string

Typed entity identifier with tags, such as "minecraft:bee<>".

SaveData

SaveData: Entity

Entity NBTs; properties, attributes, definitions, etc.

TicksLeftToStay

TicksLeftToStay: number

Countdown before entity left beehive in ticks.

BellBlockEntity

BellBlockEntity:

Bell with ID = 40.

Direction

Direction: number

There is 2 surface (such as 1), 4 on side and 1 at top (255) locations.

Ringing

Ringing: boolean

Whether sound is playing.

Ticks

Ticks: number

Ringing counter, determines animation of bell.

id

id: Bell

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

BlastFurnaceBlockEntity

BlastFurnaceBlockEntity:

BlastFurnace (Blast Furnace) with ID = 38.

BurnDuration

BurnDuration: number = 0

Currently burning fuel (appears in slot 1) total time in ticks (e.g. coal burns in 1600 ticks) before burning completed.

BurnTime

BurnTime: number = 0

Counter to BurnDuration, when them equals furnace unlit.

CookTime

CookTime: number

Currently smelting item (appears in slot 0) progress, result will be presented in slot with index 2.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

StoredXPInt

StoredXPInt: number = 0

Accumulated experience, it will be dropped when result taken or furnace digged.

id

id: BlastFurnace

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

Block

Block:

Flattened hieracly, extendable in declarations.

name

name: string

states

states: BlockState[]

version

version: number

Database tracking identifier (in 1.16 equals 17825808).

BlockState

BlockState:

Flattened hieracly, extendable in declarations.

BrewingStandBlockEntity

BrewingStandBlockEntity:

BrewingStand (Brewing Stand) with ID = 8.

CookTime

CookTime: number = 0

Every potion cooks on same time ticks, counter. When next ingredient is done, every potion in slots 1-3 obtains tag "wasJustBrewed" = true.

FuelAmount

FuelAmount: number = 0

Fuel left of FuelTotal property, when it comes to zero next charge from slot 4 was used.

FuelTotal

FuelTotal: number = 0

When fuel was taken from slot changes to it capacity, now availabled only "minecraft:blaze_powder" (name property), which sets fuel to 20.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

id

id: BrewingStand

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

CampfireBlockEntity

CampfireBlockEntity:

Campfire (Campfire / Soul Campfire) with ID = 41.

optionalItem1

Item1?: Item<ItemTag>

Item that will be smelted on campfire.

optionalItem2

Item2?: Item<ItemTag>

Item that will be smelted on campfire.

optionalItem3

Item3?: Item<ItemTag>

Item that will be smelted on campfire.

optionalItem4

Item4?: Item<ItemTag>

Item that will be smelted on campfire.

ItemTime1

ItemTime1: number = 0

Ticks counter of smelting item.

ItemTime2

ItemTime2: number

Ticks counter of smelting item.

ItemTime3

ItemTime3: number

Ticks counter of smelting item.

ItemTime4

ItemTime4: number

Ticks counter of smelting item.

id

id: Campfire

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

CauldronBlockEntity

CauldronBlockEntity:

Cauldron with ID = 16.

@remarks

Contains Items, but it intentionally not used.

optionalCustomColor

CustomColor?: number

Packed RGB color, one of my favorites is -75715.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

PotionId

PotionId: number

One of EPotionEffect enum values. But... Maybe try <enum value> - 1?

PotionType

PotionType: number = -1

Level of strength, value between 0 and 255 (more buggy to 32768).

id

id: Cauldron

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

ChemistryTableBlockEntity

ChemistryTableBlockEntity:

ChemistryTable (Chemistry Equipment) with ID = 34.

id

id: ChemistryTable

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

optionalitemAux

itemAux?: number

Brewing item data, that will be transpiled into materials, such as 17, etc.

optionalitemId

itemId?: number

Brewing item numeric ID, that will be transpiled into materials, such as 583, etc.

optionalitemStack

itemStack?: number

Brewing item count, that will be transpiled into materials, such as 1, etc.

x

x: number

y

y: number

z

z: number

ChestBlockEntity

ChestBlockEntity:

Chest (Chest / Trapped Chest) with ID = 0.

Findable

Findable: boolean = false

Exploration map can be pointed here, tract as treasure.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

optionalLootTable

LootTable?: string

Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json".

optionalLootTableSeed

LootTableSeed?: number

Randomly generated seed to determine containment.

id

id: Chest

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

optionalpairlead

pairlead?: boolean

If there's sometime created connection with double-chest.

optionalpairx

pairx?: number

optionalpairz

pairz?: number

x

x: number

y

y: number

z

z: number

CommandBlockEntity

CommandBlockEntity:

CommandBlock (Command Block) with ID = 26.

Command

Command: string

Command to be executed here, such as /playanimation \@e[type=!minecraft:player] animation.humanoid.celebrating null 20.

CustomName

CustomName: string

Like nametag, but above command block; hovering text.

ExecuteOnFirstTick

ExecuteOnFirstTick: boolean

When LPCommandMode is set to cycled and conditions are done, first command executes without TickDelay.

LPCommandMode

LPCommandMode: number

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

LPConditionalMode: number

0 means statement, 1 doesn't care about result.

LPRedstoneMode

LPRedstoneMode: number

0 means always active, 1 requires redstone.

LastExecution

LastExecution: number

When last execution has been performed.

LastOutput

LastOutput: string

Message recorded with last execution, requires TrackOutput to be set to true.

LastOutputParams

LastOutputParams: string[]

Splitted to command parts without first slash (or symbol if slash is not provided), requires TrackOutput to be set to true.

SuccessCount

SuccessCount: number

TickDelay

TickDelay: number

Delay in ticks between executions (cycled blocks) or before starting it.

TrackOutput

TrackOutput: boolean

Save last execution command results.

Version

Version: number

Database tracking identifier (in 1.16 equals 13).

auto

auto: number

conditionMet

conditionMet: boolean

Condition right now is true?

id

id: CommandBlock

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

powered

powered: boolean

Redstone signal found?

x

x: number

y

y: number

z

z: number

ComparatorBlockEntity

ComparatorBlockEntity:

Comparator (Redstone Comparator) with ID = 12.

OutputSignal

OutputSignal: number

Redstone power, value between 0 and 15.

id

id: Comparator

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

ConduitBlockEntity

ConduitBlockEntity:

Conduit with ID = 35.

Active

Active: boolean = false

Whether conduit constructed or not, underwater monument blocks come out to help.

Target

Target: number

Entity UID to protect players in water nearest, attacks monsters when fully constructed.

id

id: Conduit

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

DaylightDetectorBlockEntity

DaylightDetectorBlockEntity:

DaylightDetector (Daylight Sensor) with ID = 10.

id

id: DaylightDetector

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

DispenserBlockEntity

DispenserBlockEntity:

Dispenser with ID = 13.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

id

id: Dispenser

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

DropperBlockEntity

DropperBlockEntity:

Dropper with ID = 14.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

id

id: Dropper

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

EnchantTableBlockEntity

EnchantTableBlockEntity:

EnchantTable (Enchanting Table) with ID = 9.

id

id: EnchantTable

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

rott

rott: number

Rotation angle in radians between -Math.PI and Math.PI.

x

x: number

y

y: number

z

z: number

EndGatewayBlockEntity

EndGatewayBlockEntity:

EndGateway (End Gateway) with ID = 24.

Age

Age: number

Counter, that drops when entity moves through portal. Used to display purple beacon in portal for few hundred ticks.

ExitPortal

ExitPortal: number[] = [0, 0, 0] // so, under world

XYZ coordinates of place portal transfers to.

id

id: EndGateway

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

EndPortalBlockEntity

EndPortalBlockEntity:

EndPortal (End Portal) with ID = 22.

id

id: EndPortal

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

EnderChestBlockEntity

EnderChestBlockEntity:

EnderChest (Ender Chest) with ID = 23.

Findable

Findable: boolean = false

Exploration map can be pointed here, tract as treasure.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

optionalLootTable

LootTable?: string

Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json".

optionalLootTableSeed

LootTableSeed?: number

Randomly generated seed to determine containment.

id

id: EnderChest

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

Entity

Entity:

Flattened hieracly, extendable in declarations.

optionalAge

Age?: number

Countdown in ticks before entity become adult.

Air

Air: number

Countdown in ticks before entity start drowning.

Armor

Armor: Item<ItemTag>[]

Helmet, Chestplate, Leggings, Boots. Accessible by index, not marked with Slot property.

AttackTime

AttackTime: number

Last attack tick, determines time between attacks.

Attributes

Attributes: EntityAttribute[]

Entity attributes, such as "minecraft:health", "minecraft:follow_range", etc.

BodyRot

BodyRot: number

Entity body yaw rotation in degrees, with offset of Rotation.

Chested

Chested: boolean

Llama or mule equipped chests.

Color

Color: number

Color2

Color2: number

Dead

Dead: boolean

Entity is dead, which is required to visualize animation of dying.

DeathTime

DeathTime: number

Tick when entity become dead (health <= 0).

FallDistance

FallDistance: number

Last synchronized distance between ground and entity.

Fire

Fire: number

Fire ticks before burning stopped, alternative of Entity.setFire.

HasExecuted

HasExecuted: false

HomeDimensionId

HomeDimensionId: number

HomePos

HomePos: number[] = [-2147483648, -2147483648, -2147483648] // when not set

HurtTime

HurtTime: number

Last hurt tick, determines entity panic/attack state.

Invulnerable

Invulnerable: boolean

Immune to in-game damage types, such as NPCs and Agents.

IsAngry

IsAngry: boolean

Normally, entity become angry when attacked.

IsAutonomous

IsAutonomous: boolean

Entity can move, alternative of Entity.setMobile.

IsBaby

IsBaby: boolean

Entity is not adult, so when Age reaches 0 it is not baby.

IsEating

IsEating: boolean

Entity is eating Mainhand item, displays particles around.

IsGliding

IsGliding: boolean

Entity is using elytra (to glide).

IsGlobal

IsGlobal: boolean

IsIllagerCaptain

IsIllagerCaptain: boolean

Patrols of pillagers following their leader.

IsOrphaned

IsOrphaned: boolean

IsOutOfControl

IsOutOfControl: boolean

IsPregnant

IsPregnant: boolean

Entity breeded and prepared to duplicate itself, such as turtles.

IsRoaring

IsRoaring: boolean

IsScared

IsScared: boolean

Entity sees dangerous thing around, such as villagers flee.

IsStunned

IsStunned: boolean

IsSwimming

IsSwimming: boolean

Entity is standing on water.

IsTamed

IsTamed: boolean

Entity is tamed, such as cats or dogs.

IsTrusting

IsTrusting: boolean

Entity is trusting player (do not panic when it came), such as foxes childs breeded by someone.

LastDimensionId

LastDimensionId: number

Dimension from entity transfered when is going to portal, last saved state when loaded into dimension.

LeasherID

LeasherID: number = -1

Leashed with knot entity (normally, player).

LootDropped

LootDropped: boolean

Required on first death tick, drops loot again if set to false.

LoveCause

LoveCause: number = 0 // when is not breeded

Mainhand

Mainhand: Item<ItemTag>

Item set by Entity.setCarriedItem, entities uses it for attack and other AI-related things.

MarkVariant

MarkVariant: number

Motion

Motion: number[]

Velocity of physics in-world, vector of moving target.

NaturalSpawn

NaturalSpawn: boolean

Entity is naturally spawned, not breeded or summoned.

Offhand

Offhand: Item<ItemTag>

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

OnGround: boolean

Entity is standing on landing.

OwnerNew

OwnerNew: number = -1

Projectile shooter entity UID.

Persistent

Persistent: boolean

Entity can not be despawned.

PortalCooldown

PortalCooldown: number

Ticks before entity can move through portal again.

Pos

Pos: number[]

XYZ absolute coordinates, alternative of Entity.setPosition.

Rotation

Rotation: number[]

Yaw (horizontal rotation angle) and pitch (vertical rotation angle) respectively in degrees, alternative of Entity.setLookAngle.

Saddled

Saddled: boolean

When pig or strider is saddled (excludes horses or not?).

Sheared

Sheared: boolean

When sheep or snow golem is sheared.

ShowBottom

ShowBottom: boolean

Sitting

Sitting: boolean

Entity is sitting, such as players or foxes.

SkinID

SkinID: number

Strength

Strength: number

StrengthMax

StrengthMax: number

Surface

Surface: number

Tags

Tags: string[]

TargetID

TargetID: number = -1

Following, attacking or anything else targeted entity.

TimeStamp

TimeStamp: number

Tick when entity is born, used to limitedLife property.

TradeExperience

TradeExperience: number

TradeTier

TradeTier: number

UniqueID

UniqueID: number

Entity UID, which is passed to Inner Core callbacks.

Variant

Variant: number

boundX

boundX: number

boundY

boundY: number

boundZ

boundZ: number

canPickupItems

canPickupItems: boolean

Entity may equip, take or replace containing item from drop.

definitions

definitions: string[]

Set of rules applied (starts with +) or excluded (starts with -) from entity; it includes properties, tasks, etc.

hasBoundOrigin

hasBoundOrigin: boolean

hasSetCanPickupItems

hasSetCanPickupItems: boolean

identifier

identifier: string

Typed entity identifier without tags, such as "minecraft:cow".

limitedLife

limitedLife: number

Ticks after TimeStamp when entity become Dead.

EntityAttribute

EntityAttribute:

Flattened hieracly, extendable in declarations.

Base

Base: number

Current

Current: number

DefaultMax

DefaultMax: number

DefaultMin

DefaultMin: number

Max

Max: number

Min

Min: number

Name

Name: string

One of Entity.Attribute or your custom one.

FlowerPotBlockEntity

FlowerPotBlockEntity:

FlowerPot (Flower Pot) with ID = 7.

optionalPlantBlock

PlantBlock?: Block

Anything in particular, my cat preferr "minecraft:brown_mushroom" (name property).

id

id: FlowerPot

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

FurnaceBlockEntity

FurnaceBlockEntity:

Furnace with ID = 1.

BurnDuration

BurnDuration: number = 0

Currently burning fuel (appears in slot 1) total time in ticks (e.g. coal burns in 1600 ticks) before burning completed.

BurnTime

BurnTime: number = 0

Counter to BurnDuration, when them equals furnace unlit.

CookTime

CookTime: number

Currently smelting item (appears in slot 0) progress, result will be presented in slot with index 2.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

StoredXPInt

StoredXPInt: number = 0

Accumulated experience, it will be dropped when result taken or furnace digged.

id

id: Furnace

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

HopperBlockEntity

HopperBlockEntity:

Hopper with ID = 2.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

TransferCooldown

TransferCooldown: number = 0

Ticks counter before transfering to watching side or down if hoppers unlocked.

id

id: Hopper

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

IBlockEntity

IBlockEntity:

Flattened hieracly, extendable in declarations.

id

id: string

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

IContainerBlockEntity

IContainerBlockEntity:

Flattened hieracly, extendable in declarations.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

id

id: string

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

IFurnaceBlockEntity

IFurnaceBlockEntity:

Flattened hieracly, extendable in declarations.

BurnDuration

BurnDuration: number = 0

Currently burning fuel (appears in slot 1) total time in ticks (e.g. coal burns in 1600 ticks) before burning completed.

BurnTime

BurnTime: number = 0

Counter to BurnDuration, when them equals furnace unlit.

CookTime

CookTime: number

Currently smelting item (appears in slot 0) progress, result will be presented in slot with index 2.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

StoredXPInt

StoredXPInt: number = 0

Accumulated experience, it will be dropped when result taken or furnace digged.

id

id: string

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

ILootableBlockEntity

ILootableBlockEntity:

Flattened hieracly, extendable in declarations.

Findable

Findable: boolean = false

Exploration map can be pointed here, tract as treasure.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

optionalLootTable

LootTable?: string

Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json".

optionalLootTableSeed

LootTableSeed?: number

Randomly generated seed to determine containment.

id

id: string

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

Item

Item<T>:

Flattened hieracly, extendable in declarations.


Type parameters

optionalBlock

Block?: Block

Count

Count: number

Amount of item in slot.

Damage

Damage: number = 0 // not damaged at all

Dealed damage, when it comes to Item.getMaxDamage item will be broken.

Name

Name: string

Typed identifier, such as "minecraft:stick".

optionalSlot

Slot?: number

Indexed slot, required in containers with more than one slots.

WasPickedUp

WasPickedUp: boolean

Picked up by entity, denies despawn it naturally.

optionaltag

tag?: T

Additional data, such as nametags, enchantments, etc.

ItemFilledMapTag

ItemFilledMapTag:

Flattened hieracly, extendable in declarations.

optionalench

ench?: ItemTagEnchantment[]

List of applied enchantments in index-numeral sorting.

map_display_players

map_display_players: boolean

Whether map should display compasses for players or not.

map_name_index

map_name_index: number

Displayed for players map number, starts with 1.

map_uuid

map_uuid: number

UID to be taken from world NBT.

ItemFrameBlockEntity

ItemFrameBlockEntity:

ItemFrame (Item Frame) with ID = 17.

optionalItem

Item?: Item<ItemTag>

Item to be displayed in frame, tag doesn't exist by default.

optionalItemDropChance

ItemDropChance?: number = 1

Percent value between 0 and 1; everything just cool when elytra drops with chance 0.01.

optionalItemRotation

ItemRotation?: number

Rotation angle in degress between 0 and 315 (with in-game step 45). Also changes comparator strength, triggers observers.

id

id: ItemFrame

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

ItemTag

ItemTag:

Flattened hieracly, extendable in declarations.

optionalench

ench?: ItemTagEnchantment[]

List of applied enchantments in index-numeral sorting.

ItemTagEnchantment

ItemTagEnchantment:

Flattened hieracly, extendable in declarations.

id

id: number

One of EEnchantment enum values.

lvl

lvl: number

Level of strength, value between 0 and 255 (more buggy up to 32768).

ItemWritableBookTag

ItemWritableBookTag:

Flattened hieracly, extendable in declarations.

optionalauthor

author?: string = “Author Unknown”

Written book author, assigned when signing book.

optionalench

ench?: ItemTagEnchantment[]

List of applied enchantments in index-numeral sorting.

optionalgeneration

generation?: number = 0

Number of written copy, 0 means original.

pages

pages: ItemWritableBookTagPage[]

List of created pages in index-numeral sorting.

optionaltitle

title?: string

Written book title, assigned when signing book.

optionalxuid

xuid?: string = 0

Linked teacher book, especially for Education Edition.

ItemWritableBookTagPage

ItemWritableBookTagPage:

Flattened hieracly, extendable in declarations.

photoname

photoname: string = ””

Screenshot shotted on server (appears in pause menu), specially based on Education Edition.

text

text: string

Text placed on page as-is (with new lines \n).

JigsawBlockEntity

JigsawBlockEntity:

JigsawBlock (Jigsaw Block) with ID = 36.

final_state

final_state: string = “minecraft:air”

Typed block identifier (includes state support such as [facing=east]) to be replaced when jigsaw activated.

id

id: JigsawBlock

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

joint

joint: rollable | aligned = rollable | aligned

Connection between jigsaw nodes, as-is.

name

name: string = “minecraft:empty”

Associated structure name, jigsaw identifier, such as "template:bundle".

target

target: string = “minecraft:empty”

Required structure subset to be aligned with, such as, such as "template:pipe".

target_pool

target_pool: string = “minecraft:empty”

Pool in which jigsaws will be connected with each others, such as "template:bundle/pipe".

x

x: number

y

y: number

z

z: number

JukeboxBlockEntity

JukeboxBlockEntity:

Jukebox with ID = 33.

optionalRecordItem

RecordItem?: Item<ItemTag>

Record disc that will be played, what about "minecraft:music_disc_strad" (name property).

id

id: JukeboxBlock

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

LecternBlockEntity

LecternBlockEntity:

Lectern with ID = 37.

optionalbook

book?: Item<ItemWritableBookTag>

Standing book item, tag determines book placement.

optionalhasBook

hasBook?: boolean

If book is placed, observer detects changed block.

id

id: Lectern

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

optionalpage

page?: number

Index of page opened on lectern, redstone comparator obtains power page / totalPages * 15.

optionaltotalPages

totalPages?: number

Total pages counted in book.

x

x: number

y

y: number

z

z: number

LodestoneBlockEntity

LodestoneBlockEntity:

Lodestone with ID = 44.

id

id: Lodestone

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

trackingHandle

trackingHandle: boolean

Compass points to this lodestone.

x

x: number

y

y: number

z

z: number

MobSpawnerBlockEntity

MobSpawnerBlockEntity:

MobSpawner (Spawner) with ID = 5.

Delay

Delay: number

Ticks before spawning next entity.

DisplayEntityHeight

DisplayEntityHeight: number = 1.7999999523162842

Placeholder animation in spawner height, constant.

DisplayEntityScale

DisplayEntityScale: number

Placeholder animation in spawner size relative to block itself.

DisplayEntityWidth

DisplayEntityWidth: number = 0.6000000238418579

Placeholder animation in spawner width, constant.

EntityIdentifier

EntityIdentifier: string = ””

Typed entity identifier, such as "minecraft:enderman".

MaxNearbyEntities

MaxNearbyEntities: number = 6

Maximum containment mobs in SpawnRange, if here are more spawner just emitting particles.

MaxSpawnDelay

MaxSpawnDelay: number = 800

Maximum time in ticks between mob spawing.

MinSpawnDelay

MinSpawnDelay: number = 800

Minimum time in ticks between mob spawing.

RequiredPlayerRange

RequiredPlayerRange: number = 16

Anyone (of players) must be near to spawner, otherwise spawner hides placeholder animation and stops.

SpawnCount

SpawnCount: number = 4

Maximum spawning limit, not everyone may spawned with each other when place above comes to zero.

SpawnRange

SpawnRange: number = 4

Ranged AABB box where entities became.

id

id: MobSpawner

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

MovingBlockEntity

MovingBlockEntity:

MovingBlock (Moving Block) with ID = 19.

id

id: MovingBlock

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

movingBlock

movingBlock: Block

Block to be rendered as moving, let give a try with a "minecraft:cake" (name property).

movingBlockExtra

movingBlockExtra: Block

Block to be rendered as moving above movingBlock, let give a try with a "minecraft:flowing_lava" (name property).

pistonPosX

pistonPosX: number = 0

If block connected with a sticky piston, it will appears here.

pistonPosY

pistonPosY: number = 1

If block connected with a sticky piston, it will appears here.

pistonPosZ

pistonPosZ: number = 0

If block connected with a sticky piston, it will appears here.

x

x: number

y

y: number

z

z: number

MusicBlockEntity

MusicBlockEntity:

Music (Note Block) with ID = 11.

id

id: Music

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

note

note: number

Number between 0 and 24, which changes note tone.

x

x: number

y

y: number

z

z: number

NetherReactorBlockEntity

NetherReactorBlockEntity:

NetherReactor (Nether Reactor Core) with ID = 3.

HasFinished

HasFinished: boolean = false

IsInitialized

IsInitialized: boolean = false

Progress

Progress: number = 0

id

id: NetherReactor

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

PistonArmBlockEntity

PistonArmBlockEntity:

PistonArm (Piston) with ID = 18.

AttachedBlocks

AttachedBlocks: Block[]

Blocks attached to piston (excluding head) with slime and honey blocks.

BreakBlocks

BreakBlocks: Block[]

Blocks prevents piston from moving, such as obsidian.

LastProgress

LastProgress: number

Latest successfully changed state progress, which determine piston movement.

NewState

NewState: number

Required by redstone state, if nothing blocking way, piston moves.

Progress

Progress: number

Percent between 0 and 1 (with in-game step 0.5), where 1 means activated.

State

State: number

Currently state, 0 means pulled, 1 moving and 2 pushed.

Sticky

Sticky: boolean

Whether piston crafted with slime and can transfer blocks back.

id

id: PistonArm

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

ShulkerBoxBlockEntity

ShulkerBoxBlockEntity:

ShulkerBox (Shulker Box) with ID = 25.

Findable

Findable: boolean = false

Exploration map can be pointed here, tract as treasure.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

optionalLootTable

LootTable?: string

Definition to behavior pack path with extension, such as "loot_tables/chests/end_city_treasure.json".

optionalLootTableSeed

LootTableSeed?: number

Randomly generated seed to determine containment.

facing

facing: number

One of EBlockSide enum values.

id

id: ShulkerBox

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

SignBlockEntity

SignBlockEntity:

Sign with ID = 4.

optionalColor

Color?: string

Basic text color, EColor.RESET restores it.

Text

Text: string

Written text, delimited with newlines (\n, it may be more than 4 lines, but not rendered in-world).

TextOwner

TextOwner: string = ””

No. Owners. Constant.

id

id: Sign

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

SkullBlockEntity

SkullBlockEntity:

Skull (Mob Head) with ID = 6.

MouthMoving

MouthMoving: boolean = 0

Whether dragon mouth powered by redstone.

MouthTickCount

MouthTickCount: number = 0

Cycling time in ticks, between full-cycled move down and up.

Rotation

Rotation: number

Rotation angle in degrees, value between 22.5 and 180 (with in-game step 22.5).

SkullType

SkullType: number

0 means skeleton, 1 wither skeleton, 2 zombie, 3 player, 4 creeper and 5 ender dragon.

id

id: Skull

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

SmokerBlockEntity

SmokerBlockEntity:

Smoker with ID = 39.

BurnDuration

BurnDuration: number = 0

Currently burning fuel (appears in slot 1) total time in ticks (e.g. coal burns in 1600 ticks) before burning completed.

BurnTime

BurnTime: number = 0

Counter to BurnDuration, when them equals furnace unlit.

CookTime

CookTime: number

Currently smelting item (appears in slot 0) progress, result will be presented in slot with index 2.

Items

Items: Item<ItemTag>[]

Contained slots, which is stored in numeral-index sorting starting with zero.

@remarks

Normally, slot information removes when item became "air" (disappears), so please be careful when calling via <tag>.Items[<index>] convention!

StoredXPInt

StoredXPInt: number = 0

Accumulated experience, it will be dropped when result taken or furnace digged.

id

id: Smoker

Typed identifier, such as "Chest", "Beacon", etc.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

x

x: number

y

y: number

z

z: number

StructureBlockEntity

StructureBlockEntity:

StructureBlock (Structure Block) with ID = 32.

data

data: number

Mode of structure block; 0 means load, 1 data (consumed by pools), 2 save.

dataField

dataField: string

Metadata to be passed when data is set to data mode.

id

id: StructureBlock

Typed identifier, such as "Chest", "Beacon", etc.

ignoreEntities

ignoreEntities: boolean

Load or save NBT data of entities contained in bounds, existing data will be omitted.

includePlayers

includePlayers: boolean

Load or save NBT data of players contained in bounds.

integrity

integrity: number

Lower values destructs more random selected blocks.

isMovable

isMovable: boolean

Block Entity will be saved without instantiating new one when transporting (via pistons, commands, etc.).

isPowered

isPowered: boolean

Powered by redstone signal?

mirror

mirror: number

0 means no mirroring, 1 mirror above x, 2 mirror above y, 3 mirror above z

redstoneSaveMode

redstoneSaveMode: number

0 means save signal power (lit lamps, redstone itself, etc.), 1 forget (unlit sources will be updated when structure is placed).

removeBlocks

removeBlocks: boolean

Blocks will be merged (with structure air as real air) or pasted as-is.

rotation

rotation: number

0 means no rotation, 1 90 degress, 2 180 degress, 3 270 degress.

seed

seed: number

Seed to be passed when configuring integrity

showBoundingBox

showBoundingBox: boolean

Display bounds of structure in-world, includes vertex frame above.

structureName

structureName: string

Vanilla or behavior pack namespaced (first directory determines namespace, subfolders joined with .) relative path to structure, try something like "minecraft:endcity.ship".

x

x: number

xStructureOffset

xStructureOffset: number

xStructureSize

xStructureSize: number

y

y: number

yStructureOffset

yStructureOffset: number

yStructureSize

yStructureSize: number

z

z: number

zStructureOffset

zStructureOffset: number

zStructureSize

zStructureSize: number

Classes

CompoundTag

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

clear

  • clear(): void
  • Removes all the tags from the compound tags.


    Returns void

contains

  • contains(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

    true if specified key exists in compound tag.

containsValueOfType

  • containsValueOfType(key: string, type: number): boolean

  • 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

  • getAllKeys(): Array<string>

  • Returns Array<string>

    Java-array containing all the keys of the compound tag.

getByte

  • getByte(key: string): number

  • 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

  • getDouble(key: string): number

  • Parameters

    • key: string

    Returns number

    NBT tag of double type by it's key.

getFloat

  • getFloat(key: string): number

  • Parameters

    • key: string

    Returns number

    NBT tag of float type by it's key.

getInt

  • getInt(key: string): number

  • Parameters

    • key: string

    Returns number

    NBT tag of 32-bit integer type by it's key.

getInt64

  • getInt64(key: string): number

  • 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

  • getListTagNoClone(key: string): ListTag

  • 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

  • getShort(key: string): number

  • Parameters

    • key: string

    Returns number

    NBT tag of short type by it's key.

getString

  • getString(key: string): string

  • Parameters

    • key: string

    Returns string

    NBT tag of string type by it's key.

getValueType

  • getValueType(key: string): number

  • Parameters

    • key: string

    Returns number

    Value type for the specified key. One of the ENbtDataType constants.

putByte

  • putByte(key: string, value: number): void
  • 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

    Returns void

putDouble

  • putDouble(key: string, value: number): void
  • Puts value of double type into compound tag.


    Parameters

    • key: string
    • value: number

    Returns void

putFloat

  • putFloat(key: string, value: number): void
  • Puts value of float type into compound tag.


    Parameters

    • key: string
    • value: number

    Returns void

putInt

  • putInt(key: string, value: number): void
  • Puts value of 32-bit integer type into compound tag.


    Parameters

    • key: string
    • value: number

    Returns void

putInt64

  • putInt64(key: string, value: number): void
  • Puts value of 64-bit integer type into compound tag.


    Parameters

    • key: string
    • value: number

    Returns void

putListTag

  • putListTag(key: string, value: ListTag): void
  • Puts value of list type into compound tag.


    Parameters

    Returns void

putShort

  • putShort(key: string, value: number): void
  • Puts value of short type into compound tag.


    Parameters

    • key: string
    • value: number

    Returns void

putString

  • putString(key: string, value: string): void
  • Puts value of string type into compound tag.


    Parameters

    • key: string
    • value: string

    Returns void

remove

  • remove(key: string): void
  • 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

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

  • clear(): void
  • Removes all the tags from the compound tags.


    Returns void

getByte

  • getByte(index: number): number

  • 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

  • getDouble(index: number): number

  • Parameters

    • index: number

    Returns number

    NBT tag of double type by it's index.

getFloat

  • getFloat(index: number): number

  • Parameters

    • index: number

    Returns number

    NBT tag of float type by it's index.

getInt

  • getInt(index: number): number

  • Parameters

    • index: number

    Returns number

    NBT tag of 32-bit integer type by it's index.

getInt64

  • getInt64(index: number): number

  • 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

  • getListTagNoClone(index: number): ListTag

  • 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

  • getShort(index: number): number

  • Parameters

    • index: number

    Returns number

    NBT tag of short type by it's index.

getString

  • getString(index: number): string

  • Parameters

    • index: number

    Returns string

    NBT tag of string type by it's index.

getValueType

  • getValueType(index: number): number

  • Parameters

    • index: number

    Returns number

    Value type for the specified index. One of the ENbtDataType constants.

length

  • length(): number

  • Returns number

    Count of the tags in the list tag.

putByte

  • putByte(index: number, value: number): void
  • Puts value of byte type into list tag.


    Parameters

    • index: number
    • value: number

    Returns void

putCompoundTag

  • putCompoundTag(index: number, value: CompoundTag): void
  • Puts value of compound type into list tag.


    Parameters

    Returns void

putDouble

  • putDouble(index: number, value: number): void
  • Puts value of double type into list tag.


    Parameters

    • index: number
    • value: number

    Returns void

putFloat

  • putFloat(index: number, value: number): void
  • Puts value of float type into list tag.


    Parameters

    • index: number
    • value: number

    Returns void

putInt

  • putInt(index: number, value: number): void
  • Puts value of 32-bit integer type into list tag.


    Parameters

    • index: number
    • value: number

    Returns void

putInt64

  • putInt64(index: number, value: number): void
  • Puts value of 64-bit integer type into list tag.


    Parameters

    • index: number
    • value: number

    Returns void

putListTag

  • putListTag(index: number, value: ListTag): void
  • Puts value of list type into list tag.


    Parameters

    Returns void

putShort

  • putShort(index: number, value: number): void
  • Puts value of short type into list tag.


    Parameters

    • index: number
    • value: number

    Returns void

putString

  • putString(index: number, value: string): void
  • Puts value of string type into list tag.


    Parameters

    • index: number
    • value: string

    Returns void

toScriptable

  • toScriptable(): any[]
  • Converts list tag to JavaScript object for easier reading.

    @since

    2.0.5b45


    Returns any[]

    Valid JavaScript representation of list tag.

Page Options