C4 Engine
C4 Engine API Documentation

WaveGenerator::GetWaveGeneratorType

Defined in:  C4Water.h
Returns the wave generator type.
Prototype

WaveGeneratorType GetWaveGeneratorType(voidconst;

Description
The GetWaveGeneratorType function returns the wave generator type, which can be one of the following constants.
kWaveGeneratorPoint Point wave generator. This generates a circular wave about a single point.
kWaveGeneratorLine Line wave generator. This generates a wave along a line segment.
kWaveGeneratorRandom Random wave generator. This generates random waves over an entire water block.
WaveGeneratorFlags
kWaveGeneratorUpdate The wave generator needs to be updated (read-only flag).
kWaveGeneratorNonpersistent The wave generator is nonpersistent, meaning that it will be automatically destroyed when it finishes running.