GetElementVelocity: Difference between revisions

Revision as of 14:58, 22 August 2006

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

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. If this function does fail, the first return value will be set to false. Other than that though, this function will return three floats that represent the element's current velocity along the x, y, and z axis respectively.

Example

speedx, speedy, speedz = getElementVelocity ( findPlayer ( "someguy" ) )
actualspeed = (speedx^2 + speedy^2 + speedz^2)^(0.5) 
--Raising something to the exponent of 0.5 is the same thing as taking a square root.
outputChatBox ( "Someguy's current Velocity: ", actualspeed, " arbitrary units." )

@@ Line 1: / Line 1: @@
 __NOTOC__
 ==Description==
-This function returns three floats containing the velocity (movement speeds) 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. If this function does fail, the first argument will be set to 'false'
+This function returns three floats containing the velocity (movement speeds) along the X, Y, and Z axis respectively.
 ==Syntax==
@@ Line 8: / Line 8: @@
 ===Required Arguments===
 *'''theElement''': The [[element]] you wish to retrieve the velocity of.
+===Returns===
+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. If this function does fail, the first return value will be set to ''false''. Other than that though, this function will return three floats that represent the element's current velocity along the ''x'', ''y'', and ''z'' axis respectively.
 ==Example==
@@ Line 16: / Line 20: @@
 ==See Also==
-{{Player functions}}
+{{element functions}}