Class Roll

Roll options class [[include:Options/Particles/Roll.md]]

Implements

Index

Constructors

Properties

backColor? darken enable enlighten mode speed

Methods

Constructors

constructor

new Roll(): Roll
Returns Roll

Properties

`Optional`backColor

backColor?: OptionsColor

Roll back color

`Readonly`darken

darken: RollLight = ...

Roll darken options

enable

enable: boolean = false

Enables the roll

`Readonly`enlighten

enlighten: RollLight = ...

Roll enlighten options

mode

mode: "both" | "horizontal" | "vertical" | RollMode = RollMode.vertical

Roll mode

speed

speed: RangeValue = 25

Roll speed

Methods

load

load(data?: RecursivePartial<IRoll>): void
Loads the roll options from data
Parameters
- Optionaldata: RecursivePartial<IRoll>
  The data to handle
Returns void
Implementation of IOptionLoader.load
- Defined in Options/Classes/Roll.ts:37