GetWaveHeight

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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