love.physics

Can simulate 2D rigid body physics in a realistic manner. This module is based on Box2D, and this API corresponds to the Box2D 2.3.0 API as closely as possible.

love.physics is not lightweight, and not even remotely simple to use. It's a ten-ton hammer designed for heavy-lifting (er...hammer...lifting?)

If you are just trying to make a character jump around on blocks or the likes, then move along, nothing to see here.

Types

Body Bodies are objects with velocity and position.
Contact Contacts are objects created to manage collisions in worlds.
Fixture Fixtures attach shapes to bodies. 0.8.0
Joint Attach multiple bodies together to interact in unique ways.
Shape Shapes are objects used to control mass and collisions.
World A world is an object that contains all bodies and joints.

Functions

love.physics.getDistance Returns the two closest points between two fixtures and their distance. 0.8.0
love.physics.getMeter Returns the meter scale factor. 0.8.0
love.physics.newBody Creates a new body.
love.physics.newChainShape Creates a new ChainShape. 0.8.0
love.physics.newCircleShape Creates a new CircleShape.
love.physics.newDistanceJoint Creates a DistanceJoint between two bodies.
love.physics.newEdgeShape Creates a new EdgeShape. 0.8.0
love.physics.newFixture Creates and attaches a fixture. 0.8.0
love.physics.newFrictionJoint A FrictionJoint applies friction to a body. 0.8.0
love.physics.newGearJoint Create a GearJoint connecting two Joints.
love.physics.newMotorJoint Creates a joint between two bodies which controls the relative motion between them. 0.9.0
love.physics.newMouseJoint Create a joint between a body and the mouse.
love.physics.newPolygonShape Creates a new PolygonShape.
love.physics.newPrismaticJoint Creates a PrismaticJoint between two bodies.
love.physics.newPulleyJoint Creates a PulleyJoint to join two bodies to each other and the ground.
love.physics.newRectangleShape Shorthand for creating rectangular PolygonShapes.
love.physics.newRevoluteJoint Creates a pivot joint between two bodies.
love.physics.newRopeJoint Creates a joint between two bodies that enforces a max distance between them. 0.8.0
love.physics.newWeldJoint A WeldJoint essentially glues two bodies together. 0.8.0
love.physics.newWheelJoint Creates a wheel joint. 0.8.0
love.physics.newWorld Creates a new World.
love.physics.setMeter Sets the meter scale factor. 0.8.0

Enums

BodyType The types of a Body.
JointType Different types of joints.
ShapeType The different types of Shapes, as returned by Shape:getType.

See Also

  • love
  • Tutorial:Physics
  • Tutorial:PhysicsCollisionCallbacks



Shape:getType
  • References/Game Development/LÖVE/love.physics/Shape

Shape:getType Gets a string representing the Shape. This function can be useful for conditional debug drawing. Function Synopsis

2025-01-10 15:47:30
Fixture:getDensity
  • References/Game Development/LÖVE/love.physics/Fixture

Fixture:getDensity Available since LÖVE 0.8.0 This method is not supported in earlier versions. Returns the density of the fixture.

2025-01-10 15:47:30
Body:setGravityScale
  • References/Game Development/LÖVE/love.physics/Body

Body:setGravityScale Available since LÖVE 0.8.0 This method is not supported in earlier versions. Sets a new gravity scale factor for the body

2025-01-10 15:47:30
Body:setLinearDamping
  • References/Game Development/LÖVE/love.physics/Body

Body:setLinearDamping Sets the linear damping of a Body See

2025-01-10 15:47:30
Body:putToSleep
  • References/Game Development/LÖVE/love.physics/Body

Body:putToSleep Removed in LÖVE 0.8.0 This method is not supported in that and later versions. Put the body to sleep. A sleeping body

2025-01-10 15:47:30
Contact:getChildren
  • References/Game Development/LÖVE/love.physics/Contact

Contact:getChildren Available since LÖVE 0.9.0 This function is not supported in earlier versions. Gets the child indices of the shapes of the

2025-01-10 15:47:30
Shape:getChildCount
  • References/Game Development/LÖVE/love.physics/Shape

Shape:getChildCount Available since LÖVE 0.8.0 This function is not supported in earlier versions. Returns the number of children the shape

2025-01-10 15:47:30
EdgeShape:getPreviousVertex
  • References/Game Development/LÖVE/love.physics/Shape/EdgeShape

EdgeShape:getPreviousVertex Available since LÖVE 0.10.2 This function is not supported in earlier versions. Gets the vertex that establishes

2025-01-10 15:47:30
Body:getUserData
  • References/Game Development/LÖVE/love.physics/Body

Body:getUserData Available since LÖVE 0.9.1 This method is not supported in earlier versions. Returns the Lua value associated with this Body

2025-01-10 15:47:30
World:setAllowSleep
  • References/Game Development/LÖVE/love.physics/World

World:setAllowSleep Removed in LÖVE 0.8.0 This method is not supported in that and later versions. Set the sleep behaviour of the world.

2025-01-10 15:47:30