GetWaveHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
Line 1: Line 1:
__NOTOC__
This function returns the current wave height.
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float getWaveHeight ( void )
float getWaveHeight ( void )
</syntaxhighlight>
</syntaxhighlight>
===Returns===
Returns the height as a [[float]], ''false'' otherwise.
==Example==
This example changes the wave height to the given amount.
<syntaxhighlight lang="lua">
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 )
</syntaxhighlight>
==See Also==
{{World functions}}

Revision as of 09:48, 31 July 2007

This function returns the current wave height.

Syntax

float getWaveHeight ( void )

Returns

Returns the height as a float, false otherwise.

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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetWaveHeight?oldid=9473"