b2d.chain
Functions for Box2D v3 chains. A chain owns multiple connected segment
shapes, so it is represented by a separate b2Chain handle.
Functions
b2d.chain.destroy(chain:Opaque<"b2Chain">): voidNb2d.chain.from_shape(shape_id:Opaque<"b2Shape">):Opaque<"b2Chain"> | undefinedNb2d.chain.get_friction(chain:Opaque<"b2Chain">): numberNb2d.chain.get_geometry(chain:Opaque<"b2Chain">): Record<string | number, unknown>Nb2d.chain.get_material(chain:Opaque<"b2Chain">): numberNb2d.chain.get_restitution(chain:Opaque<"b2Chain">): numberNb2d.chain.get_segment_count(chain:Opaque<"b2Chain">): numberNb2d.chain.get_segments(chain:Opaque<"b2Chain">): { shape_id: number }[]Nb2d.chain.get_world(chain:Opaque<"b2Chain">):Opaque<"b2World">Nb2d.chain.is_valid(chain:Opaque<"b2Chain">): booleanNb2d.chain.set_friction(chain:Opaque<"b2Chain">, friction: number): voidNb2d.chain.set_material(chain:Opaque<"b2Chain">, material: number): voidNb2d.chain.set_restitution(chain:Opaque<"b2Chain">, restitution: number): voidN
b2d.chain.destroy(chain: Opaque<"b2Chain">): voidN
- Since Defold 1.13.0
Destroying a chain removes all segment shapes owned by the chain. Destroying
any segment shape through b2d.body.destroy_shape also destroys its parent chain.
Parameters
chain:Opaque<"b2Chain">— chain
b2d.chain.from_shape(shape_id: Opaque<"b2Shape">): Opaque<"b2Chain"> | undefinedN
- Since Defold 1.13.0
Returns nil if the shape is not a chain segment.
Parameters
shape_id:Opaque<"b2Shape">— shape handle from a shape info table, or passbody, shape_index
Returns
chain:Opaque<"b2Chain"> | undefined— parent chain, ornilif the shape is not a chain segment
b2d.chain.get_friction(chain: Opaque<"b2Chain">): numberN
- Since Defold 1.13.0
Get chain friction.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
friction:number— chain friction
b2d.chain.get_geometry(chain: Opaque<"b2Chain">): Record<string | number, unknown>N
- Since Defold 1.13.0
Get the chain geometry.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
geometry:Record<string | number, unknown>— chain geometry
b2d.chain.get_material(chain: Opaque<"b2Chain">): numberN
- Since Defold 1.13.0
Get chain material id.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
material:number— chain material id
b2d.chain.get_restitution(chain: Opaque<"b2Chain">): numberN
- Since Defold 1.13.0
Get chain restitution.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
restitution:number— chain restitution
b2d.chain.get_segment_count(chain: Opaque<"b2Chain">): numberN
- Since Defold 1.13.0
Get the number of segment shapes in a chain.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
count:number— segment count
b2d.chain.get_segments(chain: Opaque<"b2Chain">): { shape_id: number }[]N
- Since Defold 1.13.0
Get the segment shapes owned by a chain.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
segments:{ shape_id: number }[]— chain segment shapes
b2d.chain.get_world(chain: Opaque<"b2Chain">): Opaque<"b2World">N
- Since Defold 1.13.0
Get the world owning a chain.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
world:Opaque<"b2World">— owning world
b2d.chain.is_valid(chain: Opaque<"b2Chain">): booleanN
- Since Defold 1.13.0
Validate a chain handle.
Parameters
chain:Opaque<"b2Chain">— chain
Returns
valid:boolean— true if the chain handle still refers to a live Box2D chain
b2d.chain.set_friction(chain: Opaque<"b2Chain">, friction: number): voidN
- Since Defold 1.13.0
Set chain friction.
Parameters
chain:Opaque<"b2Chain">— chainfriction:number— chain friction
b2d.chain.set_material(chain: Opaque<"b2Chain">, material: number): voidN
- Since Defold 1.13.0
Set chain material id.
Parameters
chain:Opaque<"b2Chain">— chainmaterial:number— chain material id
b2d.chain.set_restitution(chain: Opaque<"b2Chain">, restitution: number): voidN
- Since Defold 1.13.0
Set chain restitution.
Parameters
chain:Opaque<"b2Chain">— chainrestitution:number— chain restitution