docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method GetComponentRO

    GetComponentRO<T>(Entity)

    Gets a reference to a component for an entity, for read-only access.

    Declaration
    public static RefRO<T> GetComponentRO<T>(Entity entity) where T : unmanaged, IComponentData
    Parameters
    Type Name Description
    Entity entity

    The entity.

    Returns
    Type Description
    RefRO<T>

    A read/write reference to component T.

    Type Parameters
    Name Description
    T

    The type of component to retrieve.

    Remarks

    Use this method to look up data in another entity using its Entity object. For example, if you have a component that contains an Entity field, you can look up the component data for the referenced entity using this method.

    When iterating over a set of entities via IJobEntity or Query<T1>(), do not use this method to access data of the current entity in the set. This function is much slower than accessing the data directly (by passing the component containing the data to your lambda iteration function as a parameter).

    When you call this method it gets replaced with component access methods through ComponentLookup<T>.

    This lookup method results in a slower, indirect memory access. When possible, organize your data to minimize the need for indirect lookups.

    Exceptions
    Type Condition
    ArgumentException

    Thrown if the component type has no fields.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)