Views

Sets functions for the collision callbacks during the world update.

Four Lua functions can be given as arguments. The value nil removes a function.

When called, each function will be passed three arguments. The first two arguments are the colliding fixtures and the third argument is the Contact between them. The postSolve callback additionally gets the normal and tangent impulse for each contact point. See notes.

If you are interested to know when exactly each callback is called, consult a Box2d manual

Function

Synopsis

Arguments

function beginContact

Gets called when two fixtures begin to overlap.

function endContact

Gets called when two fixtures cease to overlap. This will also be called outside of a world update, when colliding objects are destroyed.

function preSolve

Gets called before a collision gets resolved.

function postSolve

Gets called after the collision has been resolved.

Returns

Nothing.

Set functions to be called when shapes collide.

Four Lua functions can be given as arguments. The value nil can be given for events that are uninteresting.

When called, each function will be passed three arguments. The first two arguments (one for each shape) will pass data that has been set with Shape:setData (or nil). The third argument passes the Contact between the two shapes.

Note: Using Shape:destroy when there is an active remove callback can lead to a crash. It is possible to work around this issue by only destroying object that are not in active contact with anything.

Function

Synopsis

Arguments

function add

Called when two shapes first collide.

function persist

Called each frame, if collision lasts more than 1 frame.

function remove

Called when two shapes finish colliding.

function result

Called after a collision has been calculated. Note: This callback is not properly bound in LOVE at the time of writing, as a result, this callback does not get called, nor do proper arguments get passed for it.

Returns

Nothing.

Notes

Below are the parameters for the postSolve callback. Note that the numbers of normal and tangent impulse correspond with the numbers of contact points.

See Also

• World
• Tutorial:PhysicsCollisionCallbacks

Other Languages