Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    AsyncScript Class

    Namespace: Stride.Engine
    Assembly: Stride.Engine.dll

    A script which can be implemented as an async microthread.

    System.Object → EntityComponent → ScriptComponent → AsyncScript
    Derived from AsyncScript:

    public abstract class AsyncScript : ScriptComponent, IIdentifiable, ICollectorHolder
    Name Description
    Properties
    CancellationToken

    Gets a token indicating if the script execution was canceled.

    Methods
    Execute()

    Called once, as a microthread

    PriorityUpdated()
    | Improve this Doc View Source

    Properties


    CancellationToken

    Gets a token indicating if the script execution was canceled.

    public CancellationToken CancellationToken { get; }
    Property Value
    Type Description
    System.Threading.CancellationToken
    | Improve this Doc View Source

    Methods


    Execute()

    Called once, as a microthread

    public abstract Task Execute()
    Returns
    Type Description
    System.Threading.Tasks.Task

    PriorityUpdated()

    protected override void PriorityUpdated()
    Overrides
    ScriptComponent.PriorityUpdated()

    Inherited Members

    ScriptComponent.LiveScriptingMask
    ScriptComponent.ScriptGlobalProfilingKey
    ScriptComponent.ProfilingKey
    ScriptComponent.Audio
    ScriptComponent.SpriteAnimation
    ScriptComponent.Services
    ScriptComponent.Game
    ScriptComponent.Content
    ScriptComponent.GameProfiler
    ScriptComponent.GraphicsDevice
    ScriptComponent.Input
    ScriptComponent.Script
    ScriptComponent.SceneSystem
    ScriptComponent.EffectSystem
    ScriptComponent.DebugText
    ScriptComponent.Streaming
    ScriptComponent.Log
    ScriptComponent.Priority
    ScriptComponent.IsLiveReloading
    ScriptComponent.Collector
    ScriptComponent.Cancel()
    EntityComponent.Entity
    EntityComponent.Id
    EntityComponent.EnsureEntity

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    PhysicsScriptComponentExtensions.GetSimulation(ScriptComponent)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation