Modding:Block Json Properties: Difference between revisions

An incomplete list of all available properties

   <tr style='background-color: gray;'>

     <td colspan="4" style='font-size: 14pt; border-bottom: 2pt solid black; padding-left: 100px;'><b>Core (no byType available)</b></td>

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 '''<code>stone</code>''' would turn into '''<code>game:stone</code>'''.  

The code identifier has to be unique, at least inside his domain, so in theory there can be equal identifiers with different domain prefixes.

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.

Additionally it is possible to refer to external lists that are found in the worldproperties folder, such as <code>block/rock</code>, which contains all states of all rock types. This used for <code>gravel</code>, <code>sand</code> and <code>rock</code>:

Futhermore there are two ways of combining together groups. So far we covered the default combination mode, which is <code>multiplicative</code> (the total count of variants is the product of all states).

Things might get clearer if we look at another example:

The <code>additive</code> combination means all states will be added as a separate variant.

    </td>

     <td colspan="4" style='font-size: 14pt; border-bottom: 2pt solid black; padding-left: 100px;'><b>Specific</b></td>

A complete tutorial of how to create your own class can be found [[Advanced Blocks|here]].

A complete tutorial of creating your own entityclass can be found [[Block Entity|here]].

     <td>A behavior adds custom abilities such as falling block..</td>

Here is an overview of all exisiting behaviors, if you want to create your own custom behavior you can read [[Adding Block Behavior]].

     <td>Basic glow level for all the blocks model elements.</td>

<td>If true and the quantity dropped is >=1 any subsequent drop will be ignored.</td>

Futhermore you can also switch between different distribution modes using the '''''dist''''' property.

     <td colspan="4" style='font-size: 14pt; border-bottom: 2pt solid black; padding-left: 100px;'><b>Common</b></td>

     <td>Custom Attributes that's always assiociated with this item.</td>

Extra attributes added to a block. Those are final and cannot be modified. It's a good way to keep things oragnized and and modifiable. The '''oreblastingbomb''' for example has attributes, which define its radius and type. These can be used by behaviors and blockentities:

        "blastRadius": { type: "Int", value: 4 },

        "blastType": { type: "Int", value: 0 },

    },

     <td>The temperature at which it burns.</td>

     <td>For how long it burns.</td>

     <td>How many degrees celsius it can resists before it ignites.</td>

     <td>How many degrees celsius it takes to smelt/transform this into another. Only used when put in a stove and Melted is set.</td>

     <td>If set, the block/item is smeltable in a furnace and this is the resulting itemstack once the MeltingPoint has been reached for the supplied duration.</td>

Futhermore it can be used to define smelting processes. An example would be an '''ingotmold''' which turns into an ingotmold-burned:

     <td colspan="4" style='font-size: 14pt; border-bottom: 2pt solid black; padding-left: 100px;'><b>Rendering</b></td>

     <td scope="row"><div class="tt" data-tt-id="p_renderpass" data-tt-parent="root">renderpass</div></td>

     <td>string (of enum)</td>

    <td scope="row"><div class="tt" data-tt-id="p_opaque" data-tt-parent="p_renderpass">opaque</div></td>

     <td>0</td>

    <td>Used for solid blocks with no half transparency.</td>

     <td scope="row"><div class="tt" data-tt-id="p_opaquenocull" data-tt-parent="p_renderpass">opaquenocull</div></td>

    <td></td>

    <td>1</td>

     <td>Used for non-solid single faced blocks, such as tall grass.</td>

     <td scope="row"><div class="tt" data-tt-id="p_transparent" data-tt-parent="p_renderpass">transparent</div></td>

     <td>2</td>

    <td>Use for solid halftransparent blocks, such as glass</td>

     <td scope="row"><div class="tt" data-tt-id="p_shape" data-tt-parent="root">shape</div></td>

     <td>shape</td>

     <td></td>

     <td></td>

     <td></td>

     <td></td>

     <td scope="row"><div class="tt" data-tt-id="p_shapeinventory" data-tt-parent="root">shapeinventory</div></td>

     <td>shape</td>

     <td></td>

  <tr>

     <td scope="row"><div class="tt" data-tt-id="p_drawtype" data-tt-parent="root" hide="children">drawtype</div></td>

     <td>string (of enum)</td>

     <td>cube</td>

     <td>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.</td>

     <td scope="row"><div class="tt" data-tt-id="p_textures" data-tt-parent="root">textures</div></td>

     <td>key: direction, value: texture</td>

     <td>The texture definitions for the block as seen in the world, when dropped on the ground or held in the hand.</td>

     <td scope="row" valign="top"><div class="tt" data-tt-id="p_textures_base" data-tt-parent="p_textures">base</div><br><br><div class="tt" data-tt-id="p_textures_overlays" data-tt-parent="p_textures">overlays</div><br><br><div class="tt" data-tt-id="p_textures_base" data-tt-parent="p_textures">alternates</div></td>

     <td colspan="3">{{:json:block:texture}}</td>

     <td scope="row"><div class="tt" data-tt-id="p_texturesinventory" data-tt-parent="root">texturesinventory</div></td>

    <td>key: direction, value: texture</td>

     <td>The texture definitions for the block as seen in the player inventory. Overrides the textures definition if set.</td>

     <td scope="row"><div class="tt" data-tt-id="p_sideopaque" data-tt-parent="root">sideopaque</div></td>

     <td>key: direction, value: boolean</td>

     <td scope="row"><div class="tt" data-tt-id="p_sidesolid" data-tt-parent="root">sidesolid</div></td>

     <td>key: direction, value: boolean</td>

     <td>true</td>

     <td>Determins if given block side is solid. If true, other blocks like torches can be attached to it</td>