SetWaveHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (fix oop)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function}}
This function sets the wave height to the desired value, the default is 0.
This function sets the wave height to the desired value, the default is 0.


Line 6: Line 7:
bool setWaveHeight ( float height )
bool setWaveHeight ( float height )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Water]].setWaveHeight||getWaveHeight}}


===Required Arguments===  
===Required Arguments===  
*'''height:''' A float between 0 and 100.
*'''height:''' A float between 0 and 100.


===Returns===
==Returns==
Returns ''true'' if the function was successful, ''false'' otherwise.
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not.


==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">
function scriptWave ( player, command, height )
function scriptWave ( thePlayer, command, height )
  local oldHeight = getWaveHeight()
local oldHeight = getWaveHeight()
  height = tonumber ( height )
height = tonumber ( height )
  success = setWaveHeight ( height )
success = setWaveHeight ( height )
  if ( success ) then
if ( success ) then
    outputChatBox ( "The old wave height was: " .. oldHeight .. "; " .. getClientName ( player ) .. " set it to: " .. height )
outputChatBox ( "The old wave height was: " .. oldHeight .. "; " .. getPlayerName ( thePlayer ) .. " set it to: " .. height )
  else outputChatBox ( "Invalid number." )
else
  end
outputChatBox ( "Invalid number." )
end
end
end
addCommandHandler ( "setwave", scriptWave )
addCommandHandler ( "setwave", scriptWave )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{World functions}}
{{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"