CigiWaveControl Class
Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Sim
SDK edition to use it.
You should upgrade to
| Inherits from: | CigiHostPacket |
CigiWaveControl Class
Properties
int RegionID#
The Environmental region ID specified in the packet.
int WaveID#
The value of the Wave ID specified in the packet.
int WaveEnabled#
The value of the Wave Enable parameter specified in the packet.
int Scope#
The value of the Scope parameter specified in the packet. Determines whether the wave is defined for global, regional, or entity-controlled maritime surface conditions.
int Breaker#
The value of the Breaker Type parameter specified in the packet.
float Height#
The value of the Wave Height parameter specified in the packet.
float Length#
The value of the Wavelength parameter specified in the packet.
float Period#
The value of the Period parameter specified in the packet. Determines the time required for one complete oscillation of the wave.
float WindDirection#
The value of the Wind Direction parameter specified in the packet. Determines the direction in which the wave propagates.
float Offset#
The value of the Phase Offset parameter specified in the packet. Determines the phase offset of the wave.
float Leading#
The value of the Leading parameter specified in the packet.
Members
Last update:
2022-12-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)