GetElementVelocity

From Multi Theft Auto: Wiki
Revision as of 19:15, 19 August 2007 by Arc (talk | contribs)
Jump to navigation Jump to search

Description

This function returns three floats containing the velocity (movement speeds) along the X, Y, and Z axis respectively.

Syntax

float float float getElementVelocity ( element theElement )

Required Arguments

  • theElement: The element you wish to retrieve the velocity of.

Returns

If succesful, returns three floats that represent the element's current velocity along the x, y, and z axis respectively. This function can fail if the element is a player in a car. Use the vehicle element in this case. It will also fail if the element specified does not have a velocity, or does not exist. In case of failure, the first return value will be false.


Example

Click to collapse [-]
Server

This example retrieves, calculates, and displays the speed of a player named someguy. 

-- find a player named "someguy" and get his velocity.
speedx, speedy, speedz = getElementVelocity ( getPlayerFromNick ( "someguy" ) )
-- use pythagorean theorem to get actual velocity
-- raising something to the exponent of 0.5 is the same thing as taking a square root.
actualspeed = (speedx^2 + speedy^2 + speedz^2)^(0.5) 
-- report the results.
outputChatBox ( "Someguy's current velocity: " .. actualspeed .. " arbitrary units." )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementVelocity?oldid=10735"