Modding:Json Block Behaviors: Difference between revisions

From Vintage Story Wiki
(8 intermediate revisions by one other user not shown)
Line 9: Line 9:
{| class="wikitable"
{| class="wikitable"
|-
|-
! Behavior Name !! Additional Properties !! Detail link
! Behavior Name !! Additional Properties !! Example Blocks !! Detail link
|-
|-
| HorizontalAttachable || handleDrops (bool, default: true) || [[Json_block_behaviors_horizontalattachable|Horizontal Attachable]]
| BreakIfFloating || none || rock || [[Json_block_behaviors_BreakIfFloating| Break if Floating]]
|-
|-
| HorizontalOrientable || dropBlockFace (Compass Direction, default: "North") <br> dropBlock (block name) || [[Json_block_behaviors_horizontalorientable|Horizontal Orientable]]
| CanIgnite || none || torch || [[Json_block_behaviors_CanIgnite|Can Ignite]]
|-
|-
| NWOrientable || none || [[Json_block_behaviors_NWOrientable|North/West Orientable]]
| CollectFrom || none || henbox || [[Json_block_behaviors_CollectFromThis|Collect From]]
|-
|-
| Pillar || none || [[Json_block_behaviors_pillar|Pillar]]
| Container || none || barrel, chest || [[Json_block_behaviors_Container|Container]]
|-
|-
| Slab || none || [[Json_block_behaviors_slab|Slab]]
| ExchangeOnInteract || exchangeStates (string array of block states) <br> sounds (path from sounds folder) || trapdoor || [[Json_block_behaviors_ExchangeOnInteract|Exchange On Interact]]
|-
|-
| HorizontalUpDownOrientable || none || [[Json_block_behaviors_HorizontalUpDownOrientable| Horizontal Up/Down Orientable]]
| FiniteSpreadingLiquid || liquidCollisionSound (path from sounds folder) <br> sourceReplacementCode (block code) <br> flowingReplacementCode (block code) <br> collidesWith (other liquid) <br> spreadDelay (int, default: 150) || water, lava || [[Json_block_behaviors_FiniteSpreadingLiquid| Finite Spreading Liquid]]
|-
|-
| FiniteSpreadingLiquid || liquidCollisionSound (path from sounds folder) <br> sourceReplacementCode (block code) <br> flowingReplacementCode (block code) <br> collidesWith (other liquid) <br> spreadDelay (int, default: 150) || [[Json_block_behaviors_FiniteSpreadingLiquid| Finite Spreading Liquid]]
| Harvestable || none || bigberrybush, smallberrybush ||[[Json_block_behaviors_Harvestable|Harvestable]]
|-
|-
| OmniAttachable || facingPos (int, default: 1)|| [[Json_block_behaviors_OmniAttachable|Omni-Attachable]]
| HorizontalAttachable || handleDrops (bool, default: true) || painting, shelf, toolrack ||[[Json_block_behaviors_horizontalattachable|Horizontal Attachable]]
|-
|-
| Unplaceable || none || [[Json_block_behaviors_Unplaceable|Unplaceable]]
| HorizontalOrientable || dropBlockFace (Compass Direction, default: "North") <br> dropBlock (block name) || bloomerybase, chest, skep || [[Json_block_behaviors_horizontalorientable|Horizontal Orientable]]
|-
|-
| Unstable || attachedToFaces (default: down) || [[Json_block_behaviors_Unstable|Unstable]]
| HorizontalUpDownOrientable || none || - || [[Json_block_behaviors_HorizontalUpDownOrientable| Horizontal Up/Down Orientable]]
|-
|-
| Harvestable || none || [[Json_block_behaviors_Harvestable|Harvestable]]
| Ignitable || none || charcoalpit || [[Json_block_behaviors_ignitable|Ignitable]]
|-
|-
| NoParticles || none || [[Json_block_behaviors_NoParticles|No Particles]]
| Ladder || dropBlockFace (face direction, Default: north)|| ladder || [[Json_block_behaviors_Ladder|Ladder]]
|-
|-
| Container || none || [[Json_block_behaviors_Container|Container]]
| Lockable|| none || chest, displaycase, door, trapdoor|| [[Json_block_behaviors_Lockable|Lockable]]
|-
|-
| Ignitable || none || [[Json_block_behaviors_ignitable|Ignitable]]
| NoParticles || none || - || [[Json_block_behaviors_NoParticles|No Particles]]
|-
|-
| UnstableFalling || none || [[Json_block_behaviors_UnstableFalling| Unstable Falling]]
| NWOrientable || none || chimney, mannequin, path || [[Json_block_behaviors_NWOrientable|North/West Orientable]]
|-
|-
| BreakIfFloating || none || [[Json_block_behaviors_BreakIfFloating| Break if Floating]]
| OmniAttachable || facingPos (int, default: 1)|| lantern || [[Json_block_behaviors_OmniAttachable|Omni-Attachable]]
|-
|-
| CanIgnite || none || [[Json_block_behaviors_CanIgnite|Can Ignite]]
| OmniRotatable || rotateSides (bool, default: false) <br> facing (string) || all slabs || [[Json_block_behaviors_OmniRotatable|Omni-Rotatable]]
|-
|-
| ExchangeOnInteract || exchangeStates (string array of block states) <br> sounds (path from sounds folder) || [[Json_block_behaviors_ExchangeOnInteract|Exchange On Interact]]
| Pillar || none || axle, log || [[Json_block_behaviors_pillar|Pillar]]
|-
|-
| OmniRotatable || rotateH (bool, default: false) <br> rotateV (bool, default: false) <br> rotatev4 (bool, default: false) <br> rotateSides (bool, default: false) <br> facing (string)|| [[Json_block_behaviors_OmniRotatable|Omni-Rotatable]]
| PushEventOnBlockBroken || string EventName || - ||[[Json_block_behaviors_PushEventOnBlockBroken|Push Event on Block Broken]]
|-
|-
| Ladder || dropBlockFace (face direction, Default: north)|| [[Json_block_behaviors_Ladder|Ladder]]
| RightClickPickup || none || bucket, toolmold || [[Json_block_behaviors_RightClickPickup|Right Click Pickup]]
|-
|-
| PushEventOnBlockBroken || string EventName || [[Json_block_behaviors_PushEventOnBlockBroken|Push Event on Block Broken]]
| Slab || none || plankslab, cobbleslab (all slabs) || [[Json_block_behaviors_slab|Slab]]
|-
|-
| RightClickPickup || none || [[Json_block_behaviors_RightClickPickup|Right Click Pickup]]
| SneakPlacing || none || crock ||[[Json_block_behaviors_SneakPlacing|Sneak Placing]]
|-
|-
| CollectFromThis || none || [[Json_block_behaviors_CollectFromThis|Collect From This]]
| Unplaceable || none || pan || [[Json_block_behaviors_Unplaceable|Unplaceable]]
|-
|-
| SneakPlacing || none || [[Json_block_behaviors_SneakPlacing|Sneak Placing]]
| Unstable || attachedToFaces (default: down) || all crops || [[Json_block_behaviors_Unstable|Unstable]]
|-
| UnstableFalling || none || anvil, gravel, sand || [[Json_block_behaviors_UnstableFalling| Unstable Falling]]
|}
|}


{{Navbox/modding|Vintage Story}}
{{Navbox/modding|Vintage Story}}

Revision as of 19:51, 7 May 2020

Adding behaviors to your block

Block behaviors are an array of objects with properties attached to your block. Below is an example of two behaviors, one with properties and one without properties. 

  behaviors: [{name: "behavior1", properties: {myProperty1: "myValue1", myProperty2: "myValue2"}},{name: "behavior2"}],

All Block Behaviors

Here is a table containing all properties of the base game as of 1.9.

Behavior Name Additional Properties Example Blocks Detail link
BreakIfFloating none rock Break if Floating
CanIgnite none torch Can Ignite
CollectFrom none henbox Collect From
Container none barrel, chest Container
ExchangeOnInteract exchangeStates (string array of block states)
sounds (path from sounds folder)		 trapdoor Exchange On Interact
FiniteSpreadingLiquid liquidCollisionSound (path from sounds folder)
sourceReplacementCode (block code)
flowingReplacementCode (block code)
collidesWith (other liquid)
spreadDelay (int, default: 150)		 water, lava Finite Spreading Liquid
Harvestable none bigberrybush, smallberrybush Harvestable
HorizontalAttachable handleDrops (bool, default: true) painting, shelf, toolrack Horizontal Attachable
HorizontalOrientable dropBlockFace (Compass Direction, default: "North")
dropBlock (block name)		 bloomerybase, chest, skep Horizontal Orientable
HorizontalUpDownOrientable none - Horizontal Up/Down Orientable
Ignitable none charcoalpit Ignitable
Ladder dropBlockFace (face direction, Default: north) ladder Ladder
Lockable none chest, displaycase, door, trapdoor Lockable
NoParticles none - No Particles
NWOrientable none chimney, mannequin, path North/West Orientable
OmniAttachable facingPos (int, default: 1) lantern Omni-Attachable
OmniRotatable rotateSides (bool, default: false)
facing (string)		 all slabs Omni-Rotatable
Pillar none axle, log Pillar
PushEventOnBlockBroken string EventName - Push Event on Block Broken
RightClickPickup none bucket, toolmold Right Click Pickup
Slab none plankslab, cobbleslab (all slabs) Slab
SneakPlacing none crock Sneak Placing
Unplaceable none pan Unplaceable
Unstable attachedToFaces (default: down) all crops Unstable
UnstableFalling none anvil, gravel, sand Unstable Falling
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.

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 • Block • Block Behaviors • Block Classes • Block Entities • Block Entity 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


Retrieved from "https://wiki.vintagestory.at/index.php?title=Modding:Json_Block_Behaviors&oldid=9049"