]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
define limits to functions
authorJack Humbert <jack.humb@gmail.com>
Sun, 11 Jun 2017 18:28:30 +0000 (14:28 -0400)
committerGitHub <noreply@github.com>
Sun, 11 Jun 2017 18:28:30 +0000 (14:28 -0400)
docs/key_functions.md

index c0f06f9c8ae25376a34975b807fdef11c7be048b..74b80b42f1060962b90aae6ee7b0d085d68568b5 100644 (file)
@@ -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.