Skip to Content
defold-typescript
Get startedGuidesAPILibraries
Defold

b2d.world

Query and cast functions for the Defold-owned Box2D v2 world.

Functions

b2d.world.cast_mover(world: Opaque<"b2World">, capsule: b2d.MoverCapsule, translation: Vector3, filter?: b2d.QueryFilter): numberN

  • Since Defold 1.13.0

The return value is the fraction of translation that can be traveled before collision, or 1 if there is no hit.

Parameters

  • world: Opaque<"b2World"> — world
  • capsule: b2d.MoverCapsule — mover capsule
  • translation: Vector3 — capsule displacement
  • filter?: b2d.QueryFilter — optional query filter

Returns

  • fraction: number — travel fraction before collision

b2d.world.cast_ray(2 overloads)N

  • 2 overloads added in Defold 1.13.2
  • 1 overload removed in Defold 1.13.2
  • Since Defold 1.13.2
  1. <Backend extends "v2" = "v2">(world: Opaque<"b2World">, origin: Vector3, translation: Vector3, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.FixtureCastHit[], b2d.TreeStats]>

    Cast a ray.

    Parameters

    • world: Opaque<"b2World"> — world from b2d.get_world or b2d.body.get_world
    • origin: Vector3 — world ray origin
    • translation: Vector3 — world ray translation
    • filter?: b2d.QueryFilter — optional query filter
    • max_results?: number — optional maximum result count

    Returns

    • hits: b2d.fixture_cast_hit[] — ray-cast hits
    • stats: b2d.TreeStats — broad-phase query statistics
  2. <Backend extends "v3">(world: Opaque<"b2World">, origin: Vector3, translation: Vector3, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.ShapeCastHit[], b2d.TreeStats]>

    The translation is the ray displacement from origin. Result order is not guaranteed by Box2D.

    Parameters

    • world: Opaque<"b2World"> — world
    • origin: Vector3 — ray start position
    • translation: Vector3 — ray displacement
    • filter?: b2d.QueryFilter — optional query filter
    • max_results?: number — optional maximum result count. Omit or pass 0 for unlimited results.

    Returns

    • hits: b2d.shape_cast_hit[] — ray-cast hits
    • stats: b2d.TreeStats — broad-phase query statistics
  • Removed in Defold 1.13.2: (world: Opaque<"b2World">, origin: Vector3, translation: Vector3, filter: { category_bits?: number; mask_bits?: number; group_index?: number }, max_results: number): LuaMultiReturn<[{ fixture: number; shape: number; point: Vector3; normal: Vector3; fraction: number }[], { node_visits: number; leaf_visits: number }]>

b2d.world.cast_ray_closest(2 overloads)N

  • 2 overloads added in Defold 1.13.2
  • 1 overload removed in Defold 1.13.2
  • Since Defold 1.13.2
  1. <Backend extends "v2" = "v2">(world: Opaque<"b2World">, origin: Vector3, translation: Vector3, filter?: b2d.QueryFilter): b2d.FixtureCastHit | undefined

    Cast a ray and return the closest hit.

    Parameters

    Returns

    • hit: b2d.fixture_cast_hit | nil — closest hit, or nil
  2. <Backend extends "v3">(world: Opaque<"b2World">, origin: Vector3, translation: Vector3, filter?: b2d.QueryFilter): b2d.ShapeCastHit | undefined

    The translation is the ray displacement from origin.

    Parameters

    • world: Opaque<"b2World"> — world
    • origin: Vector3 — ray start position
    • translation: Vector3 — ray displacement
    • filter?: b2d.QueryFilter — optional query filter

    Returns

    • hit: b2d.shape_cast_hit | nil — closest hit, or nil
  • Removed in Defold 1.13.2: (world: Opaque<"b2World">, origin: Vector3, translation: Vector3, filter: { category_bits?: number; mask_bits?: number; group_index?: number }): { fixture: number; shape: number; point: Vector3; normal: Vector3; fraction: number; node_visits: number; leaf_visits: number } | undefined

b2d.world.cast_shape(2 overloads)N

  • 2 overloads added in Defold 1.13.2
  • 1 overload removed in Defold 1.13.2
  • Since Defold 1.13.2
  1. <Backend extends "v2" = "v2">(world: Opaque<"b2World">, shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, translation: Vector3, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.FixtureCastHit[], b2d.TreeStats]>

    Uses Box2D v2 time-of-impact for fixture child shapes that support distance proxies. Grid fixture children are skipped.

    Parameters

    • world: Opaque<"b2World"> — world from b2d.get_world or b2d.body.get_world
    • shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 } — query shape
    • translation: Vector3 — world shape translation
    • filter?: b2d.QueryFilter — optional query filter
    • max_results?: number — optional maximum result count

    Returns

    • hits: b2d.fixture_cast_hit[] — shape-cast hits
    • stats: b2d.TreeStats — broad-phase query statistics
  2. <Backend extends "v3">(world: Opaque<"b2World">, shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, translation: Vector3, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.ShapeCastHit[], b2d.TreeStats]>

    The translation is the shape displacement.

    Parameters

    • world: Opaque<"b2World"> — world
    • shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 } — cast shape
    • translation: Vector3 — shape displacement
    • filter?: b2d.QueryFilter — optional query filter
    • max_results?: number — optional maximum result count. Omit or pass 0 for unlimited results.

    Returns

    • hits: b2d.shape_cast_hit[] — shape-cast hits
    • stats: b2d.TreeStats — broad-phase query statistics
  • Removed in Defold 1.13.2: (world: Opaque<"b2World">, shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, translation: Vector3, filter: { category_bits?: number; mask_bits?: number; group_index?: number }, max_results: number): LuaMultiReturn<[{ fixture: number; shape: number; point: Vector3; normal: Vector3; fraction: number }[], { node_visits: number; leaf_visits: number }]>

b2d.world.collide_mover(world: Opaque<"b2World">, capsule: b2d.MoverCapsule, filter?: b2d.QueryFilter, max_results?: number): b2d.MoverPlane[]N

  • Since Defold 1.13.0

Collide a mover capsule against the world.

Parameters

  • world: Opaque<"b2World"> — world
  • capsule: b2d.MoverCapsule — mover capsule
  • filter?: b2d.QueryFilter — optional query filter
  • max_results?: number — optional maximum result count. Omit or pass 0 for unlimited results.

Returns

b2d.world.enable_continuous(world: Opaque<"b2World">, enable: boolean): voidN

  • Since Defold 1.13.0

Enable or disable continuous collision.

Parameters

  • world: Opaque<"b2World"> — world
  • enable: boolean — true to enable continuous collision

b2d.world.enable_sleeping(world: Opaque<"b2World">, enable: boolean): voidN

  • Since Defold 1.13.0

Enable or disable world sleeping.

Parameters

  • world: Opaque<"b2World"> — world
  • enable: boolean — true to allow sleeping

b2d.world.enable_speculative(world: Opaque<"b2World">, enable: boolean): voidN

  • Since Defold 1.13.0

Enable or disable speculative collision.

Parameters

  • world: Opaque<"b2World"> — world
  • enable: boolean — true to enable speculative collision

b2d.world.enable_warm_starting(world: Opaque<"b2World">, enable: boolean): voidN

  • Since Defold 1.13.0

Enable or disable warm starting.

Parameters

  • world: Opaque<"b2World"> — world
  • enable: boolean — true to enable warm starting

b2d.world.explode(world: Opaque<"b2World">, definition: b2d.ExplosionDefinition): voidN

  • Since Defold 1.13.0

Apply an explosion impulse.

Parameters

b2d.world.get_awake_body_count(world: Opaque<"b2World">): numberN

  • Since Defold 1.13.0

Get the number of awake bodies.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • count: number — awake body count

b2d.world.get_counters(world: Opaque<"b2World">): b2d.WorldCountersN

  • Since Defold 1.13.0

Get world counters.

Parameters

  • world: Opaque<"b2World"> — world

Returns

b2d.world.get_gravity(world: Opaque<"b2World">): Vector3N

  • Since Defold 1.13.0

Get world gravity.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • gravity: Vector3 — gravity vector

b2d.world.get_hit_event_threshold(world: Opaque<"b2World">): numberN

  • Since Defold 1.13.0

Get the hit event threshold.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • threshold: number — hit event threshold in project units per second

b2d.world.get_maximum_linear_speed(world: Opaque<"b2World">): numberN

  • Since Defold 1.13.0

Get the maximum linear speed.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • speed: number — maximum linear speed in project units per second

b2d.world.get_profile(world: Opaque<"b2World">): b2d.WorldProfileN

  • Since Defold 1.13.0

Get world profiling data.

Parameters

  • world: Opaque<"b2World"> — world

Returns

b2d.world.get_restitution_threshold(world: Opaque<"b2World">): numberN

  • Since Defold 1.13.0

Get the restitution threshold.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • threshold: number — restitution threshold in project units per second

b2d.world.is_continuous_enabled(world: Opaque<"b2World">): booleanN

  • Since Defold 1.13.0

Get whether continuous collision is enabled.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • enabled: boolean — true if continuous collision is enabled

b2d.world.is_locked(world: Opaque<"b2World">): booleanN

  • Since Defold 1.13.0

The world is locked during callbacks and some simulation phases. Functions marked as locked during callbacks cannot be called while this returns true.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • locked: boolean — true if the world is locked

b2d.world.is_sleeping_enabled(world: Opaque<"b2World">): booleanN

  • Since Defold 1.13.0

Get whether world sleeping is enabled.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • enabled: boolean — true if sleeping is enabled

b2d.world.is_valid(world: Opaque<"b2World">): booleanN

  • Since Defold 1.13.0

Check whether a world handle is valid.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • valid: boolean — true if the world handle is valid

b2d.world.is_warm_starting_enabled(world: Opaque<"b2World">): booleanN

  • Since Defold 1.13.0

Get whether warm starting is enabled.

Parameters

  • world: Opaque<"b2World"> — world

Returns

  • enabled: boolean — true if warm starting is enabled

b2d.world.overlap_aabb(2 overloads)N

  • 2 overloads added in Defold 1.13.2
  • 1 overload removed in Defold 1.13.2
  • Since Defold 1.13.2
  1. <Backend extends "v2" = "v2">(world: Opaque<"b2World">, aabb: b2d.Aabb, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.FixtureInfo[], b2d.TreeStats]>

    Overlap an AABB.

    Parameters

    Returns

    • fixtures: b2d.fixture_info[] — overlapping fixtures. ⚠️ index is 1-based; passed to Defold unchanged.
    • stats: b2d.TreeStats — broad-phase query statistics
  2. <Backend extends "v3">(world: Opaque<"b2World">, aabb: b2d.Aabb, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.ShapeInfo[], b2d.TreeStats]>

    Find shapes overlapping an AABB.

    Parameters

    • world: Opaque<"b2World"> — world
    • aabb: b2d.Aabb — query bounds
    • filter?: b2d.QueryFilter — optional query filter
    • max_results?: number — optional maximum result count. Omit or pass 0 for unlimited results.

    Returns

    • hits: b2d.shape_info[] — overlapping shapes
    • stats: b2d.TreeStats — broad-phase query statistics
  • Removed in Defold 1.13.2: (world: Opaque<"b2World">, aabb: { lower: Vector3; upper: Vector3 }, filter: { category_bits?: number; mask_bits?: number; group_index?: number }, max_results: number): LuaMultiReturn<[{ index: number; type: number; sensor: boolean; density: number; friction: number; restitution: number; child_count: number }[], { node_visits: number; leaf_visits: number }]>

b2d.world.overlap_shape(2 overloads)N

  • 2 overloads added in Defold 1.13.2
  • 1 overload removed in Defold 1.13.2
  • Since Defold 1.13.2
  1. <Backend extends "v2" = "v2">(world: Opaque<"b2World">, shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.FixtureInfo[], b2d.TreeStats]>

    Overlap a shape.

    Parameters

    • world: Opaque<"b2World"> — world from b2d.get_world or b2d.body.get_world
    • shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 } — query shape
    • filter?: b2d.QueryFilter — optional query filter
    • max_results?: number — optional maximum result count

    Returns

    • fixtures: b2d.fixture_info[] — overlapping fixtures. ⚠️ index is 1-based; passed to Defold unchanged.
    • stats: b2d.TreeStats — broad-phase query statistics
  2. <Backend extends "v3">(world: Opaque<"b2World">, shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, filter?: b2d.QueryFilter, max_results?: number): LuaMultiReturn<[b2d.ShapeInfo[], b2d.TreeStats]>

    Find shapes overlapping a shape proxy.

    Parameters

    • world: Opaque<"b2World"> — world
    • shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 } — query shape
    • filter?: b2d.QueryFilter — optional query filter
    • max_results?: number — optional maximum result count. Omit or pass 0 for unlimited results.

    Returns

    • hits: b2d.shape_info[] — overlapping shapes
    • stats: b2d.TreeStats — broad-phase query statistics
  • Removed in Defold 1.13.2: (world: Opaque<"b2World">, shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CAPSULE; radius: number; center1: Vector3; center2: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE | typeof b2d.shape.SHAPE_TYPE_SEGMENT; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, filter: { category_bits?: number; mask_bits?: number; group_index?: number }, max_results: number): LuaMultiReturn<[{ index: number; type: number; sensor: boolean; density: number; friction: number; restitution: number; child_count: number }[], { node_visits: number; leaf_visits: number }]>

b2d.world.rebuild_static_tree(world: Opaque<"b2World">): voidN

  • Since Defold 1.13.0

Rebuild the static broad-phase tree.

Parameters

  • world: Opaque<"b2World"> — world

b2d.world.set_contact_tuning(world: Opaque<"b2World">, hertz: number, damping_ratio: number, pushout: number): voidN

  • Since Defold 1.13.0

Set contact solver tuning.

Parameters

  • world: Opaque<"b2World"> — world
  • hertz: number — contact stiffness frequency in hertz
  • damping_ratio: number — contact damping ratio
  • pushout: number — pushout velocity in project units per second

b2d.world.set_gravity(world: Opaque<"b2World">, gravity: Vector3): voidN

  • Since Defold 1.13.0

Set world gravity.

Parameters

  • world: Opaque<"b2World"> — world
  • gravity: Vector3 — gravity vector

b2d.world.set_hit_event_threshold(world: Opaque<"b2World">, threshold: number): voidN

  • Since Defold 1.13.0

Set the hit event threshold.

Parameters

  • world: Opaque<"b2World"> — world
  • threshold: number — hit event threshold in project units per second

b2d.world.set_joint_tuning(world: Opaque<"b2World">, hertz: number, damping_ratio: number): voidN

  • Since Defold 1.13.0

Set joint solver tuning.

Parameters

  • world: Opaque<"b2World"> — world
  • hertz: number — joint stiffness frequency in hertz
  • damping_ratio: number — joint damping ratio

b2d.world.set_maximum_linear_speed(world: Opaque<"b2World">, speed: number): voidN

  • Since Defold 1.13.0

Set the maximum linear speed.

Parameters

  • world: Opaque<"b2World"> — world
  • speed: number — maximum linear speed in project units per second

b2d.world.set_restitution_threshold(world: Opaque<"b2World">, threshold: number): voidN

  • Since Defold 1.13.0

Collisions below this relative speed use inelastic collision response.

Parameters

  • world: Opaque<"b2World"> — world
  • threshold: number — restitution threshold in project units per second

On this page

Functionsb2d.world.cast_mover(world: Opaque<"b2World">, capsule: b2d.MoverCapsule, translation: Vector3, filter?: b2d.QueryFilter): numberNb2d.world.cast_ray(2 overloads)Nb2d.world.cast_ray_closest(2 overloads)Nb2d.world.cast_shape(2 overloads)Nb2d.world.collide_mover(world: Opaque<"b2World">, capsule: b2d.MoverCapsule, filter?: b2d.QueryFilter, max_results?: number): b2d.MoverPlane[]Nb2d.world.enable_continuous(world: Opaque<"b2World">, enable: boolean): voidNb2d.world.enable_sleeping(world: Opaque<"b2World">, enable: boolean): voidNb2d.world.enable_speculative(world: Opaque<"b2World">, enable: boolean): voidNb2d.world.enable_warm_starting(world: Opaque<"b2World">, enable: boolean): voidNb2d.world.explode(world: Opaque<"b2World">, definition: b2d.ExplosionDefinition): voidNb2d.world.get_awake_body_count(world: Opaque<"b2World">): numberNb2d.world.get_counters(world: Opaque<"b2World">): b2d.WorldCountersNb2d.world.get_gravity(world: Opaque<"b2World">): Vector3Nb2d.world.get_hit_event_threshold(world: Opaque<"b2World">): numberNb2d.world.get_maximum_linear_speed(world: Opaque<"b2World">): numberNb2d.world.get_profile(world: Opaque<"b2World">): b2d.WorldProfileNb2d.world.get_restitution_threshold(world: Opaque<"b2World">): numberNb2d.world.is_continuous_enabled(world: Opaque<"b2World">): booleanNb2d.world.is_locked(world: Opaque<"b2World">): booleanNb2d.world.is_sleeping_enabled(world: Opaque<"b2World">): booleanNb2d.world.is_valid(world: Opaque<"b2World">): booleanNb2d.world.is_warm_starting_enabled(world: Opaque<"b2World">): booleanNb2d.world.overlap_aabb(2 overloads)Nb2d.world.overlap_shape(2 overloads)Nb2d.world.rebuild_static_tree(world: Opaque<"b2World">): voidNb2d.world.set_contact_tuning(world: Opaque<"b2World">, hertz: number, damping_ratio: number, pushout: number): voidNb2d.world.set_gravity(world: Opaque<"b2World">, gravity: Vector3): voidNb2d.world.set_hit_event_threshold(world: Opaque<"b2World">, threshold: number): voidNb2d.world.set_joint_tuning(world: Opaque<"b2World">, hertz: number, damping_ratio: number): voidNb2d.world.set_maximum_linear_speed(world: Opaque<"b2World">, speed: number): voidNb2d.world.set_restitution_threshold(world: Opaque<"b2World">, threshold: number): voidN