SetVehicleTurnVelocity: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
[[Category:Incomplete]] | [[Category:Incomplete]] | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
Sets the angular velocity of a vehicle. Basically applies a spin to it. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setVehicleTurnVelocity ( | bool setVehicleTurnVelocity ( vehicle theVehicle, float rx, float ry, float rz ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theVehicle:''' vehicle to apply the spin to | ||
*'''rx:''' velocity around the X axis | |||
*'''ry:''' velocity around the Y axis | |||
*'''rz:''' velocity around the Z axis | |||
*''' | |||
*''' | |||
===Returns=== | ===Returns=== | ||
Returns ''true'' if blah, ''false'' otherwise. | Returns ''true'' if blah, ''false'' otherwise. | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function onColShapeHit ( thePlayer, matchingDimension ) | ||
-- When a player hits the collision shape, check if he's in a vehicle | |||
local playerVehicle = getPlayerOccupiedVehicle ( thePlayer ) | |||
if playerVehicle ~= false then | |||
-- If so, give it a spin | |||
setVehicleTurnVelocity ( playerVehicle, 0, 0, 20 ) | |||
end | |||
end | |||
addEventHandler ( "onColShapeHit", getRootElement ( ), onColShapeHit ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{FunctionArea_Functions}} | {{FunctionArea_Functions}} | ||
Revision as of 19:15, 15 August 2007
|
This article needs checking. |
Reason(s): We need a min-max values allowed or a recommended min-max/relevant range? --Ransom 02:46, 11 April 2007 (CDT) |
Sets the angular velocity of a vehicle. Basically applies a spin to it.
Syntax
bool setVehicleTurnVelocity ( vehicle theVehicle, float rx, float ry, float rz )
Required Arguments
- theVehicle: vehicle to apply the spin to
- rx: velocity around the X axis
- ry: velocity around the Y axis
- rz: velocity around the Z axis
Returns
Returns true if blah, false otherwise.
Example
function onColShapeHit ( thePlayer, matchingDimension )
-- When a player hits the collision shape, check if he's in a vehicle
local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )
if playerVehicle ~= false then
-- If so, give it a spin
setVehicleTurnVelocity ( playerVehicle, 0, 0, 20 )
end
end
addEventHandler ( "onColShapeHit", getRootElement ( ), onColShapeHit )