π VehicleWheeled
Vehicles are wheeled entities which Characters can possesses and drive.
πAuthority
This class can only be spawned on π¦ Server side.
πͺInheritance
This class shares methods and events from Base Entity, Base Actor, Base Vehicle, Base Paintable, Base Damageable.
π§βπ»API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
Any Skeletal Mesh can be used to create a Vehicle, although only Skeletal Meshes with Wheels bones can use the built-in feature of animated Wheels.
π Examplesβ
Server/Index.lua
-- Spawns a Pickup Vehicle
local vehicle = VehicleWheeled(location or Vector(), rotation or Rotator(), "nanos-world::SK_Pickup", CollisionType.Normal, true, false, true, "nanos-world::A_Vehicle_Engine_10")
-- Configure it's Engine power and Aerodynamics
vehicle:SetEngineSetup(700, 5000)
vehicle:SetAerodynamicsSetup(2500)
-- Configure it's Steering Wheel and Headlights location
vehicle:SetSteeringWheelSetup(Vector(0, 27, 120), 24)
vehicle:SetHeadlightsSetup(Vector(270, 0, 70))
-- Configures each Wheel
vehicle:SetWheel(0, "Wheel_Front_Left", 27, 18, 45, Vector(), true, true, false, false, false, 1500, 3000, 1000, 1, 3, 20, 20, 250, 50, 10, 10, 0, 0.5, 0.5)
vehicle:SetWheel(1, "Wheel_Front_Right", 27, 18, 45, Vector(), true, true, false, false, false, 1500, 3000, 1000, 1, 3, 20, 20, 250, 50, 10, 10, 0, 0.5, 0.5)
vehicle:SetWheel(2, "Wheel_Rear_Left", 27, 18, 0, Vector(), false, true, true, false, false, 1500, 3000, 1000, 1, 4, 20, 20, 250, 50, 10, 10, 0, 0.5, 0.5)
vehicle:SetWheel(3, "Wheel_Rear_Right", 27, 18, 0, Vector(), false, true, true, false, false, 1500, 3000, 1000, 1, 4, 20, 20, 250, 50, 10, 10, 0, 0.5, 0.5)
-- Adds 6 Doors/Seats
vehicle:SetDoor(0, Vector( 50, -75, 105), Vector( 8, -32.5, 95), Rotator(0, 0, 10), 70, -150)
vehicle:SetDoor(1, Vector( 50, 75, 105), Vector( 25, 50, 90), Rotator(0, 0, 0), 70, 150)
vehicle:SetDoor(2, Vector( -90, -75, 130), Vector( -90, -115, 155), Rotator(0, 90, 20), 60, -150)
vehicle:SetDoor(3, Vector( -90, 75, 130), Vector( -90, 115, 155), Rotator(0, -90, 20), 60, 150)
vehicle:SetDoor(4, Vector(-195, -75, 130), Vector(-195, -115, 155), Rotator(0, 90, 20), 60, -150)
vehicle:SetDoor(5, Vector(-195, 75, 130), Vector(-195, 115, 155), Rotator(0, -90, 20), 60, 150)
-- Make it ready (so clients only create Physics once and not for each function call above)
vehicle:RecreatePhysics()
π Constructorsβ
Default Constructor
No description provided
local my_vehiclewheeled = VehicleWheeled(location, rotation, asset, collision_type?, gravity_enabled?, auto_create_physics?, auto_unflip?, engine_sound?, horn_sound?, brake_sound?, engine_start_sound?, vehicle_door_sound?, auto_start_engine?, custom_animation_blueprint?)
Type | Name | Default | Description |
---|---|---|---|
Vector | location | Required parameter | No description provided |
Rotator | rotation | Required parameter | No description provided |
SkeletalMesh Reference | asset | Required parameter | No description provided |
CollisionType | collision_type | CollisionType.Auto | No description provided |
boolean | gravity_enabled | true | No description provided |
boolean | auto_create_physics | true | Can be disabled to improve performance when setting several configs. Must call RecreatePhysics() after all |
boolean | auto_unflip | true | Auto rotates the vehicle if flipped |
Sound Reference | engine_sound | nanos-world::A_Vehicle_Engine_01 | No description provided |
Sound Reference | horn_sound | nanos-world::A_Vehicle_Horn_Toyota | No description provided |
Sound Reference | brake_sound | nanos-world::A_Vehicle_Brake | No description provided |
Sound Reference | engine_start_sound | nanos-world::A_Car_Engine_Start | No description provided |
Sound Reference | vehicle_door_sound | nanos-world::A_Vehicle_Door | No description provided |
boolean | auto_start_engine | true | No description provided |
Blueprint Reference | custom_animation_blueprint |
| No description provided |
tip
Please take a look at our Default's Vehicle package with all built-in Vehicles already properly configured and ready to use.
More related examples:
Monster Truckgetting-started/tutorials-and-examples/monster-truckπΏ Static Functionsβ
Inherited Entity Static Functions
This class doesn't have own static functions.
π¦ Functionsβ
Inherited Entity Functions
Inherited Actor Functions
Inherited Paintable Functions
Inherited Damageable Functions
Inherited Vehicle Functions
Returns | Name | Description | |
---|---|---|---|
integer | GetGear | Gets the current Gear | |
integer | GetRPM | Gets the current RPM | |
Horn | Starts or stops the vehicles horn | ||
RecreatePhysics | Recreate the Vehicle Physics | ||
SetAerodynamicsSetup | Configures the Vehicle Aerodynamics Settings | ||
SetAutoStartEngine | Sets if the Engine auto starts when the driver enters the Vehicle | ||
![]() | SetCameraOffset | Sets the Vehicle Camera Offset | |
SetEngineSetup | Configures the Vehicle Engine (Torque, RPM, Braking) | ||
SetEngineStarted | Sets if the Engine is turned off/on | ||
SetHeadlightsSetup | Configures the Headlights Offset and Color. | ||
SetSteeringSetup | Configures the Vehicle Steering | ||
SetSteeringWheelSetup | Configures where the Steering Wheel is located | ||
SetTaillightsSetup | Configures the Taillights Offset. | ||
SetTireFlat | Sets a Tire as Flat or not | ||
SetTransmissionSetup | Configures the Vehicle Transmission | ||
SetWheel | Configures a Vehicle Wheel |

GetGear
Gets the current Gear
β Returns integer.
local ret = my_vehiclewheeled:GetGear()

GetRPM
Gets the current RPM
β Returns integer.
local ret = my_vehiclewheeled:GetRPM()

Horn
Starts or stops the vehicles horn
my_vehiclewheeled:Horn(enable_horn)
Type | Parameter | Default | Description |
---|---|---|---|
boolean | enable_horn | Required parameter | No description provided |

RecreatePhysics
Call this after configuring the vehicle if passed auto_create_physics
to constructor
my_vehiclewheeled:RecreatePhysics()

SetAerodynamicsSetup
Configures the Vehicle Aerodynamics Settings
my_vehiclewheeled:SetAerodynamicsSetup(mass?, drag_coefficient?, vehicle_chassis_width?, vehicle_chassis_height?, vehicle_downforce_coefficient?, center_of_mass_override?)
Type | Parameter | Default | Description |
---|---|---|---|
integer | mass? | 1500 | Mass of the vehicle chassis |
float | drag_coefficient? | 0.3 | Force resisting forward motion at speed |
integer | vehicle_chassis_width? | 180 | Chassis width used for drag force computation (cm) |
integer | vehicle_chassis_height? | 140 | Chassis height used for drag force computation (cm) |
float | vehicle_downforce_coefficient? | 0.3 | Force pressing vehicle into ground at speed |
Vector | center_of_mass_override? | Vector(0, 0, 50) | Overrides the center of mass. Good for curves stabilization. Ideally the Z should be the same as the wheels radius |

SetAutoStartEngine
Sets if the Engine auto starts when the driver enters the Vehicle
my_vehiclewheeled:SetAutoStartEngine(auto_start)
Type | Parameter | Default | Description |
---|---|---|---|
boolean | auto_start | Required parameter | No description provided |

SetCameraOffset
Sets the Vehicle Camera Offset
my_vehiclewheeled:SetCameraOffset(offset)
Type | Parameter | Default | Description |
---|---|---|---|
Vector | offset | Required parameter | No description provided |

SetEngineSetup
Configures the Vehicle Engine (Torque, RPM, Braking)
my_vehiclewheeled:SetEngineSetup(max_torque?, max_rpm?, idle_rpm?, brake_effect?, rev_up_moi?, rev_down_rate?)
Type | Parameter | Default | Description |
---|---|---|---|
integer | max_torque? | 700 | Max Engine Torque (Nm) is multiplied by TorqueCurve |
integer | max_rpm? | 5700 | Maximum revolutions per minute of the engine |
integer | idle_rpm? | 1200 | Idle RMP of engine then in neutral/stationary |
float | brake_effect? | 0.05 | Braking effect from engine, when throttle released |
integer | rev_up_moi? | 5 | Affects how fast the engine RPM speed up |
integer | rev_down_rate? | 600 | Affects how fast the engine RPM slows down |

SetEngineStarted
Sets if the Engine is turned off/on (this will affect Lights, Sounds and ability to Throttle)
my_vehiclewheeled:SetEngineStarted(started)
Type | Parameter | Default | Description |
---|---|---|---|
boolean | started | Required parameter | No description provided |

SetHeadlightsSetup
Configures the Headlights Offset and Color.
my_vehiclewheeled:SetHeadlightsSetup(location, color?)
Type | Parameter | Default | Description |
---|---|---|---|
Vector | location | Required parameter | No description provided |
Color | color? | Color(1, 0.86, 0.5) | No description provided |

SetSteeringSetup
Configures the Vehicle Steering
my_vehiclewheeled:SetSteeringSetup(steering_type, angle_ratio?)
Type | Parameter | Default | Description |
---|---|---|---|
SteeringType | steering_type | Required parameter | No description provided |
float | angle_ratio? | 0.7 | Only applies when AngleRatio is selected |

SetSteeringWheelSetup
Configures where the Steering Wheel is located, so Characters can grab it procedurally properly
my_vehiclewheeled:SetSteeringWheelSetup(location, radius)
Type | Parameter | Default | Description |
---|---|---|---|
Vector | location | Required parameter | No description provided |
integer | radius | Required parameter | No description provided |

SetTaillightsSetup
Configures the Taillights Offset.
my_vehiclewheeled:SetTaillightsSetup(location)
Type | Parameter | Default | Description |
---|---|---|---|
Vector | location | Required parameter | No description provided |

SetTireFlat
Sets a Tire as Flat or not
my_vehiclewheeled:SetTireFlat(wheel_index, is_flat)
Type | Parameter | Default | Description |
---|---|---|---|
integer | wheel_index | Required parameter | No description provided |
boolean | is_flat | Required parameter | No description provided |

SetTransmissionSetup
Configures the Vehicle Transmission
my_vehiclewheeled:SetTransmissionSetup(transmission_final_ratio?, transmission_change_up_rpm?, transmission_change_down_rpm?, transmission_gear_change_time?, transmission_efficiency?)
Type | Parameter | Default | Description |
---|---|---|---|
float | transmission_final_ratio? | 3.08 | The final gear ratio multiplies the transmission gear ratios |
integer | transmission_change_up_rpm? | 4500 | Engine Revs at which gear up change occurs |
integer | transmission_change_down_rpm? | 2000 | Engine Revs at which gear down change occurs |
float | transmission_gear_change_time? | 0.4 | Time it takes to switch gears (seconds) |
float | transmission_efficiency? | 0.9 | Mechanical frictional losses mean transmission might operate at 0.94 (94% efficiency) |

SetWheel
Wheels can be updated in runtime by calling SetWheel again, you can for example change the suspension high or disable a wheel totally by toggling affected_by_engine off or setting radius to 0.
my_vehiclewheeled:SetWheel(index, bone_name, radius?, width?, max_steer_angle?, offset?, is_affected_by_engine?, is_affected_by_brake?, is_affected_by_handbrake?, has_abs_enabled?, has_traction_control_enabled?, max_brake_torque?, max_handbrake_torque?, cornering_stiffness?, side_slip_modifier?, friction_force_multiplier?, slip_threshold?, skid_threshold?, suspension_spring_rate?, suspension_spring_preload?, suspension_max_raise?, suspension_max_drop?, suspension_smoothing?, suspension_damping_ratio?, suspension_wheel_load_ratio?, suspension_axis?, suspension_force_offset?)
Type | Parameter | Default | Description |
---|---|---|---|
integer | index | Required parameter | Index of the wheel (0-N). Set it in ASC order |
string | bone_name | Required parameter | Name of the bone to attach this wheel to |
integer | radius? | 32 | Radius of the wheel |
integer | width? | 20 | Width of the wheel |
integer | max_steer_angle? | 50 | Steer angle in degrees for this wheel |
Vector | offset? | Vector(0, 0, 0) | If bone_name is specified, offset the wheel from the bone's location. Otherwise this offsets the wheel from the vehicle's origin |
boolean | is_affected_by_engine? | true | Whether engine should power this wheel |
boolean | is_affected_by_brake? | true | Whether brake should affect this wheel |
boolean | is_affected_by_handbrake? | true | Whether handbrake should affect this wheel |
boolean | has_abs_enabled? | false | Advanced Braking System Enabled |
boolean | has_traction_control_enabled? | false | Straight Line Traction Control Enabled |
integer | max_brake_torque? | 1500 | Max brake torque for this wheel (Nm) |
integer | max_handbrake_torque? | 3000 | Max handbrake brake torque for this wheel (Nm). A handbrake should have a stronger brake torque than the brake |
integer | cornering_stiffness? | 1000 | Tyre Cornering Ability |
float | side_slip_modifier? | 1.0 | Wheel Lateral Skid Grip Loss, lower number less grip on skid |
float | friction_force_multiplier? | 2.0 | Friction Force Multiplier |
float | slip_threshold? | 20.0 | Wheel Longitudinal Slip Threshold |
float | skid_threshold? | 20.0 | Wheel Lateral Skid Threshold |
float | suspension_spring_rate? | 250.0 | Spring Force (N/m) |
float | suspension_spring_preload? | 50.0 | Spring Preload (N/m) |
float | suspension_max_raise? | 10.0 | How far the wheel can go above the resting position |
float | suspension_max_drop? | 10.0 | How far the wheel can drop below the resting position |
float | suspension_smoothing? | 0.0 | Smooth suspension [0-off, 10-max] - Warning might cause momentary visual inter-penetration of the wheel against objects/terrain |
float | suspension_damping_ratio? | 0.5 | Suspension damping, larger value causes the suspension to come to rest faster [range 0 to 1] |
float | suspension_wheel_load_ratio? | 0.5 | Amount wheel load effects wheel friction. - At 0 wheel friction is completely independent of the loading on the wheel (This is artificial as it always assumes even balance between all wheels) - At 1 wheel friction is based on the force pressing wheel into the ground. This is more realistic. - Lower value cures lift off over-steer, generally makes vehicle easier to handle under extreme motions. |
Vector | suspension_axis? | Vector(0, 0, -1) | Local body direction in which where suspension forces are applied (typically along -Z-axis) |
Vector | suspension_force_offset? | Vector(0, 0, 0) | Vertical offset from where suspension forces are applied (along Z-axis) |
π Eventsβ
Inherited Entity Events
Inherited Actor Events
Inherited Damageable Events
Inherited Vehicle Events
Name | Description | |
---|---|---|
![]() | Horn | Triggered when Vehicle honks |

Horn
Triggered when Vehicle honks
VehicleWheeled.Subscribe("Horn", function(self, is_honking)
-- Horn was called
end)
Type | Argument | Description |
---|---|---|
VehicleWheeled | self | No description provided |
boolean | is_honking | No description provided |