SetVehicleWheelScale: Difference between revisions
Jump to navigation
Jump to search
m (Remove unneeded link tags from OOP syntax) |
(Define the default wheel scale for vehicles with wheel upgrades more precisely) |
||
Line 3: | Line 3: | ||
{{New feature/item|3.0158|1.5.7|20642|This function sets the scale of all the wheels of a [[vehicle]]. The wheel scale multiplies the visible height and length (but not width) of all the wheels in a vehicle, without affecting their collisions or the handling, similarly to [[setVehicleComponentScale]]. The wheel scale is applied after the [[setVehicleModelWheelSize|model wheel size]].}} | {{New feature/item|3.0158|1.5.7|20642|This function sets the scale of all the wheels of a [[vehicle]]. The wheel scale multiplies the visible height and length (but not width) of all the wheels in a vehicle, without affecting their collisions or the handling, similarly to [[setVehicleComponentScale]]. The wheel scale is applied after the [[setVehicleModelWheelSize|model wheel size]].}} | ||
{{Note|Installing or removing a wheel upgrade in a vehicle resets the wheel scale to the default value.}} | {{Note|Installing or removing a wheel upgrade in a vehicle resets the wheel scale to the default value.}} | ||
{{Tip|The default value for vehicles without wheel upgrades is 1, which renders the wheels in the model as usual. On the other hand, the default value for vehicles with a wheel upgrade | {{Tip|The default value for vehicles without wheel upgrades is 1, which renders the wheels in the model as usual. On the other hand, the default value for vehicles with a wheel upgrade is the [[setVehicleModelWheelSize|size of the wheels in the front axle]] of the vehicle model.}} | ||
==Syntax== | ==Syntax== |
Revision as of 11:58, 4 September 2020
This function sets the scale of all the wheels of a vehicle. The wheel scale multiplies the visible height and length (but not width) of all the wheels in a vehicle, without affecting their collisions or the handling, similarly to setVehicleComponentScale. The wheel scale is applied after the model wheel size.
Tip: The default value for vehicles without wheel upgrades is 1, which renders the wheels in the model as usual. On the other hand, the default value for vehicles with a wheel upgrade is the size of the wheels in the front axle of the vehicle model. |
Syntax
bool setVehicleWheelScale ( vehicle theVehicle, float wheelScale )
OOP Syntax Help! I don't understand this!
- Method: vehicle:setWheelScale(...)
- Variable: .wheelScale
- Counterpart: getVehicleWheelScale
Required Arguments
- theVehicle: The vehicle whose wheel scale you wish to modify.
- wheelScale: The wheel scale value to set.
Returns
Returns true if the wheel scale has been set successfully, or an error if some parameter is invalid.
Example
This example adds a shrinkwheels command that reduces the wheel scale of a vehicle in half each time it is invoked.
addCommandHandler("shrinkwheels", function() local veh = getPedOccupiedVehicle(localPlayer) if veh then local newScale = getVehicleWheelScale(veh) * 0.5 setVehicleWheelScale(veh, newScale) outputChatBox("Vehicle wheel scale set to " .. newScale .. ".", 0, 255, 0) else outputChatBox("You must be in a vehicle to use this command.", 255, 0, 0) end end)
See Also
- areVehicleLightsOn
- getHeliBladeCollisionsEnabled
- getHelicopterRotorSpeed
- getVehicleAdjustableProperty
- getVehicleComponentPosition
- getVehicleComponentRotation
- getVehicleComponents
- getVehicleComponentScale
- getVehicleComponentVisible
- getVehicleCurrentGear
- getVehicleDummyPosition
- getVehicleGravity
- getVehicleLandingGearDown
- getVehicleModelDummyDefaultPosition
- getVehicleModelDummyPosition
- getVehicleModelExhaustFumesPosition
- getVehicleModelWheelSize
- getVehicleNitroCount
- getVehicleNitroLevel
- getVehicleWheelFrictionState
- getVehicleWheelScale
- isTrainChainEngine
- isVehicleNitroActivated
- isVehicleNitroRecharging
- isVehicleOnGround
- isVehicleWheelOnGround
- isVehicleWindowOpen
- resetVehicleComponentPosition
- resetVehicleComponentRotation
- resetVehicleComponentScale
- resetVehicleDummyPositions
- setHeliBladeCollisionsEnabled
- setHelicopterRotorSpeed
- setVehicleAdjustableProperty
- setVehicleComponentPosition
- setVehicleComponentRotation
- setVehicleComponentScale
- setVehicleComponentVisible
- setVehicleDummyPosition
- setVehicleGravity
- setVehicleLandingGearDown
- setVehicleModelDummyPosition
- setVehicleModelExhaustFumesPosition
- setVehicleModelWheelSize
- setVehicleNitroActivated
- setVehicleNitroCount
- setVehicleNitroLevel
- setVehicleWheelScale
- setVehicleWheelStates
- setVehicleWindowOpen
- Shared
- addVehicleUpgrade
- attachTrailerToVehicle
- blowVehicle
- createVehicle
- detachTrailerFromVehicle
- fixVehicle
- getOriginalHandling
- getTrainDirection
- getTrainPosition
- getTrainSpeed
- getTrainTrack
- getVehicleColor
- getVehicleCompatibleUpgrades
- getVehicleController
- getVehicleDoorOpenRatio
- getVehicleDoorState
- getVehicleEngineState
- getVehicleHandling
- getVehicleHeadLightColor
- getVehicleLandingGearDown
- getVehicleLightState
- getVehicleMaxPassengers
- getVehicleModelFromName
- getVehicleName
- getVehicleNameFromModel
- getVehicleOccupant
- getVehicleOccupants
- getVehicleOverrideLights
- getVehiclePaintjob
- getVehiclePanelState
- getVehiclePlateText
- getVehicleSirenParams
- getVehicleSirens
- getVehicleSirensOn
- getVehicleTowedByVehicle
- getVehicleTowingVehicle
- getVehicleTurretPosition
- getVehicleType
- getVehicleUpgradeOnSlot
- getVehicleUpgradeSlotName
- getVehicleUpgrades
- getVehicleVariant
- getVehicleWheelStates
- isTrainDerailable
- isTrainDerailed
- isVehicleBlown
- isVehicleDamageProof
- isVehicleFuelTankExplodable
- isVehicleLocked
- isVehicleOnGround
- isVehicleTaxiLightOn
- removeVehicleUpgrade
- setTrainDerailable
- setTrainDerailed
- setTrainDirection
- setTrainPosition
- setTrainSpeed
- setTrainTrack
- setVehicleColor
- setVehicleDamageProof
- setVehicleDoorOpenRatio
- setVehicleDoorState
- setVehicleDoorsUndamageable
- setVehicleEngineState
- setVehicleFuelTankExplodable
- setVehicleHandling
- setVehicleHeadLightColor
- setVehicleLandingGearDown
- setVehicleLightState
- setVehicleLocked
- setVehicleOverrideLights
- setVehiclePaintjob
- setVehiclePanelState
- setVehiclePlateText
- setVehicleSirens
- setVehicleSirensOn
- setVehicleTaxiLightOn
- setVehicleTurretPosition
- setVehicleVariant
- setVehicleWheelStates