Modding:Block Json Properties
Overview
An incomplete list of all available properties
Property | Type | Default | Usage | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
json |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Core (no byType available) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Code |
string | required | A unique identifier for the block. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A domain prefix will be added dynamically depending on the location of the file. Every mod and the VintageStory itself have a unique prefix.
For example the code |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enabled |
boolean | true | If the block will be loaded or not. Can be used to temporarily remove the block. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VariantGroups |
array of object | - | Allows you define multiple variants of the same block. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The variantgroups property allows you to define multiple variants of this block. All of them will have their unique code, which will added to the code. An easy example would be a bowl, which can either be raw or burned: variantgroups: [
{ code:"type", states: ["raw", "burned"] },
],
Meaning there will be two blocks It's also possible to define multiple groups. variantgroups: [
{ code:"state", states: ["closed", "opened"] },
{ code:"contents", states: ["empty", "cabbage"] },
],
As a result you will have 2x2 groups, which will be added one after each other: Additionally it is possible to refer to external lists that are found in the worldproperties folder, such as variantgroups: [
{ loadFromProperties: "block/rock" },
],
Here is a full list of all groups and their variants (you can also find them in the For example, the following creates a variant group named orientation. It contains 5 states. variantgroups: [
{ code: "orientation", states: ["up"], loadFromProperties: "abstract/horizontalorientation" }
],
Unwanted variant states can be filtered out with the
Wondering where some links have gone?
Futhermore there are two ways of combining together groups. So far we covered the default combination mode, which is Let's take a look at a different example (flowerpot), which uses the variantgroups: [
{ code: "type", states: ["raw"] },
{ code: "empty", states: ["empty"], combine: "additive" },
{ code: "flower", loadFromProperties: "block/flower", combine: "additive" },
{ code: "mushroom", loadFromProperties: "block/mushroom", combine: "additive" },
{ code: "sapling", loadFromProperties: "block/wood", combine: "additive" },
],
The variants are Things might get clearer if we look at another example: variantgroups: [
{ code: "something", states: ["same", "different"] },
{ code: "type", states: ["raw", "baked"] },
{ code: "empty", states: ["red", "green"], "combine": "additive" },
],
In this case, the result would be The |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Specific | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Class |
string | "block" | The block class can add special functionalities for the block. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A complete tutorial of creating you own class can be found here. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxstacksize |
number | 64 | Determines the maximum amount you can stack the block in one slot. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enabled |
boolean | true | If the block will be added to game or not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockmaterial |
string | The blocks material. Amongst others, it will determine how quickly a specific tool can mine it. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Json:block:material | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resistance |
How many seconds it takes to break the block (excluding speed mining bonus). Decimal numbers are allowed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creativeinventory |
arrays | In which creative inventory tabs the block should be visible in. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rendering | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renderpass |
string (of enum) | opaque | Determines how the block will be drawn. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
opaque |
0 | Used for solid blocks with no half transparency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
opaquenocull |
1 | Used for non-solid single faced blocks, such as tall grass. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transparent |
2 | Use for solid halftransparent blocks, such as glass | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
liquid |
3 | Used for liquids, produces waves. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
topsoil |
4 | Used for grass covered blocks. Allows for a smooth transition from grass to soil, while still allowing climate tinting of grass. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shape |
shape | For the json drawtype, the shape definition of the block as shown in the world, dropped on the ground or held in hand. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base |
The path to the shape json file, the base dir is assets/shapes/. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotateX |
float | 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotateY |
float | 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotateZ |
float | 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shapeinventory |
shape | For the json drawtype, the shape definition of the block as shown in the players inventory. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base |
The path to the shape json file, the base dir is assets/shapes/. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotateX |
float | 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotateY |
float | 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotateZ |
float | 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ambientocclusion |
boolean | true | If ambient occlusion will be applied to the block. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
drawtype |
string (of enum) | cube | Determines how the block is tesselated, select JSON for being able to use custom JSON Models. The other values are hardcoded methods of tesselating the block. Check Drawtypes for a full list. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockLayer_1 |
0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockLayer_2 |
1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockLayer_3 |
2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockLayer_4 |
3 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockLayer_5 |
4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockLayer_6 |
5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blockLayer_7 |
6 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
json |
7 | Will draw a json model. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
empty |
8 | Nothing will be drawn. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cube |
9 | Draws an ordinary cube. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cross |
10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transparent |
11 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
liquid |
12 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
crossandsnowlayer |
13 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
textures |
key: direction, value: texture | The texture definitions for the block as seen in the world, when dropped on the ground or held in the hand. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base overlays alternates |
The dictionary contains multiple named textures. Different tessellators expect different texture names. Most tessellators accept the special "all" alias to set all textures at once.
Default example (glass): textures: {
all: { base: "block/glass" },
}
textures: {
all: {base: "block/stone/rock/{rock}" },
}
There are a few aliases that set multiple textures at the same time:
For example, hay block uses two aliases: textures: {
horizontals: { base: "block/hay/{type}-side" },
verticals: { base: "block/hay/{type}-top" },
},
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
texturesinventory |
key: direction, value: texture | The texture definitions for the block as seen in the player inventory. Overrides the textures definition if set. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sideopaque |
key: direction, value: boolean | true | Determines if given block face is fully opaque. If yes, the opposite face of the adjacent block will not be drawn for efficiency reasons. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
all east west up down north south
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sidesolid |
key: direction, value: boolean | true | Determins if given block side is solid. If true, other blocks like torches can be attached to it | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
all east west up down north south
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sound | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sounds |
key: string, value: string | The sounds to be played when a player interacts with this block. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
place |
player/build | Sound to played when placing this block. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
walk |
walk/default | Sound to played when walking on this block. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
break |
player/destruct | Sound to played when breaking this block. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hit |
- | Currently unused. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inside |
- | Sound to played when moving inside block (only works for blocks that have no collisionbox, naturally). |