Method GetOrCreateSystemManaged
GetOrCreateSystemManaged<T>()
Retrieve the instance of a system of type T from the current World. If the system
does not exist in this World, it will first be created.
Declaration
public T GetOrCreateSystemManaged<T>() where T : ComponentSystemBaseReturns
| Type | Description |
|---|---|
| T | The instance of system type |
Type Parameters
| Name | Description |
|---|---|
| T | The system type |
Remarks
Important: This function creates a sync point if a system is created, which means that the EntityManager waits for all currently running Jobs to complete before creating the system, and no additional Jobs can start before the function is finished. A sync point can cause a drop in performance because the ECS framework may not be able to make use of the processing power of all available cores.
Note: This system reference is not guaranteed to be safe to use. If the system or world is destroyed then the OnDestroy and cleanup functionality will have been called for this system.
If possible, using GetOrCreateSystem(Type) is preferred, and instead of public member data, component data is recommended for system level data that needs to be shared between systems or externally to them. This defines a data protocol for the system which is separated from the system functionality.
Private member data which is only used internally to the system is recommended.
Keep in mind using a managed reference for systems
- encourages coupling of data and functionality
- couples data to the system type with no direct path to decouple
- does not provide lifetime or thread safety guarantees for data access
- does not provide lifetime or thread safety guarantees for system access through the returned managed reference
GetOrCreateSystemManaged(Type)
Retrieve the instance of a system of type type from the current World. If the system
does not exist in this World, it will first be created.
Declaration
public ComponentSystemBase GetOrCreateSystemManaged(Type type)Parameters
| Type | Name | Description |
|---|---|---|
| Type | type | The system type |
Returns
| Type | Description |
|---|---|
| ComponentSystemBase | The instance of system type |
Remarks
Important: This function creates a sync point if a system is created, which means that the EntityManager waits for all currently running Jobs to complete before creating the system, and no additional Jobs can start before the function is finished. A sync point can cause a drop in performance because the ECS framework may not be able to make use of the processing power of all available cores.
Note: This system reference is not guaranteed to be safe to use. If the system or world is destroyed then the OnDestroy and cleanup functionality will have been called for this system.
If possible, using GetOrCreateSystem(Type) is preferred, and instead of public member data, component data is recommended for system level data that needs to be shared between systems or externally to them. This defines a data protocol for the system which is separated from the system functionality.
Private member data which is only used internally to the system is recommended.
Keep in mind using a managed reference for systems
- encourages coupling of data and functionality
- couples data to the system type with no direct path to decouple
- does not provide lifetime or thread safety guarantees for data access
- does not provide lifetime or thread safety guarantees for system access through the returned managed reference
GetOrCreateSystemManaged(SystemTypeIndex)
Retrieve the instance of a system of type type from the current World. If the system
does not exist in this World, it will first be created.
Declaration
public ComponentSystemBase GetOrCreateSystemManaged(SystemTypeIndex type)Parameters
| Type | Name | Description |
|---|---|---|
| SystemTypeIndex | type | The system type |
Returns
| Type | Description |
|---|---|
| ComponentSystemBase | The instance of system type |