summaryrefslogtreecommitdiffstats
path: root/docs/key_functions.md
diff options
context:
space:
mode:
authorLuiz Ribeiro <luizribeiro@gmail.com>2017-07-04 17:17:28 +0200
committerLuiz Ribeiro <luizribeiro@gmail.com>2017-07-04 17:17:28 +0200
commitd5486265b8afcada68306c815b08c225fce287af (patch)
tree8fb7f8fee4aa3937003bd69d5c77ca867c010d12 /docs/key_functions.md
parent738b072bb0f25d0369a998c550c369e4f64cc7a5 (diff)
parent34c8bf47a76c8a2dcd3b1a19dd608f8fb2fafb31 (diff)
downloadqmk_firmware-d5486265b8afcada68306c815b08c225fce287af.tar.gz
qmk_firmware-d5486265b8afcada68306c815b08c225fce287af.tar.xz
Merge branch 'master' into ps2avrGB
Diffstat (limited to 'docs/key_functions.md')
-rw-r--r--docs/key_functions.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/key_functions.md b/docs/key_functions.md
index c0f06f9c8..74b80b42f 100644
--- a/docs/key_functions.md
+++ b/docs/key_functions.md
@@ -6,6 +6,10 @@ These functions work the same way that their `ACTION_*` functions do - they're j
Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them.
+### Limits of these aliases
+
+Currently, the keycodes able to used with these functions are limited to the TMK ones, meaning you can't use keycodes like `KC_TILD`, or anything greater than 0xFF. For a full list of the keycodes able to be used, [see this list](keycode.txt).
+
### Switching and toggling layers
`MO(layer)` - momentary switch to *layer*. As soon as you let go of the key, the layer is deactivated and you pop back out to the previous layer. When you apply this to a key, that same key must be set as `KC_TRNS` on the destination layer. Otherwise, you won't make it back to the original layer when you release the key (and you'll get a keycode sent). You can only switch to layers *above* your current layer. If you're on layer 0 and you use `MO(1)`, that will switch to layer 1 just fine. But if you include `MO(3)` on layer 5, that won't do anything for you -- because layer 3 is lower than layer 5 on the stack.