Example

====== Masters - Rate Master Functions ======

^ by: | Alex del Bondio |
^ published: | April 2019 |
^ description: | Macros for rate masters. |
^ remarks: | This is based on the [[macros:identifier:titanid|fixed Titan IDs]] which we found exactly for these macros. |

{{tag>rate master}}
==== functions ====
  * [[macros:function:Masters.SetMaster]]
  * [[macros:function:Masters.DeadBlackOut]]
  * [[macros:function:Masters.ClearFlash]]
  * [[macros:function:Masters.NudgeUp]]
  * [[macros:function:Masters.NudgeDown]]

**The Titan IDs have slightly changed from v10 to v11 see [[macros:identifier:titanid]], and while the mentioned reserved IDs are a good starting point, there is no guarantee they haven't changed in your show. If these macros do not work for you then try to find the Titan IDs of your masters and adjust the macros accordingly.**

===== Code =====
These are examples for Rate Master 1. For other Rate Masters (including Rate Grand Master) please refer to the Titan IDs mentioned above
<code xml ratemaster.xml>
<?xml version="1.0" encoding="utf-8"?>
<avolites.macros>

  <macro id="Macros.Ratemaster1.full" name="Set Ratemaster 1 to full">
    <sequence>
      <step>Masters.SetMaster(1613, 1)</step>
    </sequence>
  </macro>

  <macro id="Macros.Ratemaster1.50" name="Set Ratemaster 1 to 50%">
    <sequence>
      <step>Masters.SetMaster(1613, 0.5)</step>
    </sequence>
  </macro>

  <macro id="Macros.Ratemaster1.zero" name="Set Ratemaster 1 to 0">
    <sequence>
      <step>Masters.SetMaster(1613, 0)</step>
    </sequence>
  </macro>  

  <macro id="Macros.Ratemaster1.Freeze" name="Set Ratemaster 1 to 0 (temp.)">
    <sequence>
      <step>Masters.DeadBlackOut(1613)</step>
    </sequence>
  </macro>

  <macro id="Macros.Ratemaster1.UnFreeze" name="Set Ratemaster 1 to previous value">
    <sequence>
      <step>Masters.ClearFlash(1613)</step>
    </sequence>
  </macro>

  <macro id="Macros.Ratemaster1.NudgeUp" name="Increase Ratemaster 1 by +10%">
    <sequence>
      <step>Masters.NudgeUp(1613)</step>
    </sequence>
  </macro>

  <macro id="Macros.Ratemaster1.NudgeDown" name="Decrease Ratemaster 1 by 10%">
    <sequence>
      <step>Masters.NudgeDown(1613)</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]]



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

  - [[macros:deploying|make this macro available]]
  - apply when needed (you'll see the results when you have the relevant master assigned)


~~DISCUSSION~~