This shows you the differences between two versions of the page.
Next revision | Previous revision Next revision Both sides next revision | ||
token:TriggerValue [2015/07/15 06:18] peternlewis created |
token:TriggerValue [2021/11/14 11:35] ccstone |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | The //%TriggerValue%// token returns the value associated with the trigger (eg the typed string, or the hot key pressed, or the parameter passed by the [Execute a Macro action](action:Execute_a_Macro) or via AppleScript or the web server. | + | The //%TriggerValue%// token returns the value associated with how the macro was triggered. |
+ | |||
+ | Different ways of triggering the macro will set this field differently. | ||
+ | |||
+ | * You can pass an explicit value in using the "with parameter" option when executing a script from AppleScript. | ||
+ | * You can pass an explicit value in when using the [Execute a Macro action](action:Execute_a_Macro). | ||
+ | * You can pass an explicit value in when executing the macro via the web server. | ||
+ | * You can pass an explicit value in when executing the macro via the [kmtrigger URL](trigger:URL). | ||
+ | |||
+ | **When a Macro is triggered, the The //%TriggerValue%// token value will be based on the trigger:** | ||
+ | |||
+ | ^ Trigger Type ^ `%TriggerValue%` token ^ | ||
+ | | [Typed String trigger](trigger:Typed_String) | The exact text you typed to trigger | | ||
+ | | [[trigger:Status_Menu|Status Menu]] or [[manual:Palettes|Palette]] | The current modifiers (Note that Option means "edit this macro instead of triggering it"). | | ||
+ | | [[trigger:Hot_Key|Hot Key Trigger]] or [[trigger:USB_Device_Key|USB Device Key]] | The key that was pressed. | | ||
+ | | [[trigger:Application|Application Trigger]] | Path to the application that was triggered. | | ||
+ | | [[trigger:Folder|Folder Trigger]] | Path of the file that was added or removed. | | ||
+ | | [Execute a Macro action](action:Execute_a_Macro) | Although _Execute a Macro_ is _not_ technically a trigger, when a Macro is executed by this method (the "Sub-Macro"), the //%TriggerValue%// token (as evaluated in the "Sub-Macro") will be either of two values:\\ 1. The //%TriggerValue%// of the calling ("Main") Macro\\ OR \\ 2. The value of the Parameter of the _Execute a Macro_, **if** a Parameter is provided. | | ||
+ | |||
+ | To use the %TriggerValue% token in a numeric field, use the [CALCULATE](https://wiki.keyboardmaestro.com/function/CALCULATE) function: CALCULATE(%TriggerValue%). | ||
+ | |||
+ | You can easily access the individual parts using the token array notation, eg `%TriggerValue[3]%` will be the third comma-separated value, and `%TriggerValue[3];%` will be the third semicolon-separated value, and `%TriggerValue[3] %` (note the space between the `]` and the `%`) will be the third space-separated value (8.0.4+). | ||
+ | |||
+ | ===== See Also ===== | ||
+ | |||
+ | === Tokens === | ||
+ | |||
+ | * [[Trigger|%Trigger%]] token | ||
+ | * [[TriggerBase|%TriggerBase%]] token | ||
+ | * [[TriggerClipboard|%TriggerClipboard%]] token | ||
+ | * [[/Tokens|All Tokens]] | ||
+ |