User Tools
AppleScript
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
AppleScript [2017/06/04 22:09] JMichaelTX [Get Existing Variable] |
AppleScript [2025/02/27 01:45] (current) peternlewis [Local & Instance Variables] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Using AppleScript to Get and Set Keyboard Maestro Variables ====== | ====== Using AppleScript to Get and Set Keyboard Maestro Variables ====== | ||
| - | \\ | ||
| - | ===== Get and Set Variables ===== | ||
| Keyboard Maestro Version 7.1 introduced a streamlined way to Get and Set Keyboard Maestro Variables from AppleScript. | Keyboard Maestro Version 7.1 introduced a streamlined way to Get and Set Keyboard Maestro Variables from AppleScript. | ||
| - | In AppleScript, you can tell the application "Keyboard Maestro Engine" to: | + | In AppleScript, you can access Keyboard Maestro variables like this: |
| - | getvariable <KM Variable Name> | + | ```applescript |
| - | setvariable <KM Variable Name> to <New Value> | + | tell application "Keyboard Maestro Engine" |
| + | set v to getvariable "<KM Variable Name>" | ||
| + | setvariable "<KM Variable Name>" to "<New Value>" | ||
| + | end tell | ||
| + | ``` | ||
| where both the `<KM Variable Name>` and `<New Value>` are text values. | where both the `<KM Variable Name>` and `<New Value>` are text values. | ||
| - | ==== Examples ==== | + | **For more details, see:** |
| + | - [[manual:Scripting|Scripting article in the Manual Section]]. | ||
| + | - [[action:Execute_an_AppleScript|Execute AppleScript Action]]. | ||
| + | |||
| + | ===== Global Variables ===== | ||
| + | |||
| + | Global Variables (available in //all// macros) may be got and set like this: | ||
| ```applescript | ```applescript | ||
| Line 44: | Line 52: | ||
| ``` | ``` | ||
| + | **Real-World Example** | ||
| Normally, you would not have both a GET and a SET variable within the same AppleScript tell block.\\ | Normally, you would not have both a GET and a SET variable within the same AppleScript tell block.\\ | ||
| Line 50: | Line 58: | ||
| ```applescript | ```applescript | ||
| + | ### Requires Keyboard Maestro 7.1+ ### | ||
| + | |||
| --- GET REQUIRED KM VARIABLES --- | --- GET REQUIRED KM VARIABLES --- | ||
| Line 67: | Line 77: | ||
| ``` | ``` | ||
| + | ===== Local & Instance Variables ===== | ||
| - | **For more details, see [[manual:Scripting|Scripting article in the Manual Section]].** | ||
| - | ---- | + | To get or set [[manual:Variables#Scope|Local or Instance Variables]], you must pass the macro execution instance to the `getvariable` or `setvariable` command. The instance is passed in to your script via the KMINSTANCE environment variable (v8.0.3+). |
| + | |||
| + | ```applescript | ||
| + | set kmInst to system attribute "KMINSTANCE" | ||
| + | tell application "Keyboard Maestro Engine" | ||
| + | set v to getvariable "Local__SomeLocalVariable" instance kmInst | ||
| + | setvariable "Local__FromAS" instance kmInst to "Variable set in AppleScript." | ||
| + | end tell | ||
| + | |||
| + | log v | ||
| + | ``` | ||
| + | |||
| + | |||
| + | ===== Dictionary Values ===== | ||
| + | |||
| + | You can read and write [[manual:Dictionaries|Dictionary]] values from AppleScript. | ||
| + | |||
| + | ```applescript | ||
| + | ### Requires Keyboard Maestro 8.0+ ### | ||
| + | |||
| + | tell application "Keyboard Maestro Engine" | ||
| + | set kmDictList to name of dictionaries | ||
| + | set dictKeyList to dictionary keys of dictionary "First Names" | ||
| + | |||
| + | set value of dictionary key "P" of dictionary "First Names" to "Fred" | ||
| + | end tell | ||
| + | ``` | ||
| ===== Prior to Ver 7.1 ===== | ===== Prior to Ver 7.1 ===== | ||
| Line 86: | Line 122: | ||
| | | ||
| --- Compatible with Keyboard Maestro 6+ --- | --- Compatible with Keyboard Maestro 6+ --- | ||
| - | -- • Creates the KM Variable it does not exist (just like KM 7 setvariable) | + | -- • Creates the KM Variable if does not exist (just like KM 7 setvariable) |
| -- • Returns true if new Variable was created | -- • Returns true if new Variable was created | ||
| | | ||
AppleScript.1496628583.txt.gz · Last modified: 2017/06/04 22:09 by JMichaelTX
Page Tools
