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

PropertyModifiersTypeDescription
colornumberGet the color of the wave lines.
directionanyGet the direction of the wave circles: 1 means outwards, -1 means inwards. Defaults to -1
lineWidthnumberGet the width of the wave lines.
radiusnumberGet the radius of the wave.