Class ClientEntityConfig

Namespace

Vintagestory.ServerMods.NoObf

Assembly

VSEssentials.dll

Specific configuration settings for entities on the client-side.

public class ClientEntityConfig

Inheritance

object

ClientEntityConfig

Examples

"client": {
	"renderer": "Shape",
	"textures": {
		"material": { "base": "block/stone/rock/{rock}1" }
	},
	"shape": { "base": "item/stone" },
	"size": 1,
	"behaviors": [
		{ "code": "passivephysics" },
		{ "code": "interpolateposition" }
	]
},

Fields

Renderer (Required)

Name of the renderer system that draws this entity. Vanilla Entity Renderer Systems are:

• Item
  
• Dummy
  
• BlockFalling
  
• Shape
  
• PlayerShape
  
• EchoChamber
  You will likely want to use Shape.

[JsonProperty]
public string Renderer

Field Value

string

Shape (Required)

The shape of the entity. Must be set unless Renderer is not set to "Shape".

[JsonProperty]
public CompositeShape Shape

Field Value

CompositeShape

Animations (Optional) (Default: None)

The animation data for the entity.

[JsonProperty]
public AnimationMetaData[] Animations

Field Value

AnimationMetaData[]

Behaviors (Optional) (Default: None)

A list of all client-side behaviors for the entity.

[JsonProperty(ItemConverterType = typeof(JsonAttributesConverter))]
public JsonObject[] Behaviors

Field Value

JsonObject[]

GlowLevel (Optional) (Default: 0)

The glow level for the entity.

[JsonProperty]
public int GlowLevel

Field Value

int

PitchStep (Optional) (Default: true)

Makes entities pitch forward and backwards when stepping.

[JsonProperty]
public bool PitchStep

Field Value

bool

Size (Optional) (Default: 1)

The size of the entity.

[JsonProperty]
public float Size

Field Value

float

SizeGrowthFactor (Optional) (Default: 0)

The rate at which the entity's size grows with age - used for chicks and other small baby animals.

[JsonProperty]
public float SizeGrowthFactor

Field Value

float

Texture (Optional) (Default: None)

Sets a single texture. It is recommended to specify texture keys by using Textures instead of this.

[JsonProperty]
protected CompositeTexture Texture

Field Value

CompositeTexture

Properties

Textures (Recommended) (Default: None)

A list of all available textures for the entity. First texture in the list will be the default.

[JsonProperty]
public Dictionary<string, CompositeTexture> Textures { get; set; }

Property Value

Dictionary<string, CompositeTexture>