setWaveHeight

Client-side

Server-side

Shared

This page is incomplete! Help wanted!

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.

Syntax

 setWaveHeight ( )

Code Examples

server

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 )

setWaveHeight

Syntax

Code Examples

See Also

Water Functions

Reference