GetWaveHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function}}
This function returns the current wave height.
This function returns the current wave height.


Line 11: Line 12:


==Example==  
==Example==  
<section name="Server" class="server" show="true">
This example changes the wave height to the given amount.
This example changes the wave height to the given amount.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 24: Line 26:
addCommandHandler ( "setwave", scriptWave )
addCommandHandler ( "setwave", scriptWave )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{World functions}}
{{World functions}}

Revision as of 14:58, 4 August 2007

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 ( 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=9763"