SetWindVelocity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Cleaned up the grammar & example.)
mNo edit summary
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)

Revision as of 20:58, 18 April 2012

This function changes the wind velocity.

Syntax

bool setWindVelocity ( float velocityX, float velocityY, float velocityZ )

Required Arguments

  • velocityX: The velocity of the wind along the x axis
  • velocityY: The velocity of the wind along the y axis
  • velocityZ: The velocity of the wind along the z axis

Returns

Returns true if successful, false otherwise.

Example

Click to collapse [-]
Client

This example shows how to make a simple /windVelocity command. 

local function windVelocityCommand(_, x, y, z)
	-- Ensure all arguments are valid (default to 0 otherwise)
	x = tonumber(x) or 0
	y = tonumber(y) or 0
	z = tonumber(z) or 0
	
	-- 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
addCommandHandler("windVelocity", windVelocityCommand)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetWindVelocity?oldid=29983"