Class Move

Particles Move
key option type example notes
angle object See angle documentation below
attract object See attract documentation below
direction string "none"
"top"
"top-right"
"right"
"bottom-right"
"bottom"
"bottom-left"
"left"
"top-left"
distance object See distance documentation below
enable boolean true / false
gravity object See gravity documentation below
noise object See noise documentation below
outModes object See out modes documentation below
random boolean true / false
size boolean true / false
speed number 4 assuming a predefined distance for the particle to travel, speed is the amount of time takes to travel the predefined distance for any particle
straight boolean true / false
trail object See trail documentation below
vibrate boolean true / false
warp boolean true / false

Particles Move Angle
key option type example notes
offset boolean true / false
value number 3000

Particles Move Attract
key option type example notes
enable boolean true / false
rotate.x number 3000
rotate.y number 1500

Particles Move Distance
key option type example notes
horizontal number 50
vertical number 50

Particles Move Gravity
key option type example notes
acceleration number 9.81
enable boolean true / false
maxSpeed number 50

Particles Move Noise
key option type example notes
clamp boolean true / false
delay.value number / object 1 / { min: 0.5, max: 1.5 }
enable boolean true / false
generator string "generator name"

Particles Move Out Modes
key option type example notes
default string "out"
"destroy"
"bounce"
"none"
"split"
bottom string "out"
"destroy"
"bounce"
"none"
"split"
left string "out"
"destroy"
"bounce"
"none"
"split"
right string "out"
"destroy"
"bounce"
"none"
"split"
top string "out"
"destroy"
"bounce"
"none"
"split"

Particles Move Spin
key option type example notes
acceleration number 2
enable boolean true / false
position object { x: 50, y: 50 }

Particles Move Trail
key option type example notes
enable boolean true / false
length number 10
fillColor color object This color object is the same described {@links IColor

Hierarchy

  • Move

Implements

Constructors

constructor

Properties

angle attract center decay direction distance drift enable gravity outModes path random size speed spin straight trail vibrate warp

Accessors

bounce collisions noise outMode out_mode

Methods

load

Constructors

constructor

Properties

angle

angle: MoveAngle

attract

attract: MoveAttract

center

center: ICoordinates & { radius: number }

decay

decay: number

direction

direction: number | "none" | "left" | "top" | "bottom" | "right" | MoveDirectionAlt | MoveDirection | "bottomLeft" | "bottomRight" | "topLeft" | "topRight" | "outside" | "inside"

distance

distance: Partial<IDistance>

drift

drift: RangeValue

enable

enable: boolean

gravity

gravity: MoveGravity

outModes

outModes: OutModes

path

path: MovePath

random

random: boolean

size

size: boolean

speed

speed: RangeValue

spin

spin: Spin

straight

straight: boolean

trail

trail: MoveTrail

vibrate

vibrate: boolean

warp

warp: boolean

Accessors

bounce

  • get bounce(): boolean

  • Deprecated

    this property is obsolete, please use the new collisions object on particles options

    Returns boolean

  • set bounce(value: boolean): void

  • Deprecated

    this property is obsolete, please use the new collisions object on particles options

    Parameters

    • value: boolean

    Returns void

collisions

  • get collisions(): boolean

  • Deprecated

    this property is obsolete, please use the new collisions object on particles options

    Returns boolean

  • set collisions(value: boolean): void

  • Deprecated

    this property is obsolete, please use the new collisions object on particles options

    Parameters

    • value: boolean

    Returns void

noise

outMode

  • get outMode(): "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"

  • Deprecated

    this property is obsolete, please use the new outMode

    Returns "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"

  • set outMode(value: "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"): void

  • Deprecated

    this property is obsolete, please use the new outMode

    Parameters

    • value: "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"

    Returns void

out_mode

  • get out_mode(): "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"

  • Deprecated

    this property is obsolete, please use the new outMode

    Returns "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"

  • set out_mode(value: "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"): void

  • Deprecated

    this property is obsolete, please use the new outMode

    Parameters

    • value: "split" | "none" | "bounce" | "destroy" | OutModeAlt | OutMode | "bounceHorizontal" | "bounceVertical" | "out"

    Returns void

Methods

load

Settings

Member Visibility

Theme