SetWaveHeight
Jump to navigation
Jump to search
This function sets the wave height to the desired value, the default is 0.
Syntax
bool setWaveHeight ( float height )
Required Arguments
- height: A float between 0 and 100.
Returns
Returns a boolean value true or false that tells you if it was successful or not.
Example
This example changes the wave height to the given amount.
function scriptWave ( player, command, height ) local oldHeight = getWaveHeight() height = tonumber ( height ) success = setWaveHeight ( height ) if ( success ) then outputChatBox ( "The old wave height was: " .. oldHeight .. "; " .. getClientName ( player ) .. " set it to: " .. height ) else outputChatBox ( "Invalid number." ) end end addCommandHandler ( "setwave", scriptWave )
See Also
- areTrafficLightsLocked
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getCloudsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGravity
- getHeatHaze
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getOcclusionsEnabled
- getRainLevel
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getWeather
- getWindVelocity
- getSkyGradient
- getPlayerBlurLevel
- getZoneName
- isGarageOpen
- removeWorldModel
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetWindVelocity
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setCloudsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorSoundsEnabled
- setMinuteDuration
- setMoonSize
- setOcclusionsEnabled
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightState
- setTrafficLightsLocked
- setWeather
- setWeatherBlended
- setWindVelocity
- setJetpackMaxHeight
- setPlayerBlurLevel