Example

====== Trigger - Toggle Trigger Mappings v10/v11 ======

^ by: | Sebastian Beutel |
^ published: | January 2018 |
^ description: | Toggles trigger mappings on/off (without entering system mode).|
^ remarks: | Idea from facebook group: https://www.facebook.com/groups/Avolites/permalink/1163736800425219/ |

<fs x-large>**This is version dependent**</fs>

The way how Titan assigns IDs to mappings has changed. In short, in Titan v10 the macro works with ''Triggers.ToggleMappingEnable(2)''. In Titan v11 try something like ''Triggers.ToggleMappingEnable(1817)''. From Titan v12, use ''Triggers.ToggleMappingEnabledByHandle'' instead and define the mapping by its user number. See [[:macros:function: Triggers.ToggleMappingEnable]] for details.

{{tag>toggle trigger mapping}}

==== functions ====
  * [[:macros:function: Triggers.ToggleMappingEnable]]

===== Code v10 =====
<code xml ToggleTriggerMappings.xml>
<?xml version="1.0" encoding="utf-8"?>
<avolites.macros>

<!-- the first two trigger mappings are predefined and fix, thus the first user mapping is ID 2 -->

  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.1" name="Toggle Triggermapping 1">
    <description>Toggle Triggermapping 1.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(2)</step>
    </sequence>
  </macro>
  
  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.2" name="Toggle Triggermapping 2">
    <description>Toggle Triggermapping 2.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(3)</step>
    </sequence>
  </macro>
  
  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.3" name="Toggle Triggermapping 3">
    <description>Toggle Triggermapping 3.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(4)</step>
    </sequence>
  </macro>
  
  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.4" name="Toggle Triggermapping 4">
    <description>Toggle Triggermapping 4.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(5)</step>
    </sequence>
  </macro>
  
  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.5" name="Toggle Triggermapping 5">
    <description>Toggle Triggermapping 5.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(6)</step>
    </sequence>
  </macro>
  
</avolites.macros>
</code>

===== Code v11 =====
<code xml ToggleTriggerMappingsV11.xml>
<?xml version="1.0" encoding="utf-8"?>
<avolites.macros>

<!-- from v11 the mapppingIds are titanIds and may change. This may or may not work. -->

  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.v11.1" name="Toggle Triggermapping v11 1">
    <description>Toggle Triggermapping v11 1.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(1817)</step>
    </sequence>
  </macro>
  
  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.v11.2" name="Toggle Triggermapping v11 2">
    <description>Toggle Triggermapping v11 2.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(1818)</step>
    </sequence>
  </macro>
  
  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.v11.3" name="Toggle Triggermapping v11 3">
    <description>Toggle Triggermapping v11 3.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(1819)</step>
    </sequence>
  </macro>
  
  <macro id="Avolites.Macros.Triggers.Mapping.Toggle.v11.4" name="Toggle Triggermapping v11 4">
    <description>Toggle Triggermapping v11 4.</description>
    <sequence>
      <step>Triggers.ToggleMappingEnable(1820)</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]]

The macros use the function [[macros:function:Triggers.ToggleMappingEnable]] to enable/disable trigger mappings. The first two mappings are predefined and cannot be altered, thus the user-defined mappings start with ID 2.

//N.B. currently it is not possible to show whether a specific mapping is enabled using [[macros:active_binding]] as this requires a property, but there are no properties available for this purpose. (thanks to Gregory Haynes for explaining this)//

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

  * [[:macros:deploying|make this macro available]]
  * use the macros to toggle on/off the trigger mappings without entering system mode

~~DISCUSSION~~