HytaleDocs
ItemBlock

Blocks

Asset path: Server/Item/Block/Blocks/*.json

The counter-party to "Support". This block offers supporting faces which can match the face requirements of adjacent/nearby blocks.

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another BlockType most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Group

Sets the group for this block. Used by BlockSets.

A group of "@Tech" will prevent physics from being automatically applied to the block.

Type information: (Nullable) String

BlockListAssetId

The name of a BlockList asset, for use in builder tool brushes

Type information: (Nullable) String

Reference to a BlockTypeListAsset asset

PrefabListAssetId

The name of a PrefabList asset, for use in builder tool brushes

Type information: (Nullable) String

Reference to a PrefabListAsset asset

DrawType

Type information:

Any one of the following String (defaults to Cube):

NameDescription
"Empty"
"GizmoCube"
"Cube"
"Model"
"CubeWithModel"

Textures

Type information:

(Nullable) Array of the type:

BlockTypeTextures with the following properties:

KeyTypeDescription
All(Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
Sides(Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
UpDown(Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
Up(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
Down(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
North(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
South(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
West(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
East(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
WeightInteger defaults to: 1

TextureSideMask

Type information: (Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/

with the extension: *.png

CubeShadingMode

Type information:

Any one of the following String (defaults to Standard):

NameDescription
"Standard"
"Flat"
"Fullbright"
"Reflective"

CustomModelTexture

Type information:

(Nullable) Array of the type:

CustomModelTexture with the following properties:

KeyTypeDescription
Texture(Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
WeightInteger defaults to: 0

CustomModel

Type information: (Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/Items/
  • Common/Resources/
  • Common/NPC/
  • Common/VFX/
  • Common/Consumable/

with the extension: *.blockymodel

BlockBreakingDecalId

The block breaking decal defined here defines the decal asset that should be overlaid when this block is damaged

Type information: (Nullable) String

Reference to a BlockBreakingDecal asset

Material

Type information:

Any one of the following String (defaults to Empty):

NameDescription
"Empty"
"Solid"

Opacity

Type information:

Any one of the following String (defaults to Solid):

NameDescription
"Solid"
"Semitransparent"
"Cutout"
"Transparent"

RequiresAlphaBlending

Type information: Boolean defaults to: false

CustomModelScale

Type information:

(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

CustomModelAnimation

Type information: (Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/Items/
  • Common/Resources/
  • Common/NPC/
  • Common/VFX/
  • Common/Consumable/

with the extension: *.blockyanim

CustomModelAnimationSpeed

A multiplier for the playback speed of the block model animation. 1 is the authored speed.

Type information:

(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Light

Type information:

(Nullable)

ColorLight with the following properties:

KeyTypeDescription
Color(Nullable) A color the form:

#RGB

RadiusInteger defaults to: 0

TickProcedure

Type information:

(Nullable) Either

BasicChanceBlockGrowthProcedure with the following properties:

KeyTypeDescription
TypeConstant value: BasicChance

This field controls the type, it must be set to the constant value "BasicChance" to function as this type.

NextId(Nullable) String
ChanceMinInteger defaults to: 0
ChanceInteger defaults to: 0
NextTickingBoolean defaults to: false

or

SplitChanceBlockGrowthProcedure with the following properties:

KeyTypeDescription
TypeConstant value: SplitChance

This field controls the type, it must be set to the constant value "SplitChance" to function as this type.

NextIdsMap of the following:
Map
KeyType
any Stringanything
ChanceMinInteger defaults to: 0
DataInteger defaults to: 0
NextTickingBoolean defaults to: false

RandomTickProcedure

Type information:

(Nullable) Any of these:

Key: TypeType
ChangeIntoBlock
ChangeIntoBlockProcedure

ChangeIntoBlockProcedure with the following properties:

KeyTypeDescription
TypeConstant value: ChangeIntoBlock

This field controls the type, it must be set to the constant value "ChangeIntoBlock" to function as this type.

TargetBlock(Nullable) String

Reference to a BlockType asset

PlaceBlock
PlaceBlockProcedure

PlaceBlockProcedure with the following properties:

KeyTypeDescription
TypeConstant value: PlaceBlock

This field controls the type, it must be set to the constant value "PlaceBlock" to function as this type.

PlacementsArray of the type: PlacementRule

The blocks that can be placed at the configured Offset. Each rule may optionally be scoped to one of this block's visual States; a rule with no State applies to the block's default (stateless) form. The first rule matching the block's current State is placed when the target cell is clear.

OffsetVector3i

The block offset (relative to the ticking block) at which to place the block. For example X=0, Y=1, Z=0 places the block one cell directly above.

RequireEmptyTargetBoolean defaults to: true

Whether the target cell must be empty (air) for the placement to occur. When true (the default) an obstruction causes the procedure to silently do nothing and retry on a later tick.

SpreadTo
SpreadToProcedure

SpreadToProcedure with the following properties:

KeyTypeDescription
TypeConstant value: SpreadTo

This field controls the type, it must be set to the constant value "SpreadTo" to function as this type.

SpreadDirectionsArray of the type: Vector3i

The directions this block can spread in.

MinYInteger defaults to: 0

The minimum Y level this block can spread to, relative to the current block. For example, a value of -1 means the block can spread to blocks one level below it.

MaxYInteger defaults to: 0

The maximum Y level this block can spread to, relative to the current block. For example, a value of 1 means the block can spread to blocks one level above it.

AllowedTagString

The asset tag that the block can spread to.

RequireEmptyAboveTargetBoolean defaults to: true

Whether the block requires an empty block above the target block to spread.

AllowedAboveFluids(Nullable) Array of String

Reference to a Fluid asset

List of fluids that spreading is allowed to occur under. Null will allow spreading under any fluid.

RequiredLightLevelInteger defaults to: 6

The minimum light level required for the block to spread.

RevertBlock(Nullable) String

Reference to a BlockType asset

If specified, the block will revert to this block if it is covered by another block.

ConnectedBlockRuleSet

Type information:

(Nullable) Any of these:

Key: TypeType
CustomTemplate
CustomTemplateConnectedBlockRuleSet

CustomTemplateConnectedBlockRuleSet with the following properties:

KeyTypeDescription
TypeConstant value: CustomTemplate

This field controls the type, it must be set to the constant value "CustomTemplate" to function as this type.

TemplateShapeAssetId(Nullable) String

Reference to a CustomConnectedBlockTemplateAsset asset

The name of a ConnectedBlockTemplateAsset asset

TemplateShapeBlockPatterns(Nullable) Map

You must specify all shapes as a BlockPattern. The shapes are as outlined in the keys of the ShapeTemplateAsset's map.

Patterned
PatternedConnectedBlockRuleSet

PatternedConnectedBlockRuleSet with the following properties:

KeyTypeDescription
TypeConstant value: Patterned

This field controls the type, it must be set to the constant value "Patterned" to function as this type.

RuleSetIdString

Reference to a PatternedConnectedBlockRuleSetAsset asset

The name of a ConnectedBlockRuleSetAsset asset

TemplatedShapes(Nullable) Map (1)
Roof
RoofConnectedBlockRuleSet

RoofConnectedBlockRuleSet with the following properties:

KeyTypeDescription
TypeConstant value: Roof

This field controls the type, it must be set to the constant value "Roof" to function as this type.

RegularStairConnectedBlockRuleSet
Hollow(Nullable) StairConnectedBlockRuleSet
Topper(Nullable) ConnectedBlockOutput
WidthInteger defaults to: 1
MaterialName(Nullable) String
Stair
StairConnectedBlockRuleSet

StairConnectedBlockRuleSet with the following properties:

KeyTypeDescription
TypeConstant value: Stair

This field controls the type, it must be set to the constant value "Stair" to function as this type.

StraightConnectedBlockOutput
Corner_LeftConnectedBlockOutput
Corner_RightConnectedBlockOutput
Inverted_Corner_Left(Nullable) ConnectedBlockOutput
Inverted_Corner_Right(Nullable) ConnectedBlockOutput
MaterialName(Nullable) String defaults to: Stair

Effect

Type information:

(Nullable) Array of the type: Any one of the following String:

NameDescription
"None"
"Wind"
"WindAttached"
"WindRandom"
"WindFractal"
"Ice"
"Water"
"Lava"
"Slime"
"Ripple"

TransitionTexture

Type information: (Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/

with the extension: *.png

TransitionToGroups

Type information: (Nullable) Array of String

TransitionToTag

Type information: (Nullable) String

BlockParticleSetId

The block particle set defined here defines which particles should be spawned when an entity interacts with this block (like when stepping on it for example

Type information: (Nullable) String

Reference to a BlockParticleSet asset

ParticleColor

Type information:

(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

TextureComputedColor

Type information:

(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

Particles

The particles defined here will be spawned on top of blocks of this type placed in the world.

Type information:

(Nullable) Array of the type:

ModelParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

TargetEntityPartAny one of the following String (defaults to Self):
EntityPart
NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"
TargetNodeName(Nullable) String
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ScaleNumber defaults to: 1.0
PositionOffset(Nullable)
Vector3f

Vector3f with the following properties:

KeyTypeDescription
XEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
YEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ZEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RotationOffset(Nullable)
Direction

Direction with the following properties:

KeyTypeDescription
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Pitch(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DetachedFromModelBoolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemoveBoolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

RandomRotation

Type information:

Any one of the following String (defaults to None):

NameDescription
"None"
"YawPitchRollStep1"
"YawStep1"
"YawStep1XZ"
"YawStep90"

VariantRotation

Type information:

Any one of the following String (defaults to None):

NameDescription
"None"
"Wall"
"UpDown"
"Pipe"
"DoublePipe"
"NESW"
"UpDownNESW"
"Debug"
"All"

FlipType

Type information:

(Nullable) Any one of the following String (defaults to Symmetric):

NameDescription
"Orthogonal"
"OrthogonalInverse"
"Symmetric"

RotationYawPlacementOffset

Type information:

Any one of the following String (defaults to None):

NameDescription
"None"
"Ninety"
"OneEighty"
"TwoSeventy"

Seats

The details of the seats on this block.

Type information:

(Nullable) Array of the type:

BlockMountPoint with the following properties:

KeyTypeDescription
Offset(Nullable)
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0

Relative offset from the block center (the point at .5,.5,.5 in world). Forward on a chair is 0,0,0.3

YawNumber defaults to: 0.0

Offset for the model sitting on this seat in DEGREES

Beds

The details of the beds for this block.

Type information:

(Nullable) Array of the type:

BlockMountPoint with the following properties:

KeyTypeDescription
Offset(Nullable)
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0

Relative offset from the block center (the point at .5,.5,.5 in world). Forward on a chair is 0,0,0.3

YawNumber defaults to: 0.0

Offset for the model sitting on this seat in DEGREES

MovementSettings

Type information:

BlockMovementSettings with the following properties:

KeyTypeDescription
IsClimbableBoolean defaults to: false
IsBouncyBoolean defaults to: false
BounceVelocity(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ClimbUpSpeedMultiplier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ClimbDownSpeedMultiplier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ClimbLateralSpeedMultiplier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Drag(Nullable) Either Number defaults to: 0.8199999928474426 or String that matches the pattern: ^(-?Infinity|NaN)$
Friction(Nullable) Either Number defaults to: 0.18000000715255737 or String that matches the pattern: ^(-?Infinity|NaN)$
TerminalVelocityModifier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
HorizontalSpeedMultiplier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
JumpForceMultiplier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DisableAutoStepBoolean defaults to: false

If this block's hitbox permits auto-stepping, then this setting can disable it for this block.

Flags

Type information:

(Nullable)

BlockFlags with the following properties:

KeyTypeDescription
IsStackableBoolean defaults to: true

Bench

Type information:

(Nullable) Any of these:

Key: TypeType
CraftingCraftingBench
ProcessingProcessingBench
DiagramCraftingDiagramCraftingBench
StructuralCraftingStructuralCraftingBench

Gathering

Type information:

(Nullable)

BlockGathering with the following properties:

KeyTypeDescription
Breaking(Nullable)
BlockBreakingDropType

BlockBreakingDropType with the following properties:

KeyTypeDescription
GatherType(Nullable) String
QualityInteger defaults to: 0
ItemId(Nullable) String

Reference to a Item asset

QuantityInteger defaults to: 1
DropList(Nullable) Either String or ItemDropList

Reference to a ItemDropList asset

Harvest(Nullable)
HarvestingDropType

HarvestingDropType with the following properties:

KeyTypeDescription
ItemId(Nullable) String

Reference to a Item asset

DropList(Nullable) Either String or ItemDropList

Reference to a ItemDropList asset

Soft(Nullable)
SoftBlockDropType

SoftBlockDropType with the following properties:

KeyTypeDescription
ItemId(Nullable) String

Reference to a Item asset

DropList(Nullable) Either String or ItemDropList

Reference to a ItemDropList asset

IsWeaponBreakableBoolean defaults to: true
Physics(Nullable)
PhysicsDropType

PhysicsDropType with the following properties:

KeyTypeDescription
ItemId(Nullable) String

Reference to a Item asset

DropList(Nullable) Either String or ItemDropList

Reference to a ItemDropList asset

Tools(Nullable) Array of the type:
BlockToolData

BlockToolData with the following properties:

KeyTypeDescription
Type(Nullable) String
State(Nullable) String
ItemId(Nullable) String

Reference to a Item asset

DropList(Nullable) Either String or ItemDropList

Reference to a ItemDropList asset

UseDefaultDropWhenPlacedBoolean defaults to: false

If this is set then player placed blocks will use the default drop behaviour instead of using the droplists.

PlacementSettings

Type information:

(Nullable)

BlockPlacementSettings with the following properties:

KeyTypeDescription
AllowRotationKeyBoolean defaults to: true
PlaceInEmptyBlocksBoolean defaults to: false

If this block is allowed to be placed inside other blocks with an Empty Material (destroying them).

RotationMode(Nullable) Any one of the following String (defaults to Default):
RotationMode
NameDescription
"FacingPlayer"
"BlockNormal"
"StairFacingPlayer"
"Default"

The mode determining the rotation of this block when placed.

BlockPreviewVisibility(Nullable) Any one of the following String (defaults to Default):
BlockPreviewVisibility
NameDescription
"AlwaysVisible"
"AlwaysHidden"
"Default"

An override for the block preview visibility

WallPlacementOverrideBlockId(Nullable) String
FloorPlacementOverrideBlockId(Nullable) String
CeilingPlacementOverrideBlockId(Nullable) String
AllowBreakReplaceBoolean defaults to: false

Farming

Type information:

(Nullable)

FarmingData with the following properties:

KeyTypeDescription
Stages(Nullable) Map of the following:
Map
KeyType
any StringArray of the type: Type Selector
StartingStageSet(Nullable) String defaults to: Default
StageSetAfterHarvest(Nullable) String
ActiveGrowthModifiers(Nullable) Array of the type: Either String or GrowthModifierAsset

Reference to a GrowthModifierAsset asset

SoilConfig(Nullable)
SoilConfig

SoilConfig with the following properties:

KeyTypeDescription
TargetBlockString

Reference to a BlockType asset

LifetimeRangef

FallingBlockSettings

Settings for blocks that can become falling block entities.

Type information:

(Nullable)

FallingBlockSettings with the following properties:

KeyTypeDescription
Impact(Nullable) Type Selector (1)

The FallingBlockImpact that should be applied to falling block entities when they hit the ground.

HitboxCollisionConfig(Nullable) String

Reference to a HitboxCollisionConfig asset

The HitboxCollision config to apply to falling block entities.

IsDoor

Type information: Boolean defaults to: false

AllowsMultipleUsers

Type information: Boolean defaults to: true

HitboxType

Type information: (Nullable) String defaults to: Full

Reference to a BlockBoundingBoxes asset

InteractionHitboxType

Type information: (Nullable) String

Reference to a BlockBoundingBoxes asset

InteractionHint

This property allows to specify custom text that will be displayed underneath the crosshair when the player aims at this block. The value of this property should be a reference to a translation. {key} will be replaced with the interaction input binding.

Type information: (Nullable) String

DamageToEntities

Type information: Integer defaults to: 0

Interactions

A null value removes the inherited interaction for that slot, so a block state can drop its parent's interaction entirely (e.g. a one-time switch becoming inert once turned on).

Type information:

(Nullable) Map of the following:

KeyTypeDescription
PrimaryEither String or RootInteraction

Reference to a RootInteraction asset

SecondaryEither String or RootInteraction

Reference to a RootInteraction asset

Ability1Either String or RootInteraction

Reference to a RootInteraction asset

Ability2Either String or RootInteraction

Reference to a RootInteraction asset

Ability3Either String or RootInteraction

Reference to a RootInteraction asset

Ability4Either String or RootInteraction

Reference to a RootInteraction asset

UseEither String or RootInteraction

Reference to a RootInteraction asset

PickEither String or RootInteraction

Reference to a RootInteraction asset

PickupEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEnterEither String or RootInteraction

Reference to a RootInteraction asset

CollisionLeaveEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEither String or RootInteraction

Reference to a RootInteraction asset

EntityStatEffectEither String or RootInteraction

Reference to a RootInteraction asset

SwapToEither String or RootInteraction

Reference to a RootInteraction asset

SwapFromEither String or RootInteraction

Reference to a RootInteraction asset

DeathEither String or RootInteraction

Reference to a RootInteraction asset

WieldingEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileSpawnEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileHitEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileMissEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileBounceEither String or RootInteraction

Reference to a RootInteraction asset

HeldEither String or RootInteraction

Reference to a RootInteraction asset

HeldOffhandEither String or RootInteraction

Reference to a RootInteraction asset

EquippedEither String or RootInteraction

Reference to a RootInteraction asset

DodgeEither String or RootInteraction

Reference to a RootInteraction asset

GameModeSwapEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakImpactEither String or RootInteraction

Reference to a RootInteraction asset

BlockSoundSetId

Sets the BlockSoundSet that will be used for this block for various events e.g. placement, breaking

Type information: (Nullable) String defaults to: EMPTY

Reference to a BlockSoundSet asset

PhysicalMaterialId

Sets the PhysicalMaterial of the block. Currently used primarily for acoustic properties.

Type information: (Nullable) String defaults to: EMPTY

Reference to a PhysicalMaterial asset

SoundOcclusionOpacity

Scales per-source audio occlusion attenuation for this block. Multiplied with PhysicalMaterial AttenuationPerBlock. Set to 0, the material applies no attenuation. Set to 1 it applies the full specified attenuation. Can be set to values higher than 1 to increase attenuation until no sound penetrates.

Type information:

(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

AmbientSoundEventId

A looping ambient sound event that emits from this block when placed in the world or held in-hand.

Type information: (Nullable) String

Reference to a SoundEvent asset

ConditionalSounds

An array of conditional ambient sounds. Each entry references a looping sound event and an AmbienceFX whose conditions determine when the sound plays from this block.

Type information:

(Nullable) Array of the type:

ConditionalBlockSound with the following properties:

KeyTypeDescription
SoundEventIdString

Reference to a SoundEvent asset

AmbienceFXIdString

Reference to a AmbienceFX asset

InteractionSoundEventId

A oneshot sound event that plays upon interaction with this block.

Type information: (Nullable) String

Reference to a SoundEvent asset

Looping

Type information: Boolean defaults to: false

SupportDropType

Type information:

(Nullable) Any one of the following String (defaults to Break):

NameDescription
"Break"
"Destroy"
"Fall"

MaxSupportDistance

Type information: Integer defaults to: 0

SupportsRequiredFor

Type information:

Any one of the following String (defaults to All):

NameDescription
"Any"
"All"

Support

A set of "Required Support" conditions. If met, the block won't fall off from block physics checks. If this field is empty the block is automatically considered supported.

Type information:

(Nullable) Map of the following:

KeyTypeDescription
UpArray of the type: RequiredBlockFaceSupport
DownArray of the type: RequiredBlockFaceSupport
NorthArray of the type: RequiredBlockFaceSupport
EastArray of the type: RequiredBlockFaceSupport
SouthArray of the type: RequiredBlockFaceSupport
WestArray of the type: RequiredBlockFaceSupport
UpNorthArray of the type: RequiredBlockFaceSupport
UpSouthArray of the type: RequiredBlockFaceSupport
UpEastArray of the type: RequiredBlockFaceSupport
UpWestArray of the type: RequiredBlockFaceSupport
DownNorthArray of the type: RequiredBlockFaceSupport
DownSouthArray of the type: RequiredBlockFaceSupport
DownEastArray of the type: RequiredBlockFaceSupport
DownWestArray of the type: RequiredBlockFaceSupport
NorthEastArray of the type: RequiredBlockFaceSupport
SouthEastArray of the type: RequiredBlockFaceSupport
SouthWestArray of the type: RequiredBlockFaceSupport
NorthWestArray of the type: RequiredBlockFaceSupport
UpNorthEastArray of the type: RequiredBlockFaceSupport
UpSouthEastArray of the type: RequiredBlockFaceSupport
UpSouthWestArray of the type: RequiredBlockFaceSupport
UpNorthWestArray of the type: RequiredBlockFaceSupport
DownNorthEastArray of the type: RequiredBlockFaceSupport
DownSouthEastArray of the type: RequiredBlockFaceSupport
DownSouthWestArray of the type: RequiredBlockFaceSupport
DownNorthWestArray of the type: RequiredBlockFaceSupport
AllArray of the type: RequiredBlockFaceSupport
BlockSidesArray of the type: RequiredBlockFaceSupport
CardinalDirectionsArray of the type: RequiredBlockFaceSupport
HorizontalArray of the type: RequiredBlockFaceSupport
UpCardinalDirectionsArray of the type: RequiredBlockFaceSupport
DownCardinalDirectionsArray of the type: RequiredBlockFaceSupport

Supporting

Type information:

(Nullable) Map of the following:

KeyTypeDescription
UpArray of the type: BlockFaceSupport
DownArray of the type: BlockFaceSupport
NorthArray of the type: BlockFaceSupport
EastArray of the type: BlockFaceSupport
SouthArray of the type: BlockFaceSupport
WestArray of the type: BlockFaceSupport
UpNorthArray of the type: BlockFaceSupport
UpSouthArray of the type: BlockFaceSupport
UpEastArray of the type: BlockFaceSupport
UpWestArray of the type: BlockFaceSupport
DownNorthArray of the type: BlockFaceSupport
DownSouthArray of the type: BlockFaceSupport
DownEastArray of the type: BlockFaceSupport
DownWestArray of the type: BlockFaceSupport
NorthEastArray of the type: BlockFaceSupport
SouthEastArray of the type: BlockFaceSupport
SouthWestArray of the type: BlockFaceSupport
NorthWestArray of the type: BlockFaceSupport
UpNorthEastArray of the type: BlockFaceSupport
UpSouthEastArray of the type: BlockFaceSupport
UpSouthWestArray of the type: BlockFaceSupport
UpNorthWestArray of the type: BlockFaceSupport
DownNorthEastArray of the type: BlockFaceSupport
DownSouthEastArray of the type: BlockFaceSupport
DownSouthWestArray of the type: BlockFaceSupport
DownNorthWestArray of the type: BlockFaceSupport
AllArray of the type: BlockFaceSupport
BlockSidesArray of the type: BlockFaceSupport
CardinalDirectionsArray of the type: BlockFaceSupport
HorizontalArray of the type: BlockFaceSupport
UpCardinalDirectionsArray of the type: BlockFaceSupport
DownCardinalDirectionsArray of the type: BlockFaceSupport

IgnoreSupportWhenPlaced

Whether when this block is placed by a player that the support requirements should be ignored.

Type information: Boolean defaults to: false

Aliases

Specifies the alternatives names (aliases) for a block type for use in command matching

Type information: (Nullable) Array of String

Tint

Type information:

(Nullable) Array of the type: A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

TintUp

Type information:

(Nullable) Array of the type: A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

TintDown

Type information:

(Nullable) Array of the type: A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

TintNorth

Type information:

(Nullable) Array of the type: A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

TintSouth

Type information:

(Nullable) Array of the type: A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

TintWest

Type information:

(Nullable) Array of the type: A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

TintEast

Type information:

(Nullable) Array of the type: A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

BiomeTint

Type information: Integer

BiomeTintUp

Type information: Integer defaults to: 0

BiomeTintDown

Type information: Integer defaults to: 0

BiomeTintNorth

Type information: Integer defaults to: 0

BiomeTintSouth

Type information: Integer defaults to: 0

BiomeTintWest

Type information: Integer defaults to: 0

BiomeTintEast

Type information: Integer defaults to: 0

State

Type information:

(Nullable)

StateData with the following properties:

KeyTypeDescription
Definitions(Nullable) Map of the following:
Map
KeyType
any StringEither String or BlockType

Reference to a BlockType asset

BlockEntity

Type information:

(Nullable)

Holder with the following properties:

KeyTypeDescription
Components(Nullable)
Object

Object with the following properties:

KeyTypeDescription
AugmentBlockAugmentBlock
BenchBlockBenchBlock
BlockBlockSection
BlockAnimationSectionBlockAnimationSection
BlockChunkBlockChunk
BlockComponentBlockComponentSection
BlockComponentChunkBlockComponentChunk
BlockExplosiveBlockExplosive
BlockHealthChunkBlockHealthChunk
BlockHealthSectionBlockHealthSection
BlockMapMarkerBlockMapMarker
BlockPhysicsBlockPhysics
BlockSpawnerBlockSpawner
ChunkColumnChunkColumn
ChunkSectionChunkSection
ChunkSpawnedNPCDataChunkSpawnedNPCData
CompanionBlockSpawnerBlockCompanionBlockSpawnerBlock
CoopCoopBlock
EntityEntitySection
EntityChunkEntityChunk
EnvironmentEnvironmentSection
EnvironmentChunkEnvironmentChunk
EventTrackedBlockTrackedBlockComponent
FarmingBlockFarmingBlock
FluidFluidSection
HeightmapColumnHeightmapColumn
InstanceInstanceBlock
InstanceConfigConfigurableInstanceBlock
ItemContainerBlockItemContainerBlock
LaunchPadLaunchPad
MusicEmitterBlockMusicEmitterBlock
MusicPlayerBlockMusicPlayerBlock
PlacedByInteractionPlacedByInteractionComponent
PortalPortalDevice
PrefabSpawnerPrefabSpawnerBlock
ProcessingBenchBlockProcessingBenchBlock
RespawnBlockRespawnBlock
SpawnMarkerBlockSpawnMarkerBlock
TeleporterTeleporter
TilledSoilTilledSoilBlock
TrackedPlacementTrackedPlacement
UnknownUnknownComponents
WorldChunkWorldChunk

Rail

Type information:

(Nullable)

RailConfig with the following properties:

KeyTypeDescription
PointsArray of the type:
RailPoint

RailPoint with the following properties:

KeyTypeDescription
PointVector3f
NormalVector3f

ExplosionConfig

The explosion config associated with this block.

Type information:

(Nullable)

ExplosionConfig with the following properties:

KeyTypeDescription
DamageEntitiesBoolean defaults to: true

Determines whether the explosion should damage entities.

DamageBlocksBoolean defaults to: true

Determines whether the explosion should damage blocks.

DetonateExplosiveBlocksBoolean defaults to: true

Determines whether the explosion should detonate explosive blocks within the explosion radius.

BlockDamageRadiusInteger defaults to: 3

The radius in which blocks should be damaged by the explosion.

BlockDamageFalloff(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The falloff applied to the block damage.

BlockDropChance(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The chance in which a block drops its loot after breaking.

EntityDamageRadius(Nullable) Either Number defaults to: 5.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The radius in which entities should be damaged by the explosion.

EntityDamage(Nullable) Either Number defaults to: 50.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The amount of damage to be applied to entities within range.

EntityDamageCauseString defaults to: Environment

Reference to a DamageCause asset

The cause of the damage to be applied to entities within range.

EntityDamageFalloff(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The falloff applied to the entity damage.

Knockback(Nullable) Type Selector (2)

Determines the knockback effect applied to damaged entities.

ItemTool(Nullable)
ItemTool

ItemTool with the following properties:

KeyTypeDescription
Specs(Nullable) Array of the type: ItemToolSpec
SpeedNumber defaults to: 0.0
DurabilityLossBlockTypes(Nullable) Array of the type: DurabilityLossBlockTypes
BreakShape(Nullable) Either BoxBreakShape or CylinderBreakShape

Optional break shape. When set, breaking with this tool affects the set of blocks the shape covers (oriented to the user's view) instead of only the targeted block.

BreakShapeDurabilityModeBreakShapeDurabilityMode

How durability is consumed when a break shape affects multiple blocks: once per swing, or once per block broken.

HitSoundLayer(Nullable) String

Reference to a SoundEvent asset

Sound to play in addition to the block breaking sound when hitting a block this tool is designed to break.

IncorrectMaterialSoundLayer(Nullable) String

Reference to a SoundEvent asset

Sound to play in addition to the block breaking sound when hitting a block this tool cannot break.

The item tool to reference when applying damage to blocks.

Particles(Nullable) Array of the type:
ModelParticle

ModelParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

TargetEntityPartEntityPart
TargetNodeName(Nullable) String
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ScaleNumber defaults to: 1.0
PositionOffset(Nullable) Vector3f
RotationOffset(Nullable) Direction
DetachedFromModelBoolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemoveBoolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

The particles to spawn when the explosion is triggered.

SoundEventId(Nullable) String

Reference to a SoundEvent asset

The sound event played to surrounding players when the explosion is triggered.

ExplosionReactionState

Type information: (Nullable) String

Notes:

Types referenced by this type

Map

(Nullable) Map of the following:

KeyType
any StringString

Map (1)

(Nullable) Map of the following:

KeyType
any String
ConnectedBlockOutput

ConnectedBlockOutput with the following properties:

KeyTypeDescription
State(Nullable) String

An optional state definition to apply to the base block type

Block(Nullable) String

An optional block ID to use instead of the base block type

Type Selector

Any of these:

Key: TypeType
BlockState
BlockStateFarmingStageData

BlockStateFarmingStageData with the following properties:

KeyTypeDescription
TypeConstant value: BlockState

This field controls the type, it must be set to the constant value "BlockState" to function as this type.

Duration(Nullable) Rangef
SoundEventId(Nullable) String

Reference to a SoundEvent asset

State(Nullable) String
BlockType
BlockTypeFarmingStageData

BlockTypeFarmingStageData with the following properties:

KeyTypeDescription
TypeConstant value: BlockType

This field controls the type, it must be set to the constant value "BlockType" to function as this type.

Duration(Nullable) Rangef
SoundEventId(Nullable) String

Reference to a SoundEvent asset

Block(Nullable) String

Reference to a BlockType asset

Prefab
PrefabFarmingStageData

PrefabFarmingStageData with the following properties:

KeyTypeDescription
TypeConstant value: Prefab

This field controls the type, it must be set to the constant value "Prefab" to function as this type.

Duration(Nullable) Rangef
SoundEventId(Nullable) String

Reference to a SoundEvent asset

Prefabs(Nullable) Array of the type: PrefabStage
ReplaceMaskTags(Nullable) Array of String
TolerateObstructionsBelowYInteger
TolerateObstructionsAboveYInteger
Spread
SpreadFarmingStageData

SpreadFarmingStageData with the following properties:

KeyTypeDescription
TypeConstant value: Spread

This field controls the type, it must be set to the constant value "Spread" to function as this type.

Duration(Nullable) Rangef
SoundEventId(Nullable) String

Reference to a SoundEvent asset

ExecutionsIntRange

Defines the number of times the stage will be repeated. Range must be positive, min value must be >= 1.

SpreadDecayPercentIntRange (1)

The amount to reduce (linear decay) the spread rate (chance to spread) for any spawned blocks that also have a spread stage. Range must be positive.

GrowthBehavioursArray of the type: DirectionalGrowthBehaviour

Defines an array of the different growth behaviours that'll be run for each execution.

IntRange

Fixed size array of the following:

Type
Integer
Integer

IntRange (1)

Fixed size array of the following:

Type
Integer
Integer

Type Selector (1)

Any of these:

Key: TypeType
Break
BreakFallingBlockImpact

BreakFallingBlockImpact with the following properties:

KeyTypeDescription
TypeConstant value: Break

This field controls the type, it must be set to the constant value "Break" to function as this type.

DropItemsBoolean defaults to: true
Explode
ExplodeFallingBlockImpact

ExplodeFallingBlockImpact with the following properties:

KeyTypeDescription
TypeConstant value: Explode

This field controls the type, it must be set to the constant value "Explode" to function as this type.

default case: Place
PlaceFallingBlockImpact

PlaceFallingBlockImpact with the following properties:

KeyTypeDescription
Type(Nullable) String

This field controls the type, it must be set to the constant value "Place" to function as this type.

AugmentBlock

AugmentBlock with the following properties:

KeyTypeDescription
Upgrades(Nullable) Array of the type:
AugmentBlockUpgradeLevel

AugmentBlockUpgradeLevel with the following properties:

KeyTypeDescription
State(Nullable) String
Cost(Nullable) Array of the type: MaterialQuantity
RequiredAugmentTags(Nullable) Array of String
GrantsAugmentTags(Nullable) Array of String
ReplaceBlock(Nullable) String
CurrentLevelInteger defaults to: 0
GrantsAugmentTags(Nullable) Array of String
RadiusNumber defaults to: 100.0
ProgressionKey(Nullable) String
ProgressionLevelOffsetInteger defaults to: 0

BenchBlock

BenchBlock with the following properties:

KeyTypeDescription
TierLevelInteger defaults to: 1
UpgradeItems(Nullable) Array of the type:
ItemStack

ItemStack with the following properties:

KeyTypeDescription
IdString

Reference to a Item asset

QuantityInteger defaults to: 1
DurabilityNumber defaults to: 0.0
MaxDurabilityNumber defaults to: 0.0
QualityOverrideInteger
Metadata(Nullable) Type 0
OverrideDroppedItemAnimationBoolean defaults to: false

Type 0

(Nullable) Map of the following:

KeyType
any Stringanything

BlockSection

BlockSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

BlockAnimationSection

BlockAnimationSection with the following properties:

KeyTypeDescription
VersionInteger
RevisionInteger defaults to: 0
Entries(Nullable) Array of the type:
SerializedEntry

SerializedEntry with the following properties:

KeyTypeDescription
IndexInteger defaults to: 0
Speed(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

BlockChunk

BlockChunk with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

BlockComponentSection

BlockComponentSection with the following properties:

KeyTypeDescription
Blocks(Nullable) Map of the following:
Map
KeyType

A string that contains any integer

Holder

BlockComponentChunk

BlockComponentChunk with the following properties:

KeyTypeDescription
BlockComponents(Nullable) Map of the following:
Map
KeyType

A string that contains any integer

Holder

BlockExplosive

BlockExplosive with the following properties:

KeyTypeDescription
PrimedOnPlaceBoolean defaults to: false

If the fuse will immediately being running down when the block is placed.

FuseDuration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration between being primed and exploding.

BlockHealthChunk

BlockHealthChunk with the following properties:

KeyTypeDescription
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

Binary data representing the state of this BlockHealthChunk

LastRepairGameTime(Nullable) String

The last tick of the world this BlockHealthChunk processed.

BlockHealthSection

BlockHealthSection with the following properties:

KeyTypeDescription
VersionInteger
Health(Nullable) Map of the following:
Map
KeyType

A string that contains any integer

BlockHealth

Damaged blocks by section block index.

Fragility(Nullable) Map of the following:
Map
KeyType

A string that contains any integer

Number

Fragile blocks by section block index, with the seconds of fragility left.

BlockMapMarker

BlockMapMarker with the following properties:

KeyTypeDescription
NameString
IconString
DiscoverableBoolean

Whether the marker stays hidden until a gameplay system reveals it to a player.

IconSize(Nullable) Any one of the following String:
MapMarkerIconSize
NameDescription
"Default"

The standard marker icon size.

"Major"

A larger marker icon size.

The size of the marker icon on the world map and the compass. Omit this field or use Default for the standard size. Use Major for a larger icon.

CompassIcon(Nullable) String

Optional icon used on the compass. Omit this field to use Icon.

Alert(Nullable)
MapMarkerAlert

MapMarkerAlert with the following properties:

KeyTypeDescription
Icon(Nullable) String

Optional icon shown during the alert, relative to UI/WorldMap/MapMarkers. Omit this field to keep the marker icon.

Duration(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$

The time in seconds that the alert lasts. The timer starts the first time the marker is inside the compass field of view.

Timeout(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$

The time in seconds that the alert waits for the marker to come inside the compass field of view. If it does not, the alert is removed.

Tint(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

Optional tint of the icon during the alert. Omit this field to keep the marker tint.

Optional compass alert shown for a period after the client adds the marker. Omit this field for no alert.

BlockPhysics

BlockPhysics with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

BlockSpawner

BlockSpawner with the following properties:

KeyTypeDescription
BlockSpawnerId(Nullable) String

ChunkColumn

ChunkColumn with the following properties:

KeyTypeDescription
Sections(Nullable) Array of the type:
Holder

Holder with the following properties:

KeyTypeDescription
Components(Nullable) Type 1

Type 1

(Nullable)

Object with the following properties:

KeyTypeDescription
AugmentBlock
AugmentBlock

AugmentBlock with the following properties:

KeyTypeDescription
Upgrades(Nullable) Array of the type: AugmentBlockUpgradeLevel
CurrentLevelInteger defaults to: 0
GrantsAugmentTags(Nullable) Array of String
RadiusNumber defaults to: 100.0
ProgressionKey(Nullable) String
ProgressionLevelOffsetInteger defaults to: 0
BenchBlock
BenchBlock

BenchBlock with the following properties:

KeyTypeDescription
TierLevelInteger defaults to: 1
UpgradeItems(Nullable) Array of the type: ItemStack
Block
BlockSection

BlockSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
BlockAnimationSection
BlockAnimationSection

BlockAnimationSection with the following properties:

KeyTypeDescription
VersionInteger
RevisionInteger defaults to: 0
Entries(Nullable) Array of the type: SerializedEntry
BlockChunk
BlockChunk

BlockChunk with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
BlockComponent
BlockComponentSection

BlockComponentSection with the following properties:

KeyTypeDescription
Blocks(Nullable) Type 2
BlockComponentChunk
BlockComponentChunk

BlockComponentChunk with the following properties:

KeyTypeDescription
BlockComponents(Nullable) Type 2
BlockExplosive
BlockExplosive

BlockExplosive with the following properties:

KeyTypeDescription
PrimedOnPlaceBoolean defaults to: false

If the fuse will immediately being running down when the block is placed.

FuseDuration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration between being primed and exploding.

BlockHealthChunk
BlockHealthChunk

BlockHealthChunk with the following properties:

KeyTypeDescription
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

Binary data representing the state of this BlockHealthChunk

LastRepairGameTime(Nullable) String

The last tick of the world this BlockHealthChunk processed.

BlockHealthSection
BlockHealthSection

BlockHealthSection with the following properties:

KeyTypeDescription
VersionInteger
Health(Nullable) Type 3

Damaged blocks by section block index.

Fragility(Nullable) Type 4

Fragile blocks by section block index, with the seconds of fragility left.

BlockMapMarker
BlockMapMarker

BlockMapMarker with the following properties:

KeyTypeDescription
NameString
IconString
DiscoverableBoolean

Whether the marker stays hidden until a gameplay system reveals it to a player.

IconSize(Nullable) MapMarkerIconSize

The size of the marker icon on the world map and the compass. Omit this field or use Default for the standard size. Use Major for a larger icon.

CompassIcon(Nullable) String

Optional icon used on the compass. Omit this field to use Icon.

Alert(Nullable) MapMarkerAlert

Optional compass alert shown for a period after the client adds the marker. Omit this field for no alert.

BlockPhysics
BlockPhysics

BlockPhysics with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
BlockSpawner
BlockSpawner

BlockSpawner with the following properties:

KeyTypeDescription
BlockSpawnerId(Nullable) String
ChunkColumn
ChunkColumn

ChunkColumn with the following properties:

KeyTypeDescription
Sections(Nullable) Array of the type: Holder
ChunkSection
ChunkSection

ChunkSection with the following properties:

KeyTypeDescription
ChunkSpawnedNPCData
ChunkSpawnedNPCData

ChunkSpawnedNPCData with the following properties:

KeyTypeDescription
EnvironmentSpawnCounts(Nullable) Map of string to double
CompanionBlockSpawnerBlock
CompanionBlockSpawnerBlock

CompanionBlockSpawnerBlock with the following properties:

KeyTypeDescription
Marker(Nullable) PersistentRef
ClaimedByBlock(Nullable) Vector3i
Coop
CoopBlock

CoopBlock with the following properties:

KeyTypeDescription
FarmingCoopId(Nullable) String
Residents(Nullable) Array of the type: CoopResident
Storage(Nullable) Either EmptyItemContainer or SimpleItemContainer
Entity
EntitySection

EntitySection with the following properties:

KeyTypeDescription
Entities(Nullable) Array of the type: Holder
EntityChunk
EntityChunk

EntityChunk with the following properties:

KeyTypeDescription
Entities(Nullable) Array of the type: Holder
Environment
EnvironmentSection

EnvironmentSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
EnvironmentChunk
EnvironmentChunk

EnvironmentChunk with the following properties:

KeyTypeDescription
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
EventTrackedBlock
TrackedBlockComponent

TrackedBlockComponent with the following properties:

KeyTypeDescription
UUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
ContextKey(Nullable) String
FarmingBlock
FarmingBlock

FarmingBlock with the following properties:

KeyTypeDescription
CurrentStageSet(Nullable) String
GrowthProgress(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
LastTickGameTime(Nullable) String
GenerationInteger
PreviousBlockType(Nullable) String
SpreadRate(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
ExecutionsInteger
Fluid
FluidSection

FluidSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
HeightmapColumn
HeightmapColumn

HeightmapColumn with the following properties:

KeyTypeDescription
HeightmapEither LegacyHeightmap or TreeHeightmap
Instance
InstanceBlock

InstanceBlock with the following properties:

KeyTypeDescription
WorldName(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
CloseOnBlockRemoveBoolean defaults to: true
InstanceConfig
ConfigurableInstanceBlock

ConfigurableInstanceBlock with the following properties:

KeyTypeDescription
WorldName(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
CloseOnBlockRemoveBoolean defaults to: true
InstanceName(Nullable) String
InstanceKey(Nullable) String
PositionOffset(Nullable) Vector3d
Rotation(Nullable) Rotation3f
PersonalReturnPointBoolean defaults to: false
RemoveBlockAfterNumber defaults to: -1.0
ItemContainerBlock
ItemContainerBlock

ItemContainerBlock with the following properties:

KeyTypeDescription
Droplist(Nullable) String

Reference to a ItemDropList asset

ItemContainer(Nullable) SimpleItemContainer
CapacityInteger defaults to: 20
StayOpenWhenEmptyBoolean

If true, the container keeps its OpenWindow block state when the last window closes on an empty container.

LaunchPad
LaunchPad

LaunchPad with the following properties:

KeyTypeDescription
VelocityXNumber defaults to: 0.0

The X velocity of the launch pad.

VelocityYNumber defaults to: 0.0

The Y velocity of the launch pad.

VelocityZNumber defaults to: 0.0

The Z velocity of the launch pad.

PlayersOnlyBoolean defaults to: false

Determines whether only players can use this launch pad.

MusicEmitterBlock
MusicEmitterBlock

MusicEmitterBlock with the following properties:

KeyTypeDescription
MusicContainer(Nullable) String

Reference to a MusicContainer asset

MusicContainer asset id this emitter plays.

AudioCategoryOverride(Nullable) String

Reference to a AudioCategory asset

Optional AudioCategory asset id overriding the container's routing.

ReferenceDistance(Nullable) Either Number defaults to: 8.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance at which the emitter plays at full volume.

MaxDistance(Nullable) Either Number defaults to: 25.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance beyond which the emitter is inaudible.

SpatialBlend(Nullable) Either Number defaults to: 0.6000000238418579 or String that matches the pattern: ^(-?Infinity|NaN)$

0 = fully 2D, 1 = fully 3D positioned.

ReverbSend(Nullable) Either Number defaults to: 0.3499999940395355 or String that matches the pattern: ^(-?Infinity|NaN)$

Fraction routed to environment reverb. 0 = dry, 1 = full. Lower keeps sustained music from washing in reverberant spaces.

Volume(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Volume adjustment in decibels, usually to compensate for a quiet mono downmix. 0 = unchanged.

LoopBoolean defaults to: true

Loop the container indefinitely, overriding its authored LoopCount.

OriginInteger defaults to: 0

Persisted epoch-milli the emitter first started. 0 = unstamped.

MusicPlayerBlock
MusicPlayerBlock

MusicPlayerBlock with the following properties:

KeyTypeDescription
InsertSound(Nullable) String

Reference to a SoundEvent asset

SoundEvent played at the block when a music item is inserted, before the start delay.

RemoveSound(Nullable) String

Reference to a SoundEvent asset

SoundEvent played at the block after a music item is removed and the track has stopped, after the stop delay.

StartDelaySeconds(Nullable) Either Number defaults to: 2.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Seconds between the insert sound and the track starting.

StopDelaySeconds(Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$

Seconds between the track stopping on item removal and the remove sound playing.

ReferenceDistance(Nullable) Either Number defaults to: 8.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance at which the track plays at full volume.

MaxDistance(Nullable) Either Number defaults to: 25.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance beyond which the track is inaudible.

SpatialBlend(Nullable) Either Number defaults to: 0.6000000238418579 or String that matches the pattern: ^(-?Infinity|NaN)$

0 = fully 2D, 1 = fully 3D positioned.

ReverbSend(Nullable) Either Number defaults to: 0.3499999940395355 or String that matches the pattern: ^(-?Infinity|NaN)$

Fraction routed to environment reverb. 0 = dry, 1 = full. Lower keeps sustained music from washing in reverberant spaces.

Volume(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Volume adjustment in decibels.

LoopBoolean defaults to: true

Loop the inserted item's container indefinitely, overriding its authored LoopCount.

PlacedByInteraction
PlacedByInteractionComponent

PlacedByInteractionComponent with the following properties:

KeyTypeDescription
WhoPlacedUuid(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
Portal
PortalDevice

PortalDevice with the following properties:

KeyTypeDescription
Config(Nullable) PortalDeviceConfig
BaseBlockType(Nullable) String
DestinationWorld(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
PrefabSpawner
PrefabSpawnerBlock

PrefabSpawnerBlock with the following properties:

KeyTypeDescription
PrefabPath(Nullable) String

The prefab path where the prefab is located. This uses the dot-notation. 'folder.folder.folder.filename'

FitHeightmapBoolean defaults to: false

Determines if the child prefab should follow the heightmap during generation in worldgen.

InheritSeedBoolean defaults to: true

Determines if the child prefab should inherit the worldgen-id from the parent. This allows child prefabs to have independent markers.

InheritHeightConditionBoolean defaults to: true

Determines if the child prefab should inherit the HeightCondition from the parent. Setting to false allows child prefabs to bypass the height condition check.

PrefabWeights(Nullable) PrefabWeights

Determines the probability of each individual prefab file being selected to generate when the PrefabPath points to a folder containing multiple prefabs.

ProcessingBenchBlock
ProcessingBenchBlock

ProcessingBenchBlock with the following properties:

KeyTypeDescription
InputContainer(Nullable) Either EmptyItemContainer or SimpleItemContainer
FuelContainer(Nullable) Either EmptyItemContainer or SimpleItemContainer
OutputContainer(Nullable) Either EmptyItemContainer or SimpleItemContainer
ProgressNumber defaults to: 0.0
FuelTimeNumber defaults to: 0.0
ActiveBoolean defaults to: false
NextExtraInteger defaults to: -1
RecipeId(Nullable) String
LastTickGameTime(Nullable) String
RespawnBlock
RespawnBlock

RespawnBlock with the following properties:

KeyTypeDescription
OwnerUUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
SpawnMarkerBlock
SpawnMarkerBlock

SpawnMarkerBlock with the following properties:

KeyTypeDescription
MarkerReference(Nullable) PersistentRef
Config(Nullable) Data
Teleporter
Teleporter

Teleporter with the following properties:

KeyTypeDescription
World(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
Transform(Nullable) Transform
RelativeInteger defaults to: 0
Warp(Nullable) String
OwnedWarp(Nullable) String
IsCustomNameBoolean defaults to: false
WarpNameWordList(Nullable) String

The ID of the Word list to select default warp names from

TilledSoil
TilledSoilBlock

TilledSoilBlock with the following properties:

KeyTypeDescription
VersionInteger
PlantedBoolean
ModifierTimes(Nullable) Map (2)
Flags(Nullable) Array of String
FertilizedBoolean
ExternalWaterBoolean
WateredUntil(Nullable) String
DecayTime(Nullable) String
TrackedPlacement
TrackedPlacement

TrackedPlacement with the following properties:

KeyTypeDescription
BlockName(Nullable) String
Unknown
UnknownComponents

UnknownComponents with the following properties:

KeyTypeDescription
Components(Nullable) Map (3)
WorldChunk
WorldChunk

WorldChunk with the following properties:

KeyTypeDescription

Type 2

(Nullable) Map of the following:

KeyType

A string that contains any integer

Holder

Holder with the following properties:

KeyTypeDescription
Components(Nullable) Type 1

Type 3

(Nullable) Map of the following:

KeyType

A string that contains any integer

BlockHealth

BlockHealth with the following properties:

KeyTypeDescription
Health(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Remaining health from 0.0 (destroyed) to 1.0 (undamaged).

LastDamage(Nullable) Integer

The game time of the last hit, as epoch milliseconds.

Type 4

(Nullable) Map of the following:

KeyType

A string that contains any integer

Number

MapMarkerIconSize

(Nullable) Any one of the following String:

NameDescription
"Default"

The standard marker icon size.

"Major"

A larger marker icon size.

Map of string to double

(Nullable) Map of the following:

KeyType
StringNumber

Map (2)

(Nullable) Map of the following:

KeyType
any StringString

Map (3)

(Nullable) Map of the following:

KeyType
any StringMap of the following:
Map
KeyType
any Stringanything

ChunkSection

ChunkSection with the following properties:

KeyTypeDescription

ChunkSpawnedNPCData

ChunkSpawnedNPCData with the following properties:

KeyTypeDescription
EnvironmentSpawnCounts(Nullable) Map of the following:
Map of string to double
KeyType
StringNumber

CompanionBlockSpawnerBlock

CompanionBlockSpawnerBlock with the following properties:

KeyTypeDescription
Marker(Nullable)
PersistentRef

PersistentRef with the following properties:

KeyTypeDescription
UUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
ClaimedByBlock(Nullable)
Vector3i

Vector3i with the following properties:

KeyTypeDescription
XInteger defaults to: 0
YInteger defaults to: 0
ZInteger defaults to: 0

CoopBlock

CoopBlock with the following properties:

KeyTypeDescription
FarmingCoopId(Nullable) String
Residents(Nullable) Array of the type:
CoopResident

CoopResident with the following properties:

KeyTypeDescription
Metadata(Nullable) CapturedNPCMetadata
PersistentRef(Nullable) PersistentRef
DeployedToWorldBoolean defaults to: false
LastHarvested(Nullable) String
Storage(Nullable) Either
EmptyItemContainer

EmptyItemContainer with the following properties:

KeyTypeDescription
IdConstant value: Empty

This field controls the type, it must be set to the constant value "Empty" to function as this type.

or
SimpleItemContainer

SimpleItemContainer with the following properties:

KeyTypeDescription
Id(Nullable) String

This field controls the type, it must be set to the constant value "Simple" to function as this type.

CapacityInteger defaults to: 0
Items(Nullable) Type 5

Type 5

(Nullable) Map of the following:

KeyType

A string that contains any integer

ItemStack

ItemStack with the following properties:

KeyTypeDescription
IdString

Reference to a Item asset

QuantityInteger defaults to: 1
DurabilityNumber defaults to: 0.0
MaxDurabilityNumber defaults to: 0.0
QualityOverrideInteger
Metadata(Nullable) Type 0
OverrideDroppedItemAnimationBoolean defaults to: false

EntitySection

EntitySection with the following properties:

KeyTypeDescription
Entities(Nullable) Array of the type:
Holder

Holder with the following properties:

KeyTypeDescription
Components(Nullable) Type 1

EntityChunk

EntityChunk with the following properties:

KeyTypeDescription
Entities(Nullable) Array of the type:
Holder

Holder with the following properties:

KeyTypeDescription
Components(Nullable) Type 1

EnvironmentSection

EnvironmentSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

EnvironmentChunk

EnvironmentChunk with the following properties:

KeyTypeDescription
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

TrackedBlockComponent

TrackedBlockComponent with the following properties:

KeyTypeDescription
UUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
ContextKey(Nullable) String

FarmingBlock

FarmingBlock with the following properties:

KeyTypeDescription
CurrentStageSet(Nullable) String
GrowthProgress(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
LastTickGameTime(Nullable) String
GenerationInteger
PreviousBlockType(Nullable) String
SpreadRate(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
ExecutionsInteger

FluidSection

FluidSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

HeightmapColumn

HeightmapColumn with the following properties:

KeyTypeDescription
HeightmapEither
LegacyHeightmap

LegacyHeightmap with the following properties:

KeyTypeDescription
IdConstant value: Legacy

This field controls the type, it must be set to the constant value "Legacy" to function as this type.

HeightString that matches the pattern: ^[0-9a-zA-Z+/]+$
or
TreeHeightmap

TreeHeightmap with the following properties:

KeyTypeDescription
IdConstant value: Tree

This field controls the type, it must be set to the constant value "Tree" to function as this type.

TopValuesArray of Integer
CollisionTopsArray of Integer
EstimatedTops(Nullable) Array of Integer
EstimatedCollisionTops(Nullable) Array of Integer

InstanceBlock

InstanceBlock with the following properties:

KeyTypeDescription
WorldName(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
CloseOnBlockRemoveBoolean defaults to: true

ConfigurableInstanceBlock

ConfigurableInstanceBlock with the following properties:

KeyTypeDescription
WorldName(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
CloseOnBlockRemoveBoolean defaults to: true
InstanceName(Nullable) String
InstanceKey(Nullable) String
PositionOffset(Nullable)
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0
Rotation(Nullable)
Rotation3f

Rotation3f with the following properties:

KeyTypeDescription
Pitch(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
Yaw(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
PersonalReturnPointBoolean defaults to: false
RemoveBlockAfterNumber defaults to: -1.0

ItemContainerBlock

ItemContainerBlock with the following properties:

KeyTypeDescription
Droplist(Nullable) String

Reference to a ItemDropList asset

ItemContainer(Nullable)
SimpleItemContainer

SimpleItemContainer with the following properties:

KeyTypeDescription
Id(Nullable) String

This field controls the type, it must be set to the constant value "Simple" to function as this type.

CapacityInteger defaults to: 0
Items(Nullable) Type 5
CapacityInteger defaults to: 20
StayOpenWhenEmptyBoolean

If true, the container keeps its OpenWindow block state when the last window closes on an empty container.

LaunchPad

LaunchPad with the following properties:

KeyTypeDescription
VelocityXNumber defaults to: 0.0

The X velocity of the launch pad.

VelocityYNumber defaults to: 0.0

The Y velocity of the launch pad.

VelocityZNumber defaults to: 0.0

The Z velocity of the launch pad.

PlayersOnlyBoolean defaults to: false

Determines whether only players can use this launch pad.

MusicEmitterBlock

MusicEmitterBlock with the following properties:

KeyTypeDescription
MusicContainer(Nullable) String

Reference to a MusicContainer asset

MusicContainer asset id this emitter plays.

AudioCategoryOverride(Nullable) String

Reference to a AudioCategory asset

Optional AudioCategory asset id overriding the container's routing.

ReferenceDistance(Nullable) Either Number defaults to: 8.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance at which the emitter plays at full volume.

MaxDistance(Nullable) Either Number defaults to: 25.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance beyond which the emitter is inaudible.

SpatialBlend(Nullable) Either Number defaults to: 0.6000000238418579 or String that matches the pattern: ^(-?Infinity|NaN)$

0 = fully 2D, 1 = fully 3D positioned.

ReverbSend(Nullable) Either Number defaults to: 0.3499999940395355 or String that matches the pattern: ^(-?Infinity|NaN)$

Fraction routed to environment reverb. 0 = dry, 1 = full. Lower keeps sustained music from washing in reverberant spaces.

Volume(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Volume adjustment in decibels, usually to compensate for a quiet mono downmix. 0 = unchanged.

LoopBoolean defaults to: true

Loop the container indefinitely, overriding its authored LoopCount.

OriginInteger defaults to: 0

Persisted epoch-milli the emitter first started. 0 = unstamped.

MusicPlayerBlock

MusicPlayerBlock with the following properties:

KeyTypeDescription
InsertSound(Nullable) String

Reference to a SoundEvent asset

SoundEvent played at the block when a music item is inserted, before the start delay.

RemoveSound(Nullable) String

Reference to a SoundEvent asset

SoundEvent played at the block after a music item is removed and the track has stopped, after the stop delay.

StartDelaySeconds(Nullable) Either Number defaults to: 2.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Seconds between the insert sound and the track starting.

StopDelaySeconds(Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$

Seconds between the track stopping on item removal and the remove sound playing.

ReferenceDistance(Nullable) Either Number defaults to: 8.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance at which the track plays at full volume.

MaxDistance(Nullable) Either Number defaults to: 25.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance beyond which the track is inaudible.

SpatialBlend(Nullable) Either Number defaults to: 0.6000000238418579 or String that matches the pattern: ^(-?Infinity|NaN)$

0 = fully 2D, 1 = fully 3D positioned.

ReverbSend(Nullable) Either Number defaults to: 0.3499999940395355 or String that matches the pattern: ^(-?Infinity|NaN)$

Fraction routed to environment reverb. 0 = dry, 1 = full. Lower keeps sustained music from washing in reverberant spaces.

Volume(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Volume adjustment in decibels.

LoopBoolean defaults to: true

Loop the inserted item's container indefinitely, overriding its authored LoopCount.

PlacedByInteractionComponent

PlacedByInteractionComponent with the following properties:

KeyTypeDescription
WhoPlacedUuid(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long

PortalDevice

PortalDevice with the following properties:

KeyTypeDescription
Config(Nullable)
PortalDeviceConfig

PortalDeviceConfig with the following properties:

KeyTypeDescription
SpawningState(Nullable) String defaults to: Spawning

The StateData for the short transition from off to on, when the instance is being created

OnState(Nullable) String defaults to: Active

The StateData when the portal is summoned and active.

OffState(Nullable) String defaults to: default

The StateData when there is no portal and the device is inactive.

ReturnBlockType(Nullable) String

This block type will be placed (once) on the spawn point of the portal world.

BaseBlockType(Nullable) String
DestinationWorld(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long

PrefabSpawnerBlock

PrefabSpawnerBlock with the following properties:

KeyTypeDescription
PrefabPath(Nullable) String

The prefab path where the prefab is located. This uses the dot-notation. 'folder.folder.folder.filename'

FitHeightmapBoolean defaults to: false

Determines if the child prefab should follow the heightmap during generation in worldgen.

InheritSeedBoolean defaults to: true

Determines if the child prefab should inherit the worldgen-id from the parent. This allows child prefabs to have independent markers.

InheritHeightConditionBoolean defaults to: true

Determines if the child prefab should inherit the HeightCondition from the parent. Setting to false allows child prefabs to bypass the height condition check.

PrefabWeights(Nullable)
PrefabWeights

PrefabWeights with the following properties:

KeyTypeDescription
DefaultNumber defaults to: 1.0

The default weight to use for entries that are not specifically mapped to a weight value.

Weights(Nullable) Map of string to double (1)

The mapping of prefab names to weight values.

Determines the probability of each individual prefab file being selected to generate when the PrefabPath points to a folder containing multiple prefabs.

Map of string to double (1)

(Nullable) Map of the following:

KeyType
StringNumber

ProcessingBenchBlock

ProcessingBenchBlock with the following properties:

KeyTypeDescription
InputContainer(Nullable) Either
EmptyItemContainer

EmptyItemContainer with the following properties:

KeyTypeDescription
IdConstant value: Empty

This field controls the type, it must be set to the constant value "Empty" to function as this type.

or
SimpleItemContainer

SimpleItemContainer with the following properties:

KeyTypeDescription
Id(Nullable) String

This field controls the type, it must be set to the constant value "Simple" to function as this type.

CapacityInteger defaults to: 0
Items(Nullable) Type 5
FuelContainer(Nullable) Either
EmptyItemContainer

EmptyItemContainer with the following properties:

KeyTypeDescription
IdConstant value: Empty

This field controls the type, it must be set to the constant value "Empty" to function as this type.

or
SimpleItemContainer

SimpleItemContainer with the following properties:

KeyTypeDescription
Id(Nullable) String

This field controls the type, it must be set to the constant value "Simple" to function as this type.

CapacityInteger defaults to: 0
Items(Nullable) Type 5
OutputContainer(Nullable) Either
EmptyItemContainer

EmptyItemContainer with the following properties:

KeyTypeDescription
IdConstant value: Empty

This field controls the type, it must be set to the constant value "Empty" to function as this type.

or
SimpleItemContainer

SimpleItemContainer with the following properties:

KeyTypeDescription
Id(Nullable) String

This field controls the type, it must be set to the constant value "Simple" to function as this type.

CapacityInteger defaults to: 0
Items(Nullable) Type 5
ProgressNumber defaults to: 0.0
FuelTimeNumber defaults to: 0.0
ActiveBoolean defaults to: false
NextExtraInteger defaults to: -1
RecipeId(Nullable) String
LastTickGameTime(Nullable) String

RespawnBlock

RespawnBlock with the following properties:

KeyTypeDescription
OwnerUUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long

SpawnMarkerBlock

SpawnMarkerBlock with the following properties:

KeyTypeDescription
MarkerReference(Nullable)
PersistentRef

PersistentRef with the following properties:

KeyTypeDescription
UUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
Config(Nullable)
Data

Data with the following properties:

KeyTypeDescription
SpawnMarkerString

Reference to a SpawnMarker asset

The spawn marker to use.

MarkerOffset(Nullable) Vector3i

An offset from the block at which the marker entity should be spawned.

Teleporter

Teleporter with the following properties:

KeyTypeDescription
World(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
Transform(Nullable)
Transform

Transform with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0
Pitch(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
Yaw(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
RelativeInteger defaults to: 0
Warp(Nullable) String
OwnedWarp(Nullable) String
IsCustomNameBoolean defaults to: false
WarpNameWordList(Nullable) String

The ID of the Word list to select default warp names from

TilledSoilBlock

TilledSoilBlock with the following properties:

KeyTypeDescription
VersionInteger
PlantedBoolean
ModifierTimes(Nullable) Map of the following:
Map
KeyType
any StringString
Flags(Nullable) Array of String
FertilizedBoolean
ExternalWaterBoolean
WateredUntil(Nullable) String
DecayTime(Nullable) String

TrackedPlacement

TrackedPlacement with the following properties:

KeyTypeDescription
BlockName(Nullable) String

UnknownComponents

UnknownComponents with the following properties:

KeyTypeDescription
Components(Nullable) Map of the following:
Map
KeyType
any StringType 6

Type 6

Map of the following:

KeyType
any Stringanything

WorldChunk

WorldChunk with the following properties:

KeyTypeDescription

Type Selector (2)

Any of these:

Key: TypeType
default case: Directional
DirectionalKnockback

DirectionalKnockback with the following properties:

KeyTypeDescription
Type(Nullable) String

This field controls the type, it must be set to the constant value "Directional" to function as this type.

ForceNumber defaults to: 0.0
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
RelativeXNumber defaults to: 0.0
VelocityYNumber defaults to: 0.0
RelativeZNumber defaults to: 0.0
Force
ForceKnockback

ForceKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Force

This field controls the type, it must be set to the constant value "Force" to function as this type.

ForceNumber defaults to: 0.0
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
DirectionVector3d
Point
PointKnockback

PointKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Point

This field controls the type, it must be set to the constant value "Point" to function as this type.

ForceNumber defaults to: 0.0
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
VelocityYNumber defaults to: 0.0
RotateYInteger defaults to: 0
OffsetXInteger defaults to: 0
OffsetZInteger defaults to: 0

ChangeVelocityType

(Nullable) Any one of the following String (defaults to Add):

NameDescription
"Add"

Adds the velocity to any existing velocity

"Set"

Changes the velocity to the given value. Overriding existing values.

BreakShapeDurabilityMode

Any one of the following String (defaults to PerSwing):

NameDescription
"PerSwing"
"PerBlock"

EntityPart

Any one of the following String (defaults to Self):

NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"

On this page

ParentTagsGroupBlockListAssetIdPrefabListAssetIdDrawTypeTexturesTextureSideMaskCubeShadingModeCustomModelTextureCustomModelBlockBreakingDecalIdMaterialOpacityRequiresAlphaBlendingCustomModelScaleCustomModelAnimationCustomModelAnimationSpeedLightTickProcedureRandomTickProcedureConnectedBlockRuleSetEffectTransitionTextureTransitionToGroupsTransitionToTagBlockParticleSetIdParticleColorTextureComputedColorParticlesRandomRotationVariantRotationFlipTypeRotationYawPlacementOffsetSeatsBedsMovementSettingsFlagsBenchGatheringPlacementSettingsFarmingFallingBlockSettingsIsDoorAllowsMultipleUsersHitboxTypeInteractionHitboxTypeInteractionHintDamageToEntitiesInteractionsBlockSoundSetIdPhysicalMaterialIdSoundOcclusionOpacityAmbientSoundEventIdConditionalSoundsInteractionSoundEventIdLoopingSupportDropTypeMaxSupportDistanceSupportsRequiredForSupportSupportingIgnoreSupportWhenPlacedAliasesTintTintUpTintDownTintNorthTintSouthTintWestTintEastBiomeTintBiomeTintUpBiomeTintDownBiomeTintNorthBiomeTintSouthBiomeTintWestBiomeTintEastStateBlockEntityRailExplosionConfigExplosionReactionStateNotes:MapMap (1)Type SelectorIntRangeIntRange (1)Type Selector (1)AugmentBlockBenchBlockType 0BlockSectionBlockAnimationSectionBlockChunkBlockComponentSectionBlockComponentChunkBlockExplosiveBlockHealthChunkBlockHealthSectionBlockMapMarkerBlockPhysicsBlockSpawnerChunkColumnType 1Type 2Type 3Type 4MapMarkerIconSizeMap of string to doubleMap (2)Map (3)ChunkSectionChunkSpawnedNPCDataCompanionBlockSpawnerBlockCoopBlockType 5EntitySectionEntityChunkEnvironmentSectionEnvironmentChunkTrackedBlockComponentFarmingBlockFluidSectionHeightmapColumnInstanceBlockConfigurableInstanceBlockItemContainerBlockLaunchPadMusicEmitterBlockMusicPlayerBlockPlacedByInteractionComponentPortalDevicePrefabSpawnerBlockMap of string to double (1)ProcessingBenchBlockRespawnBlockSpawnMarkerBlockTeleporterTilledSoilBlockTrackedPlacementUnknownComponentsType 6WorldChunkType Selector (2)ChangeVelocityTypeBreakShapeDurabilityModeEntityPart