docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Filtering data

    You can filter the data in an Entities.ForEach expression, either by change, or by shared component.

    Change filtering

    You can use WithChangeFilter<T> to enable change filtering, which processes components only if another component in the entity has changed since the last time the current SystemBase instance has run. The component type in the change filter must either be in the lambda expression parameter list, or part of a WithAll<T> statement. For example:

    
    Entities
        .WithChangeFilter<Source>()
        .ForEach((ref Destination outputData,
            in Source inputData) =>
            {
                /* Do work */
            })
        .ScheduleParallel();
    

    An entity query supports change filtering on up to two component types.

    Unity applies change filtering at the archetype chunk level. If any code accesses a component in a chunk that has write access, then Unity marks that component type in that archetype chunk as changed, even if the code didn’t change any data.

    Shared component filtering

    Unity groups entities with shared components into chunks with other entities that have the same value for their shared components. To select groups of entities that have specific shared component values, use the WithSharedComponentFilter method.

    The following example selects entities grouped by a Cohort ISharedComponentData. The lambda expression in this example sets a DisplayColor IComponentData component based on the entity’s cohort:

    
    [RequireMatchingQueriesForUpdate]
    public partial class ColorCycleJob : SystemBase
    {
        protected unsafe override void OnUpdate()
        {
    
            EntityManager.GetAllUniqueSharedComponents<Cohort>(out var cohorts, Allocator.Temp);
            for (int i=0; i<cohorts.Length; i++)
            {
                var cohort = cohorts[i];
                DisplayColor newColor = ColorTable.GetNextColor(cohort.Value);
                Entities.WithSharedComponentFilter(cohort)
                    .ForEach((ref DisplayColor color) => { color = newColor; })
                    .ScheduleParallel();
            }
        }
    }
    

    The example uses the EntityManager to get all the unique cohort values. It then schedules a lambda job for each cohort, and passes the new color to the lambda expression as a captured variable.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    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.

    In This Article
    • Change filtering
    • Shared component filtering
    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)