Class SystemAPI.ManagedAPI
The managed half of SystemAPI. It's exactly what you'd expect.
Managed versions of API found in SystemAPI, that only runs on main thread.
You can use this in ISystem and SystemBase.
Inheritance
SystemAPI.ManagedAPI
Assembly: Unity.Entities.dll
Syntax
public static class SystemAPI.ManagedAPI
Methods
Name |
Description |
GetComponentTypeHandle<T>(bool)
|
Gets the run-time type information required to access an array of component data in a chunk.
|
GetComponent<T>(Entity)
|
Look up the value of a component for an entity.
|
GetComponent<T>(SystemHandle)
|
Gets the value of a component for an entity associated with a system.
|
GetSharedComponentTypeHandle<T>()
|
Gets the run-time type information required to access a shared component data in a chunk.
|
GetSingletonEntity<T>()
|
Gets the Entity instance for a singleton.
|
GetSingleton<T>()
|
Gets the value of a singleton component.
|
HasComponent<T>(Entity)
|
Checks whether an entity has a specific type of component.
|
HasComponent<T>(SystemHandle)
|
Checks whether an entity associated with a system has a specific type of component.
|
HasSingleton<T>()
|
Checks whether a singleton component of the specified type exists.
|
IsComponentEnabled<T>(Entity)
|
Checks whether the IComponentData of type T is enabled on the specified Entity.
For the purposes of EntityQuery matching, an entity with a disabled component will behave as if it does not
have that component. The type T must implement the IEnableableComponent interface.
|
IsComponentEnabled<T>(SystemHandle)
|
Checks whether the IComponentData of type T is enabled on the specified system using a SystemHandle.
For the purposes of EntityQuery matching, a system with a disabled component will behave as if it does not
have that component. The type T must implement the IEnableableComponent interface.
|
SetComponentEnabled<T>(Entity, bool)
|
Enable or disable the IComponentData of type T on the specified Entity. This operation
does not cause a structural change (even if it occurs on a worker thread), or affect the value of the component.
For the purposes of EntityQuery matching, an entity with a disabled component will behave as if it does not
have that component. The type T must implement the IEnableableComponent interface.
|
SetComponentEnabled<T>(SystemHandle, bool)
|
Enable or disable the IComponentData of type T on the specified system using a SystemHandle. This operation
does not cause a structural change (even if it occurs on a worker thread), or affect the value of the component.
For the purposes of EntityQuery matching, a system with a disabled component will behave as if it does not
have that component. The type T must implement the IEnableableComponent interface.
|
TryGetSingletonEntity<T>(out Entity)
|
Gets the singleton Entity, and returns whether or not a singleton Entity of the specified type exists in the World.
|
TryGetSingleton<T>(out T)
|
Gets the value of a singleton component, and returns whether or not a singleton component of the specified type exists in the World.
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.