Skip to Content
defold-typescript
Get startedGuidesAPILibraries
Defold

b2d

Functions for interacting with Box2D.

Functions

b2d.get_body(url: string | Hash | Url): Opaque<"b2Body"> | undefined

Get the Box2D body from a collision object

Parameters

  • url: string | Hash | Url — the url to the game object collision component

Returns

  • body: Opaque<"b2Body"> | undefined — the body if successful. Otherwise nil.

b2d.get_gameobject_id(body: Opaque<"b2Body">): Hash | undefinedN

  • Since Defold 1.14.0

Returns the id of the game object that owns the body's collision-object component. Raises a Lua error if the body handle is invalid or its game object has been deleted.

const body = b2d.get_body("#collisionobject");
if (body !== undefined) {
  const id = b2d.get_gameobject_id(body);
}
local body = b2d.get_body("#collisionobject")
local id = b2d.get_gameobject_id(body)

Parameters

  • body: Opaque<"b2Body"> — the Box2D body

Returns

  • id: Hash | undefined — the game object id, or nil if the body has no associated game object

b2d.get_version(): b2d.VersionInfoN

  • Since Defold 1.13.0

Get the Box2D version information for the active backend.

Returns

b2d.get_world(): Opaque<"b2World"> | undefinedC

  • Signature changed in Defold 1.13.2 — before: (): Opaque<"b2World">

Get the Box2D world from the current collection

Returns

  • world: Opaque<"b2World"> | undefined — the world if successful. Otherwise nil.

Types

interface b2d.Aabb { lower: Vector3; upper: Vector3; }

type b2d.B2Body = Opaque<"b2Body">

type b2d.B2World = Opaque<"b2World">

interface b2d.ChainDefinition { vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3; friction?: number; restitution?: number; material?: number; filter?: b2d.FilterOptions; enable_sensor_events?: boolean; }

interface b2d.ChainGeometry { loop: boolean; segment_count: number; vertices: Vector3[]; prev_vertex?: Vector3; next_vertex?: Vector3; }

interface b2d.ContactData { shape_a: b2d.ShapeInfo; shape_b: b2d.ShapeInfo; normal: Vector3; rolling_impulse: number; point_count: number; points: b2d.ContactPoint[]; }

interface b2d.ContactPoint { point: Vector3; anchor_a: Vector3; anchor_b: Vector3; separation: number; normal_impulse: number; tangent_impulse: number; total_normal_impulse: number; normal_velocity: number; id: number; persisted: boolean; }

interface b2d.ExplosionDefinition { position: Vector3; radius: number; falloff: number; impulse_per_length: number; mask_bits?: number; }

interface b2d.Filter { category_bits: number; mask_bits: number; group_index: number; }

interface b2d.FilterOptions { category_bits?: number; mask_bits?: number; group_index?: number; }

interface b2d.FixtureCastHit { fixture: b2d.FixtureInfo; shape: b2d.FixtureInfo; point: Vector3; normal: Vector3; fraction: number; node_visits?: number; leaf_visits?: number; }

interface b2d.FixtureDefinition { shape: b2d.shape.Definition; friction?: number; restitution?: number; density?: number; sensor?: boolean; is_sensor?: boolean; filter?: b2d.Filter; }

interface b2d.FixtureInfo { body?: Opaque<"b2Body">; index: number; child_index?: number; type: b2d.shape.ShapeType; sensor: boolean; density: number; friction: number; restitution: number; child_count: number; }

interface b2d.MassData { mass: number; center: Vector3; inertia: number; }

interface b2d.MoverCapsule { center1: Vector3; center2: Vector3; radius: number; }

interface b2d.MoverPlane { shape: b2d.ShapeInfo; normal: Vector3; offset: number; hit: boolean; }

interface b2d.QueryFilter { category_bits?: number; mask_bits?: number; group_index?: number; }

interface b2d.ShapeCastHit { shape: b2d.ShapeInfo; point: Vector3; normal: Vector3; fraction: number; node_visits?: number; leaf_visits?: number; }

interface b2d.ShapeCastOutput { point: Vector3; normal: Vector3; fraction: number; iterations: number; }

type b2d.ShapeCreateDefinition = { shape: b2d.shape.Definition; density?: number; friction?: number; restitution?: number; material?: number; sensor?: boolean; is_sensor?: boolean; filter?: b2d.Filter } | { type: b2d.shape.ShapeType; radius?: number; center?: Vector3; center1?: Vector3; center2?: Vector3; v0?: Vector3; v1?: Vector3; v2?: Vector3; v3?: Vector3; hx?: number; hy?: number; angle?: number; vertices?: Vector3[]; density?: number; friction?: number; restitution?: number; material?: number; sensor?: boolean; is_sensor?: boolean; filter?: b2d.Filter }

interface b2d.ShapeInfo { index: number; shape_id: Opaque<"b2Shape">; type: b2d.shape.ShapeType; sensor: boolean; density: number; friction: number; restitution: number; material: number; child_count: number; is_chain_segment: boolean; }

interface b2d.Transform { position: Vector3; angle: number; }

interface b2d.TreeStats { node_visits: number; leaf_visits: number; }

interface b2d.VersionInfo { version: string; major: number; middle: number; minor: number; }

interface b2d.WorldCounters { body_count: number; shape_count: number; contact_count: number; joint_count: number; island_count: number; stack_used: number; static_tree_height: number; tree_height: number; byte_count: number; task_count: number; color_counts: number[]; }

interface b2d.WorldProfile { step: number; pairs: number; collide: number; solve: number; merge_islands: number; prepare_stages: number; solve_constraints: number; prepare_constraints: number; integrate_velocities: number; warm_start: number; solve_impulses: number; integrate_positions: number; relax_impulses: number; apply_restitution: number; store_impulses: number; split_islands: number; transforms: number; hit_events: number; refit: number; bullets: number; sleep_islands: number; sensors: number; }

On this page

Functionsb2d.get_body(url: string | Hash | Url): Opaque<"b2Body"> | undefinedb2d.get_gameobject_id(body: Opaque<"b2Body">): Hash | undefinedNb2d.get_version(): b2d.VersionInfoNb2d.get_world(): Opaque<"b2World"> | undefinedCTypesinterface b2d.Aabb { lower: Vector3; upper: Vector3; }type b2d.B2Body = Opaque<"b2Body">type b2d.B2World = Opaque<"b2World">interface b2d.ChainDefinition { vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3; friction?: number; restitution?: number; material?: number; filter?: b2d.FilterOptions; enable_sensor_events?: boolean; }interface b2d.ChainGeometry { loop: boolean; segment_count: number; vertices: Vector3[]; prev_vertex?: Vector3; next_vertex?: Vector3; }interface b2d.ContactData { shape_a: b2d.ShapeInfo; shape_b: b2d.ShapeInfo; normal: Vector3; rolling_impulse: number; point_count: number; points: b2d.ContactPoint[]; }interface b2d.ContactPoint { point: Vector3; anchor_a: Vector3; anchor_b: Vector3; separation: number; normal_impulse: number; tangent_impulse: number; total_normal_impulse: number; normal_velocity: number; id: number; persisted: boolean; }interface b2d.ExplosionDefinition { position: Vector3; radius: number; falloff: number; impulse_per_length: number; mask_bits?: number; }interface b2d.Filter { category_bits: number; mask_bits: number; group_index: number; }interface b2d.FilterOptions { category_bits?: number; mask_bits?: number; group_index?: number; }interface b2d.FixtureCastHit { fixture: b2d.FixtureInfo; shape: b2d.FixtureInfo; point: Vector3; normal: Vector3; fraction: number; node_visits?: number; leaf_visits?: number; }interface b2d.FixtureDefinition { shape: b2d.shape.Definition; friction?: number; restitution?: number; density?: number; sensor?: boolean; is_sensor?: boolean; filter?: b2d.Filter; }interface b2d.FixtureInfo { body?: Opaque<"b2Body">; index: number; child_index?: number; type: b2d.shape.ShapeType; sensor: boolean; density: number; friction: number; restitution: number; child_count: number; }interface b2d.MassData { mass: number; center: Vector3; inertia: number; }interface b2d.MoverCapsule { center1: Vector3; center2: Vector3; radius: number; }interface b2d.MoverPlane { shape: b2d.ShapeInfo; normal: Vector3; offset: number; hit: boolean; }interface b2d.QueryFilter { category_bits?: number; mask_bits?: number; group_index?: number; }interface b2d.ShapeCastHit { shape: b2d.ShapeInfo; point: Vector3; normal: Vector3; fraction: number; node_visits?: number; leaf_visits?: number; }interface b2d.ShapeCastOutput { point: Vector3; normal: Vector3; fraction: number; iterations: number; }type b2d.ShapeCreateDefinition = { shape: b2d.shape.Definition; density?: number; friction?: number; restitution?: number; material?: number; sensor?: boolean; is_sensor?: boolean; filter?: b2d.Filter } | { type: b2d.shape.ShapeType; radius?: number; center?: Vector3; center1?: Vector3; center2?: Vector3; v0?: Vector3; v1?: Vector3; v2?: Vector3; v3?: Vector3; hx?: number; hy?: number; angle?: number; vertices?: Vector3[]; density?: number; friction?: number; restitution?: number; material?: number; sensor?: boolean; is_sensor?: boolean; filter?: b2d.Filter }interface b2d.ShapeInfo { index: number; shape_id: Opaque<"b2Shape">; type: b2d.shape.ShapeType; sensor: boolean; density: number; friction: number; restitution: number; material: number; child_count: number; is_chain_segment: boolean; }interface b2d.Transform { position: Vector3; angle: number; }interface b2d.TreeStats { node_visits: number; leaf_visits: number; }interface b2d.VersionInfo { version: string; major: number; middle: number; minor: number; }interface b2d.WorldCounters { body_count: number; shape_count: number; contact_count: number; joint_count: number; island_count: number; stack_used: number; static_tree_height: number; tree_height: number; byte_count: number; task_count: number; color_counts: number[]; }interface b2d.WorldProfile { step: number; pairs: number; collide: number; solve: number; merge_islands: number; prepare_stages: number; solve_constraints: number; prepare_constraints: number; integrate_velocities: number; warm_start: number; solve_impulses: number; integrate_positions: number; relax_impulses: number; apply_restitution: number; store_impulses: number; split_islands: number; transforms: number; hit_events: number; refit: number; bullets: number; sleep_islands: number; sensors: number; }