Summary
A value wrapper with utilities for being drawn in the Inspector.
- Assembly
- Animancer
.dll - Namespace
- Animancer
- Interfaces
-
- IComparable
<IParameter>
- IComparable
- Implementing Types
graph BT
Type-.->Interface0["IComparable<IParameter>"]
Type["IParameter"]
class Type type-node
Implementing0["Parameter<T>"]-.->Type
click Implementing0 "/animancer/api/Animancer/Parameter_1"
Syntax
public interface IParameter : IComparable<IParameter>Remarks
This interface is used for non-generic access to
Animancer.Parameter`1.Properties
| Name | Value | Summary |
|---|---|---|
| InspectorControlOnly | bool |
[Assert-Only]
If true, attempts to set the
Animancer.IParameter.Value in code will be ignored so this parameter can only be
controlled manually in the Inspector.
|
| Key | StringReference |
The key this parameter is registered with in the
Animancer.ParameterDictionary. |
| LogContext | Object |
[Assert-Only] If set, all interactions with this parameter will be logged with this prefix.
|
| Value | Object |
The current value of this parameter.
|
| ValueType | Type |
The type of the
Animancer.IParameter.Value. |
Methods
| Name | Value | Summary |
|---|---|---|
| GetOnValueChanged |
Delegate |
Returns a delegate that will be invoked when the
Animancer.IParameter.Value changes. |