Tip API Reference

Public JoltPenetrator setters and diagnostic methods, including activation and configuration behavior.

Obtain a Tip with jolt_penetrator_tip(body, config). Store the returned object, check is_struct and later use is_valid(). Its native handle is not a GameMaker instance ID; different tips on the same body have separate identities.

Before activation, is_valid() describes a valid prepared object; get_info() reports handle=0, enabled=false and empty relationships. The first set_enabled(true) validates the tip on the surface. On failure, fix the settings and retry. After registration, setters apply immediately and respect Busy while engaged/rearming.

tip.set_local_position(x, y, z);
tip.set_local_axis(x, y, z);
tip.set_max_angle(degrees);
tip.set_max_insertion(metres);
tip.set_max_simultaneous_penetrations(count);
tip.set_max_capture_axial_speed(speed);
tip.set_mask(bits);
tip.set_capture_model(model);
tip.set_probe_length(metres);
tip.set_probe_radius(metres);
tip.set_capture_gap(metres);
tip.set_capture_overlap(metres);
tip.set_tip_surface_tolerance(metres);
tip.set_rearm_separation(metres);
tip.set_contact_assisted(enabled);
tip.set_contact_tolerance(metres);
tip.set_enabled(true);

Changing and reading safely#

if (is_struct(tip) && tip.is_valid()) {
    if (!tip.set_max_angle(35)) {
        show_debug_message(jolt_get_error_message());
    }
    var info = tip.get_info();
    if (is_struct(info)) {
        show_debug_message("Model: " + string(info.capture_model));
        show_debug_message("Relationships: " + string(array_length(info.relationships)));
    }
}

get_info() fields#

The struct contains schema=1, handle, body_handle, enabled, state, reject_reason, relationships and all current configuration fields: mask, local_position, local_axis, max_angle, contact_tolerance, max_insertion, max_simultaneous_penetrations, max_capture_axial_speed, capture_model, contact_assisted, probe_length, probe_radius, capture_gap, capture_overlap, tip_surface_tolerance and rearm_separation. relationships contains numeric handles; use get_relationships() for objects.

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.