cheatsheet.md

Capsicum cheat sheet

Here is a quick reference of the most useful classes, interfaces, structs, and attributes that have been introduced in this documentation by ECS, the C# Job System, and the Burst compiler.

Note: This is not an exhaustive list and can be added to over time as Capsicum, and its related documentation, expands. Check the repository code and the Scripting API under the namespaces mentioned below for more examples. Be aware that links can break as the code evolves, so if you notice a problem let us know in the forums or as an issue in the repository.

ECS related

Namespace	Name	Type
Unity.Collections	NativeHashMap	Unsafe Struct
Unity.Collections	NativeList	Unsafe Struct
Unity.Collections	NativeQueue	Unsafe Struct
Unity.Entities	Chunk	Unsafe Struct
Unity.Entities	ComponentDataArray	Unsafe Struct
Unity.Entities	ComponentDataFromEntity	Unsafe Struct
Unity.Entities	ComponentGroup	Unsafe Class
Unity.Entities	ComponentSystem	Abstract Class
Unity.Entities	ComponentType	Struct
Unity.Entities	DynamicBuffer	Unsafe 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	Interface
Unity.Entities	IJobProcessComponentData	Interface
Unity.Entities	ISharedComponentData	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	TransformSystem	Class

Attributes

• [Inject]

Unsafe attributes

• [NativeContainer]
• [NativeContainerIsAtomicWriteOnly]
• [NativeContainerSupportsMinMaxWriteRestriction]
• [NativeContainerSupportsDeallocateOnJobCompletion]
• [NativeDisableUnsafePtrRestriction]
• [NativeSetClassTypeToNullOnSchedule]

Other

• #if ENABLE_UNITY_COLLECTIONS_CHECKS ... #endif

C# Job System related

Note: ECS code can also use the following objects, but they are part of the Unity codebase since 2018.1 and not part of any related packages. For more information, see the C# Job System manual.

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

• [ReadOnly]
• [WriteOnly]

Burst compiler related

Attributes

• [BurstDiscard]
• [BurstCompile]