Skip to content

BlockType

← Back to Asset Types

Documentation for the BlockType asset type.

Location

Item/Block/Blocks

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/BlockType.schema.json"

Schema

Group stringnull

Sets the group for this block. Used by BlockSets. A group of "@Tech" will prevent physics from being automatically applied to the block.

BlockListAssetId stringnull

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

PrefabListAssetId stringnull

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

DrawType string
Enum:"Empty""GizmoCube""Cube""Model""CubeWithModel"
Default:"Cube"
Textures arraynull
Array items: BlockTypeTextures
TextureSideMask stringnull
CubeShadingMode string
Enum:"Standard""Flat""Fullbright""Reflective"
Default:"Standard"
CustomModelTexture arraynull
Array items: CustomModelTexture
CustomModel stringnull
BlockBreakingDecalId stringnull

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

Material string
Enum:"Empty""Solid"
Default:"Empty"
Opacity string
Enum:"Solid""Semitransparent""Cutout""Transparent"
Default:"Solid"
RequiresAlphaBlending boolean
Default:false
CustomModelScale NullableNumberOrSpecial
CustomModelAnimation stringnull
Light unknown
Any of
ColorLight
null
TickProcedure unknown
Any of
BasicChanceBlockGrowthProcedure
SplitChanceBlockGrowthProcedure
null
ConnectedBlockRuleSet unknown
Any of
CustomTemplateConnectedBlockRuleSet
RoofConnectedBlockRuleSet
StairConnectedBlockRuleSet
null
Effect arraynull
Array items: string
TransitionTexture stringnull
TransitionToGroups arraynull
Array items: string
TransitionToTag stringnull
BlockParticleSetId stringnull

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

ParticleColor unknown
Any of
string
string
null
Particles arraynull

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

Array items: ModelParticle
RandomRotation string
Enum:"None""YawPitchRollStep1""YawStep1""YawStep1XZ""YawStep90"
Default:"None"
VariantRotation string
Enum:"None""Wall""UpDown""Pipe""DoublePipe""NESW""UpDownNESW""Debug""All"
Default:"None"
FlipType stringnull
Enum:"Orthogonal""Symmetric"
Default:"Symmetric"
RotationYawPlacementOffset string
Enum:"None""Ninety""OneEighty""TwoSeventy"
Default:"None"
Seats arraynull

The details of the seats on this block.

Array items: BlockMountPoint
Beds arraynull

The details of the beds for this block.

Array items: BlockMountPoint
MovementSettings unknown
Any of
BlockMovementSettings
null
Flags unknown
Any of
BlockFlags
null
Bench unknown
Any of
CraftingBench
ProcessingBench
DiagramCraftingBench
StructuralCraftingBench
null
Gathering unknown
Any of
BlockGathering
null
PlacementSettings unknown
Any of
BlockPlacementSettings
null
Farming unknown
Any of
FarmingData
null
IsDoor boolean
Default:false
AllowsMultipleUsers boolean
Default:true
HitboxType stringnull
Default:"Full"
InteractionHitboxType stringnull
InteractionHint stringnull

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.

DamageToEntities integer
Default:0
Interactions objectnull
Primary unknown
Any of
stringReference to RootInteraction
Secondary unknown
Any of
stringReference to RootInteraction
Ability1 unknown
Any of
stringReference to RootInteraction
Ability2 unknown
Any of
stringReference to RootInteraction
Ability3 unknown
Any of
stringReference to RootInteraction
Use unknown
Any of
stringReference to RootInteraction
Pick unknown
Any of
stringReference to RootInteraction
Pickup unknown
Any of
stringReference to RootInteraction
CollisionEnter unknown
Any of
stringReference to RootInteraction
CollisionLeave unknown
Any of
stringReference to RootInteraction
Collision unknown
Any of
stringReference to RootInteraction
EntityStatEffect unknown
Any of
stringReference to RootInteraction
SwapTo unknown
Any of
stringReference to RootInteraction
SwapFrom unknown
Any of
stringReference to RootInteraction
Death unknown
Any of
stringReference to RootInteraction
Wielding unknown
Any of
stringReference to RootInteraction
ProjectileSpawn unknown
Any of
stringReference to RootInteraction
ProjectileHit unknown
Any of
stringReference to RootInteraction
ProjectileMiss unknown
Any of
stringReference to RootInteraction
ProjectileBounce unknown
Any of
stringReference to RootInteraction
Held unknown
Any of
stringReference to RootInteraction
HeldOffhand unknown
Any of
stringReference to RootInteraction
Equipped unknown
Any of
stringReference to RootInteraction
Dodge unknown
Any of
stringReference to RootInteraction
GameModeSwap unknown
Any of
stringReference to RootInteraction
Additional properties
Any of
stringReference to RootInteraction
BlockSoundSetId stringnull

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

Default:"EMPTY"
AmbientSoundEventId stringnull

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

InteractionSoundEventId stringnull

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

Looping boolean
Default:false
SupportDropType stringnull
Enum:"Break""Destroy"
Default:"Break"
MaxSupportDistance integer
Default:0
Min: 0Max: 14
SupportsRequiredFor string
Enum:"Any""All"
Default:"All"
Support objectnull

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.

Up array
Array items: RequiredBlockFaceSupport
Down array
Array items: RequiredBlockFaceSupport
North array
Array items: RequiredBlockFaceSupport
East array
Array items: RequiredBlockFaceSupport
South array
Array items: RequiredBlockFaceSupport
West array
Array items: RequiredBlockFaceSupport
UpNorth array
Array items: RequiredBlockFaceSupport
UpSouth array
Array items: RequiredBlockFaceSupport
UpEast array
Array items: RequiredBlockFaceSupport
UpWest array
Array items: RequiredBlockFaceSupport
DownNorth array
Array items: RequiredBlockFaceSupport
DownSouth array
Array items: RequiredBlockFaceSupport
DownEast array
Array items: RequiredBlockFaceSupport
DownWest array
Array items: RequiredBlockFaceSupport
NorthEast array
Array items: RequiredBlockFaceSupport
SouthEast array
Array items: RequiredBlockFaceSupport
SouthWest array
Array items: RequiredBlockFaceSupport
NorthWest array
Array items: RequiredBlockFaceSupport
UpNorthEast array
Array items: RequiredBlockFaceSupport
UpSouthEast array
Array items: RequiredBlockFaceSupport
UpSouthWest array
Array items: RequiredBlockFaceSupport
UpNorthWest array
Array items: RequiredBlockFaceSupport
DownNorthEast array
Array items: RequiredBlockFaceSupport
DownSouthEast array
Array items: RequiredBlockFaceSupport
DownSouthWest array
Array items: RequiredBlockFaceSupport
DownNorthWest array
Array items: RequiredBlockFaceSupport
All array
Array items: RequiredBlockFaceSupport
BlockSides array
Array items: RequiredBlockFaceSupport
CardinalDirections array
Array items: RequiredBlockFaceSupport
Horizontal array
Array items: RequiredBlockFaceSupport
UpCardinalDirections array
Array items: RequiredBlockFaceSupport
DownCardinalDirections array
Array items: RequiredBlockFaceSupport
Additional properties: array
Supporting objectnull
Up array
Array items: BlockFaceSupport
Down array
Array items: BlockFaceSupport
North array
Array items: BlockFaceSupport
East array
Array items: BlockFaceSupport
South array
Array items: BlockFaceSupport
West array
Array items: BlockFaceSupport
UpNorth array
Array items: BlockFaceSupport
UpSouth array
Array items: BlockFaceSupport
UpEast array
Array items: BlockFaceSupport
UpWest array
Array items: BlockFaceSupport
DownNorth array
Array items: BlockFaceSupport
DownSouth array
Array items: BlockFaceSupport
DownEast array
Array items: BlockFaceSupport
DownWest array
Array items: BlockFaceSupport
NorthEast array
Array items: BlockFaceSupport
SouthEast array
Array items: BlockFaceSupport
SouthWest array
Array items: BlockFaceSupport
NorthWest array
Array items: BlockFaceSupport
UpNorthEast array
Array items: BlockFaceSupport
UpSouthEast array
Array items: BlockFaceSupport
UpSouthWest array
Array items: BlockFaceSupport
UpNorthWest array
Array items: BlockFaceSupport
DownNorthEast array
Array items: BlockFaceSupport
DownSouthEast array
Array items: BlockFaceSupport
DownSouthWest array
Array items: BlockFaceSupport
DownNorthWest array
Array items: BlockFaceSupport
All array
Array items: BlockFaceSupport
BlockSides array
Array items: BlockFaceSupport
CardinalDirections array
Array items: BlockFaceSupport
Horizontal array
Array items: BlockFaceSupport
UpCardinalDirections array
Array items: BlockFaceSupport
DownCardinalDirections array
Array items: BlockFaceSupport
Additional properties: array
IgnoreSupportWhenPlaced boolean

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

Default:false
Aliases arraynull

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

Array items: string
Tint arraynull
Array items: ColorRGB
TintUp arraynull
Array items: ColorRGB
TintDown arraynull
Array items: ColorRGB
TintNorth arraynull
Array items: ColorRGB
TintSouth arraynull
Array items: ColorRGB
TintWest arraynull
Array items: ColorRGB
TintEast arraynull
Array items: ColorRGB
BiomeTint integer
BiomeTintUp integer
Default:0
BiomeTintDown integer
Default:0
BiomeTintNorth integer
Default:0
BiomeTintSouth integer
Default:0
BiomeTintWest integer
Default:0
BiomeTintEast integer
Default:0
State unknown
Any of
Data
StateData
ItemContainerStateData
null
BlockEntity unknown
Any of
Holder
null
Rail unknown
Any of
RailConfig
null
All of
base