GetVehicleAdjustableProperty: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Fixed wrong argument description)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
{{Client function}}
{{Client function}}
Use this to get the value of a vehicles adjustable property. This property relates to movable parts of a model, for example hydra jets or dump truck tray.
Use this to get the value of a vehicles adjustable property. This property relates to movable parts of a model, for example hydra jets or dump truck tray.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool/int getVehicleAdjustableProperty ( vehicle )</syntaxhighlight>
<syntaxhighlight lang="lua">int getVehicleAdjustableProperty ( vehicle theVehicle )</syntaxhighlight>
 
===Required Arguments===
*'''theVehicle:''' The vehicle you want to get the adjustable property of.


===Returns===
===Returns===
If successful, returns a value from 0 upwards representing adjustment. 0 is default position. Maximum varies per vehicle, for example hydra horizontal flight is 5000, while dump truck tray max tilt is 2500. Returns ''false'' in case of failure.
Returns a value from 0 upwards representing adjustment. 0 is default position. Maximum varies per vehicle, for example hydra horizontal flight is 5000, while dump truck tray max tilt is 2500. Or returns ''false'' if the vehicle passed to the function is invalid.
 
==Example==
This example creates a command, so if the local player wants to know how much they tilt/adjusted a vehicle adjustable property
<syntaxhighlight lang="lua">addCommandHandler("getAdjust",function()
      if isPedInVehicle(localPlayer) then
          local adjusted = getVehicleAdjustableProperty(getPedOccupiedVehicle(localPlayer))
          if adjusted then
                outputChatBox(adjusted)
          else
                outputChatBox("Sorry, but your vehicle doesn't have any adjustable properties!")
          end
      else
          outputChatBox("Sorry, but you have to be in a vehicle to use this command!")
      end
end)
</syntaxhighlight>


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

Latest revision as of 13:43, 10 May 2018

Use this to get the value of a vehicles adjustable property. This property relates to movable parts of a model, for example hydra jets or dump truck tray.

Syntax

int getVehicleAdjustableProperty ( vehicle theVehicle )

Required Arguments

  • theVehicle: The vehicle you want to get the adjustable property of.

Returns

Returns a value from 0 upwards representing adjustment. 0 is default position. Maximum varies per vehicle, for example hydra horizontal flight is 5000, while dump truck tray max tilt is 2500. Or returns false if the vehicle passed to the function is invalid.

Example

This example creates a command, so if the local player wants to know how much they tilt/adjusted a vehicle adjustable property 

addCommandHandler("getAdjust",function()
      if isPedInVehicle(localPlayer) then
           local adjusted = getVehicleAdjustableProperty(getPedOccupiedVehicle(localPlayer))
           if adjusted then
                outputChatBox(adjusted)
           else
                outputChatBox("Sorry, but your vehicle doesn't have any adjustable properties!")
           end
      else
           outputChatBox("Sorry, but you have to be in a vehicle to use this command!")
      end
end)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleAdjustableProperty?oldid=54901"