5.80. UpdateScript (element)

<updateScript> ‐ A schedule update script

5.80.1. Attributes

NameTypeDefaults
idIDNone (required)

5.80.2. Description

This element is used to contain a script associated with the update of a schedule. It consists of list of commands made of an action and a target (see Section 2.4). These commands can be automatically triggered each time the schedule is updated (between begin time and end time).

The execution of the update script is controlled by the value ifv of the attribute interpolation_refreshing_variation of the element UDP Server defined in the configuration file. The value ifv is the threshold of the variation of the interpolator value (a float value between 0 and 1) variation under which the update script is not executed.

5.80.3. Expected content

This element expects a list of commands as content (without trigger component).

5.80.4. Example

In the example below, the update script contains one command. The action associated with this command sends a UDP message labeled source {#r} harmonie. The target host is the udp_host named spatializer.

<schedule begin="100000" dur="4" repeatCount="2" 
          mode="sinus-periodic" fill="remove">
    <completionScript>
      <command>
        <action>
          <send_message value="start scale" /> 
          <target type="single_node" value="#moving cylinder #{#p}" />
        </action>
        <action>
          <send_message_udp value="source {#r} harmonie 0.00" />
          <target type="single_host" value="spatializer" />
        </action>
      </command>
    </completionScript>
    <updateScript>
      <command>
        <action>
          <send_message_udp value="source {#r} harmonie" />
          <target type="single_host" value="spatializer" />
        </action>
      </command>
    </updateScript>
</schedule>