Modding:Block Entity Behaviors: Difference between revisions
From Vintage Story Wiki
Lazy Warlock (talk | contribs) |
Lazy Warlock (talk | contribs) |
||
| Line 14: | Line 14: | ||
! Class Name !! Example Blocks !! Description !! Github Link | ! Class Name !! Example Blocks !! Description !! Github Link | ||
|- | |- | ||
| Animatable || | | Animatable || brake, clutch || - || [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 ] | | MPAngledGears || angledgears || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorAngledGears.cs Angled Gears Block Entity Behavior Class ] | ||
| Line 23: | Line 23: | ||
|- | |- | ||
| MPBrake || brake || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorBrake.cs Brake Block Entity Behavior Class ] | | MPBrake || brake || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorBrake.cs Brake Block Entity Behavior Class ] | ||
|- | |||
| Combinable || - || - || [https://github.com/anegostudios/vsessentialsmod/blob/master/BlockEntityBehavior/BEBehaviorCombinable.cs Combinable Entity Behavior Class ] | |||
|- | |- | ||
| MPConsumer || quern || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorMPConsumer.cs Consumer Block Entity Behavior Class ] | | MPConsumer || quern || - || [https://github.com/anegostudios/vssurvivalmod/blob/master/Systems/MechanicalPower/BlockEntityBehavior/BEBehaviorMPConsumer.cs Consumer Block Entity Behavior Class ] | ||
Revision as of 20:16, 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 | brake, clutch | - | 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 |
| Combinable | - | - | Combinable 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 |
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.
| Modding | |
|---|---|
| Modding Introduction | Getting Started • Theme Pack |
| Content Modding | Content Mods • Developing a Content Mod • Basic Tutorials • Intermediate Tutorials • Advanced Tutorials • Content Mod Concepts |
| Code Modding | Code Mods • Setting up your Development Environment |
| Property Overview | Item • Entity • Entity Behaviors • Block • Block Behaviors • Block Classes • Block Entities • Block Entity Behaviors • Collectible Behaviors • World properties |
| Workflows & Infrastructure | Modding Efficiency Tips • Mod-engine compatibility • Mod Extensibility • VS Engine |
| Additional Resources | Community Resources • Modding API Updates • Programming Languages • List of server commands • List of client commands • Client startup parameters • Server startup parameters Example Mods • API Docs • GitHub Repository |
