Modding:Block Entity Behaviors: Difference between revisions

From Vintage Story Wiki
(Created page with "== 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...")
 
Line 7: Line 7:


Most block entity behavior classes can be viewed at the Vintage Story Github [https://github.com/anegostudios/vssurvivalmod/tree/master/Systems/MechanicalPower/BlockEntityBehavior here] for those looking to learn more about each.
Most block entity behavior classes can be viewed at the Vintage Story Github [https://github.com/anegostudios/vssurvivalmod/tree/master/Systems/MechanicalPower/BlockEntityBehavior 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.9.+
{| class="wikitable"
|-
! Class Name !! Example Blocks !! Description !! Github Link
|-
| Animatable || angledgears || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorAngledGears.cs Animatable Entity Behavior Class ]
|-
| MPAngledGears || angledgears || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorAngledGears.cs Angled Gears Block Entity Behavior Class ]
|-
| MPAxle || axle || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorAxle.cs 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. ||  [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorMPBase.cs Base Block Entity Behavior Class ]
|-
| MPBrake || brake || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorBrake.cs Brake Block Entity Behavior Class ]
|-
| MPConsumer || quern || - ||  [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorMPConsumers.cs Consumer Block Entity Behavior Class ]
|-
| MPToggle || toggle || - ||  [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorToggle.cs Block Toggle Entity Behavior Class ]
|-
| MPTransmission || transmission || - ||  [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorTransmission.cs Transmission Block Entity Behavior Class ]
|-
| MPWindmillRotor || windmillrotor || - ||  [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorWindmillRotor.cs Windmill Block Entity Behavior Class ]
|}
{{Navbox/modding|Vintage Story}}

Revision as of 20:07, 1 May 2020

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.

Otherwise, you can give your block entity behaviors with the following format:

entityBehaviors: [{ name: "BlockEntityBehavior" }]

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.9.+

Class Name Example Blocks Description Github Link
Animatable angledgears - Animatable Entity Behavior Class
MPAngledGears angledgears - Angled Gears Block Entity Behavior Class
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
MPToggle toggle - Block Toggle Entity Behavior Class
MPTransmission transmission - Transmission Block Entity Behavior Class
MPWindmillRotor windmillrotor - Windmill Block Entity Behavior Class
Icon Sign.png

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.