User Tools
Site Tools
Sidebar
channel_float
Description
Defines properties of a floating-point value channel.
Parent Objects
Extends
Properties
| Name | Description | Default | Required |
|---|---|---|---|
| value | A float value representing the default value for the parameter. | 0.0 | no |
| current_value | A float value representing the current value for the parameter. | 0.0 | no |
| min | A float value representing the minimum value for the parameter, or for each component of a vector-valued channel. | 0.0 | no |
| max | A float value representing the maximum value for the parameter, or for each component of a vector-valued channel. | 1.0 | no |
| clamped | A boolean value representing whether or not min and max are enforced. | false | no |
| display_as_percent | A boolean value representing whether or not the parameter value should be shown to the user as a percentage. | false | no |
| step_size | A float value representing the step size, or paging size, to use for this parameter when presenting UI to the user. Effectively a scaling value. Value applies to all components of a vector-valued channel. | 1.0 | no |
| mappable | A boolean value representing whether or not the channel is mappable. | false | no |
Details
The current_value attribute is overridden anytime an animation is associated with the channel.
Example
{
"id" : "value",
"type" : "float",
"name" : "Dummy",
"label" : "Dummy",
"visible" : false,
"locked" : true,
"auto_follow" : true,
"value" : 0,
"current_value" : 0,
"min" : -1,
"max" : 1,
"clamped" : true,
"display_as_percent" : true,
"step_size" : 0.04
}
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution 3.0 Unported
