GetElementVelocity: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Clarification of units used) |
||
| Line 11: | Line 11: | ||
===Returns=== | ===Returns=== | ||
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''. | 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''. | ||
The returned values are expressed in GTA units per 1/50th of a second[http://forum.mtasa.com/viewtopic.php?f=91&t=31225]. A GTA Unit is equal to one metre[http://gta.wikia.com/Unit#GTA3.2C_GTAVC_.26_GTASA]. | |||
==Example== | ==Example== | ||
| Line 18: | Line 20: | ||
-- find a player named "someguy" and get his velocity. | -- find a player named "someguy" and get his velocity. | ||
speedx, speedy, speedz = getElementVelocity ( getPlayerFromNick ( "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) | actualspeed = (speedx^2 + speedy^2 + speedz^2)^(0.5) | ||
-- multiply by 50 to obtain the speed in metres per second | |||
mps = actualspeed * 50 | |||
-- other useful conversions | |||
-- kilometres per hour | |||
kmh = actualspeed * 180 | |||
-- miles per hour | |||
mph = actualspeed * 111.847 | |||
-- report the results. | -- report the results. | ||
outputChatBox ( "Someguy's current velocity: " .. | outputChatBox ( "Someguy's current velocity: " .. mps .. " metres per second." ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
Revision as of 14:47, 13 January 2011
This function returns three floats containing the velocity (movement speeds) along the X, Y, and Z axis respectively. This means that velocity values can be positive and negative for each axis.
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.
The returned values are expressed in GTA units per 1/50th of a second[1]. A GTA Unit is equal to one metre[2].
Example
Click to collapse [-]
ServerThis 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) -- multiply by 50 to obtain the speed in metres per second mps = actualspeed * 50 -- other useful conversions -- kilometres per hour kmh = actualspeed * 180 -- miles per hour mph = actualspeed * 111.847 -- report the results. outputChatBox ( "Someguy's current velocity: " .. mps .. " metres per second." )
See Also
- addElementDataSubscriber
- attachElements
- clearElementVisibleTo
- cloneElement
- createElement
- destroyElement
- detachElements
- getAllElementData
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementCollisionsEnabled
- getElementByID
- getElementByIndex
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementColShape
- getElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementSyncer
- getElementType
- getElementVelocity
- getElementZoneName
- getElementsByType
- getElementsWithinColShape
- getElementsWithinRange
- getLowLODElement
- getRootElement
- hasElementData
- hasElementDataSubscriber
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementVisibleTo
- isElementWithinColShape
- isElementWithinMarker
- removeElementData
- removeElementDataSubscriber
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementSyncer
- setElementVelocity
- setElementVisibleTo
- setLowLODElement