Modding:Block Entity Classes: Difference between revisions
Lazy Warlock (talk | contribs) |
Lazy Warlock (talk | contribs) |
||
Line 5: | Line 5: | ||
NOTE: Although they are referenced in JSONS as "Anvil", "Bed" etc. Block Entity class files themselves use the BEAnvil, BEBed naming convention. | 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 [https://github.com/anegostudios/vssurvivalmod/tree/master/BlockEntity here] for those looking to learn more about each. | |||
Additionally, all mechanical block entities can be found [https://github.com/anegostudios/vssurvivalmod/tree/master/Systems/MechanicalPower/BlockEntity here]. | |||
== All Block Entities == | == All Block Entities == |
Revision as of 03:39, 1 May 2020
Using block 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 | - | Block Entity Class |
Beehive | wildbeehive | - | Beehive Block Entity Class |
Bellows | bellows | - | Block Entity Class |
BerryBush | smallberrybush, largeberrybush | - | Block Entity Class |
BlastFurnace | - | - | Blast Furnace Block Entity Class |
Bloomery | bloomerybase | - | Bloomery Block Entity Class |
Bomb | oreblastingbomb | - | Bomb Block Entity Class |
Bucket | bucket | - | Block Entity Class |
Canvas | canvas | - | Block Entity Class |
CharcoalPit | charcoalpit | - | Block Entity Class |
Chisel | chiseledblock | - | Block Entity Class |
Chute | chute | - | Block Entity Class |
ClayForm | clayform | - | Block Entity Class |
Crock | crock | - | Block Entity Class |
DisplayCase | displaycase | - | Block Entity Class |
EchoChamber | echochamber | - | Block Entity Class |
Farmland | farmland | - | Block Entity Class |
Fire | - | - | Block Entity Class |
FireWoodPile | firewoodpile | - | Block Entity Class |
FirePit | firepit | - | Block Entity Class |
Forge | forge | - | Block Entity Class |
GenericContainer | - | - | Block Entity Class |
GenericTypedContainer | chest, storagevessel, stationarybasket | - | Block Entity Class |
IngotMold | ingotmold | - | Block Entity Class |
IngotPile | ingotpile | - | Block Entity Class |
ItemFlow | - | - | Block Entity Class |
KnappingSurface | knappingsurface | - | Block Entity Class |
LabeledChest | chest-labeled | - | Block Entity Class |
Lantern | lantern | - | Block Entity Class |
LocustNest | cage (locustnest) | - | Block Entity Class |
Meal | bowl-meal | Block Entity Class | |
PeatPile | peatpile | - | Block Entity Class |
PlankPile | plankpile | - | Block Entity Class |
PlatePile | platepile | - | Block Entity Class |
PumpkinVine | vine (pumpkin) | - | Block Entity Class |
Quern | quern | - | Block Entity Class |
Sapling | plaintreesapling | - | Block Entity Class |
Shelf | shelf | - | Block Entity Class |
Sign | sign | - | Block Entity Class |
SignPost | signpost | - | Block Entity Class |
SmeltedContainer | crucible | - | Block Entity Class |
Spawner | meta | - | Block Entity Class |
StaticTranslocator | statictranslocator | - | Block Entity Class |
Stove | - | - | Block Entity Class |
Tapestry | tapestry | - | Block Entity Class |
Teleporter | teleporter | - | Block Entity Class |
ToolMold | toolmold | - | Block Entity Class |
ToolRack | toolrack | - | Block Entity Class |
Torch | torch (including colored version) | - | Block Entity Class |
Trough | trough-small, trough-large | - | Block Entity Class |
WateringCan | wateringcan | - | 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 | - | 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.
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 |