GetWaveHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added oop syntax)
m (fix oop)
 
Line 8: Line 8:
</syntaxhighlight>
</syntaxhighlight>


{{OOP||[[water]]:getWaveHeight|waveHeight|setWaveHeight}}
{{OOP||[[Water]].getWaveHeight||setWaveHeight}}


===Returns===
===Returns===

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