SetWaveHeight - Revision history

Qaisjp: fix oop

2016-08-07T15:07:18Z

fix oop

← Older revision		Revision as of 15:07, 7 August 2016
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

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

	===Required Arguments===		===Required Arguments===

2016-08-06T17:51:16Z

Added oop syntax

← Older revision		Revision as of 17:51, 6 August 2016
Line 7:		Line 7:
	bool setWaveHeight ( float height )		bool setWaveHeight ( float height )
	</syntaxhighlight>		</syntaxhighlight>

			{{OOP\|\|[[water]]:setWaveHeight\|waveHeight\|getWaveHeight}}

	===Required Arguments===		===Required Arguments===

2009-08-27T12:28:55Z

Example

← Older revision		Revision as of 12:28, 27 August 2009
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function scriptWave ( thePlayer, 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~~ ( thePlayer ) .. " 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 )

2009-03-01T20:09:27Z

2007-08-04T16:05:56Z

← Older revision		Revision as of 16:05, 4 August 2007
Line 23:		Line 23:
	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 .. "; " .. getClientName ( thePlayer ) .. " set it to: " .. height )
	else outputChatBox ( "Invalid number." )		else outputChatBox ( "Invalid number." )
	end		end

2007-08-04T16:04:43Z

← Older revision		Revision as of 16:04, 4 August 2007
Line 18:		Line 18:
	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 )

2007-08-04T16:03:34Z

← Older revision		Revision as of 16:03, 4 August 2007
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 14:		Line 15:

	==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">
Line 27:		Line 29:
	addCommandHandler ( "setwave", scriptWave )		addCommandHandler ( "setwave", scriptWave )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{World functions}}		{{World functions}}

2007-08-01T15:53:10Z

Returns

← Older revision		Revision as of 15:53, 1 August 2007
Line 10:		Line 10:
	*'''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==

2007-07-31T09:48:20Z

Syntax

@@ Line 1: / Line 1: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
 bool setWaveHeight ( float height )
 </syntaxhighlight>

2007-06-09T00:01:27Z

New page

==Syntax==
<syntaxhighlight lang="lua">
bool setWaveHeight ( float height )
</syntaxhighlight>