Summary

[Pro-Only] A base wrapper which allows access to the value of properties that are controlled by animations.

Assembly

Animancer.dll

Namespace

Animancer

Interfaces

Base Types

Derived Types

Syntax

public abstract class AnimatedProperty<TJob, TValue> : AnimancerJob<TJob>, IDisposable 
    where TJob : struct, IAnimationJob where TValue : struct

Documentation: Animated Properties

Name	Description
TJob
TValue

Name	Summary
AnimatedProperty(IAnimancerComponent, int, NativeArrayOptions)	Allocates room for a specified number of properties to be filled by `InitializeProperty(int, Transform, Type, string)`.
AnimatedProperty(IAnimancerComponent, string)	Initializes a single property.
AnimatedProperty(IAnimancerComponent, string[])	Initializes a group of properties.

Name	Constant Value	Summary
_Properties		The properties wrapped by this object.
_Values		The value of each of the Animancer.AnimatedProperty`2._Properties from the most recent update.

Name	Value	Summary
this[int]	TValue	Returns the value of the property at the specified `index`.
Value	TValue	Returns the value of the first property.

Name	Value	Summary
CreateJob()	void	Creates and assigns the `AnimancerJob._Job`.
Destroy()	void	Destroys the `_Playable` and restores the graph connection it was intercepting.
Dispose()	void	Cleans up the Unity.Collections.NativeArray`1s.
GetValue(int)	TValue	Returns the value of the property at the specified `index`.
GetValues()	TValue[]	Returns a new array containing the values of all properties.
GetValues(TValue[])	void	Resizes the `values` if necessary and copies the value of each property into it.
InitializeProperty(Animator, int, string)	void	Initializes a property on the target `UnityEngine.Animator`.
InitializeProperty(Animator, int, Transform, Type, string)	void	Initializes the specified `index` to read a property with the specified `name`.

Name	Value	Summary
implicit operator TValue(AnimatedProperty<TJob, TValue>)	TValue