stride3d.stride-docs/en/tutorials/csharpintermediate/async-scripts.md

Async scripts

Explanation

This C# Intermediate tutorial covers the usage of asynchronous scripts or 'async' scripts. Up until this point every tutorial has been using Sync scripts. That means that those scripts are executed right after each other. If one particular sync script would take 1 second to completion, our game would freeze that 1 second, untill the update loop is complete. All of the previously made Sync scripts can be made in to an Async script.

With Async scripts we can perform heavy duty operations or reach out to an api without it freezing our application. A game can be made entirely with either Sync or Async scripts, or a combination of them both.

Code

Retrieving data from a web api

A common usecase for async scripts, is retrieving data from a web API. Depending on the speed of the API and the amount of data to be be retrieved this mostly take up somewhere between 20 milliseconds and 2 seconds. [!code-csharpAsyncWebApi]

Async Collision trigger

In a previous tutorial we made a collision trigger script that would notify the user once an object is passing through it. We can make a similar script using Async script. [!code-csharpAsyncCollisionTrigger]