getWaveHeight | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getWaveHeight

Client-side
Server-side
Shared

Pair: setWaveHeight

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function returns the current wave height.

OOP Syntax Help! I don't understand this!

Syntax 

​float getWaveHeight ( )

Returns

Returns the height as a float , false otherwise.

  • float: value

Code Examples

shared

This example changes the wave height to the given amount.

function scriptWave ( thePlayer, command, height )
  local oldHeight = getWaveHeight()
  height = tonumber ( height )
  success = setWaveHeight ( height )
  if ( success ) then
    outputChatBox ( "The old wave height was: " .. oldHeight .. "; " .. getPlayerName ( thePlayer ) .. " set it to: " .. height )
  else
    outputChatBox ( "Invalid number." )
  end
end
addCommandHandler ( "setwave", scriptWave )

See Also

Water Functions
Reference