Official 2D Entities 0.29 is now available

2D Entities 0.29 is out! This release is designed to work with Tiny 0.29 and requires Unity 2020.1.0f1 or newer

Important Note: This release is targeted for Tiny 0.29 only. This means that it will not work with other versions of Tiny at this time. See this post for more information on what’s new in Tiny 0.29.

What's in 2D Entities

This is a foundational set of 2D features. As such it is focused on supporting basic rendering of sprites and collision detection in 2D.

Rendering

• Sprite
• Sprite Renderer
• Sprite Atlas
• Runtime 2D rendering pipeline
• Editor 2D rendering pipeline

Physical Collision Detection

• Primitive colliders
• Compound collider
• Rigidbody2D
• Physics broadphase
• Broadphase querying API

Playable Demos

Play Tiny Gems


Play Tiny Spaceship

Getting Started
Here's a preconfigured project to get you started quickly:
2D Entities Starter

Samples:
The source projects for the playable demos above are also available for you to explore. Find them here:
Project Tiny Samples
For this release the 2D Entities starter project and the sample projects have been upgraded to Unity 2020.1 and use 2D Entities 0.29.

Documentation:
For more detailed instructions on how to use 2D entities see the package docs here:
2D Entities Package Docs
In this version we have added the following information:

• A 2D specific Getting Started section
• What gets converted and how
• An FAQ

Please share your experience with the tools by replying to this post or creating a new one. How does this feature help you achieve your desired outcomes? What works as expected? And what doesn’t? We’re excited to hear back from you!

We will be curating answers to frequently asked questions in the discussion.

 

Known Issues

• In the editor, the audio will not be played when triggered
• You have to keep the Main Camera SubScene open in Edit mode at all times to see anything being rendered in the GameView window
• There is a max string length to the build path
• Sharing assets between SubScenes is currently not supported
• Adding spaces in the Build Settings filename will cause the build pipeline to fail building
• In the editor during Play Mode, the Scene View will not visualise the contents of a SubScene correctly, if the SubScene is in Edit Mode.
• You must decorate your converter with the ConverterVersion attribute. You should increment the version number every time you change the converter.
• Batching results will differ between editor and Project Tiny builds because they don't share the same render pipeline.
• When minimizing and resuming an android application, the application will reboot.

 

Hello @unity_Nb9eavDsBsU7WQ,
Thank you for your feedback!

Regarding collision response, this is a feature we are currently developing and will release in a future version of 2D Entities.

 

2D and 3D can be rendered together, however 2D will always be rendered on top of 3D content (this includes 3D Text).

To render 3D, you need to use a project with the Universal Rendering Pipeline (URP). The easiest way to set everything up is to start by using Tiny3D and then add the 2D Entities package into the Tiny3D project.

In the Tiny3D root assembly, be sure to add the following assemblies, to pull in the 2D rendering pipeline into the Tiny executable

 

@Thaina the 2D Entities package contains the following features:

Rendering

• Sprite
• Sprite Renderer
• Sprite Atlas
• Runtime 2D rendering pipeline
• Editor 2D rendering pipeline

Physical Collision Detection

• Primitive colliders
• Compound collider
• Rigidbody2D
• Physics broadphase
• Broadphase querying API

The Tiny packages contains 3D text rendering, however, there is no UI solution for Project Tiny yet.
For an overview of what features Project Tiny contains, see the Feature status summary.

 

So is there no LTS support with this package?

 

@JamesArndt, no, there is no LTS support for this package. 2D Entities is still in an experimental phase where many of our foundational systems are being worked on. Once the development of the package stabilises, we will start supporting the package for long term usage. This is one of the reason why we do not advice to use the current version of 2D Entities in projects that are either live, or are aiming to go live in the near future.

 

Okay, awesome. Thank you for the response.

 

@dannyalgorithmic since the 2D Entities public (and internal) API might change before we release the first verified version of the package, we will not create learn tutorials yet. We do however have a few examples in our package docs. We will make sure we always have a few examples in the package docs to explain general concepts within the package, using the latest API.
If you find areas where we either haven't explained the concept properly, or not at all, do let us know and we will make sure to add it into the package docs.

 

@dannyalgorithmic,
So there are two things to highlight in your code:
1. The

OverlapColliderInput

also requires the colliders transform, so that the check knows there the collider is located. I saw that this is not noted in our docs, so I will make sure we add it in there in the next update.
2. You are using

.Schedule

, which means that you are trying to multithread this job. In Tiny 0.29, multithreading is not supported, so you will not get any performance benefits from using

.Schedule

vs.

.Run

. However, if you do want to "future proof" your collision code, or just try out the multithreading in the editor, I'll leave the code for multithreading as well (it is a little bit different than running it on the main thread).

Main threaded collision check:

Code (CSharp):

1. using Unity.Entities;
2. using Unity.U2D.Entities.Physics;
3. using Unity.Transforms;
4.  
5. public class CollisionSystem : SystemBase
6. {
7.     protected override void OnUpdate()
8.     {
9.         var physicsWorld = World.GetExistingSystem<PhysicsWorldSystem>().PhysicsWorld;
10.         Entities
11.             .ForEach((
12.                 in Entity colliderEntity,
13.                 in PhysicsColliderBlob blob,
14.                 in Translation translation,
15.                 in Rotation rotation) =>
16.             {
17.                 var colliderInput = new OverlapColliderInput()
18.                 {
19.                     Collider = blob.Collider,
20.                     Filter = CollisionFilter.Default,
21.                     Transform = new PhysicsTransform(translation.Value, rotation.Value)
22.                 };
23.                 if (physicsWorld.OverlapCollider(colliderInput, out var hit))
24.                 {
25.                     if(colliderEntity == hit.Entity)
26.                         UnityEngine.Debug.Log("Hit itself");
27.                     else
28.                         UnityEngine.Debug.Log($"Hit entity={hit.Entity.Index}");
29.                 }
30.             }).Run();
31.     }
32. }

Multi-threaded collision check:

Code (CSharp):

1. using Unity.Entities;
2. using Unity.U2D.Entities.Physics;
3. using Unity.Transforms;
4.  
5. using Unity.Jobs;
6.  
7. public class CollisionSystem : SystemBase
8. {
9.     protected override void OnUpdate()
10.     {
11.         var physicsWorldSystem = World.GetExistingSystem<PhysicsWorldSystem>();
12.        
13.         // Create a callback that is performed after the physics system has finished its frame calculations
14.         physicsWorldSystem.ScheduleCallback(PhysicsCallbacks.Phase.PostExport,
15.             (ref PhysicsWorld world, JobHandle deps) =>
16.             {
17.                 // Capture the Physics world variable, since you cant bring any references into a job
18.                 var capturedWorld = world;
19.                 deps = Entities
20.                     .WithReadOnly(capturedWorld)
21.                     .ForEach((
22.                     in Entity colliderEntity,
23.                     in PhysicsColliderBlob blob,
24.                     in Translation translation,
25.                     in Rotation rotation) =>
26.                 {
27.                     var colliderInput = new OverlapColliderInput()
28.                     {
29.                         Collider = blob.Collider,
30.                         Filter = CollisionFilter.Default,
31.                         Transform = new PhysicsTransform(translation.Value, rotation.Value)
32.                     };
33.                     if (capturedWorld.OverlapCollider(colliderInput, out var hit))
34.                     {
35.                         if(colliderEntity == hit.Entity)
36.                             UnityEngine.Debug.Log("Hit itself");
37.                         else
38.                             UnityEngine.Debug.Log($"Hit entity={hit.Entity.Index}");
39.                     }
40.        
41.                 }).Schedule(deps);
42.        
43.                 return deps;
44.             });
45.     }
46. }

Let me know if these code chunks and explanation solves your issue!

 

Multithreading is available for all supported build targets.
To enable Multithreading, click on the “+” sign at the bottom of the Build Configuration inspector and add the DotsRuntimeScriptingSettings component.

Then you can check “Enable Multithreading”.
Note that Multithreading is not supported on Safari. One way to workaround is to set multithreading on in the Common build configuration inherited by others, and then create a specific WASM build configuration for Safari. The web template loading the build will have to be changed to select the correct build (we are doing some work to enable/document web template customization).

In the future, we plan to add an automatic fallback to Single threading for Safari and do more work on Burst to improve web performance and size.

Note, due to the nature of how multithreading is supported in the DOTS Runtime Tiny configuration, enabling Multithreading will automatically enable Burst Compilation as well. It is not possible to have multithreading enabled without burst compilation enabled in DOTS Runtime unless building for the non-Tiny configuration, Net Standard 2.0 on desktop.

Hope this helps!
JC

 

Well sorry it's confusing. Builds with Multithreading compiles & runs but we haven't completed all optimization & stabilization work. You might not see yet real performance improvements, and feel free to share any issue you discover.

 

@Luxxuor could you share with us how you are using the physics feature set?