In game development, you often need to know when two objects in the game intersect or come into contact. This is known as collision detection. When a collision is detected, you typically want something to happen. This is known as collision response.
Godot offers a number of collision objects in 2D and 3D to provide both collision detection and response. Trying to decide which one to use for your project can be confusing. You can avoid problems and simplify development if you understand how each works and what their pros and cons are.
In this guide, you will learn:
Godot's four collision object types
How each collision object works
When and why to choose one type over another
This document's examples will use 2D objects. Every 2D physics object and collision shape has a direct equivalent in 3D and in most cases they work in much the same way.
Godot offers four kinds of physics bodies, extending CollisionObject2D:
Area2Dnodes provide detection and influence. They can detect when objects overlap and can emit signals when bodies enter or exit. An
Area2Dcan also be used to override physics properties, such as gravity or damping, in a defined area.
The other three bodies extend PhysicsBody2D:
A static body is one that is not moved by the physics engine. It participates in collision detection, but does not move in response to the collision. They are most often used for objects that are part of the environment or that do not need to have any dynamic behavior.
A body that provides collision detection, but no physics. All movement and collision response must be implemented in code.
Static bodies and rigid bodies can be configured to use a physics material. This allows adjusting the friction and bounce of an object, and set if it's absorbent and/or rough.
A physics body can hold any number of Shape2D objects as children. These shapes are used to define the object's collision bounds and to detect contact with other objects.
In order to detect collisions, at least one
Shape2D must be
assigned to the object.
Be careful to never scale your collision shapes in the editor.
The "Scale" property in the Inspector should remain
(1, 1). When changing
the size of the collision shape, you should always use the size handles, not
Node2D scale handles. Scaling a shape can result in unexpected
Physics process callback¶
The physics engine may spawn multiple threads to improve performance, so
it can use up to a full frame to process physics. Because of this, the value
of a body's state variables such as
may not be accurate for the current frame.
In order to avoid this inaccuracy, any code that needs to access a body's properties should
be run in the Node._physics_process()
callback, which is called before each physics step at a constant frame rate
(60 times per second by default). This method will be passed a
parameter, which is a floating-point number equal to the time passed in
seconds since the last step. When using the default 60 Hz physics update rate,
it will typically be equal to
0.01666... (but not always, see below).
It's recommended to always use the
delta parameter when relevant in your
physics calculations, so that the game behaves correctly if you change the
physics update rate or if the player's device can't keep up.
Collision layers and masks¶
One of the most powerful, but frequently misunderstood, collision features
is the collision layer system. This system allows you to build up complex
interactions between a variety of objects. The key concepts are layers
and masks. Each
CollisionObject2D has 20 different physics layers
it can interact with.
Let's look at each of the properties in turn:
This describes the layers that the object appears in. By default, all bodies are on layer
This describes what layers the body will scan for collisions. If an object isn't in one of the mask layers, the body will ignore it. By default, all bodies scan layer
These properties can be configured via code, or by editing them in the Inspector.
Keeping track of what you're using each layer for can be difficult, so you may find it useful to assign names to the layers you're using. Names can be assigned in Project Settings -> Layer Names.
You have four node types in your game: Walls, Player, Enemy, and Coin. Both Player and Enemy should collide with Walls. The Player node should detect collisions with both Enemy and Coin, but Enemy and Coin should ignore each other.
Start by naming layers 1-4 "walls", "player", "enemies", and "coins" and place each node type in its respective layer using the "Layer" property. Then set each node's "Mask" property by selecting the layers it should interact with. For example, the Player's settings would look like this:
In function calls, layers are specified as a bitmask. Where a function enables
all layers by default, the layer mask will be given as
0x7fffffff. Your code
can use binary, hexadecimal, or decimal notation for layer masks, depending
on your preference.
The code equivalent of the above example where layers 1, 3 and 4 were enabled would be as follows:
# Example: Setting mask value for enabling layers 1, 3 and 4 # Binary - set the bit corresponding to the layers you want to enable (1, 3, and 4) to 1, set all other bits to 0. # Note: Layer 20 is the first bit, layer 1 is the last. The mask for layers 4,3 and 1 is therefore 0b00000000000000001101 # (This can be shortened to 0b1101) # Hexadecimal equivalent (1101 binary converted to hexadecimal) 0x000d # (This value can be shortened to 0xd) # Decimal - Add the results of 2 to the power of (layer be enabled-1). # (2^(1-1)) + (2^(3-1)) + (2^(4-1)) = 1 + 4 + 8 = 13 pow(2, 1) + pow(2, 3) + pow(2, 4)
Area nodes provide detection and influence. They can detect when objects overlap and emit signals when bodies enter or exit. Areas can also be used to override physics properties, such as gravity or damping, in a defined area.
There are three main uses for Area2D:
Overriding physics parameters (such as gravity) in a given region.
Detecting when other bodies enter or exit a region or what bodies are currently in a region.
Checking other areas for overlap.
By default, areas also receive mouse and touchscreen input.
A static body is one that is not moved by the physics engine. It participates
in collision detection, but does not move in response to the collision. However,
it can impart motion or rotation to a colliding body as if it were moving,
StaticBody2D nodes are most often used for objects that are part of the environment
or that do not need to have any dynamic behavior.
Example uses for
Platforms (including moving platforms)
Walls and other obstacles
This is the node that implements simulated 2D physics. You do not control a RigidBody2D directly. Instead, you apply forces to it and the physics engine calculates the resulting movement, including collisions with other bodies, and collision responses, such as bouncing, rotating, etc.
You can modify a rigid body's behavior via properties such as "Mass", "Friction", or "Bounce", which can be set in the Inspector.
The body's behavior is also affected by the world's properties, as set in Project Settings -> Physics, or by entering an Area2D that is overriding the global physics properties.
When a rigid body is at rest and hasn't moved for a while, it goes to sleep. A sleeping body acts like a static body, and its forces are not calculated by the physics engine. The body will wake up when forces are applied, either by a collision or via code.
Rigid body modes¶
A rigid body can be set to one of four modes:
Rigid - The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode.
Static - The body behaves like a StaticBody2D and does not move.
Character - Similar to "Rigid" mode, but the body cannot rotate.
Kinematic - The body behaves like a KinematicBody2D and must be moved by code.
One of the benefits of using a rigid body is that a lot of behavior can be had "for free" without writing any code. For example, if you were making an "Angry Birds"-style game with falling blocks, you would only need to create RigidBody2Ds and adjust their properties. Stacking, falling, and bouncing would automatically be calculated by the physics engine.
However, if you do wish to have some control over the body, you should take
care - altering the
linear_velocity, or other physics properties
of a rigid body can result in unexpected behavior. If you need to alter any
of the physics-related properties, you should use the _integrate_forces()
callback instead of
_physics_process(). In this callback, you have access
to the body's Physics2DDirectBodyState,
which allows for safely changing properties and synchronizing them with
the physics engine.
For example, here is the code for an "Asteroids" style spaceship:
Note that we are not setting the
properties directly, but rather applying forces (
the body and letting the physics engine calculate the resulting movement.
When a rigid body goes to sleep, the
function will not be called. To override this behavior, you will
need to keep the body awake by creating a collision, applying a
force to it, or by disabling the can_sleep
property. Be aware that this can have a negative effect on performance.
By default, rigid bodies do not keep track of contacts, because this can require a huge amount of memory if many bodies are in the scene. To enable contact reporting, set the contacts_reported property to a non-zero value. The contacts can then be obtained via Physics2DDirectBodyState.get_contact_count() and related functions.
KinematicBody2D bodies detect collisions with other bodies, but are not affected by physics properties like gravity or friction. Instead, they must be controlled by the user via code. The physics engine will not move a kinematic body.
When moving a kinematic body, you should not set its
Instead, you use the
These methods move the body along a given vector, and it will instantly stop
if a collision is detected with another body. After the body has collided,
any collision response must be coded manually.
Kinematic collision response¶
After a collision, you may want the body to bounce, to slide along a wall, or to alter the properties of the object it hit. The way you handle collision response depends on which method you used to move the KinematicBody2D.
move_and_collide(), the function returns a
KinematicCollision2D object, which contains
information about the collision and the colliding body. You can use this
information to determine the response.
For example, if you want to find the point in space where the collision occurred:
Or to bounce off of the colliding object:
Sliding is a common collision response; imagine a player moving along walls
in a top-down game or running up and down slopes in a platformer. While it's
possible to code this response yourself after using
move_and_slide() provides a convenient way to implement sliding movement
without writing much code.
move_and_slide() automatically includes the timestep in its
calculation, so you should not multiply the velocity vector
For example, use the following code to make a character that can walk along the ground (including slopes) and jump when standing on the ground:
See Kinematic character (2D) for more details on using
including a demo project with detailed code.