aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-06-11 14:28:30 -0400
committerGitHub <noreply@github.com>2017-06-11 14:28:30 -0400
commit6bd4df7a90e6137653c22b5dffa95870566eb4fd (patch)
treef9dc718495d3a14c2d6e18b2b6b851a6f76b5b41
parentc22a400603bfafedefa04c430214965cd191663b (diff)
downloadfirmware-6bd4df7a90e6137653c22b5dffa95870566eb4fd.tar.gz
firmware-6bd4df7a90e6137653c22b5dffa95870566eb4fd.tar.bz2
firmware-6bd4df7a90e6137653c22b5dffa95870566eb4fd.zip
define limits to functions
-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.