Difference between revisions of "GetWaveHeight"

From Multi Theft Auto: Wiki
Jump to: navigation, search
 
m (fix oop)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
{{Server client function}}
 +
This function returns the current wave height.
 +
 
==Syntax==
 
==Syntax==
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
float getWaveHeight ( void )
+
float getWaveHeight()
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
{{OOP||[[Water]].getWaveHeight||setWaveHeight}}
 +
 +
===Returns===
 +
Returns the height as a [[float]], ''false'' otherwise.
 +
 +
==Example==
 +
<section name="Server" class="server" show="true">
 +
This example changes the wave height to the given amount.
 +
<syntaxhighlight lang="lua">
 +
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 )
 +
</syntaxhighlight>
 +
</section>
 +
 +
==See Also==
 +
{{Water functions}}

Latest revision as of 15:07, 7 August 2016

This function returns the current wave height.

Syntax

float getWaveHeight()

OOP Syntax Help! I don't understand this!

Method: Water.getWaveHeight(...)
Counterpart: setWaveHeight

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

See Also