SetVehicleWheelsRotation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
Allows the scripter to manipulate wheel rotation for vehicles. This function supports Automobiles, Bikes (Including BMX), and Trailers.
This function is used to manipulate the wheel rotation of a vehicle. Cars, Bikes (including BMX) and Trailers are supported.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setVehicleWheelsRotation ( vehicle vehicleElement, float rotation )
bool setVehicleWheelsRotation ( vehicle theVehicle, float rotation )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[vehicle]]:setVehicleWheelsRotation|vehicleWheelsRotation|getVehicleWheelsRotation}}


===Required Arguments===
===Required Arguments===
* '''vehicleElement:''' the vehicle (Automobile, Bike, or Trailer) whose wheel rotation is to be set.
* '''theVehicle:''' the vehicle whose wheel rotation is to be set.
* '''rotation:''' the new wheel rotation value.
* '''rotation:''' the new wheel rotation value.


Line 17: Line 16:


==Example==
==Example==
This example sets the wheel rotation of the vehicle the player is in, and also for any attached trailer.
This example sets the wheel rotation of the vehicle when the player gets into any vehicle and if there is any attached trailer.


<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
addEventHandler("onClientVehicleEnter", root,
     function()
     function()
         local theVeh = getPedOccupiedVehicle(localPlayer)
         local theVeh = getPedOccupiedVehicle(localPlayer)
Line 45: Line 44:
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
==Requirements==
{{Requirements|n/a|1.6.0.r22592|}}


==See Also==
==See Also==
{{Client vehicle functions}}
{{Client vehicle functions}}

Latest revision as of 08:42, 30 June 2024

This function is used to manipulate the wheel rotation of a vehicle. Cars, Bikes (including BMX) and Trailers are supported.

Syntax

bool setVehicleWheelsRotation ( vehicle theVehicle, float rotation )

Required Arguments

  • theVehicle: the vehicle whose wheel rotation is to be set.
  • rotation: the new wheel rotation value.

Returns

Returns true if successful, false otherwise.

Example

This example sets the wheel rotation of the vehicle when the player gets into any vehicle and if there is any attached trailer.

Click to collapse [-]
Client
addEventHandler("onClientVehicleEnter", root,
    function()
        local theVeh = getPedOccupiedVehicle(localPlayer)
        if setVehicleWheelsRotation(theVeh, 0) then 
            outputChatBox("SET OK")
        else
            outputChatBox("SET FAILED")
        end
    end
)

addEventHandler("onClientPreRender", root, function()
    local theVeh = getPedOccupiedVehicle(localPlayer)
    if theVeh then
        setVehicleWheelsRotation(theVeh, 0)
        -- also do it for trailer
        local trailer = getVehicleTowedByVehicle(theVeh)
        if trailer then
            setVehicleWheelsRotation(trailer, 0)
        end
    end
end)

Requirements

Minimum server version n/a
Minimum client version 1.6.0.r22592

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.6.0.r22592" />

See Also

Shared