Class AnimationMetaData

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

Animation Meta Data is a json type that controls how an animation should be played. Open in GitHub

[DocumentAsJson]
public class AnimationMetaData

Inheritance

object

AnimationMetaData

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Examples

"animations": [
	{
		"code": "hurt",
		"animation": "hurt",
		"animationSpeed": 2.2,
		"weight": 10,
		"blendMode": "AddAverage"
	},
	{
		"code": "die",
		"animation": "death",
		"animationSpeed": 1.25,
		"weight": 10,
		"blendMode": "Average",
		"triggeredBy": { "onControls": [ "dead" ] }
	},
	{
		"code": "idle",
		"animation": "idle",
		"blendMode": "AddAverage",
		"easeOutSpeed": 4,
		"triggeredBy": { "defaultAnim": true }
	},
	{
		"code": "walk",
		"animation": "walk",
		"weight": 5
	}
]

Fields

Animation

The animations code identifier that we want to play

[JsonProperty]
public string Animation

Field Value

string

AnimationSound

[JsonProperty]
public AnimationSound AnimationSound

Field Value

AnimationSound

AnimationSpeed

The speed this animation should play at.

[JsonProperty]
public float AnimationSpeed

Field Value

float

Attributes

Custom attributes that can be used for the animation. Valid vanilla attributes are:

• damageAtFrame (float)
  
• soundAtFrame (float)
  
• authorative (bool)
  

[JsonProperty]
[JsonConverter(typeof(JsonAttributesConverter))]
public JsonObject Attributes

Field Value

JsonObject

BlendMode

The animation blend mode. Controls how this animation will react with other concurrent animations. Also see ElementBlendMode to control blend mode per element.

[JsonProperty]
public EnumAnimationBlendMode BlendMode

Field Value

EnumAnimationBlendMode

ClientSide

If true, the server does not sync this animation.

[JsonProperty]
public bool ClientSide

Field Value

bool

Code

Unique identifier to be able to reference this AnimationMetaData instance

[JsonProperty]
public string Code

Field Value

string

CodeCrc32

public uint CodeCrc32

Field Value

uint

EaseInSpeed

A multiplier applied to the weight value to "ease in" the animation. Choose a high value for looping animations or it will be glitchy

[JsonProperty]
public float EaseInSpeed

Field Value

float

EaseOutSpeed

A multiplier applied to the weight value to "ease out" the animation. Choose a high value for looping animations or it will be glitchy

[JsonProperty]
public float EaseOutSpeed

Field Value

float

ElementBlendMode

A way of specifying BlendMode per element.

[JsonProperty]
public Dictionary<string, EnumAnimationBlendMode> ElementBlendMode

Field Value

Dictionary<string, EnumAnimationBlendMode>

ElementWeight

A way of specifying Weight for each element. Also see ElementBlendMode to control blend modes per element..

[JsonProperty]
public Dictionary<string, float> ElementWeight

Field Value

Dictionary<string, float>

FpVariant

public AnimationMetaData FpVariant

Field Value

AnimationMetaData

HoldEyePosAfterEasein

A value that determines whether to change the first-person eye position for the camera. Higher values will keep eye position static.

[JsonProperty]
public float HoldEyePosAfterEasein

Field Value

float

MulWithWalkSpeed

Should this animation speed be multiplied by the movement speed of the entity?

[JsonProperty]
public bool MulWithWalkSpeed

Field Value

bool

StartFrameOnce

public float StartFrameOnce

Field Value

float

SupressDefaultAnimation

Should this animation stop default animations from playing?

[JsonProperty]
public bool SupressDefaultAnimation

Field Value

bool

TriggeredBy

Controls when this animation should be played.

[JsonProperty]
public AnimationTrigger TriggeredBy

Field Value

AnimationTrigger

WasStartedFromTrigger

public bool WasStartedFromTrigger

Field Value

bool

Weight

The weight of this animation. When using multiple animations at a time, this controls the significance of each animation. The method for determining final animation values depends on this and BlendMode.

[JsonProperty]
public float Weight

Field Value

float

WeightCapFactor

This property can be used in cases where a animation with high weight is played alongside another animation with low element weight. In these cases, the easeIn become unaturally fast. Setting a value of 0.8f or similar here addresses this issue.

• 0f = uncapped weight
  
• 0.5f = weight cannot exceed 2
  
• 1f = weight cannot exceed 1

[JsonProperty]
public float WeightCapFactor

Field Value

float

WithFpVariant

[JsonProperty]
public bool WithFpVariant

Field Value

bool

Properties

AdjustCollisionBox

[JsonProperty]
public bool AdjustCollisionBox { get; set; }

Property Value

bool

Methods

Clone()

Not a deep clone of all fields. Scalar fields, for example AnimationSpeed, are fresh copies and can be changed dynamically or per-entity, after cloning the AnimationMetaData.
For performance reasons, the non-scalar fields such as the Attributes, ElementWeight, ElementBlendMode and TriggeredBy are not deep-cloned as these fields are usually unchanging for all entities using the animation.
Note: If any implementing entity needs to change the non-scalar fields dynamically, or on a per-entity basis, that entity's code can clone and replace the object in its own individual copy of the AnimationMetaData. e.g. EntityDrifter replaces .TriggeredBy in some of its animations

public AnimationMetaData Clone()

Returns

AnimationMetaData

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

FromBytes(BinaryReader, string)

public static AnimationMetaData FromBytes(BinaryReader reader, string version)

Parameters

reader BinaryReader

version string

Returns

AnimationMetaData

GetCrc32(string)

public static uint GetCrc32(string animcode)

Parameters

animcode string

Returns

uint

GetCurrentAnimationSpeed(float)

public float GetCurrentAnimationSpeed(float walkspeed)

Parameters

walkspeed float

Returns

float

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Init()

public AnimationMetaData Init()

Returns

AnimationMetaData

Matches(int)

public bool Matches(int currentActivities)

Parameters

currentActivities int

Returns

bool

ToBytes(BinaryWriter)

public void ToBytes(BinaryWriter writer)

Parameters

writer BinaryWriter