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

IDisposable

Base Types

Object
AnimancerJob<TJob>

Derived Types

graph BT Type-->Base0["AnimancerJob<TJob>"] Base0-->Base1["Object"] Type-.->Interface0["IDisposable"] Type["AnimatedProperty<TJob, TValue>"] class Type type-node Derived0["AnimatedFloat"]-->Type click Derived0 "/animancer-v7-4/api/Animancer/AnimatedFloat" Derived1["AnimatedInt"]-->Type click Derived1 "/animancer-v7-4/api/Animancer/AnimatedInt" Derived2["AnimatedBool"]-->Type click Derived2 "/animancer-v7-4/api/Animancer/AnimatedBool"

Syntax

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

Examples

Animation Jobs

Remarks

Documentation: Animated Properties

Type Parameters

Name	Description
TJob
TValue

Constructors

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.

Fields

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.

Properties

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.

Methods

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`.

Operators

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

AnimatedProperty<TJob, TValue> Class