Struct IntProperty
Integer property handle used to read and write values in the AnimationStream.
Namespace: UnityEngine.Animations.Rigging
Syntax
public struct IntProperty : IAnimatableProperty<int>
Fields
value
The PropertyStreamHandle used in the AnimationStream.
Declaration
public PropertyStreamHandle value
Field Value
Type | Description |
---|---|
PropertyStreamHandle |
Methods
Bind(Animator, Component, String)
Creates a IntProperty handle representing a property binding on a Component.
Declaration
public static IntProperty Bind(Animator animator, Component component, string name)
Parameters
Type | Name | Description |
---|---|---|
Animator | animator | The Animator on which to bind the new handle. |
Component | component | The Component owning the parameter. |
String | name | The property name |
Returns
Type | Description |
---|---|
IntProperty | Returns a IntProperty handle that represents the new binding. |
BindCustom(Animator, String)
Creates a IntProperty handle for a custom property in the AnimationStream to pass extra data to downstream animation jobs in the graph.
Declaration
public static IntProperty BindCustom(Animator animator, string property)
Parameters
Type | Name | Description |
---|---|---|
Animator | animator | The Animator on which to bind the new handle. |
String | property | The name of the property. |
Returns
Type | Description |
---|---|
IntProperty | Returns a IntProperty handle that represents the new binding. |
Get(AnimationStream)
Gets the property value from a stream.
Declaration
public int Get(AnimationStream stream)
Parameters
Type | Name | Description |
---|---|---|
AnimationStream | stream | The AnimationStream that holds the animated values. |
Returns
Type | Description |
---|---|
Int32 | The integer property value. |
Implements
Set(AnimationStream, Int32)
Sets the property value into a stream.
Declaration
public void Set(AnimationStream stream, int v)
Parameters
Type | Name | Description |
---|---|---|
AnimationStream | stream | The AnimationStream that holds the animated values. |
Int32 | v | The new integer property value. |