Parameter Execute DAT

Summary

The Parameter Execute DAT runs a script when a parameter of any operator changes state. There are 4 ways a parameter can trigger the script: if its value, expression, export, or enable state changes.

Parameter Execute DATs are created with default python method placeholders. Unlike other execute DATs, the Parameter Execute DAT does not cook the node that it is watching, to avoid issues with recursive updates.

parameterexecuteDAT_Class

Parameters - Parameter Execute Page

Active active - While on, the DAT will respond to the Parameter that is referenced.

Execute from executeloc - ⊞ - (Tscript only) Determines the location the script is run from.

• Current Node current - (Tscript only) The script is executed from the current node location.

• This Node here - The script is executed from the parent of the DAT. The DAT executes from the parent to make siblings of the DAT easy to access: DAT scripts used to execute from inside the DAT.

• Specified Operator op - The script is executed from the operator specified in the From Operator parameter below.

From Operator fromop - This operator is also the path that the script will be executed from if the Execute From parameter is set to Specified Operator.

OPs op - Specify which operator(s) the triggering parameter belongs to.

Parameters pars - Specify which parameter(s) to monitor for triggering the script.

Value Change valuechange - The onValueChange() method executes when the parameter specified changes value in any way. It is called once each frame.

Values Changed valueschanged - The onValuesChanged() method executes at end of frame with complete list of individual parameter changes. The changes are a list of named tuples, where each tuple is (Par, previous value)

On Pulse onpulse - The onPulse() method executes when a 'pulse' type parameter is pulse by clicking on it or via the Par.pulse() method.

Expression Change expressionchange - The onExpressionChange() method executes whenever the specified parameter's expression changes. For example, changing the expression from me.time.frame to me.time.seconds will trigger the script.

Export Change exportchange - The onExportChange() method executes if the export path to the specified parameter changes. For example, if the parameter is being exported to from /chopname/chan1 and that is changed so /chopname2/chan2 is now exporting to it, then the script will be triggered.

Enable Change enablechange - The onEnableChange() method executes if the specified parameter goes from being disabled to enabled.

Mode Change modechange - The onModeChange() method executes if the specified parameter's mode changes between the available constant, expression, export or bind mode.

Custom custom - Monitor Custom Parameters.

Built-In builtin - Monitor Built-In parameters.

Edit.. edit - Clicking this opens a text editor to edit text in the DAT.

Parameters - Common Page

Language language - ⊞ - Select how the DAT decides which script language to operate on.

• Input input - The DAT uses the inputs script language.

• Node node - The DAT uses it's own script language.

Edit/View Extension extension - ⊞ - Select the file extension this DAT should expose to external editors.

• dat dat - various common file extensions.

• From Language language - pick extension from DATs script language.

• Custom Extension custom - Specify a custom extension.

Custom Extension customext - Specifiy the custom extension.

Word Wrap wordwrap - ⊞ - Enable Word Wrap for Node Display.

• Input input - The DAT uses the inputs setting.

• On on - Turn on Word Wrap.

• Off off - Turn off Word Wrap.

Operator Inputs

• Input 0 -

TouchDesigner Build: 2021.100002018.28070before 2018.28070

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

The generic thing that holds an Operator, and includes Flags (display, bypass, lock, render, immune) and its position/size in the network. Whether you "lay down an Operator" or "lay down an Node", you're doing the same thing.

Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.

To pulse a parameter is to send it a signal from a CHOP or python or a mouse click that causes a new action to occur immediately. A pulse via python is via the .pulse() function on a pulse-type parameter, such as Reset in a Speed CHOP. A pulse from a CHOP is typically a 0 to 1 to 0 signal in a channel.

A text string that contains data (string, float, list, boolean, etc.) and operators (+ * < etc) that are evaluated by the node's language (python or Tscript) and returns a string, float list or boolean, etc. Expressions are used in parameters, DATs and in scripts.

Exporting is the connection of CHOP channels to parameters of operators. The output of each exporting CHOP is one or more channels, active only while the CHOP Viewer is on. The current value of a channel can be exported to a parameter of any operator, overriding that parameter's value. See Parameter.