Example

====== Clear Colour ======

^ by: |  |
^ published: | October 2017 |
^ description: | Clears Colour from programmer |
^ remarks: | Example for usage of clear mask which is of type [[macros:type:object:acwrecordmask|]] |

{{tag>clear attribute programmer editor colour mask}}
==== functions ====
  * [[:macros:function:Programmer.Editor.Clear]]

===== Code =====
<code xml clearcolour.xml>
<?xml version="1.0" encoding="utf-8"?>
<avolites.macros xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Avolites.Menus.xsd">
  <macro id="ClearColour" name="ClearColour">
    <sequence>
    <!-- Clear mask is the first argument Intensity=1, Positions=2,Colours=4, Gobos=8, Beam=16, Effect = 32, Special = 64, FX = 128, Time = 256 -->
    <!-- (int Mask, bool Clear Presets, bool ClearAllProgrammers, float fadeTime) -->
      <step pause="0.01">Programmer.Editor.Clear(4, true, false, 0)</step>
    </sequence>
  </macro>
</avolites.macros>
</code>


===== Explanation =====

This explains the functional steps within the sequence. For all the other XML details please refer to [[:macros:formats_and_syntax#xml_format|Formats and syntax]]

Simply calls ''Programmer.Editor.Clear'' with the correct parameters.

===== How to use it =====

  * [[:macros:deploying|make this macro available]]
  * instead of holding ''<Clear>'' and setting the clear mask you can now fire this macro in order to clear only colour.

~~DISCUSSION~~