Class AsyncScript

    Namespace: Xenko.Engine | Assembly: Xenko.Engine.dll
    System.Object
    EntityComponent
    ScriptComponent

    A script which can be implemented as an async microthread.

    public abstract class AsyncScript : ScriptComponent, IIdentifiable, ICollectorHolder

    Properties

    Name Description
    CancellationToken

    Gets a token indicating if the script execution was canceled.
    View Source

    CancellationToken

    Gets a token indicating if the script execution was canceled.

    public CancellationToken CancellationToken { get; }
    Type: System.Threading.CancellationToken

    Methods

    Name Description
    Execute()

    Called once, as a microthread
    PriorityUpdated()
    View Source

    Execute()

    Called once, as a microthread

    public abstract Task Execute()

    Returns

    Type: System.Threading.Tasks.Task

    View Source

    PriorityUpdated()

    protected override void PriorityUpdated()