Immune Flag

From TouchDesigner Documentation
Jump to: navigation, search
Immune Flag is off
Node Immune Flag is on
Network Immune Flag is on

Every non-component node has an Immune 2-state Flag, also known as Clone Immune Flag. If the Immune flag is On for a node in a Clone, it is not affected by changes made to the equivalent node in the master clone. You can use the Immune flag to customize parameters of operators, or to add extra operators and additional data that does not exist in the Clone's Master Component. bi-state The Immune flag on non-components is a 2-state flag.

  • ImmuneFlagOffIcon.png Off
  • ImmuneFlagOnIcon.png On - This node is made immune.

For example, Table DATs in clones are often made immune to make the table unique in each clone.

What is kept immune: the parameters, the wiring coming to the inputs of the node, and, if the node is a panel, all its Panel Values like state, u and v. The data of Table DATs and the data of Locked nodes are also kept immune.

WARNING: If you add a new node in a Clone and make the new node's Immune flag On, you may also have to make the Immune flag On of the nodes its output is connected to, since wiring information is held with the inputs of a node.

Immune on Components[edit]

Every component node has an Immune 3-state Flag, also known as Clone Immune Flag.

The Immune flag on components is a 3-state flag.

  • ImmuneFlagOffIcon.png Off
  • ImmuneFlagOnIcon.png On - This node is made immune.
  • ImmuneFlagNetworkOnIcon.png On Including Children - This node is made immune plus (if the node is a Component) all nodes inside the component (recursively) are immune.

If a node is inside a Clone component and the node's Immune flag is On, it is not affected by changes made to the equivalent node in the master clone.

Thus entire Components can be made immune using On Including Children, where all the nodes inside the component's network are immune as well.

The 3-state flag is on the tiles and also in the editor list "t" mode.

When a .toe or .tox file is saved, all cloned nodes are NOT saved in the .toe except for immune nodes. Immune nodes in clones are saved since they are not defined in the master clone. Otherwise, nodes in clones are not expected to be saved in the file.


See Clone for additional information.

Immune by Python[edit]

See cloneImmune in OP_Class.

For components, see componentCloneImmune in COMP_Class. When componentCloneImmune is True, everything inside the clone is immune. When componentCloneImmune is False, it uses the OP_Class cloneImmune member to determine if just the component is immune (its parameters etc, but not the component's network inside).

Every node has an Immune flag. When the Immune flag is on, and the node is inside a Clone, it is not affected by any change to the clone, so you can store extra data in a clone.

(1) Indicator of certain states of an operator (bypass, display, lock), or (2) option of a Tscript command.

Cloning can make multiple components match the contents of a master component. A Component whose Clone parameter is set will be forced to contain the same nodes, wiring and parameters as its master component. Cloning does not create new components as does the Replicator COMP.

An Operator Family that contains its own Network inside. There are twelve 3D Object Component and eight 2D Panel Component types. See also Network Path.

TOuch Environment file, the file type used by TouchDesigner to save your project.

TouchDesigner Component file, the file type used to save a Component from TouchDesigner.