/ 2026-04-17T04:13:15+00:00 / /lib/tpl/dazdoccenter/images/favicon.ico text/html 2012-04-06T21:37:42+00:00 /public/dson_spec/object_definitions/channel/start <h1 id="channel">channel</h1> <div class="level1"> </div> <h2 id="description">Description</h2> <div class="level2"> <p> This is an abstract object that contains the common properties for all channel types. </p> </div> <h2 id="parent_objects">Parent Objects</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/bulge_binding/start" class="wikilink1" title="public:dson_spec:object_definitions:bulge_binding:start">bulge_binding</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/modifier/start" class="wikilink1" title="public:dson_spec:object_definitions:modifier:start">modifier</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/node/start" class="wikilink1" title="public:dson_spec:object_definitions:node:start">node</a></div> </li> </ul> </div> <h2 id="properties">Properties</h2> <div class="level2"> <div class="table sectionedit1"><table class="inline"> <thead> <tr class="row0"> <th class="col0"> Name </th><th class="col1"> Description </th><th class="col2"> Default </th><th class="col3"> Required </th> </tr> </thead> <tr class="row1"> <td class="col0"> id </td><td class="col1"> A string representing a unique ID within the property scope of the containing object. </td><td class="col2"> None </td><td class="col3"> yes </td> </tr> <tr class="row2"> <td class="col0"> type </td><td class="col1"> A string representing the data type of the channel. Valid values are “alias”, “bool”, “color”, “enum”, “float”, “image”, “int” and “string”. See <a href="#extended_by" title="public:dson_spec:object_definitions:channel:start ↵" class="wikilink1">Extended By</a>. </td><td class="col2"> “float” </td><td class="col3"> yes </td> </tr> <tr class="row3"> <td class="col0"> name </td><td class="col1"> A string representing the internal name to apply to this channel. An empty string is not a valid name. </td><td class="col2"> None </td><td class="col3"> yes </td> </tr> <tr class="row4"> <td class="col0"> label </td><td class="col1"> A string representing a user-facing label to apply to this channel. </td><td class="col2"> None </td><td class="col3"> no </td> </tr> <tr class="row5"> <td class="col0"> visible </td><td class="col1"> A boolean value representing a <abbr title="User Interface">UI</abbr> hint, indicating whether or not the parameter should be shown. </td><td class="col2"> true </td><td class="col3"> no </td> </tr> <tr class="row6"> <td class="col0"> locked </td><td class="col1"> A boolean value representing whether or not the parameter is allowed to be changed. </td><td class="col2"> false </td><td class="col3"> no </td> </tr> <tr class="row7"> <td class="col0"> auto_follow </td><td class="col1"> A boolean value representing whether or not the channel should automatically be connected to a corresponding channel during conforming. </td><td class="col2"> false </td><td class="col3"> no </td> </tr> </table></div> <!-- EDIT1 TABLE [367-1340] --> </div> <h2 id="extended_by">Extended By</h2> <div class="level2"> <p> For each type of channel, there are corresponding attributes that are specific to that type. For details, see: </p> <ul> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_alias/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_alias:start">channel_alias</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_bool/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_bool:start">channel_bool</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_color/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_color:start">channel_color</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_enum/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_enum:start">channel_enum</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_float/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_float:start">channel_float</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_image/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_image:start">channel_image</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_int/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_int:start">channel_int</a></div> </li> <li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/channel_string/start" class="wikilink1" title="public:dson_spec:object_definitions:channel_string:start">channel_string</a></div> </li> </ul> </div> <h2 id="details">Details</h2> <div class="level2"> <p> The ID of a channel does not have to be unique within file scope because it is not an “asset” and its addressing is always via property addressing, so must only be unique within the scope of the containing/owning object. </p> </div> <h2 id="example">Example</h2> <div class="level2"> <pre class="code">{ &quot;id&quot; : &quot;x&quot;, &quot;label&quot; : &quot;Side-Side&quot;, &quot;visible&quot; : true, &quot;locked&quot; : true, &quot;min&quot; : 0.0, &quot;max&quot; : 1.0, &quot;clamped&quot; : true, &quot;display_as_percent&quot; : false, &quot;step_size&quot; : 2.0, &quot;value&quot; : 0.0 }</pre> </div>