Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 7.33 KB

File metadata and controls

79 lines (61 loc) · 7.33 KB

ECS Cheat Sheet

Here is a quick reference of the common classes, interfaces, structs, and attributes that have been introduced in this documentation by ECS, Burst compiler and the C# job system. Click the links below for more information from the Unity Manual and Scripting API.

Note: This is not an exhaustive list and can be added to over time as ECS, and its related documentation, expands. Check the ECSJobDemo code and the Scripting API under the namespaces mentioned below for more examples.

C# job system related

Note: These can also be used by ECS code, but they are part of the main Unity 2018.1 release and not part of the ECS packages.

Namespace Name Type
Unity.Collections NativeArray Struct
Unity.Collections NativeContainer Unsafe Class
Unity.Collections NativeSlice Struct
Unity.Jobs IJob Interface
Unity.Jobs IJobParallelFor Interface
Unity.Jobs JobHandle Interface
Unity.Jobs JobsUtility Unsafe Class

Attributes

ECS related

Namespace Name Type
Unity.Collections NativeHashMap Unsafe Struct
Unity.Collections NativeList Unsafe Struct
Unity.Collections NativeQueue Unsafe Struct
Unity.Entities ComponentDataArray Unsafe Struct
Unity.Entities ComponentDataFromEntity Unsafe Struct
Unity.Entities ComponentGroup Unsafe Class
Unity.Entities ComponentSystem - ECS Docs Abstract Class
Unity.Entities ComponentType Struct
Unity.Entities Entity Struct
Unity.Entities EntityArchetype Unsafe Struct
Unity.Entities EntityCommandBuffer Unsafe Struct
Unity.Entities EntityManager Unsafe Class
Unity.Entities ExclusiveEntityTransaction Unsafe Struct
Unity.Entities GameObjectEntity Class
Unity.Entities IComponentData - ECS Docs Interface
Unity.Entities IJobProcessComponentData Interface
Unity.Entities ISharedComponentData - ECS Docs Interface
Unity.Entities JobComponentSystem Abstract Class
Unity.Entities World Class
Unity.Jobs IJobParallelForBatch Interface
Unity.Jobs IJobParallelForFilter Interface
Unity.Rendering MeshInstanceRendererComponent Class
Unity.Transforms PositionComponent Class
Unity.Transforms CopyInitialTransformFromGameObjectComponent Class
Unity.Transforms TransformMatrixComponent Class

Attributes

  • [Inject]

Unsafe attributes

Other

  • #if ENABLE_UNITY_COLLECTIONS_CHECKS ... #endif

Burst compiler related

Attributes