Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

World.GetExistingSystemManaged

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public T GetExistingSystemManaged();

Returns

T The existing instance of system type T in this World. If no such instance exists, the method returns null.

Description

Return an existing instance of a system of type T in this World.

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 World.GetExistingSystem 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


Declaration

public ComponentSystemBase GetExistingSystemManaged(Type type);

Parameters

Parameter Description
type The system type

Returns

ComponentSystemBase The existing instance of system type type in this World. If no such instance exists, the method returns null.

Description

Return an existing instance of a system of type type in this World. Prefer the version that takes a SystemTypeIndex where possible to avoid unnecessary reflection.

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 World.GetExistingSystem 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


Declaration

public ComponentSystemBase GetExistingSystemManaged(SystemTypeIndex type);

Parameters

Parameter Description
type The system type

Returns

ComponentSystemBase The existing instance of system type type in this World. If no such instance exists, the method returns null.

Description

Return an existing instance of a system of type type in this World. This avoids unnecessary reflection.

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 World.GetExistingSystem 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