🚙 VehicleWheeled
Les véhicules sont des entités à roues que les Personnages peuvent contrôler et conduire.
👪Inheritance
This class shares methods and events from Base Entity, Base Actor, Base Paintable, Base Damageable, Base Vehicle.
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_unflip?, engine_sound?, horn_sound?, brake_sound?, engine_start_sound?, vehicle_door_sound?, auto_start_engine?, custom_animation_blueprint?, spawn_mode?)
Parameters
| 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_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 |
| SpawnMode | spawn_mode | SpawnMode.Immediate | Pass SpawnMode.AfterConstructor or SpawnMode.Manual to avoid immediately sending the entity to clients and improve performance when you want to configure it by setting several configs. Must call FinishSpawn() after all |
tip
Please take a look at our Default's Vehicle package with all built-in Vehicles already properly configured and ready to use.
Plus d'exemples comme celui-ci:
Monster Truckgetting-started/tutorials-and-examples/monster-truck🗿 Static Functions
Inherited Entity Static Functions
VehicleWheeled inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity
Base Entityscripting-reference/classes/base-classes/entity
| Returns | Name | Description | |
|---|---|---|---|
 | table of Base Entity | GetAll | Returns a table containing all Entities of the class this is called on |
| Base Entity | GetByIndex | Returns a specific Entity of this class at an index |
| integer | GetCount | Returns how many Entities of this class exist |
| table of table | GetInheritedClasses | Gets a list of all directly inherited classes from this Class created with the Inheriting System |
| iterator | GetPairs | Returns an iterator with all Entities of this class to be used with pairs() |
| table or nil | GetParentClass | Gets the parent class if this Class was created with the Inheriting System |
| table | Inherit | Inherits this class with the Inheriting System |
| boolean | IsChildOf | Gets if this Class is child of another class if this Class was created with the Inheriting System |
| function | Subscribe | Subscribes to an Event for all entities of this Class |
| function | SubscribeRemote | Subscribes to a custom event called from server |
| Unsubscribe | Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed |
This class doesn't have own static functions.
🦠 Functions
Inherited Entity Functions
VehicleWheeled inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity
Base Entityscripting-reference/classes/base-classes/entity
| Returns | Name | Description | |
|---|---|---|---|
 | BroadcastRemoteEvent | Calls a custom remote event directly on this entity to all Players | |
| BroadcastRemoteInRadiusEvent | Appelle un événement distant personnalisé directement sur cette entité pour tous les Joueurs dans un rayon donné | |
| CallRemoteEvent | Calls a custom remote event directly on this entity to a specific Player | |
 | CallRemoteEvent | Calls a custom remote event directly on this entity | |
| CallRemotePlayersEvent | Appelle un événement distant personnalisé directement sur cette entité pour une liste de Joueurs | |
 | Destroy | Destroys this Entity | |
| FinishSpawn | Finish the spawning process and send the entity to clients if it was spawned with a deferred spawn_mode | |
| table of string | GetAllValuesKeys | Gets a list of all values keys |
| table | GetClass | Gets the class of this entity |
| integer | GetID | Gets the universal network ID of this Entity (same on both client and server) |
| any | GetValue | Gets a Value stored on this Entity at the given key |
| boolean | HasAuthority | Gets if the local context has authority over this Entity (true if spawned by the client, false if spawned by the server) |
| boolean | IsA | Recursively checks if this entity is inherited from a Class |
| boolean | IsBeingDestroyed | Returns true if this Entity is being destroyed |
| boolean | IsSpawned | Gets if this Entity finished spawning |
| boolean | IsValid | Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity) |
| SetSpawnMode | Overrides when this Entity finishes spawning, from the Constructor of an Inherited Class | |
| SetValue | Sets a Value in this Entity | |
| function | Subscribe | Subscribes to an Event on this specific entity |
| function | SubscribeRemote | Subscribes to a custom event called from server on this specific entity |
| Unsubscribe | Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed |
Inherited Actor Functions
VehicleWheeled inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/actor
Base Actorscripting-reference/classes/base-classes/actor
| Returns | Name | Description | |
|---|---|---|---|
| AddActorTag | Adds an Unreal Actor Tag to this Actor | |
 | AddAngularImpulse | Add an angular impulse to this Actor. Good for one time instant burst | |
| AddImpulse | Add an impulse to this Actor. Good for one time instant burst | |
| boolean | AttachTo | Attaches this Actor to any other Actor, optionally at a specific bone |
| Detach | Detaches this Actor from AttachedTo Actor | |
| table of string | GetActorTags | Gets all Unreal Actor Tags on this Actor |
| Vector | GetAngularForce | Gets this Actor's angular force (set by SetAngularForce()) |
| float | GetAngularVelocity | Renvoie la vitesse angulaire de cet Acteur |
| table of Base Actor | GetAttachedEntities | Gets all Actors attached to this Actor |
| Base Actor or nil | GetAttachedTo | Gets the Actor this Actor is attached to |
| table | GetBounds | Gets this Actor's bounds |
| CollisionType | GetCollision | Gets this Actor's collision type |
| integer | GetDimension | Gets this Actor's dimension |
| float | GetDistanceFromCamera | Gets the distance of this Actor from the Camera |
| Vector | GetForce | Gets this Actor's force (set by SetForce()) |
| Vector | GetLocation | Gets this Actor's location in the game world |
| float | GetMass | Renvoie la masse de cet Acteur |
| Player or nil | GetNetworkAuthority | Gets this Actor's Network Authority Player |
| Vector | GetRelativeLocation | Gets this Actor's Relative Location if it's attached |
| Rotator | GetRelativeRotation | Gets this Actor's Relative Rotation if it's attached |
| Rotator | GetRotation | Gets this Actor's angle in the game world |
| Vector | GetScale | Gets this Actor's scale |
| float | GetScreenPercentage | Gets the percentage of this Actor size in the screen |
| table | GetSocketTransform | Gets a Socket Transform in world space given a bone or socket name |
| Vector | GetVelocity | Gets this Actor's current velocity |
| boolean | HasNetworkAuthority | Returns true if the local Player is currently the Network Authority of this Actor |
| boolean | IsGravityEnabled | Returns true if gravity is enabled on this Actor |
| boolean | IsInWater | Returns true if this Actor is in water |
| boolean | IsNetworkDistributed | Returns true if this Actor is currently network distributed |
| boolean | IsVisible | Returns true if this Actor is visible |
| RemoveActorTag | Removes an Unreal Actor Tag from this Actor | |
| RotateTo | Smoothly rotates this actor to an angle over a certain time | |
| SetAngularForce | Adds a permanent angular force to this Actor, set to Vector(0, 0, 0) to cancel | |
| SetCastShadow | Sets this Actor's to cast shadows or not | |
| SetCollision | Sets this Actor's collision type | |
| SetDimension | Sets this Actor's Dimension | |
| SetDistanceOptimizationMultiplier | Définit le multiplicateur d'optimisation de distance de cet Acteur | |
| SetForce | Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel | |
| SetGravityEnabled | Sets whether gravity is enabled on this Actor | |
| SetHighlightEnabled | Sets whether the highlight is enabled on this Actor, and which highlight index to use | |
| SetLifeSpan | Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed. | |
| SetLocation | Sets this Actor's location in the game world | |
| SetNetworkAuthority | Sets the Player to have network authority over this Actor | |
| SetNetworkAuthorityAutoDistributed | Sets if this Actor will auto distribute the network authority between players | |
| SetOutlineEnabled | Sets whether the outline is enabled on this Actor, and which outline index to use | |
| SetRelativeLocation | Sets this Actor's relative location in local space (only if this actor is attached) | |
| SetRelativeRotation | Sets this Actor's relative rotation in local space (only if this actor is attached) | |
| SetRenderCullDistance | Sets this Actor's render cull distance | |
| SetRotation | Sets this Actor's rotation in the game world | |
| SetScale | Sets this Actor's scale | |
| SetVisibility | Sets whether the actor is visible or not | |
| TranslateTo | Smoothly moves this actor to a location over a certain time | |
| boolean | WasRecentlyRendered | Gets if this Actor was recently rendered on screen |
Inherited Paintable Functions
VehicleWheeled inherits from Base Paintable Class, sharing it's methods and functions:
Base Paintablescripting-reference/classes/base-classes/paintable
Base Paintablescripting-reference/classes/base-classes/paintable
| Returns | Name | Description | |
|---|---|---|---|
| Color | GetMaterialColorParameter | Gets a Color parameter from this Actor's material |
| float | GetMaterialScalarParameter | Gets a Scalar parameter from this Actor's material |
| string | GetMaterialTextureParameter | Gets a Texture parameter from this Actor's material |
| Vector | GetMaterialVectorParameter | Gets a Vector parameter from this Actor's material |
| ResetMaterial | Resets the material from the specified index to the original one | |
| SetMaterial | Sets the material at the specified index of this Actor | |
| SetMaterialColorParameter | Sets a Color parameter in this Actor's material | |
| SetMaterialFromCanvas | Sets the material at the specified index of this Actor to a Canvas object | |
| SetMaterialFromSceneCapture | Sets the material at the specified index of this Actor to a SceneCapture object | |
| SetMaterialFromWebUI | Sets the material at the specified index of this Actor to a WebUI object | |
| SetMaterialScalarParameter | Sets a Scalar parameter in this Actor's material | |
| SetMaterialTextureParameter | Sets a texture parameter in this Actor's material to an image | |
| SetMaterialVectorParameter | Sets a Vector parameter in this Actor's material | |
| SetPhysicalMaterial | Overrides this Actor's Physical Material with a new one |
Inherited Damageable Functions
VehicleWheeled inherits from Base Damageable Class, sharing it's methods and functions:
Base Damageablescripting-reference/classes/base-classes/damageable
Base Damageablescripting-reference/classes/base-classes/damageable
| Returns | Name | Description | |
|---|---|---|---|
| integer | ApplyDamage | Infliger des dégâts à cette entité |
| float | GetDamageMultiplier | Obtient le multiplicateur de dégâts d'un os |
| integer | GetHealth | Obtient la santé actuelle |
| integer | GetMaxHealth | Obtient la santé maximale |
| boolean | IsDead | Retourne si l'entité est morte |
| Respawn | Fait réapparaître l'entité, restaure entièrement sa santé et la déplace vers son emplacement initial | |
| SetDamageMultiplier | Modifie la quantité de dégâts que cette entité subit sur des os spécifiques | |
| SetHealth | Définit la Santé de cette Entité | |
| SetMaxHealth | Définit la Santé maximale de cette Entité |
Inherited Vehicle Functions
VehicleWheeled inherits from Base Vehicle Class, sharing it's methods and functions:
Base Vehiclescripting-reference/classes/base-classes/vehicle
Base Vehiclescripting-reference/classes/base-classes/vehicle
| Returns | Name | Description | |
|---|---|---|---|
| AddSkeletalMeshAttached | Attaches a Skeletal Mesh as master pose to this entity | |
| AddStaticMeshAttached | Attaches a Static Mesh to this entity | |
| function | BindAnimationBlueprintEventDispatcher | Assigns and Binds an Animation Blueprint Event Dispatcher |
| varargs of any | CallAnimationBlueprintEvent | Calls an Animation Blueprint Event or Function |
| table of string | GetAllSkeletalMeshAttached | Gets all Skeletal Meshes attached to this entity |
| table of string | GetAllStaticMeshAttached | Gets all Static Meshes attached to this entity |
| any | GetAnimationBlueprintPropertyValue | Gets an Animation Blueprint Property/Variable value directly |
| table | GetDoors | Gets all configured Doors |
| SkeletalMesh Reference | GetMesh | Gets the Asset name |
| Character | GetPassenger | Gets a passenger from a seat |
| table of Character | GetPassengers | Gets all passengers |
| boolean | IsEngineStarted | Checks if the engine is started |
| PlayAnimation | Plays an Animation on this Vehicle | |
| RemoveAllSkeletalMeshesAttached | Removes all SkeletalMeshes attached | |
| RemoveAllStaticMeshesAttached | Removes all StaticMeshes attached | |
| RemoveSkeletalMeshAttached | Removes, if it exists, a SkeletalMesh from this Vehicle given its custom ID | |
| RemoveStaticMeshAttached | Removes, if it exists, a StaticMesh from this Vehicle given its custom ID | |
| SetAnimationBlueprintPropertyValue | Sets an Animation Blueprint Property/Variable value directly | |
| SetBuoyancyPontoons | Sets the Buoyancy Pontoons used by the Water simulation | |
| SetBuoyancySettings | Sets how this entity behaves on Water | |
| SetCameraArmLength | Sets how far the camera stays from this Vehicle while driving it | |
| SetCameraOffset | Sets the Vehicle Camera Offset | |
| SetDoor | Adds a Door to the Vehicle | |
| SetExplosionSettings | Configures the Explosion Settings when health reaches zero | |
| SetStaticMeshAttachedTransform | Sets a Static Mesh Attached location and rotation | |
| StopAnimation | Stops an Animation Montage on this Vehicle | |
| UnbindAnimationBlueprintEventDispatcher | Unbinds an Animation Blueprint Event Dispatcher |
| Returns | Name | Description | |
|---|---|---|---|
| integer | GetGear | Gets the current Gear |
| integer | GetRPM | Gets the current RPM |
| Horn | Starts or stops the vehicles horn | |
| boolean | IsInAir | Checks if the vehicle is in the air (no wheels touching the ground) |
| SetAerodynamicsSetup | Configures the Vehicle Aerodynamics Settings | |
| SetAutoStartEngine | Sets if the Engine auto starts when the driver enters the Vehicle | |
| SetDifferentialSetup | Configures the type of Differential | |
| SetEngineSetup | Configures the Vehicle Engine (Torque, RPM, Braking) | |
| SetEngineStarted | Sets if the Engine is turned off/on | |
| SetHeadlightsEnabled | Enables or disables the headlights | |
| SetHeadlightsSetup | Configures the Headlights Offset and Color. | |
| SetHornSound | Sets the sound asset used by the vehicle horn | |
| SetSteeringSetup | Configures the Vehicle Steering | |
| SetSteeringWheelSetup | Configures where the Steering Wheel is located | |
| SetTaillightsEnabled | Enables or disables the taillights | |
| SetTaillightsSetup | Configures the Taillights Offset. | |
| SetTireFlat | Sets a Tire as Flat or not | |
| SetTransmissionSetup | Configures the Vehicle Transmission | |
| SetWheel | Configures a Vehicle Wheel |
OptimalGetGear
Gets the current Gear
local gear = my_vehiclewheeled:GetGear()
Returns
| Type | Description |
|---|---|
| integer | gear |
OptimalGetRPM
Gets the current RPM
local rpm = my_vehiclewheeled:GetRPM()
Returns
| Type | Description |
|---|---|
| integer | rpm |
ModerateHorn
Starts or stops the vehicles horn
my_vehiclewheeled:Horn(enable_horn)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| boolean | enable_horn | Required parameter | No description provided |
OptimalIsInAir
Checks if the vehicle is in the air (no wheels touching the ground)
local is_in_air = my_vehiclewheeled:IsInAir()
Returns
| Type | Description |
|---|---|
| boolean | is_in_air |
ModerateSetAerodynamicsSetup
Configures the Vehicle Aerodynamics Settings
my_vehiclewheeled:SetAerodynamicsSetup(mass?, drag_coefficient?, vehicle_chassis_width?, vehicle_chassis_height?, vehicle_downforce_coefficient?, center_of_mass_override?)
Parameters
| 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 |
OptimalSetAutoStartEngine
Sets if the Engine auto starts when the driver enters the Vehicle
my_vehiclewheeled:SetAutoStartEngine(auto_start)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| boolean | auto_start | Required parameter | No description provided |
ModerateSetDifferentialSetup
Configures the type of Differential
my_vehiclewheeled:SetDifferentialSetup(differential_type, front_rear_split?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| DifferentialType | differential_type | Required parameter | Type of Differential |
| float | front_rear_split? | 0.5 | Ratio of torque split between front and rear (less than 0.5 means more to front, bigger than 0.5 means more to rear, works only with 4W type) |
ModerateSetEngineSetup
Configures the Vehicle Engine (Torque, RPM, Braking)
my_vehiclewheeled:SetEngineSetup(max_torque?, max_rpm?, idle_rpm?, brake_effect?, rev_up_moi?, rev_down_rate?, torque_curve?)
Parameters
| 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 |
| table | torque_curve? | { 0: 0.0, max_rpm * 0.2: 0.9, max_rpm * 0.4: 1.0, max_rpm * 0.8: 0.8, max_rpm: 0.0} | Map defining the torque [Normalized 0..1] for a given RPM with this format |
OptimalSetEngineStarted
Sets if the Engine is turned off/on (this will affect Lights, Sounds and ability to Throttle)
my_vehiclewheeled:SetEngineStarted(started)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| boolean | started | Required parameter | No description provided |
ModerateSetHeadlightsEnabled
Enables or disables the headlights
my_vehiclewheeled:SetHeadlightsEnabled(is_enabled)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| boolean | is_enabled | Required parameter | No description provided |
ModerateSetHeadlightsSetup
Configures the Headlights Offset and Color.
my_vehiclewheeled:SetHeadlightsSetup(location, color?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | location | Required parameter | No description provided |
| Color | color? | Color(1, 0.86, 0.5) | No description provided |
OptimalSetHornSound
Sets the sound asset used by the vehicle horn
my_vehiclewheeled:SetHornSound(sound_asset)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Sound Reference | sound_asset | Required parameter | No description provided |
ModerateSetSteeringSetup
Configures the Vehicle Steering
my_vehiclewheeled:SetSteeringSetup(steering_type, angle_ratio?, steering_curve?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| SteeringType | steering_type | Required parameter | Type of steering to use. Default is SteeringType.AngleRatio |
| float | angle_ratio? | 0.7 | Only applies when SteeringType.AngleRatio is selected |
| table | steering_curve? | { 0: 1.0, 20: 0.8, 60: 0.4, 120: 0.3} | Maximum steering versus forward speed (MPH) with this format |
ModerateSetSteeringWheelSetup
Configures where the Steering Wheel is located, so Characters can grab it procedurally properly
my_vehiclewheeled:SetSteeringWheelSetup(relative_location, radius, rotation?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | relative_location | Required parameter | Relative location of the steering wheel from the vehicle's origin |
| integer | radius | Required parameter | Radius of the steering wheel to align the hands properly |
| Rotator | rotation? | Rotator(0, 0, 0) | Rotation of the steering wheel to align the hands properly |
ModerateSetTaillightsEnabled
Enables or disables the taillights
my_vehiclewheeled:SetTaillightsEnabled(is_enabled)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| boolean | is_enabled | Required parameter | No description provided |
ModerateSetTaillightsSetup
Configures the Taillights Offset.
my_vehiclewheeled:SetTaillightsSetup(location)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | location | Required parameter | No description provided |
ModerateSetTireFlat
Sets a Tire as Flat or not
my_vehiclewheeled:SetTireFlat(wheel_index, is_flat)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| integer | wheel_index | Required parameter | No description provided |
| boolean | is_flat | Required parameter | No description provided |
ModerateSetTransmissionSetup
Configures the Vehicle Transmission
my_vehiclewheeled:SetTransmissionSetup(transmission_final_ratio?, transmission_change_up_rpm?, transmission_change_down_rpm?, transmission_gear_change_time?, transmission_efficiency?, forward_gear_ratios?, reverse_gear_ratios?)
Parameters
| 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) |
| table of float | forward_gear_ratios? | { 2.85, 2.02, 1.35, 1.0} | List of forward gear ratios |
| table of float | reverse_gear_ratios? | { 2.86 } | List of reverse gear ratios |
ModerateSetWheel
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?, suspension_sweep_shape?)
Parameters
| 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) |
| SuspensionSweepShape | suspension_sweep_shape? | SuspensionSweepShape.Raycast | Wheel suspension trace type, defaults to ray trace |
🚀 Events
Inherited Entity Events
VehicleWheeled inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/entity
Base Entityscripting-reference/classes/base-classes/entity
| Name | Description | |
|---|---|---|
| ClassRegister | Triggered when a new Class is registered with the Inheriting System |
| Destroy | Triggered when an Entity is destroyed |
| Spawn | Triggered when an Entity is spawned/created |
| ValueChange | Triggered when an Entity has a value changed with :SetValue() |
Inherited Actor Events
VehicleWheeled inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/actor
Base Actorscripting-reference/classes/base-classes/actor
| Name | Description | |
|---|---|---|
| DimensionChange | Déclenché lorsqu'un Actor change de dimension |
| EnterWater | Triggered when an Actor enters a water body |
| LeaveWater | Triggered when an Actor leaves a water body |
| NetworkAuthorityChange | Triggered when an Actor changes its network authority Player |
| NetworkAuthorityChange | Triggered when the local Player gets/loses network authority over this actor |
Inherited Damageable Events
VehicleWheeled inherits from Base Damageable Class, sharing it's events:
Base Damageablescripting-reference/classes/base-classes/damageable
Base Damageablescripting-reference/classes/base-classes/damageable
| Name | Description | |
|---|---|---|
| Death | Lorsque l'Entité meurt |
| HealthChange | Quand la santé de l'entité est modifiée, ou parce qu'elle a subi des dégâts ou a été manuellement définie par le script ou la réapparition |
| Respawn | Lorsque l'Entité réapparaît |
| TakeDamage | Déclenché lorsque cette Entité subit des dégâts |
Inherited Vehicle Events
VehicleWheeled inherits from Base Vehicle Class, sharing it's events:
Base Vehiclescripting-reference/classes/base-classes/vehicle
Base Vehiclescripting-reference/classes/base-classes/vehicle
| Name | Description | |
|---|---|---|
| CharacterAttemptEnter | Triggered when a Character attempts to enter the Vehicle |
| CharacterAttemptLeave | Triggered when a Character attempts to leave the Vehicle |
| CharacterEnter | Triggered when a Character fully enters the Vehicle |
| CharacterLeave | Triggered when a Character fully leaves the Vehicle |
| EngineStart | Triggered when the engine starts |
| EngineStop | Triggered when the engine stops |
| Hit | Triggered when Vehicle hits something |
| Name | Description | |
|---|---|---|
| Horn | Triggered when Vehicle honks |
Horn
Triggered when Vehicle honks
VehicleWheeled.Subscribe("Horn", function(self, is_honking)
-- Horn was called
end)
Arguments
| Type | Argument | Description |
|---|---|---|
| VehicleWheeled | self | No description provided |
| boolean | is_honking | No description provided |