Choose your operating system:
Windows
macOS
Linux
Just like other types of geometry, such as Static Meshes, Skeletal Meshes, etc., Sprites can define shapes that are used to calculate collisions with other geometry in the world.
Collision Domain
The method used for calculating collision is defined using the Sprite Collision Domain property. There are three different settings:
|
Collision Type |
Description |
|---|---|
|
None |
No collision geometry is generated; use this for purely decorative sprites. |
|
Use 2D Physics |
This is an experimental option to generate collision geometry for use with Box2D. See 2D Collision for more information on the current limitations. |
|
Use 3D Physics |
Collision geometry will be generated for use with PhysX. The 2D collision geometry defined in the sprite will be extruded using the Collision Thickness units deep in the perpendicular axis to make 3D collision geometry. |
Collision Geometry
The Geometry Type setting on collision geometry specifies the type of calculation to use for generating the collision
-
The following settings are available:
|
Type |
Description |
|---|---|
|
Source Bounding Box |
Uses the bounding box of the
Source Region
|
|
Tight Bounding Box |
|
|
Shrink Wwrapped |
(
Experimental
|
|
Fully Custom |
|
|
Diced |
Split up into smaller squares, including only no-empty ones in the final geometry. |
The Edit Collision mode displays the collision geometry and lets you adjust it in the viewport, automatically setting the mode to fully custom.
The toolbar buttons can be used to add additional polygons or snap vertices to the pixel grid. New vertices can be added by selecting an edge and Shift+clicking and selected vertices can be deleted by pressing Delete .
2D Collision
There is an initial experimental integration of Box2D 2.3.1 and various associated changes to enable 2D physics in the
-
This is a totally unsupported and undocumented prototype, exercise great caution and do not use in production. The current build only includes precompiled libraries of Box2D for Win32 and Win64, so 2D collision will not work on other platforms. Collision detection and response is automatic when the 2D domain is selected in a sprite, but queries like point traces must be separately enabled in the Physics project settings (bEnable2DPhysics option).
The integration supports collision detection and response (including Unreal collision channels/filtering), rigid body simulation, and ray casts. Non-zero extent queries, sweep tests, and overlap tests are not implemented yet. Things like CharacterMovementComponent and MoveComponent with bSweep=true rely on these sorts of queries and do not work correctly yet.
The long term integration strategy is to make it a first class citizen, where the same techniques and knowledge used in 3D scenes will directly apply to 2D scenes; for example, there'll only be one Overlap event, not a separate 2D and 3D
-
3D raycasts are already implemented for Box2D and you can both trace 'in-plane' (gameplay traces within the 2D 'world') or 'perpendicular to plane' (things like the Touch input trace to determine the object under your finger / mouse cursor), providing a proper hit result location and normal as well.