To enable collisions between a 3D model and users of your scene, you must create a new object to serve as a collider. Without a collider, users are able to walk through models as if they weren’t there. For performance reasons, colliders usually have a much simpler geometry than the model itself.
Colliders currently don’t affect how models and entities interact with each other, they can always overlap. Colliders only affect how the model interacts with the user’s avatar.
For an object to be recognized by a Decentraland scene as a collider, all it needs is to be named in a certain way. The object’s name must include the the suffix “_collider” at the end.
For example, to create a collider for a tree, you can create a simple box object surrounding its trunk. Users of the scene won’t see this box, but it will block their path.
In this case, we can name the box “BoxTree_collider” and export both the tree and the box as a single _gltf model. The _collider tag alerts the Decentraland world engine that the box object belongs to the collection of colliders, making the _collider mesh invisible.
Whenever a player views the tree model in your scene, they will see the complex model for your tree. However, when they walk into your tree, they will collide with the box, not the tree.
Add a collider to a staircase
Stairs are a very common use-case for collider objects. In order for users to climb stairs, there must be a corresponding _collider object that the users are able to step on.
We recommend using a ramp object for your stair colliders, this provides a much better experience when walking up or down. When they climb up your stairs, it will appear as a smooth ascent or descent, instead of requiring them to “jump” up each individual step.
Using a ramp object also avoids creating unnecessary geometry, saving room for other more complicated models. Keep in mind that collider geometry is also taken into account when calculating the scene limitations
Create a new object in the shape of a ramp that resembles the size and proportions of the original stairs.
Name the ramp object something similar to stairs_collider. It must end in _collider.
Overlay the ramp object to the stairs so that they occupy the same space.
Export both objects together as a single glTF model.
Now when users view the stairs in your scene, they’ll see the more elaborate model of the stairs, but when they climb them, they’ll collide with the ramp.
Best practices with colliders
- Always use the smallest number of triangles possible when creating colliders. Avoid making a copy of a complex object to use as a collider. Simple colliders guarantee a good user-experience in and keep your scene within the triangle limitations.
- Collider objects shouldn’t have any material, as users of your scene will never see it. Colliders are invisible to users.
Note: Remember that each scene is limited to log2(n+1) x 10000 triangles, where n is the number of parcels in your scene.
- All collider objects names must end with _collider. For example, tree_collider.
If you use a plane as a collider, it will only block in one direction. If you want colliders to block from both sides, for example for a wall, you need to create two planes with their normals facing in opposite directions.
When duplicating collider objects, pay attention to their names. Some programs append a _1 to the end of the filename to avoid duplicates, for example tree_collider_1. Objects that are named like this will be interpreted by the Decentraland World Engine as normal objects, not colliders.
To view the limits of all collider meshes in a Decentraland scene, launch your scene preview with
dcl startand then click
c. This draws blue lines that delimit all colliders in place.
- You can avoid adding a collider mesh if you add an invisible primitive shape that overlaps to your 3D model in your scene. Primitive shapes have collisions on by default. For example, an entity with a BoxShape() component, and its
visibleproperty set to false can do the trick.