Documentation

Unity Engine


Unity Engine


CreateSingleton

Creates and supports only a single entity with a given unmanaged component.
Read time 1 minuteLast updated 3 days ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

CreateSingleton<T>(FixedString64Bytes)

Creates and supports only a single entity with a given unmanaged component.
public Entity CreateSingleton<T>(FixedString64Bytes name = default) where T : unmanaged, IComponentData

Parameters

The debug friendly name associated with the singleton component entity.

Returns

Type

Description

EntityThe Entity object that you can use to access the singleton component entity.

Remarks

Note that while zero-size component may be created, they can not be accessed directly in code. They are only usable for situations such as in calling ComponentSystemBase.RequireForUpdate.

CreateSingleton<T>(T, FixedString64Bytes)

Creates and supports only a single entity with a given unmanaged component.
public Entity CreateSingleton<T>(T componentData, FixedString64Bytes name = default) where T : unmanaged, IComponentData

Parameters

componentData

T
The data to assign to the singleton component.

The debug friendly name associated with the singleton component entity.

Returns

Type

Description

EntityThe Entity object that you can use to access the singleton component entity.

Remarks

Note that while zero-size component may be created, they can not be accessed directly in code. They are only usable for situations such as in calling ComponentSystemBase.RequireForUpdate.