Summary
A generic value with an event for when it gets changed.
- Assembly
- Animancer
.dll - Namespace
- Animancer
- Interfaces
-
- IParameter
- IComparable
<IParameter>
- Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type-.->Interface0["IParameter"]
click Interface0 "/animancer/api/Animancer/IParameter"
Type-.->Interface1["IComparable<IParameter>"]
Type["Parameter<T>"]
class Type type-node
Syntax
public class Parameter<T> : IParameter, IComparable<IParameter>Type Parameters
| Name | Description |
|---|---|
| T |
Constructors
| Name | Summary |
|---|---|
| Parameter |
Creates a new Animancer.Parameter`1. |
| Parameter |
Creates a new Animancer.Parameter`1 with the specified starting `value`. |
Events
| Name | Type | Summary |
|---|---|---|
| OnValueChanged | Action |
Called whenever the
Animancer.Parameter`1.Value is changed. |
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 | T |
The current value of this parameter.
|
| ValueType | Type |
The type of the
Animancer.IParameter.Value. |
Methods
| Name | Value | Summary |
|---|---|---|
| GetValue |
T |
Gets the
Animancer.Parameter`1.Value. |
| SetValue |
void |
Sets the
Animancer.Parameter`1.Value. |
| ToString |
string |
Returns a string describing this parameter.
|
Operators
| Name | Value | Summary |
|---|---|---|
| implicit operator T |
T |