SetWindVelocity - Revision history

AlexTMjugador at 09:58, 18 May 2014

2014-05-18T09:58:31Z

← Older revision		Revision as of 09:58, 18 May 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function changes the wind velocity.		This function changes the wind velocity. The wind shakes the vegetation and makes particles fly in a direction. The intensity and direction of the effect deppends of the wind velocity in each axis.

	==Syntax==		==Syntax==
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''velocityX''': The velocity of the wind along the x axis		*'''velocityX''': The velocity of the wind along the x axis.
	*'''velocityY''': The velocity of the wind along the y axis		*'''velocityY''': The velocity of the wind along the y axis.
	*'''velocityZ''': The velocity of the wind along the z axis		*'''velocityZ''': The velocity of the wind along the z axis.

	===Returns===		===Returns===
	Returns ''true'' if successful, ''false'' ~~otherwise~~.		Returns ''true'' if successful, ''false'' if bad arguments were passed.

	==Example==		==Example==

John at 20:58, 18 April 2012

2012-04-18T20:58:36Z

← Older revision		Revision as of 20:58, 18 April 2012
Line 17:		Line 17:

	==Example==		==Example==
			<section name="Client" class="client" show="true">
	This example shows how to make a simple /windVelocity command.		This example shows how to make a simple /windVelocity command.
	~~<section name="Client" class="client" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local function windVelocityCommand(_, x, y, z)		local function windVelocityCommand(_, x, y, z)

John: Cleaned up the grammar & example.

2012-04-18T20:58:07Z

Cleaned up the grammar & example.

← Older revision		Revision as of 20:58, 18 April 2012
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function changes the wind velocity ~~in San Andreas. This affects just the trees~~.		This function changes the wind velocity.

	==Syntax==		==Syntax==
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''velocityX''': The velocity on the x~~-coordinate~~		*'''velocityX''': The velocity of the wind along the x axis
	*'''velocityY''': The velocity on the y~~-coordinate~~		*'''velocityY''': The velocity of the wind along the y axis
	*'''velocityZ''': The velocity on the z~~-coordinate~~		*'''velocityZ''': The velocity of the wind along the z axis

	===Returns===		===Returns===
Line 17:		Line 17:

	==Example==		==Example==
	This example shows how to make a ~~set wind velocity~~ command.		This example shows how to make a simple /windVelocity command.
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~setVelocity~~(~~command~~, x, y, z)		local function windVelocityCommand(_, x, y, z)
	if x ~~and~~ y and ~~z then~~		-- Ensure all arguments are valid (default to 0 otherwise)
	setWindVelocity (x, y, z)		x = tonumber(x) or 0
	outputChatBox("~~You were~~ set ~~wind velocity~~ to x: "..x.." y: "..y.." z: "..z)		y = tonumber(y) or 0
	~~else~~		z = tonumber(z) or 0
	~~outputChatBox("Syntax is: /setvelocity [x] [y] [z]~~")
	~~end~~		-- Set the wind velocity, and inform the user of the change.
			setWindVelocity(x, y, z)
			outputChatBox("* Wind velocity set to ("..x..", "..y..", "..z..").", 0, 255, 0)
	end		end
	addCommandHandler("~~setvelocity~~", ~~setVelocity~~)		addCommandHandler("windVelocity", windVelocityCommand)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Lolern: /* Example */

2011-12-22T15:26:18Z

Example

← Older revision		Revision as of 15:26, 22 December 2011
Line 17:		Line 17:

	==Example==		==Example==
			This example shows how to make a set wind velocity command.
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	~~{{Example}}~~		<syntaxhighlight lang="lua">
			function setVelocity(command, x, y, z)
			if x and y and z then
			setWindVelocity (x, y, z)
			outputChatBox("You were set wind velocity to x: "..x.." y: "..y.." z: "..z)
			else
			outputChatBox("Syntax is: /setvelocity [x] [y] [z]")
			end
			end
			addCommandHandler("setvelocity", setVelocity)
			</syntaxhighlight>
	</section>		</section>

	==See Also==		==See Also==
	{{Client_world_functions}}		{{Client_world_functions}}

OpenIDUser32 at 07:52, 21 November 2011

2011-11-21T07:52:28Z

← Older revision		Revision as of 07:52, 21 November 2011
Line 18:		Line 18:
	==Example==		==Example==
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	~~<syntaxhighlight lang="lua">~~		{{Example}}
	~~--Needed~~
	~~</syntaxhighlight>~~
	</section>		</section>

	==See Also==		==See Also==
	{{Client_world_functions}}		{{Client_world_functions}}

Arran Fortuna at 18:56, 14 March 2011

2011-03-14T18:56:33Z

← Older revision		Revision as of 18:56, 14 March 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~Client~~ function}}		{{Server client function}}
	This function changes the wind velocity in San Andreas. This affects just the trees.		This function changes the wind velocity in San Andreas. This affects just the trees.

Einstein: Created page with "NOTOC {{Client function}} This function changes the wind velocity in San Andreas. This affects just the trees. ==Syntax== bool setWindVelocity ( float velocityX,..."

2010-11-20T08:22:15Z

Created page with "__NOTOC__ {{Client function}} This function changes the wind velocity in San Andreas. This affects just the trees. ==Syntax== <syntaxhighlight lang="lua"> bool setWindVelocity ( float velocityX,..."

New page

__NOTOC__
{{Client function}}
This function changes the wind velocity in San Andreas. This affects just the trees.

==Syntax==
<syntaxhighlight lang="lua">
bool setWindVelocity ( float velocityX, float velocityY, float velocityZ )
</syntaxhighlight>

===Required Arguments===
*'''velocityX''': The velocity on the x-coordinate
*'''velocityY''': The velocity on the y-coordinate
*'''velocityZ''': The velocity on the z-coordinate

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--Needed
</syntaxhighlight>
</section>

==See Also==
{{Client_world_functions}}