Modding:Entity Json Properties

Overview

A complete list of all available properties

Property	Type	Default	Usage
json
Core (no byType available)
Code	string	required	A unique identifier for the entity.
	A domain prefix will be added dynamically depending on the location of the file. Every mod and VintageStory itself have a unique prefix. For example the code rabbit turns into game:rabbit. The code identifier has to be unique inside its domain. In theory there could be equal identifiers with different domain prefixes. Find out more about Domains.
Enabled	boolean	true	If the entity will be loaded or not. Can be used to temporarily remove the entity.
VariantGroups	array of object	-	Allows you define multiple variants of the same entity.
	The variantgroups property allows you to define multiple variants of this entity. All of them will have their unique pattern, which will be added to the entity code. An easy example would be a sheep, which can either be small or tall: variantgroups: [ { code:"size", states: ["small", "tall"] }, ], Meaning there will be two blocks sheep-small and sheep-tall. It's also possible to define multiple groups. variantgroups: [ { code:"size", states: ["small", "tall"] }, { code:"color", states: ["white", "black"] }, ], As a result you will have 2x2 groups, which will be added one after each other: sheep-small-white, sheep-tall-white, sheep-small-black and sheep-tall-black. Additionally it is possible to refer to external lists that are found in the worldproperties folder, such as block/rock, which contains all states of all rock types. This used for gravel, sand and rock. It's a good way to keep everything organized: variantgroups: [ { loadFromProperties: "block/rock" }, ], Here is a full list of all groups and their variants (you can also find them in the assets/worldproperties folder): The world properties are stored in the assets/survival/worldproperties folder. They are used to help fill in the variantgroups field. Instead of directly specifying every state in the variant group, the states can be loaded from a world property through the loadFromProperties key. The states from multiple world properties can be added with the loadFromPropertiesCombine key, which takes an array of strings. The states key can still be optionally added to the variant group to specify additional states. For example, the following creates a variant group named orientation. It contains 5 states. north, east, south, and west are loaded from the abstract/horizontalorientation world property. up is added to the list of states. variantgroups: [ { code: "orientation", states: ["up"], loadFromProperties: "abstract/horizontalorientation" } ], Unwanted variant states can be filtered out with the skipVariants property. Or all states that do not match an expression can be filtered out with the allowedVariants property. Name States abstract/alloy - abstract/coating n, e, s, w, u, d, ud, ns, ew, nd, ed, sd, wd, su, wu, nu, eu, es, sw, nw, ne, nwd, ned, esd, swd, nwu, neu, esu, swu, nsd, ewd, sud, wud, nud, eud, nsu, ewu, nes, esw, nsw, new, newd, nesd, eswd, nswd, eswu, nswu, newu, nesu, nesw, ewud, nsud, neud, esud, swud, nwud, neswd, neswu, newud, nesud, eswud, nswud, neswud abstract/fertility verylow, low, medium, compost, high abstract/grasscoverage none, verysparse, sparse, normal abstract/horizontalorientation north, east, south, west abstract/rockgroup - abstract/verticalorientation up, down block/flower catmint, cornflower, forgetmenot, edelweiss, heather, horsetail, orangemallow, wilddaisy, westerngorse, cowparsley, goldenpoppy, lilyofthevalley, woad, redtopgrass block/fruit blueberry, cranberry, redcurrant, whitecurrant, blackcurrant, saguaro, pineapple, redapple, pinkapple, yellowapple, cherry, peach, pear, orange, mango, breadfruit, lychee, pomegranate block/grass - block/herb basil, chamomile, cilantro, lavender, marjoram, mint, saffron, sage, thyme block/metal bismuth, bismuthbronze, blackbronze, brass, chromium, copper, cupronickel, electrum, gold, iron, meteoriciron, lead, molybdochalkos, platinum, nickel, silver, stainlesssteel, steel, tin, tinbronze, titanium, uranium, zinc block/mushroom flyagaric, fieldmushroom, almondmushroom, bitterbolete, blacktrumpet, chanterelle, commonmorel, deathcap, devilstooth, devilbolete, earthball, elfinsaddle, golddropmilkcap, greencrackedrussula, indigomilkcap, jackolantern, kingbolete, lobster, orangeoakbolete, paddystraw, puffball, redwinecap, saffronmilkcap, violetwebcap, witchhat, beardedtooth, chickenofthewoods, dryadsaddle, pinkoyster, tinderhoof, whiteoyster, reishi, funeralbell, deerear, livermushroom, pinkbonnet, shiitake block/ore-gem-cut diamond, emerald, peridot block/ore-gem-rough diamond,emerald,olivine_peridot block/ore-graded nativecopper,limonite,quartz_nativegold,galena,cassiterite,chromite,ilmenite,sphalerite,quartz_nativesilver,galena_nativesilver,bismuthinite,magnetite,hematite,malachite,pentlandite,uranium,wolframite,rhodochrosite block/ore-nugget nativecopper,limonite,nativegold,galena,cassiterite,chromite,ilmenite,sphalerite,nativesilver,bismuthinite,magnetite,hematite,malachite,pentlandite,uranium,wolframite,rhodochrosite block/ore-ungraded alum,lapislazuli,corundum,anthracite,borax,cinnabar,lignite,bituminouscoal,sylvite,quartz,olivine,sulfur,fluorite,graphite,kernite,phosphorite block/painting howl,elk,underwater,prey,forestdawn,fishandtherain,bogfort,castleruin,cow,hunterintheforest,seraph,sleepingwolf,sunkenruin,traveler,oldvillage,lastday,sodhouse block/rock andesite,chalk,chert,conglomerate,limestone,claystone,granite,sandstone,shale,basalt,peridotite,phyllite,slate,bauxite block/rockwithdeposit andesite,chalk,chert,conglomerate,limestone,claystone,granite,sandstone,shale,basalt,peridotite,phyllite,slate,obsidian,kimberlite,scoria,tuff,bauxite,halite,suevite,whitemarble,redmarble,greenmarble block/tallgrass veryshort,short,mediumshort,medium,tall,verytall,eaten block/toolmetal bismuth,bismuthbronze,blackbronze,brass,copper,gold,iron,meteoriciron,lead,molybdochalkos,silver,steel,tinbronze block/wood birch,oak,maple,pine,acacia,kapok,baldcypress,larch,redwood,ebony,walnut,purpleheart 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 Futhermore there are two ways of combining groups together. So far we covered the default combination mode, which is multiplicative (the total count of variants is the product of all states). Imagine you want to implement a living tree, were either flowers, mushrooms or saplings or on it. You can use the additive combination mode for that: variantgroups: [ { code: "type", loadFromProperties: "block/wood" }, { code: "flower", loadFromProperties: "block/flower", combine: "additive" }, { code: "mushroom", loadFromProperties: "block/mushroom", combine: "additive" }, { code: "sapling", loadFromProperties: "block/wood", combine: "additive" }, ], The living trees exists for every wood type (birch, oak, maple, pine, acacia, kapok) and can either have a flower, mushroom or a sapling suffix: livingtree-{wood type}-{flower}, livingtree-{wood type}-{all flowers}, livingtree-{wood type}-{all mushrooms} and livingtree-{wood type}-{all saplings}.
(any) byType	key: string; value: object	-	You can create properties for certain variants of the block.
	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: (property)ByType: { "selector": property, "selector2": property2, ... } 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). A slab for example has two variants (up, down), which have different collision boxes: collisionboxByType: { "*-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 } }, The char * stands for anything. In this case it ignores the code of the block. Furthermore this opens up even more possbilities for more advanced selectors like this one for doors: *-north-*-opened-left. This will ignore the second variantgroup. Additionally ByType can also be used for child properties: collisionboxnbox: { x1: 0, y1: 0, z1: 0.875, x2: 1, y2: 1, z2: 1, rotateYByType: { "*-north-*-opened-left": 90, "*-north-*-closed-left": 0, "*-west-*-opened-left": 180, "*-west-*-closed-left": 90, "*-east-*-opened-left": 0, "*-east-*-closed-left": 270, "*-south-*-opened-left": 270, "*-south-*-closed-left": 180, "*-north-*-opened-right": 270, "*-north-*-closed-right": 0, "*-west-*-opened-right": 0, "*-west-*-closed-right": 90, "*-east-*-opened-right": 180, "*-east-*-closed-right": 270, "*-south-*-opened-right": 90, "*-south-*-closed-right": 180 } }, Since Vintagestory v1.8 it is also possible to use the variantgroup as a placeholder: variantgroups: [ { code: "type", states: ["normal", "bamboo"] }, ], texture: { base: "entity/fish/{type}" }
Common

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.