README.md: Properties are not methods

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/365/head
Gergely Nagy 8 years ago
parent 7ddb1130b4
commit ac1b302ea0

@ -39,23 +39,19 @@ recommended.
## Plugin methods ## Plugin methods
The plugin provides the `StalkerEffect` object, which has the following The plugin provides the `StalkerEffect` object, which has the following
method: properties:
### `.variant` ### `.variant`
> Set the effect to use with the plugin. See below for a list. > Set the effect to use with the plugin. See below for a list.
> >
> It is recommended to use the `STALKER` macro to declare the effect itself. > It is recommended to use the `STALKER` macro to declare the effect itself.
>
> Not a method itself, but a changeable value.
### `.stepLength` ### `.stepLength`
> The length - in milliseconds - of each step of the animation. An animation > The length - in milliseconds - of each step of the animation. An animation
> lasts 256 steps. > lasts 256 steps.
> >
> Not a method itself, but a changeable value.
>
> Defaults to 50. > Defaults to 50.
## Plugin helpers ## Plugin helpers

Loading…
Cancel
Save