Modding:Block Json Properties/ru: Difference between revisions

     <td>Allows you define multiple variants of the same item.</td>

     <td scope="row"><div class="tt" data-tt-id="p_variantgroups_info" data-tt-parent="p_variantgroups" data-invisible="true"></div></td>

The variantgroups property allows you to define multiple variants of this item. All of them will have their unique pattern, which will be added to the item code.

 

An easy example would be a bowl, which can either be raw or burned:

<syntaxhighlight lang="json">

code: "bowl",

{ code:"type", states: ["raw", "burned"] },

</syntaxhighlight>

 

Meaning there will be two variants <code>bowl-raw</code> and <code>bowl-burned</code>.

 

----

 

It's also possible to define multiple groups.  

 

<syntaxhighlight lang="json">

code: "barrel",

{ code:"state", states: ["closed", "opened"] },

{ code:"contents", states: ["empty", "cabbage"] },

],

</syntaxhighlight>

 

As a result you will have 2x2 groups, which will be added one after each other: <code>barrel-closed-empty</code>, <code>barrel-closed-cabbage</code>, <code>barrel-opened-empty</code> and <code>barrel-opened-cabbage</code>.

 

 

Additionally it is possible to refer to external lists (used for blocks) 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>. It's a good way to keep everything organized:

<syntaxhighlight lang="json">

variantgroups: [

{ loadFromProperties: "block/rock" },

],

Here is a full list of all groups and their variants (you can also find them in the <code>assets/worldproperties</code> folder):

{{:json:block:worldvariantgroups}}

 

Furthermore there are other ways of combining groups together. So far we covered the default combination mode, which is <code>Multiply</code> (the total count of variants is the product of all states). There are two other methods, Add and SelectiveMultiply.

 

 

variantgroups: [

{ code: "type", states: ["raw"] },

{ code: "empty", states: ["empty"], combine: "Add" },

],

</syntaxhighlight>

 

The variants are <code>flowerpot-raw</code>, <code>flowerpot-empty</code>, <code>flowerpot-{all flowers}</code>, <code>flowerpot-{all mushrooms}</code> and <code>flowerpot-{all saplings}</code>.

 

<code>Add</code> mode could also be called separate, since it defines a variant separate from all the other groups:

 

<syntaxhighlight lang="json">

 

In this case, the result would be <code>thingy-same-raw</code>, <code>thingy-same-baked</code>, <code>thingy-different-raw</code>, <code>thingy-different-baked</code>, <code>thingy-red</code> and <code>thingy-green</code>

 

 

<syntaxhighlight lang="json">

{ code: "category",  states: ["lowerbody"] },

"aristocrat-leggings", "dirty-linen-trousers", "fine-trousers", "jailor-pants", "lackey-breeches", "merchant-pants", "messenger-trousers", "minstrel-pants", "noble-pants", "prince-breeches", "raindeer-trousers", "raw-hide-trousers", "shepherd-pants", "squire-pants", "steppe-shepherds-trousers", "tattered-peasent-gown", "torn-riding-pants", "warm-woolen-pants", "woolen-leggings", "workmans-gown"

 

The parameter <code>onVariant</code> specifies which variant group (by using that groups <code>code</code>) to target and the <code>code</code> specifies which of the target variant groups <code>states</code> (only one) to selectively combine with, ignoring all other variants without that specific state.

 

Using this will result items called <code>clothes-lowerbody-aristocrat-leggings</code>, <code>clothes-lowerbody-dirty-linen-trousers</code>, etc.

 

 

Since Vintagestory v1.8 it is also possible to use the variantgroups codes as placeholders (<code>{variant_group_code}</code>) in for example paths to textures.:

variantgroups: [

{ code: "metal", states: ["copper", "tinbronze", "bismuthbronze", "blackbronze", "gold", "silver", "iron" ] },

],

 

Now the <code>metal</code> texture path will change based on the variant. For example the variant <code>axe-copper</code> will use <code>block/metal/ingot/copper</code> as its <code>metal</code> texture.

 

    </td>

     <td scope="row"><div class="tt" data-tt-id="p_byType" data-tt-parent="root">(any) bytype</div></td>

     <td>key: string; value: object</td>

     <td>You can create properties for certain variants of the item.</td>

     <td scope="row"><div class="tt" data-tt-id="p_byType_info" data-tt-parent="p_byType" data-invisible="true"></div></td>

In order to define properties for specific variants you can add '''byType''' to the property name. This allows you to define it depending on the type and always follows the same syntax:

"selector": property,

If the selector matches the name of the variant the given property will be used. Keep in mind that only the first matching one will be used (everything below will be ignored).

<syntaxhighlight lang="json">

"*-down": { x1: 0, y1: 0, z1: 0,  x2: 1, y2: 0.5, z2: 1 },

"*-up": { x1: 0, y1: 0.5, z1: 0,  x2: 1, y2: 1, z2: 1 }

</syntaxhighlight>

 

The char '''<code>*</code>''' stands for anything. In this case it ignores the code of the item.

 

<code>*-north-*-opened-left</code>. This will ignore the second variantgroup. Additionally ByType can also be used for child properties:

<syntaxhighlight lang="json">

x1: 0, y1: 0, z1: 0.875, x2: 1, y2: 1, z2: 1,

 

 

 

</syntaxhighlight>

 

     </td>

<tr>  

     <td scope="row"><div class="tt" data-tt-id="p_allowedVariants_info" data-tt-parent="p_allowedVariants" data-invisible="true"></div></td>

By using the <code>allowedVariants</code> you can specify which variants you want to be generated. Looks at this example of different armor parts (uses both <code>allowedVariants</code> and <code>skipVariants</code>):

 

 

The wildcard char '''<code>*</code>''' stands for anything, and can be used to target many variants with one string instead of having to write them all down.

<tr>

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

  <td>array of strings</td>

  <td>-</td>

  <td>Similar to allowedVariants, but instead skips the creation of listed variants rather than assigning which are allowed. </td>

  <td>armor</td>

</tr>

<tr>  

     <td scope="row"><div class="tt" data-tt-id="p_skipVariants_info" data-tt-parent="p_skipVariants" data-invisible="true"></div></td>

By using the <code>skipVariants</code> you can specify which variants you do NOT want to be generated. For an example look above under <code>allowedVariants</code> which shows both <code>allowedVariants</code> and <code>skipVariants</code> in use at the same time.

    </td>

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

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

    <td>string</td>

    <td>anvil, firepit, quern, skep</td>

     <td scope="row"><div class="tt" data-tt-id="p_class_info" data-tt-parent="p_class" data-invisible="true"></div></td>

    <td colspan="4">

</td>

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

    <td>string</td>

    <td>The block entity class is able to tick and to store extra data. Allows for much more advanced properties.</td>

    <td>anvil, firepit, quern, skep</td>

<tr>

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

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

    <td>gravel, lantern, log, rock, torch</td>

    <td scope="row"><div class="tt" data-tt-id="p_behaviors_info" data-tt-parent="p_behaviors" data-invisible="true"></div></td>

    <td colspan="4">

<tr>

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

     <td>array of object</td>

     <td>-</td>

     <td>An entity behavior adds custom abilities to an entity assigned to a block, such as the mechanical power properties of the windmill.</td>

     <td>angledgears, axle, brake, clutch, helvehammerbase, toggle, transmission, windmillrotor</td>

     <td scope="row"><div class="tt" data-tt-id="p_ebehaviors_info" data-tt-parent="p_ebehaviors" data-invisible="true"></div></td>

     <td colspan="4">

Block entity behaviors are expanded capabilities that regular behaviors cannot accomplish. At the moment they are only used for Mechanical Power blocks, but if you're looking to make your own you can look through the existing files at the Vintage Story Github [https://github.com/anegostudios/vssurvivalmod/tree/master/Systems/MechanicalPower/BlockEntityBehavior here ].

 

</td>

     <td scope="row"><div class="tt" data-tt-id="p_entityclass_info" data-tt-parent="p_entityclass" data-invisible="true"></div></td>

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

     <td>string</td>

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

     <td>gravel</td>  

     <td scope="row"><div class="tt" data-tt-id="p_blockmaterial_info" data-tt-parent="p_blockmaterial" data-invisible="true"></div></td>

Materials are hardcoded and currently only used to determine mining speed with a specific tool. The following materials are available:

 

''Brick, Ceramic, Cloth, Fire, Glass, Gravel, Ice, Lava, Leaves, Liquid, Mantle, Metal, Other, Plant, Sand, Snow, Soil, Stone, Wood''

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

     <td>array of object</td>

     <td>&quot;block&quot;</td>

     <td>Determines whether the block is in a '''''solid''''', a '''''liquid''''', a '''''gas''''' or a '''''plasma''''' state.</td>

     <td> water </td>

<tr>

<td scope="row"><div class="tt" data-tt-id="p_blockmaterial_info" data-tt-parent="p_blockmaterial" data-invisible="true"></div></td>

Used for special collision behavior and rendering. Currently used for lava and water, which are liquids (All other blocks default to solid).

Gas and plasma are not yet implemented.

    </td>

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

     <td>decimal number</td>

     <td>6</td>

     <td>How long it takes to break this block in seconds (with a mining speed of 1).</td>

     <td>leaves, meteorite, sand</td>

     <td scope="row"><div class="tt" data-tt-id="p_resistance_info" data-tt-parent="p_resistance" data-invisible="true"></div></td>

Resistance values range from very low with leaves (0.5) to the average of stone (6) to the very high resistance value of meteoric iron deposits (60).

     </td>

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

     <td>integer</td>

     <td>0</td>

     <td>Minimum required mining tier to get the drop out of the block.</td>

     <td>ore-graded, rock</td>

     <td scope="row"><div class="tt" data-tt-id="p_requiredminingtier_info" data-tt-parent="p_requiredminingtier" data-invisible="true"></div></td>

The following are examples of the mining tiers required for certian ores in Vintage Story:

 

<table class="wikitable">

  <tr style="background-color: rgba(0,0,0,0.2);">

    <th style="background-color: rgba(0,0,0,0.2);">Tier</th>

    <th style="background-color: rgba(0,0,0,0.2);">Ores</th>

<td>'''''galena''''' and '''''rocksalt_sylvite'''''</td>

    <td>'''2'''</td>

<td>'''''lignite''''', '''''cassiterite''''', '''''sphalerite''''', '''''rocksalt''''', '''''sulfur''''' and '''''nativecopper'''''</td>

     <td>'''3'''</td>

<td>'''''bituminouscoal''''', '''''quartz_nativegold''''', '''''quartz_nativesilver''''', '''''lapislazuli''''', '''''bismuthinite''''', '''''quartz''''', '''''magnetite''''' and '''''limonite'''''</td>

     <td>'''4'''</td>

<td>'''''diamond''''' and '''''emerald'''''</td>

  <tr>

     <td>'''5'''</td>

<td>'''''chromite''''', '''''platinum''''' and '''''ilmenite'''''</td>

   </tr>

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

     <td>boolean</td>

    <td>boolean</td>

     <td>Whether snow may rest on top of this block.</td>

     <td>leavesbranchy</td>

     <td scope="row"><div class="tt" data-tt-id="p_snowcoverage_info" data-tt-parent="p_snowcoverage" data-invisible="true"></div></td>

All non-solid blocks can't be covered by snow unless it's defined different:

*Leaves (also branchy): '''true''',

*Water with particles, Lakeice: '''false'''

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

     <td>object</td>

     <td>box (0,0,0 -> 1,1,1)</td>

     <td>Defines a box with which the player collides with.</td>

     <td>carcass, door, fence, all slabs</td>

     <td scope="row"><div class="tt" data-tt-id="p_collisionbox_info" data-tt-parent="p_collisionbox" data-invisible="true"></div></td>

A '''half slab''' for example, has either a box going from 0,0,0 to 1,0.5,1 or going from 0,0.5,0 to 1,1,1, depending on whether it is a slab is down or up:

<syntaxhighlight lang="json">

"*-down": { x1: 0, y1: 0, z1: 0,   x2: 1, y2: 0.5, z2: 1 },

"*-up": { x1: 0, y1: 0.5, z1: 0,  x2: 1, y2: 1, z2: 1 }

</syntaxhighlight>

 

 

Also, setting the entire property to <code>null</code> will eliminate the collision box entirely.

</td>

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

    <td>array of object</td>

    <td>Defines multiple boxes with which the player collides with.</td>

    <td>all stairs, crate</td>

     <td scope="row"><div class="tt" data-tt-id="p_collisionboxes_info" data-tt-parent="p_collisionboxes" data-invisible="true"></div></td>

     <td colspan="4">

A '''crate''' for example requires multiple collision boxes:

<syntaxhighlight lang="json">

   "*-opened": [

     { x1: 0, y1: 0, z1: 0, x2: 1, y2: 0.0625, z2: 1 },

     { x1: 0, y1: 0, z1: 0, x2: 1, y2: 1, z2: 0.0625, rotateY: 180 },

   ]

</syntaxhighlight>

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

     <td>array of object</td>

     <td>-</td>

     <td>Simultaneously defines multiple boxes with which the player collides with and can select.</td>

     <td>all stairs</td>

     <td scope="row"><div class="tt" data-tt-id="p_colselsboxes_info" data-tt-parent="p_collisionselectionboxes" data-invisible="true"></div></td>

<syntaxhighlight lang="json">

"*-down-*": [

{ x1: 0, y1: 0.5, z1: 0, x2: 1, y2: 1, z2: 1 },

x1: 0, y1: 0, z1: 0.5, x2: 1, y2: 0.5, z2: 1,

"*-north": 180,

"*-south": 0,

{ x1: 0, y1: 0, z1: 0, x2: 1, y2: 0.5, z2: 1 },

x1: 0, y1: 0.5, z1: 0.5, x2: 1, y2: 1, z2: 1,

</syntaxhighlight>

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

     <td>object</td>

     <td>box (0,0,0 -> 1,1,1)</td>

     <td>Defines a box which the player's mouse pointer collides with for selection.</td>

     <td>carcass, door, fence, all slabs</td>

     <td scope="row"><div class="tt" data-tt-id="p_selectionbox_info" data-tt-parent="p_selectionbox" data-invisible="true"></div></td>

     <td colspan="4">

A '''half slab''' for example, has either a box going from 0,0,0 to 1,0.5,1 or going from 0,0.5,0 to 1,1,1, depending on whether it is a slab is down or up:

<syntaxhighlight lang="json">

"*-down": { x1: 0, y1: 0, z1: 0,   x2: 1, y2: 0.5, z2: 1 },

"*-up": { x1: 0, y1: 0.5, z1: 0,   x2: 1, y2: 1, z2: 1 }

</syntaxhighlight>

 

</td>

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

    <td>array of object</td>

    <td>Defines multiple boxes which the player's mouse pointer collides with for selection.</td>

    <td>carcass, door, fence, all slabs</td>

     <td scope="row"><div class="tt" data-tt-id="p_selectionboxes_info" data-tt-parent="p_selectionboxes" data-invisible="true"></div></td>

    <td colspan="4">

A '''crate''' for example requires multiple selection boxes:

<syntaxhighlight lang="json">

</syntaxhighlight>

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

     <td>integer</td>

     <td>0</td>

     <td>A value usually between 0-9999 that indicates which blocks may be replaced with others.</td>

     <td>bigberrybush, tallgrass, water</td>

     <td scope="row"><div class="tt" data-tt-id="p_replaceable_info" data-tt-parent="p_replaceable" data-invisible="true"></div></td>

     <td>'''0'''</td>

<td>'''''ordinary blocks''''' (stone for example)</td>

</table>

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

     <td>integer</td>

     <td>0</td>

     <td>Which plants can grow on top of this block.</td>

     <td>clay, gravel, sand, soil</td>

     <td scope="row"><div class="tt" data-tt-id="p_fertility_info" data-tt-parent="p_fertility" data-invisible="true"></div></td>

     <th style="background-color: rgba(0,0,0,0.2);">value</th>

     <th style="background-color: rgba(0,0,0,0.2);">effect</th>

     <td>'''0'''</td>

<td>''(rock) nothing can grow.''</td>

     <td>'''10'''</td>

<td>''(sand) some tallgrass and small trees can be grow on it.''</td>

     <td>'''100'''</td>

<td>''(soil) all grass and trees can grow on it.''</td>

  </tr>

</table>

</td>

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

    <td>0 ... 32</td>

    <td>0</td>

    <td>For light blocking blocks. Any value above 32 will completely block all light.</td>

    <td>full-plain (glass), water </td>

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

    <td>decimal number</td>

    <td>1.0</td>

    <td>Percentage walk-speed when standing on or inside this block.</td>

    <td>path, spiderweb, stonepath </td>

     <td scope="row"><div class="tt" data-tt-id="p_walkspeedmultiplier_info" data-tt-parent="p_walkspeedmultiplier" data-invisible="true"></div></td>

    <td>''Spiderweb''</td>

<td>'''0.25'''</td>

    <td>''Stonepath''</td>

<td>'''1.15'''</td>

'''Drop itself'''

 

If this property does not exist the block will drop itself.

'''No drop'''

<syntaxhighlight lang="json">

drops: [],

----

You can also specify a special item/ block. Therefore you need to define an '''ItemStack''', with the given properties:

<table class="wikitable">

  <tr style="background-color: rgba(0,0,0,0.2);">

    <th style="background-color: rgba(0,0,0,0.2);">property</th>

    <th style="background-color: rgba(0,0,0,0.2);">default</th>

<th style="background-color: rgba(0,0,0,0.2);">explanation</th>

    <td>'''type'''</td>

<td>Can either be '''''block''''' or '''''item'''''.</td>

    <td>'''code''' (required)</td>

<td>The complete code (can also include domain) of the item or block.</td>

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

  </tr>

<td>-</td>

<td>-</td>

    <td>'''quantity'''</td>

For example, the drop of a '''charcoalpile''' looks like this:

drops: [

{ type: "item", code: "charcoal" }

'''Tallgrass''' will only drop something if it's mined by a knife:

 

<syntaxhighlight lang="json">

{ type: "item", code: "drygrass", tool: "knife" },

</syntaxhighlight>

 

----

 

 

 

<syntaxhighlight lang="json">

type: "item",

code: "stone-{rock}",

quantity: { avg: 2.5, var: 0.5 }  

},

]

</syntaxhighlight>

 

This will drop 2-3 blocks.

 

'''''avg''''': Stands for the default drop quantity. If var is 0 or not specified it will always drop the given average.

 

'''''var''''': How much the drop rate can vary. Meaning the drop rate can be <code>avg - var</code> at minimum and <code>age + var</code> at maximum.

 

 

----

 

 

<syntaxhighlight lang="json">

type: "block",

code: "sapling-{wood}",

type: "item",

code: "stick",

quantity: { avg: 0.02, var: 0 },

</syntaxhighlight>