SetVehicleTurnVelocity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Deprecated method in favor of setElementAngularVelocity)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Needs_Checking|We need a min-max values allowed or a recommended min-max/relevant range?
--[[User:Ransom|Ransom]] 02:46, 11 April 2007 (CDT)}}
[[Category:Incomplete]]
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{Deprecated|setElementAngularVelocity|}}
Sets the angular velocity of a vehicle. Basically applies a spin to it.
Sets the angular velocity of a vehicle. Basically applies a spin to it.
{{Deprecated feature|3.0156|1.5.6|This function will be deprecated in '''1.5.6''', use [[setElementAngularVelocity]] in the future.}}


==Syntax==  
==Syntax==  
Line 12: Line 10:
bool setVehicleTurnVelocity ( vehicle theVehicle, float rx, float ry, float rz )           
bool setVehicleTurnVelocity ( vehicle theVehicle, float rx, float ry, float rz )           
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:setTurnVelocity|turnVelocity|getVehicleTurnVelocity}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' vehicle to apply the spin to
*'''theVehicle:''' The [[vehicle]] to apply the spin to.
*'''rx:''' velocity around the X axis
*'''rx:''' velocity around the X axis
*'''ry:''' velocity around the Y axis
*'''ry:''' velocity around the Y axis
Line 20: Line 18:


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns ''true'' if it was succesful, ''false'' otherwise.


==Example==
==Example==
Line 26: Line 24:
function onColShapeHit ( thePlayer, matchingDimension )
function onColShapeHit ( thePlayer, matchingDimension )
     -- When a player hits the collision shape, check if he's in a vehicle
     -- When a player hits the collision shape, check if he's in a vehicle
     local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )
     local playerVehicle = getPedOccupiedVehicle ( thePlayer )
     if playerVehicle ~= false then
     if playerVehicle ~= false then
         -- If so, give it a spin
         -- If so, give it a spin
Line 36: Line 34:


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Vehicle functions}}

Latest revision as of 15:58, 8 November 2018

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use setElementAngularVelocity instead.

Sets the angular velocity of a vehicle. Basically applies a spin to it.

Syntax

bool setVehicleTurnVelocity ( vehicle theVehicle, float rx, float ry, float rz )

OOP Syntax Help! I don't understand this!

Method: vehicle:setTurnVelocity(...)
Variable: .turnVelocity
Counterpart: getVehicleTurnVelocity


Required Arguments

  • theVehicle: The 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 it was succesful, false otherwise.

Example

function onColShapeHit ( thePlayer, matchingDimension )
    -- When a player hits the collision shape, check if he's in a vehicle
    local playerVehicle = getPedOccupiedVehicle ( thePlayer )
    if playerVehicle ~= false then
        -- If so, give it a spin
        setVehicleTurnVelocity ( playerVehicle, 0, 0, 20 )
    end
end
addEventHandler ( "onColShapeHit", getRootElement ( ), onColShapeHit )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleTurnVelocity?oldid=60560"