Difference between revisions of "GetWaveHeight"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m
Line 29: Line 29:
  
 
==See Also==
 
==See Also==
{{World functions}}
+
{{Water functions}}

Revision as of 20:09, 1 March 2009

This function returns the current wave height.

Syntax

float getWaveHeight()

Returns

Returns the height as a float, false otherwise.

Example

Click to collapse [-]
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 .. "; " .. getClientName ( thePlayer ) .. " set it to: " .. height )
  else outputChatBox ( "Invalid number." )
  end
end
addCommandHandler ( "setwave", scriptWave )

See Also