Modding:Block Entity Classes

This page is outdated.
Reason: A new system is being worked on to view JSON properties. Please use this page with caution, as it may not be up-to-date.
The content on this page is not up to date with the most recent game update. If you do wish to contribute, please request wiki edit access on the Discord.

Using block Entity classes

May blocks that have interactive functions will require using a block entity to accomplish. When your block requires the use of a block entity you assign it using the following property format in the JSON:

entityClass: "Entity"

NOTE: Although they are referenced in JSONS as "Anvil", "Bed" etc. Block Entity class files themselves use the BEAnvil, BEBed naming convention.

A majority of all block entities can be viewed at the Vintage Story Github here for those looking to learn more about each.

Additionally, all mechanical block entities can be found here.

All Block Entities

Here is a table containing all block entities used as of version 1.9.+z

Entity Name	Example Block JSON	Description	Github Link
Anvil	anvil	Controls the rendering and forging of work items on an anvil.	Anvil Block Entity Class
Barrel	barrel	-	Barrel Block Entity Class
Bed	bed	-	Bed Block Entity Class
Beehive	wildbeehive	-	Beehive Block Entity Class
Bellows	-	Unfinished	Bellows Block Entity Class
BerryBush	smallberrybush, largeberrybush	-	Berry Bush Block Entity Class
BlastFurnace	-	Unfinished	Blast Furnace Block Entity Class
Bloomery	bloomerybase	-	Bloomery Block Entity Class
Bomb	oreblastingbomb	-	Bomb Block Entity Class
Bucket	bucket	-	Bucket Block Entity Class
Canvas	canvas	-	Canvas Block Entity Class
CharcoalPit	charcoalpit	-	Charcoal Pit Block Entity Class
Chisel	chiseledblock	-	Chiseled Block Entity Class
Chute	chute	-	Chute Block Entity Class
ClayForm	clayform	-	Clay Form Block Entity Class
Crock	crock	-	Crock Block Entity Class
DisplayCase	displaycase	-	Display Case Block Entity Class
EchoChamber	echochamber	-	Echo Chamber Block Entity Class
Farmland	farmland	-	Farmland Block Entity Class
Fire	-	-	Fire Block Entity Class
FireWoodPile	firewoodpile	-	Firewood Pile Block Entity Class
Firepit	firepit	-	Firepit Block Entity Class
Forge	forge	-	Forge Block Entity Class
GenericContainer	-	-	Generic Container Block Entity Class
GenericTypedContainer	chest, storagevessel, stationarybasket	-	Typed Generic Container Block Entity Class
IngotMold	ingotmold	-	Ingot Mold Block Entity Class
IngotPile	ingotpile	-	Ingot Pile Block Entity Class
ItemFlow	-	-	Flowing Item Block Entity Class
KnappingSurface	knappingsurface	-	Knapping Surface Block Entity Class
LabeledChest	chest-labeled	-	Labeled Chest Block Entity Class
Lantern	lantern	-	Lantern Block Entity Class
LocustNest	cage (locustnest)	-	Locust Nest Block Entity Class
Meal	bowl-meal	-	Meal Block Entity Class
PeatPile	peatpile	-	Peat Pile Block Entity Class
PlankPile	plankpile	-	Plank Pile Block Entity Class
PlatePile	platepile	-	Plate Pile Block Entity Class
PumpkinVine	vine (pumpkin)	-	Pumpkin Vine Block Entity Class
Quern	quern	-	Quern Block Entity Class
Sapling	plaintreesapling	-	Sapling Block Entity Class
Shelf	shelf	-	Shelf Block Entity Class
Sign	sign	-	Sign Block Entity Class
SignPost	signpost	-	Signpost Block Entity Class
SmeltedContainer	crucible	-	Smelted Container Block Entity Class
Spawner	meta	-	Spawner Block Entity Class
StaticTranslocator	statictranslocator	-	Static Translocator Block Entity Class
Stove	-	Unfinished	Stove Block Entity Class
Tapestry	tapestry	-	Tapestry Block Entity Class
Teleporter	teleporter	-	Teleporter Block Entity Class
ToolMold	toolmold	-	Tool Mold Block Entity Class
ToolRack	toolrack	-	Tool Rack Block Entity Class
Torch	torch (including colored version)	-	Torch Block Entity Class
Trough	trough-small, trough-large	-	Trough Block Entity Class
WateringCan	wateringcan	-	Watering Can Block Entity Class

Mechanical Power Block Entity Classes

This table contains all the block entities relevant to mechanical power.

Class Name	Example Blocks	Description	Github Link
Brake	brake	Controls the rotation of the brake axle and events that occur when the player interacts with it.	Brake Block Entity Class
Clutch	clutch	-	Clutch Block Entity Class
HelveHammer	helvehammerbase	-	Helve Hammer Class

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.