Modding:Block Entity Behaviors

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 Behaviors

Block entity behaviors are an expanded type of behavior that block entities can utilize. At the moment, these are mostly used by mechanical power blocks. If you're looking for regular block behaviors (which are used differently) they can be found here.

The block entity behaviors are added to the entityBehaviors array of the block json file at the top level (same level as code). Some behaviors accept a properties dictionary. The properties dictionary is optional for the majority of behaviors that have no properties. If the block does not set the entityclass field, then adding any block entities will cause it to default to "generic", thus transforming the block type into a block entity. Example:

{
  code: "lightningrod",
  ...
  entityBehaviors: [
    {
      "name": "AttractsLightning",
      "properties": {
        "artificialElevation": 5,
        "elevationAttractivenessMultiplier": 2
      }
    }
  ],
  ...
}

Most block entity behavior classes can be viewed at the Vintage Story Github here for those looking to learn more about each.

All Block Entity Behaviors

Here is a table containing all classes used by blocks as of version 1.19.8

Class Name	Example Blocks	Description	Github Link
Animatable	brake, clutch	-	Animatable Block Entity Behavior Class
AttractsLightning
Burning
ClutterBookshelf
ClutterBookshelfWithLore
ControlPointAnimatable
ControlPointLampNode
Door
FirepitAmbient
Fruiting
JonasBoilerDoor
JonasGasifier
JonasHydraulicPump
MicroblockSnowCover
MPAngledGears	angledgears	-	Angled Gears Block Entity Behavior Class
MPArchimedesScrew
MPAxle	axle	-	Axle Block Entity Behavior Class
MPBase	-	A generic mechanical power class that's used by most other behaviors. Otherwise this is not generally used in JSONS.	Base Block Entity Behavior Class
MPBrake	brake	-	Brake Block Entity Behavior Class
MPConsumer	quern	-	Consumer Block Entity Behavior Class
MPCreativeRotor
MPLargeGear3m
MPPulverizer
MPToggle	toggle	-	Block Toggle Entity Behavior Class
MPTransmission	transmission	-	Transmission Block Entity Behavior Class
MPWindmillRotor	windmillrotor	-	Windmill Block Entity Behavior Class
RockRubbleFromAttributes
ShapeFromAttributes
SupportBeam

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.