docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method Schedule

    Schedule<T>(T, JobHandle)

    Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.

    Declaration
    [MustUseReturnValue]
    public static JobHandle Schedule<T>(this T jobData, JobHandle dependsOn) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity instance.

    JobHandle dependsOn

    The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel.

    Returns
    Type Description
    JobHandle

    A handle that combines the current Job with previous dependencies identified by the dependsOn parameter.

    Type Parameters
    Name Description
    T

    The specific IJobEntity implementation type.

    Remarks

    Can't schedule managed components or managed shared components, use Run instead.

    Schedule<T>(T, EntityQuery, JobHandle)

    Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.

    Declaration
    [MustUseReturnValue]
    public static JobHandle Schedule<T>(this T jobData, EntityQuery query, JobHandle dependsOn) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity instance.

    EntityQuery query

    The query selecting chunks with the necessary components.

    JobHandle dependsOn

    The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel.

    Returns
    Type Description
    JobHandle

    A handle that combines the current Job with previous dependencies identified by the dependsOn parameter.

    Type Parameters
    Name Description
    T

    The specific IJobEntity implementation type.

    Remarks

    Can't schedule managed components or managed shared components, use Run instead.

    Schedule<T>(T)

    Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.

    Declaration
    public static void Schedule<T>(this T jobData) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity instance.

    Type Parameters
    Name Description
    T

    The specific IJobEntity implementation type.

    Remarks

    This job automatically uses the system's Dependency property as the input and output dependency.

    Schedule<T>(T, EntityQuery)

    Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.

    Declaration
    public static void Schedule<T>(this T jobData, EntityQuery query) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity instance.

    EntityQuery query

    The query selecting chunks with the necessary components.

    Type Parameters
    Name Description
    T

    The specific IJobEntity implementation type.

    Remarks

    This job automatically uses the system's Dependency property as the input and output dependency.


    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
    • Schedule<T>(T, JobHandle)
    • Schedule<T>(T, EntityQuery, JobHandle)
    • Schedule<T>(T)
    • Schedule<T>(T, EntityQuery)
    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)