Class AnimationMetaData
- Namespace
- Vintagestory.API.Common
- Assembly
- VintagestoryAPI.dll
public class AnimationMetaData
- Inheritance
-
AnimationMetaData
- Inherited Members
Fields
Animation
The animations code identifier that we want to play
[JsonProperty]
public string Animation
Field Value
AnimationSpeed
[JsonProperty]
public float AnimationSpeed
Field Value
Attributes
[JsonProperty]
[JsonConverter(typeof(JsonAttributesConverter))]
public JsonObject Attributes
Field Value
BlendMode
[JsonProperty]
public EnumAnimationBlendMode BlendMode
Field Value
ClientSide
If true, the server does not sync this animation
[JsonProperty]
public bool ClientSide
Field Value
Code
Unique identifier to be able to reference this AnimationMetaData instance
[JsonProperty]
public string Code
Field Value
CodeCrc32
public uint CodeCrc32
Field Value
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
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
ElementBlendMode
[JsonProperty]
public Dictionary<string, EnumAnimationBlendMode> ElementBlendMode
Field Value
ElementWeight
[JsonProperty]
public Dictionary<string, float> ElementWeight
Field Value
HoldEyePosAfterEasein
[JsonProperty]
public float HoldEyePosAfterEasein
Field Value
MulWithWalkSpeed
[JsonProperty]
public bool MulWithWalkSpeed
Field Value
StartFrameOnce
public float StartFrameOnce
Field Value
SupressDefaultAnimation
[JsonProperty]
public bool SupressDefaultAnimation
Field Value
TriggeredBy
[JsonProperty]
public AnimationTrigger TriggeredBy
Field Value
WasStartedFromTrigger
public bool WasStartedFromTrigger
Field Value
Weight
[JsonProperty]
public float Weight
Field Value
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
Methods
Clone()
public AnimationMetaData Clone()
Returns
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object obj)
Parameters
obj
objectThe object to compare with the current object.
Returns
FromBytes(BinaryReader, string)
public static AnimationMetaData FromBytes(BinaryReader reader, string version)
Parameters
reader
BinaryReaderversion
string
Returns
GetCrc32(string)
public static uint GetCrc32(string animcode)
Parameters
animcode
string
Returns
GetCurrentAnimationSpeed(float)
public float GetCurrentAnimationSpeed(float walkspeed)
Parameters
walkspeed
float
Returns
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
Matches(int)
public bool Matches(int currentActivities)
Parameters
currentActivities
int
Returns
ToBytes(BinaryWriter)
public void ToBytes(BinaryWriter writer)
Parameters
writer
BinaryWriter