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

setWaveHeight

Client-side
Server-side
Shared

Pair: getWaveHeight

Manual Review Required

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

This function sets the wave height to the desired value, the default is 0.

OOP Syntax Help! I don't understand this!

Syntax 

bool setWaveHeight ( float height )
Required Arguments
  • height: A float between 0 and 100.

Returns

  • bool: value

Returns a boolean value true or false that tells you if it was successful or not.

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