Creating a Vehicle

Creates a managed vehicle draft over a valid Dynamic chassis and returns JoltVehicle or undefined.

Creation selects the collision tester and controller-wide orientation limits. Wheels and drivetrain are configured on the returned draft before build().

Syntax#

jolt_vehicle(chassis, options=undefined)

Arguments#

Vehicle options#

Return value#

Returns a JoltVehicle draft on success. Returns undefined and sets the high-level error when the chassis or any supplied setting is invalid.

Build contract#

• Add between 2 and 32 wheels before calling build().
• Provide at least one driven wheel or add an explicit differential.
• Add differentials and anti-roll bars before build().
• build() is idempotent through the managed wrapper: a second call after success returns true.
• Runtime input and getters require a successfully built vehicle.

var car = jolt_vehicle(chassis, {
    collision: JOLT_VEHICLE_COLLISION_SPHERE,
    collision_radius: 0.08,
    maximum_slope_angle: 55,
    maximum_pitch_roll_angle: 75
});

if (is_undefined(car)) {
    var error = jolt_get_error();
    show_debug_message(error.context + ": " + error.message);
}

Configuration object and setters#

var settings = jolt_vehicle_settings();
settings.set_collision(JOLT_VEHICLE_COLLISION_SPHERE);
settings.set_collision_radius(0.08);
var car = jolt_vehicle(chassis, settings);

Configuration factories return a GML settings object and create no physics. Their setters return self, the settings object, and do not confirm that a value is valid. Fields are consumed and validated by jolt_vehicle, add_wheel or add_differential. An omitted field preserves the corresponding options default described above. Editing settings after consumption does not change an existing vehicle, wheel or differential. Settings need no destroy.

Vehicle creation returns undefined on failure. add_differential returns Boolean; add_wheel returns a numeric zero-based index or Boolean false on failure. Index 0 is success: do not use only if (!wheel_index). Complete wheel/differential configuration before build().

Verified operation contracts#

These contracts distinguish units, return values, errors and lifetime according to the current implementation. Check results: false, 0 and undefined can mean different things for different methods.