Creating Character

Creates and manages a capsule-based CharacterVirtual controller in the default physics world.

jolt_character() creates a managed JoltCharacter. Its public position is the capsule base at the character's feet, its total height includes both rounded ends, and +Z is up unless a reference frame changes it.

Syntax#

jolt_character(x, y, z, options=undefined)

Minimal setup#

jolt_start();

var player = jolt_character(0, 0, 1, {
    radius: 0.4,
    height: 1.8,
    layer: jolt_default_layer()
});

if (is_undefined(player)) {
    show_error(jolt_get_error().message, true);
}

Options#

Lifetime and identity#

player.is_valid()
player.get_native_handle()
jolt_managed_character_count()
player.destroy()

destroy() removes the native controller, invalidates the managed wrapper, clears bindings and contact arrays, and makes later operations fail safely.

Binding a GameMaker instance#

player.bind_instance(id);

// After jolt_update():
player.sync();

sync() copies x, y, z, jolt_ground_state, and jolt_is_crouched to the bound instance. unbind_instance() removes the mapping without destroying the character.

Configure after creation#

player = jolt_character();
if (!is_undefined(player)) {
    player.set_position(0, 0, 2);
    player.set_radius(0.4);
    player.set_height(2.0);
}

Height is the full capsule and position denotes the feet. Resizing is immediate and returns false on invalid values or blockage. crouch_height preserves its proportion.

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.