b2d.fixture
Functions for interacting with fixtures attached to Box2D bodies.
Fixtures are addressed functionally by (body, fixture_index) rather than persistent Lua handles.
Functions
b2d.fixture.get_aabb(body:Opaque<"b2Body">, fixture_index: number, child_index: number): { lower: Vector3; upper: Vector3 }Nb2d.fixture.get_density(body:Opaque<"b2Body">, fixture_index: number): numberNb2d.fixture.get_filter_data(body:Opaque<"b2Body">, fixture_index: number, child_index: number): { category_bits: number; mask_bits: number; group_index: number }Nb2d.fixture.get_friction(body:Opaque<"b2Body">, fixture_index: number): numberNb2d.fixture.get_restitution(body:Opaque<"b2Body">, fixture_index: number): numberNb2d.fixture.get_shape(body:Opaque<"b2Body">, fixture_index: number): { type: number; radius?: number; center?: Vector3; v0?: Vector3; v1?: Vector3; v2?: Vector3; v3?: Vector3; vertices?: Vector3[]; hx?: number; hy?: number; angle?: number; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3; center1?: Vector3; center2?: Vector3 }Nb2d.fixture.get_type(body:Opaque<"b2Body">, fixture_index: number): numberNb2d.fixture.is_sensor(body:Opaque<"b2Body">, fixture_index: number): booleanNb2d.fixture.refilter(body:Opaque<"b2Body">, fixture_index: number, touch_proxies: boolean): voidNb2d.fixture.set_density(body:Opaque<"b2Body">, fixture_index: number, density: number, update_mass?: boolean): voidNb2d.fixture.set_filter_data(body:Opaque<"b2Body">, fixture_index: number, child_index: number, filter: { category_bits: number; mask_bits: number; group_index: number }): voidNb2d.fixture.set_friction(body:Opaque<"b2Body">, fixture_index: number, friction: number): voidNb2d.fixture.set_restitution(body:Opaque<"b2Body">, fixture_index: number, restitution: number): voidNb2d.fixture.set_sensor(body:Opaque<"b2Body">, fixture_index: number, enabled: boolean): voidNb2d.fixture.set_shape(body:Opaque<"b2Body">, fixture_index: number, 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_EDGE; 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 }, update_mass?: boolean): voidNb2d.fixture.test_point(body:Opaque<"b2Body">, fixture_index: number, point: Vector3): booleanN
b2d.fixture.get_aabb(body: Opaque<"b2Body">, fixture_index: number, child_index: number): { lower: Vector3; upper: Vector3 }N
- Since Defold 1.13.0
Get fixture AABB for a child shape.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.child_index:number— 1-based child shape index. ⚠️ 1-based; passed to Defold unchanged.
Returns
aabb:{ lower: Vector3; upper: Vector3 }— the fixture AABB
b2d.fixture.get_density(body: Opaque<"b2Body">, fixture_index: number): numberN
- Since Defold 1.13.0
Get fixture density.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.
Returns
density:number— density in kg/m^2
b2d.fixture.get_filter_data(body: Opaque<"b2Body">, fixture_index: number, child_index: number): { category_bits: number; mask_bits: number; group_index: number }N
- Since Defold 1.13.0
Get fixture filter data for a child shape.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.child_index:number— 1-based child shape index. ⚠️ 1-based; passed to Defold unchanged.
Returns
filter:{ category_bits: number; mask_bits: number; group_index: number }— the filter data
b2d.fixture.get_friction(body: Opaque<"b2Body">, fixture_index: number): numberN
- Since Defold 1.13.0
Get fixture friction.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.
Returns
friction:number
b2d.fixture.get_restitution(body: Opaque<"b2Body">, fixture_index: number): numberN
- Since Defold 1.13.0
Get fixture restitution.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.
Returns
restitution:number
b2d.fixture.get_shape(body: Opaque<"b2Body">, fixture_index: number): { type: number; radius?: number; center?: Vector3; v0?: Vector3; v1?: Vector3; v2?: Vector3; v3?: Vector3; vertices?: Vector3[]; hx?: number; hy?: number; angle?: number; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3; center1?: Vector3; center2?: Vector3 }N
- Since Defold 1.13.0
Get the fixture shape as a functional shape table.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.
Returns
shape:{ type: number; radius?: number; center?: Vector3; v0?: Vector3; v1?: Vector3; v2?: Vector3; v3?: Vector3; vertices?: Vector3[]; hx?: number; hy?: number; angle?: number; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3; center1?: Vector3; center2?: Vector3 }— the shape definition, suitable for reuse in b2d.body.create_fixture
b2d.fixture.get_type(body: Opaque<"b2Body">, fixture_index: number): numberN
- Since Defold 1.13.0
Get the fixture type.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.
Returns
type:number
b2d.fixture.is_sensor(body: Opaque<"b2Body">, fixture_index: number): booleanN
- Since Defold 1.13.0
Check if a fixture is a sensor.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.
Returns
enabled:boolean
b2d.fixture.refilter(body: Opaque<"b2Body">, fixture_index: number, touch_proxies: boolean): voidN
- Since Defold 1.13.0
Refilter a fixture.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.touch_proxies:boolean— if true, touch broad-phase proxies
b2d.fixture.set_density(body: Opaque<"b2Body">, fixture_index: number, density: number, update_mass?: boolean): voidN
- Since Defold 1.13.0
Set fixture density.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.density:number— density in kg/m^2update_mass?:boolean— if true, reset body mass data after the change
b2d.fixture.set_filter_data(body: Opaque<"b2Body">, fixture_index: number, child_index: number, filter: { category_bits: number; mask_bits: number; group_index: number }): voidN
- Since Defold 1.13.0
Set fixture filter data for a child shape.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.child_index:number— 1-based child shape index. ⚠️ 1-based; passed to Defold unchanged.filter:{ category_bits: number; mask_bits: number; group_index: number }— the filter data
b2d.fixture.set_friction(body: Opaque<"b2Body">, fixture_index: number, friction: number): voidN
- Since Defold 1.13.0
Set fixture friction.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.friction:number
b2d.fixture.set_restitution(body: Opaque<"b2Body">, fixture_index: number, restitution: number): voidN
- Since Defold 1.13.0
Set fixture restitution.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.restitution:number
b2d.fixture.set_sensor(body: Opaque<"b2Body">, fixture_index: number, enabled: boolean): voidN
- Since Defold 1.13.0
Set sensor mode for a fixture.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.enabled:boolean
b2d.fixture.set_shape(body: Opaque<"b2Body">, fixture_index: number, 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_EDGE; 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 }, update_mass?: boolean): voidN
- Since Defold 1.13.0
This updates the existing Box2D v2 shape using the same table format as
b2d.body.create_fixture and b2d.fixture.get_shape.
The shape type must match the current fixture shape type. Polygon updates must
keep the same vertex count. Chain shape geometry cannot be updated in-place.
The body mass is not updated unless update_mass is true.
const body = b2d.get_body("#collisionobject");
if (body !== undefined) {
// Move a circle shape relative to the body origin.
const circle = b2d.fixture.get_shape(body, 1);
const radius = "radius" in circle ? circle.radius : undefined;
b2d.fixture.set_shape(body, 1, { type: b2d.shape.SHAPE_TYPE_CIRCLE, radius: radius ?? 16, center: vmath.vector3(24, 0, 0) }, true);
// Replace an edge shape's local endpoints.
b2d.fixture.set_shape(body, 2, {
type: b2d.shape.SHAPE_TYPE_EDGE,
v1: vmath.vector3(-32, 0, 0),
v2: vmath.vector3(32, 0, 0),
});
// Update a box shape using the polygon box convenience format.
// The existing polygon must already have four vertices.
b2d.fixture.set_shape(
body,
3,
{
type: b2d.shape.SHAPE_TYPE_BOX,
hx: 16,
hy: 8,
center: vmath.vector3(0, 20, 0),
angle: math.rad(30),
},
true,
);
}local body = b2d.get_body("#collisionobject")
-- Move a circle shape relative to the body origin.
local circle = b2d.fixture.get_shape(body, 1)
circle.center = vmath.vector3(24, 0, 0)
b2d.fixture.set_shape(body, 1, circle, true)
-- Replace an edge shape's local endpoints.
b2d.fixture.set_shape(body, 2, {
type = b2d.shape.SHAPE_TYPE_EDGE,
v1 = vmath.vector3(-32, 0, 0),
v2 = vmath.vector3( 32, 0, 0),
})
-- Update a box shape using the polygon box convenience format.
-- The existing polygon must already have four vertices.
b2d.fixture.set_shape(body, 3, {
type = b2d.shape.SHAPE_TYPE_BOX,
hx = 16,
hy = 8,
center = vmath.vector3(0, 20, 0),
angle = math.rad(30),
}, true)Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.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_EDGE; 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 }— the shape definitionupdate_mass?:boolean— if true, reset body mass data after the change
b2d.fixture.test_point(body: Opaque<"b2Body">, fixture_index: number, point: Vector3): booleanN
- Since Defold 1.13.0
Test a point against a fixture.
Parameters
body:Opaque<"b2Body">— bodyfixture_index:number— 1-based fixture index from b2d.body.get_fixtures. ⚠️ 1-based; passed to Defold unchanged.point:Vector3— point in world coordinates
Returns
hit:boolean