Update ActiveModColor docs to match current API (#1128)

pull/1129/head
Michael Richters 3 years ago committed by GitHub
parent ec7db6a74d
commit 85823f45f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -32,24 +32,26 @@ with the LEDs, and apply the highlight over those.
## Plugin properties ## Plugin properties
The plugin provides the `ActiveModColorEffect` object, which has the following The plugin provides the `ActiveModColorEffect` object, which has the following
properties: configuration methods. These methods all take a `cRGB` object, which can be
written as `CRGB(r, g, b)`, where `r`, `g`, and `b` are all 8-bit integers
(0-255). For example, `CRGB(50, 0, 50)` would be a purple-ish color.
### `.highlight_color` ### `.setHighlightColor(color)`
> The color to use for highlighting normal modifier keys and > Sets the color (a `cRGB` object) to use for highlighting normal modifier keys
> layer-shift keys. Defaults to a white color. > and layer-shift keys. Defaults to a white color.
### `.oneshot_color` ### `.setOneShotColor(color)`
> The color to use for highlighting active one-shot keys. These are > Sets the color (a `cRGB` object) to use for highlighting active one-shot
> the keys that will time out or deactivate when a subsequent key is > keys. These are the keys that will time out or deactivate when a subsequent
> pressed. Defaults to a yellow color. > key is pressed. Defaults to a yellow color.
### `.sticky_color` ### `.setStickyColor(color)`
> The color to use for highlighting "sticky" one-shot keys. These keys > Sets the color (a `cRGB` object) to use for highlighting "sticky" one-shot
> will remain active until they are pressed again. Defaults to a red > keys. These keys will remain active until they are pressed again. Defaults to
> color. > a red color.
## Plugin methods ## Plugin methods

Loading…
Cancel
Save