Class EntityClientProperties

Namespace

Vintagestory.API.Common.Entities

Assembly

VintagestoryAPI.dll

public class EntityClientProperties : EntitySidedProperties

Inheritance

object

EntitySidedProperties

EntityClientProperties

Inherited Members

EntitySidedProperties.Attributes

EntitySidedProperties.BehaviorsAsJsonObj

EntitySidedProperties.Behaviors

EntitySidedProperties.loadBehaviors(Entity, EntityProperties, IWorldAccessor)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EntityClientProperties(JsonObject[])

public EntityClientProperties(JsonObject[] behaviors)

Parameters

behaviors JsonObject[]

Fields

Animations

The animations of the entity.

public AnimationMetaData[] Animations

Field Value

AnimationMetaData[]

AnimationsByCrc32

public Dictionary<uint, AnimationMetaData> AnimationsByCrc32

Field Value

Dictionary<uint, AnimationMetaData>

AnimationsByMetaCode

public Dictionary<string, AnimationMetaData> AnimationsByMetaCode

Field Value

Dictionary<string, AnimationMetaData>

GlowLevel

The glow level for the entity.

public int GlowLevel

Field Value

int

LoadedAlternateShapes

public Shape[] LoadedAlternateShapes

Field Value

Shape[]

LoadedShape

Only loaded for World.EntityTypes instances of EntityProperties, because it makes no sense to have 1000 loaded entities needing to load 1000 shapes. During entity load/spawn this value is assigned however On the client it gets set by the EntityTextureAtlasManager On the server by the EntitySimulation system

public Shape LoadedShape

Field Value

Shape

LoadedShapeForEntity

The shape for this particular entity who owns this properties object

public Shape LoadedShapeForEntity

Field Value

Shape

PitchStep

Makes entities pitch forward and backwards when stepping

public bool PitchStep

Field Value

bool

Renderer

Set by the game client

public EntityRenderer Renderer

Field Value

EntityRenderer

RendererName

Name of there renderer system that draws this entity

public string RendererName

Field Value

string

Shape

The shape of the entity

public CompositeShape Shape

Field Value

CompositeShape

ShapeForEntity

public CompositeShape ShapeForEntity

Field Value

CompositeShape

Size

The size of the entity (default: 1f)

public float Size

Field Value

float

SizeGrowthFactor

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

public float SizeGrowthFactor

Field Value

float

Textures

Directory of all available textures. First one will be default one

public IDictionary<string, CompositeTexture> Textures

Field Value

IDictionary<string, CompositeTexture>

Properties

FirstTexture

Returns the first texture in Textures dict

public CompositeTexture FirstTexture { get; }

Property Value

CompositeTexture

Texture

Used by various renderers to retrieve the entities texture it should be drawn with

public virtual CompositeTexture Texture { get; }

Property Value

CompositeTexture

Methods

Clone()

Does not clone textures, but does clone shapes

public override EntitySidedProperties Clone()

Returns

EntitySidedProperties

DetermineLoadedShape(long)

public void DetermineLoadedShape(long forEntityId)

Parameters

forEntityId long

Init(AssetLocation, IWorldAccessor)

Initializes the client properties.

public void Init(AssetLocation entityTypeCode, IWorldAccessor world)

Parameters

entityTypeCode AssetLocation

world IWorldAccessor