From 58d353a9200c0718af9d55c866fb68c1a56b7e42 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 24 Jan 2019 14:59:06 +0100 Subject: [PATCH] Chase: Update the documentation Signed-off-by: Gergely Nagy --- doc/plugin/LEDEffect-Chase.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/doc/plugin/LEDEffect-Chase.md b/doc/plugin/LEDEffect-Chase.md index 739cd450..1a0df3fb 100644 --- a/doc/plugin/LEDEffect-Chase.md +++ b/doc/plugin/LEDEffect-Chase.md @@ -21,8 +21,23 @@ void setup() { ## Plugin methods -The plugin provides the `LEDChaseEffect` object, which has no public methods or -properties, outside of those provided by all LED modes. +The plugin provides the `LEDChaseEffect` object, which has the following methods +outside of those provided by all LED modes: + +### `.update_delay([delay])` + +> Accessor for the update delay, the time between each step of the animation. +> When called without an argument, returns the current setting. When called with +> one, sets it. +> +> Defaults to 150 (milliseconds). + +### `.distance([pixels])` + +> Accessor for the distance between the two pixels. When called without an +> argument, returns the current setting. When called with one, sets it. +> +> Defaults to 5. ## Dependencies