vehicle kit
103 tools. Generated from the plugin source; do not edit by hand.
Tools
Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above
MaxAutoRiskneed"_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours thedryRunargument. smoke = covered byedit.self_test.
vehicle.audit (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.audit_mechanical_setup (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.audit_wheels (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.batch_audit (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicles | array of string | required. Vehicle actor labels/names/paths or Blueprint asset paths. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.create_vehicle_blueprint (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
Creates a WheeledVehiclePawn Blueprint with a skeletal chassis mesh (default SkeletalCube) and one wheel setup per bone (default four corner wheels on the root bone).
| Argument | Type | Description |
|---|---|---|
path | string | required. Destination Blueprint object path, for example /Game/Vehicles/BP_Car. |
mesh | string | Skeletal mesh for the chassis; defaults to /Engine/EngineMeshes/SkeletalCube. |
wheelClass | string | ChaosVehicleWheel Blueprint/class used by every wheel; empty uses the native ChaosVehicleWheel. |
wheelBones | array of string | Bone name per wheel; empty creates four wheels on the mesh root bone with corner offsets. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.create_wheel_blueprint (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
Creates a ChaosVehicleWheel Blueprint (radius, width, steering/engine/handbrake flags) for use in vehicle wheel setups.
| Argument | Type | Description |
|---|---|---|
path | string | required. Destination Blueprint object path, for example /Game/Vehicles/BP_FrontWheel. |
radius | number | Wheel radius in centimetres. Default 35.0. |
width | number | Wheel width in centimetres. Default 20.0. |
maxSteerAngle | number | Maximum steering angle in degrees (used when affectedBySteering is true). Default 40.0. |
affectedBySteering | boolean | Wheel turns with steering input (front wheels). Default false. |
affectedByEngine | boolean | Wheel receives engine torque. Default true. |
affectedByHandbrake | boolean | Wheel is affected by the handbrake (rear wheels). Default false. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.decrease_throttle (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_auto_reverse (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_automatic_gears (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_center_of_mass_override (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_mechanical_sim (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_reverse_as_brake (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_suspension (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_throttle_as_brake (risk 2, mutates, UE 5.2+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_abs (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_brake (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_default_abs (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_default_brake (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_default_engine (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_default_handbrake (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_default_steering (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_default_traction_control (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_engine (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_friction (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_handbrake (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_steering (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.enable_wheel_traction_control (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_aero (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_chassis (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_differential (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_mechanical_setup (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_steering (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_thrusters (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_transmission (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.get_wheel_setup (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
wheelIndex | integer | required. Zero-based wheel setup or runtime wheel index. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.increase_throttle (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.inspect (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.inspect_wheel_default (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
wheelClass | string | required. ChaosVehicleWheel Blueprint asset path or generated-class path. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.list_wheels (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.reset (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.runtime_state (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.runtime_wheel_state (risk 0, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
wheelIndex | integer | required. Zero-based wheel setup or runtime wheel index. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_auto_gears (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_brake (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_center_of_mass_override (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | {x,y,z} | required. New X, Y, Z value. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_change_down_rpm (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_change_up_rpm (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_chassis_height (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_chassis_width (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_differential_front_rear_split (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_downforce_coefficient (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_drag_coefficient (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_engine_brake_effect (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_engine_idle_rpm (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_engine_max_rpm (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_engine_max_torque (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_engine_rev_down_rate (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_engine_rev_up_moi (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_final_ratio (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_forward_ratios (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
ratios | array of number | required. Ordered transmission ratios. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_gear_change_time (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_handbrake (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_inertia_tensor_scale (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | {x,y,z} | required. New X, Y, Z value. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_mass (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_parked (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_pitch (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_requires_controller_inputs (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_reverse_ratios (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
ratios | array of number | required. Ordered transmission ratios. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_roll (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_runtime_differential_split (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_runtime_downforce (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_runtime_drag (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_runtime_engine_torque (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_sleep_slope_limit (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_sleep_threshold (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_sleeping (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
enabled | boolean | required. New enabled state. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_steering (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_steering_angle_ratio (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_target_gear (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
gear | integer | required. Gear number: -1 reverse, zero neutral, one or greater forward. |
immediate | boolean | Apply the requested gear immediately. Default false. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_throttle (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_transmission_efficiency (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_brake_torque (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_cornering_stiffness (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_damping_ratio (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_friction (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_handbrake_torque (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_mass (risk 2, mutates, UE 5.2+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_max_brake_torque (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_radius (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_skid_threshold (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_slip_threshold (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_spring_rate (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_steer_angle (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_suspension_axis (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | {x,y,z} | required. New X, Y, Z default. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_default_width (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_friction (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_handbrake_torque (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_radius (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_wheel_steer_angle (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.set_yaw (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
value | number | required. Value in the units named by the tool. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.spawn_test_vehicle (risk 1, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
PIE only: spawns a transient four-wheel test vehicle (pawn + simulated cube chassis + ChaosWheeledVehicleMovementComponent) that every vehicle.* runtime tool can target by label.
| Argument | Type | Description |
|---|---|---|
label | string | required. Actor label for the spawned vehicle. |
location | {x,y,z} | Spawn location in centimetres. |
chassisMesh | string | Static mesh used as the simulated chassis; defaults to /Engine/BasicShapes/Cube. |
wheelClass | string | ChaosVehicleWheel Blueprint/class for the four wheels; empty uses the native ChaosVehicleWheel. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.stop (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
vehicle | string | required. Vehicle actor label/name/path, or a WheeledVehiclePawn Blueprint asset path for defaults. |
Returns: vehicle, componentClass, values, wheelCount, message.
vehicle.teleport (risk 2, mutates, UE 5.0+, requires plugin ChaosVehiclesPlugin, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
location | {x,y,z} | required. Destination in centimetres. |
rotation | {x,y,z} | Destination rotation: pitch, yaw, roll degrees. |
Returns: vehicle, componentClass, values, wheelCount, message.