docs.unity3d.com
    Show / Hide Table of Contents

    Class GameObjectConversionSystem

    Derive from this class to create a system that can convert GameObjects and assets into Entities. Use one of the GameObject*Group system groups with [UpdateInGroup] to select a particular phase of conversion for the system (default if left unspecified is GameObjectConversionGroup).

    Inheritance
    Object
    ComponentSystemBase
    ComponentSystem
    GameObjectConversionSystem
    Inherited Members
    ComponentSystem.PostUpdateCommands
    ComponentSystem.InitEntityQueryCache(Int32)
    ComponentSystem.Entities
    ComponentSystem.Update()
    ComponentSystem.OnUpdate()
    ComponentSystemBase.Enabled
    ComponentSystemBase.EntityQueries
    ComponentSystemBase.GlobalSystemVersion
    ComponentSystemBase.LastSystemVersion
    ComponentSystemBase.EntityManager
    ComponentSystemBase.World
    ComponentSystemBase.Time
    ComponentSystemBase.OnCreateForCompiler()
    ComponentSystemBase.OnCreate()
    ComponentSystemBase.OnStartRunning()
    ComponentSystemBase.OnStopRunning()
    ComponentSystemBase.OnDestroy()
    ComponentSystemBase.ShouldRunSystem()
    ComponentSystemBase.GetComponentTypeHandle<T>(Boolean)
    ComponentSystemBase.GetDynamicComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetBufferTypeHandle<T>(Boolean)
    ComponentSystemBase.GetSharedComponentTypeHandle<T>()
    ComponentSystemBase.GetDynamicSharedComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetEntityTypeHandle()
    ComponentSystemBase.GetComponentDataFromEntity<T>(Boolean)
    ComponentSystemBase.GetBufferFromEntity<T>(Boolean)
    ComponentSystemBase.RequireForUpdate(EntityQuery)
    ComponentSystemBase.RequireSingletonForUpdate<T>()
    ComponentSystemBase.HasSingleton<T>()
    ComponentSystemBase.GetSingleton<T>()
    ComponentSystemBase.TryGetSingleton<T>(T)
    ComponentSystemBase.SetSingleton<T>(T)
    ComponentSystemBase.GetSingletonEntity<T>()
    ComponentSystemBase.TryGetSingletonEntity<T>(Entity)
    ComponentSystemBase.GetEntityQuery(ComponentType[])
    ComponentSystemBase.GetEntityQuery(NativeArray<ComponentType>)
    ComponentSystemBase.GetEntityQuery(EntityQueryDesc[])
    Namespace: Global Namespace
    Syntax
    public abstract class GameObjectConversionSystem : ComponentSystem

    Properties

    Name Description
    BlobAssetStore
    DstEntityManager

    Methods

    Name Description
    AddHybridComponent(UnityEngine.Component)
    ConfigureEditorRenderData(Entity, GameObject, Boolean)

    Configures rendering data for picking in the editor.

    CreateAdditionalEntity(UnityEngine.Component)

    Creates an additional entity in the destination world. The entity is associated with the GameObject of the given component. New entities should be created using this method since it ensures that the resulting entities have all data required for conversion correctly set up.

    CreateAdditionalEntity(UnityEngine.Component, NativeArray<Entity>)

    Creates multiple additional entities in the destination world. The entities are associated with the GameObject of the given component. New entities should be created using this method since it ensures that the resulting entities have all data required for conversion correctly set up.

    CreateAdditionalEntity(UnityEngine.Object)

    Creates an additional entity in the destination world. The entity is associated with the given object. New entities should be created using this method since it ensures that the resulting entities have all data required for conversion correctly set up.

    CreateAdditionalEntity(UnityEngine.Object, NativeArray<Entity>)

    Creates multiple additional entities in the destination world. The entities are associated with the given object. New entities should be created using this method since it ensures that the resulting entities have all data required for conversion correctly set up.

    DeclareAssetDependency(GameObject, UnityEngine.Object)

    Declares that the conversion result of the target GameObject depends on a source asset. Any changes to the source asset should trigger a reconversion of the dependent GameObject.

    DeclareDependency(GameObject, GameObject)

    Declares that the conversion result of the target GameObject depends on another GameObject. Any changes to the dependency should trigger a reconversion of the dependent GameObject.

    DeclareDependency(GameObject, UnityEngine.Component)

    Declares that the conversion result of the target GameObject depends on another component. Any changes to the dependency should trigger a reconversion of the dependent component.

    DeclareDependency(UnityEngine.Component, UnityEngine.Component)

    Declares that the conversion result of the target Component depends on another component. Any changes to the dependency should trigger a reconversion of the dependent component.

    DeclareLinkedEntityGroup(GameObject)

    Adds a LinkedEntityGroup to the primary Entity of this GameObject for all Entities that are created from this GameObject and its descendants. As a result, EntityManager.Instantiate and EntityManager.SetEnabled will work on those Entities as a group.

    DeclareReferencedAsset(UnityEngine.Object)

    DeclareReferencedAsset includes the referenced asset in the conversion process. Once it has been declared, you can use GetPrimaryEntity to find the Entity for the asset. This Entity will also be tagged with the Asset component.

    DeclareReferencedPrefab(GameObject)

    DeclareReferencedPrefab includes the referenced Prefab in the conversion process. Once it has been declared, you can use GetPrimaryEntity to find the Entity for the Prefab. If the object is a Prefab, all Entities in it will be made part of a LinkedEntityGroup, thus Instantiate will clone the whole group. All Entities in the Prefab will also be tagged with the Prefab component thus will not be picked up by an EntityQuery by default.

    ForkSettings(Byte)

    Extremely specialized use that is a (hopefully) temporary workaround our inability to generate multiple prefabs into the same World from the same source. Temporary because we want to switch to BlobAsset prefabs, but until then we need a way to avoid duplication of EntityGuids for these multiple prefabs. So we reserve space for a "namespace ID" in the EntityGuid, where if nonzero it is up to the developer to manage.

    GetEntities(UnityEngine.Component)

    Returns all entities in the destination world that are associated with the GameObject of the given component. This includes the primary entity associated with the object as well as all additional entities that were associated with this object. The first entity returned by the enumerator is the primary entity.

    GetEntities(UnityEngine.Object)

    Returns all entities in the destination world that are associated with the given object. This includes the primary entity associated with the object as well as all additional entities that were associated with this object. The first entity returned by the enumerator is the primary entity.

    GetGuidForAssetExport(UnityEngine.Object)
    GetPrimaryEntity(UnityEngine.Component)

    Returns the primary entity associated with the given GameObject of the given component. This entity is from the destination world.

    GetPrimaryEntity(UnityEngine.Object)

    Returns the primary entity associated with the given object. This entity is from the destination world.

    GetSceneSectionEntity(Entity)

    Gets the entity representing the scene section of the entity passed in, the section entity is created if it doesn't already exist. Metadata components added to this section entity will be serialized into the entity scene header. At runtime these components will be added to the scene section entities when the scene is resolved. Only struct IComponentData components without BlobAssetReferences or Entity members are supported.

    HasPrimaryEntity(UnityEngine.Component)

    Returns true if the GameObject owning component is included in the set of converted objects.

    HasPrimaryEntity(UnityEngine.Object)

    Returns true if the uobject is included in the set of converted objects.

    OnCreate()
    TryCreateAssetExportWriter(UnityEngine.Object)
    TryGetPrimaryEntity(UnityEngine.Component)
    TryGetPrimaryEntity(UnityEngine.Object)

    Extension Methods

    ComponentSystemBaseManagedComponentExtensions.HasSingleton<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.GetSingleton<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.SetSingleton<T>(ComponentSystemBase, T)
    JobForEachExtensions.GetEntityQueryForIJobForEach(ComponentSystemBase, Type)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023