SetWaveHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (fix oop)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
{{Server client function}}
This function sets the wave height to the desired value, the default is 0.
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setWaveHeight ( float height )
bool setWaveHeight ( float height )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Water]].setWaveHeight||getWaveHeight}}
===Required Arguments===
*'''height:''' A float between 0 and 100.
==Returns==
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not.
==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 sets the wave height to the desired value, the default is 0.

Syntax

bool setWaveHeight ( float height )


OOP Syntax Help! I don't understand this!

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


Required Arguments

  • height: A float between 0 and 100.

Returns

Returns a boolean value true or false that tells you if it was successful or not.

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


Retrieved from "https://wiki.multitheftauto.com/wiki/SetWaveHeight?oldid=48777"