GetElementVelocity: Difference between revisions

Revision as of 19:15, 19 August 2007

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." )

@@ Line 1: / Line 1: @@
+{{Server client function}}
 __NOTOC__
 ==Description==
@@ Line 10: / Line 11: @@
 ===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.
+If succesful, returns three ''float''s 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==
-This example retreives, calculates, and displays the speed of a player named ''someguy''.
+<section name="Server" class="server" show="true">
+This example retrieves, calculates, and displays the speed of a player named ''someguy''.
 <syntaxhighlight lang="lua">
---find a player named "someguy" and get his velocity.
+-- find a player named "someguy" and get his velocity.
-speedx, speedy, speedz = getElementVelocity ( findPlayer ( "someguy" ) )
+speedx, speedy, speedz = getElementVelocity ( getPlayerFromNick ( "someguy" ) )
---use pythagorean theorem to get actual velocity
+-- use pythagorean theorem to get actual velocity
---Raising something to the exponent of 0.5 is the same thing as taking a square root.
+-- 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.
+-- report the results.
-outputChatBox ( "Someguy's current Velocity: " .. actualspeed .. " arbitrary units." )
+outputChatBox ( "Someguy's current velocity: " .. actualspeed .. " arbitrary units." )
 </syntaxhighlight>
+</section>
 ==See Also==
 {{element functions}}