docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method TryGetComponent

    TryGetComponent<T>(Entity, out T)

    Try to look up the value of a component for an entity.

    Declaration
    public static bool TryGetComponent<T>(Entity entity, out T result) where T : unmanaged, IComponentData
    Parameters
    Type Name Description
    Entity entity

    The entity.

    T result

    A struct of type T containing the component value, or default if the entity does not have the component.

    Returns
    Type Description
    bool

    True if the entity has the component, false otherwise.

    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.

    Exceptions
    Type Condition
    ArgumentException

    Thrown if the component type has no fields.

    In This Article
    Back to top
    Copyright © 2025 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)