Class ComponentGroup | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class ComponentGroup

    Inheritance
    System.Object
    ComponentGroup
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Unity.Entities
    Syntax
    public class ComponentGroup : IDisposable

    Properties

    IsEmptyIgnoreFilter

    Declaration
    public bool IsEmptyIgnoreFilter { get; }
    Property Value
    Type Description
    System.Boolean

    Types

    Declaration
    public ComponentType[] Types { get; }
    Property Value
    Type Description
    ComponentType[]

    Methods

    AddDependency(JobHandle)

    Declaration
    public void AddDependency(JobHandle job)
    Parameters
    Type Name Description
    JobHandle job

    CalculateLength()

    Declaration
    public int CalculateLength()
    Returns
    Type Description
    System.Int32

    CompareComponents(ComponentType[])

    Declaration
    public bool CompareComponents(ComponentType[] componentTypes)
    Parameters
    Type Name Description
    ComponentType[] componentTypes
    Returns
    Type Description
    System.Boolean

    CompleteDependency()

    Declaration
    public void CompleteDependency()

    CreateForEachFilter<SharedComponent1>(List<SharedComponent1>)

    Declaration
    public ForEachComponentGroupFilter CreateForEachFilter<SharedComponent1>(List<SharedComponent1> sharedComponent1)where SharedComponent1 : struct, ISharedComponentData
    Parameters
    Type Name Description
    List<SharedComponent1> sharedComponent1
    Returns
    Type Description
    ForEachComponentGroupFilter
    Type Parameters
    Name Description
    SharedComponent1

    Dispose()

    Declaration
    public void Dispose()
    Implements
    System.IDisposable.Dispose()

    GetCombinedComponentOrderVersion()

    Declaration
    public int GetCombinedComponentOrderVersion()
    Returns
    Type Description
    System.Int32

    GetComponentDataArray<T>()

    Declaration
    public ComponentDataArray<T> GetComponentDataArray<T>()where T : struct, IComponentData
    Returns
    Type Description
    ComponentDataArray<T>
    Type Parameters
    Name Description
    T

    GetComponentDataArray<T>(ForEachComponentGroupFilter, Int32)

    Declaration
    public ComponentDataArray<T> GetComponentDataArray<T>(ForEachComponentGroupFilter filter, int filterIdx)where T : struct, IComponentData
    Parameters
    Type Name Description
    ForEachComponentGroupFilter filter
    System.Int32 filterIdx
    Returns
    Type Description
    ComponentDataArray<T>
    Type Parameters
    Name Description
    T

    GetDependency()

    Declaration
    public JobHandle GetDependency()
    Returns
    Type Description
    JobHandle

    GetEntityArray()

    Declaration
    public EntityArray GetEntityArray()
    Returns
    Type Description
    EntityArray

    GetEntityArray(ForEachComponentGroupFilter, Int32)

    Declaration
    public EntityArray GetEntityArray(ForEachComponentGroupFilter filter, int filterIdx)
    Parameters
    Type Name Description
    ForEachComponentGroupFilter filter
    System.Int32 filterIdx
    Returns
    Type Description
    EntityArray

    GetFixedArrayArray<T>()

    Declaration
    public FixedArrayArray<T> GetFixedArrayArray<T>()where T : struct
    Returns
    Type Description
    FixedArrayArray<T>
    Type Parameters
    Name Description
    T

    GetSharedComponentDataArray<T>()

    Declaration
    public SharedComponentDataArray<T> GetSharedComponentDataArray<T>()where T : struct, ISharedComponentData
    Returns
    Type Description
    SharedComponentDataArray<T>
    Type Parameters
    Name Description
    T

    ResetFilter()

    Declaration
    public void ResetFilter()

    SetFilter(NativeArray<Int32>)

    Declaration
    public void SetFilter(NativeArray<int> indexList)
    Parameters
    Type Name Description
    NativeArray<System.Int32> indexList

    SetFilter<SharedComponent1>(SharedComponent1)

    Declaration
    public void SetFilter<SharedComponent1>(SharedComponent1 sharedComponent1)where SharedComponent1 : struct, ISharedComponentData
    Parameters
    Type Name Description
    SharedComponent1 sharedComponent1
    Type Parameters
    Name Description
    SharedComponent1

    SetFilter<SharedComponent1, SharedComponent2>(SharedComponent1, SharedComponent2)

    Declaration
    public void SetFilter<SharedComponent1, SharedComponent2>(SharedComponent1 sharedComponent1, SharedComponent2 sharedComponent2)where SharedComponent1 : struct, ISharedComponentData where SharedComponent2 : struct, ISharedComponentData
    Parameters
    Type Name Description
    SharedComponent1 sharedComponent1
    SharedComponent2 sharedComponent2
    Type Parameters
    Name Description
    SharedComponent1
    SharedComponent2

    SetFilterChanged(ComponentType)

    Declaration
    public void SetFilterChanged(ComponentType componentType)
    Parameters
    Type Name Description
    ComponentType componentType

    SetFilterChanged(ComponentType[])

    Declaration
    public void SetFilterChanged(ComponentType[] componentType)
    Parameters
    Type Name Description
    ComponentType[] componentType

    SetFilterChangedRequiredVersion(UInt32)

    Declaration
    public void SetFilterChangedRequiredVersion(uint requiredVersion)
    Parameters
    Type Name Description
    System.UInt32 requiredVersion
    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