Wavecomponent

WaveComponent class

A component to display a wave effect in the game.

See WaveComponentData for the data schema used to create a wave component

Signature:

export declare class WaveComponent extends Component3D<WaveComponentData> 

Extends: Component3D<WaveComponentData>

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the WaveComponent class.

Properties

Property

Modifiers

Type

Description

color

number

Get the color of the wave lines.

direction

any

Get the direction of the wave circles: 1 means outwards, -1 means inwards. Defaults to -1

lineWidth

number

Get the width of the wave lines.

radius

number

Get the radius of the wave.