gdscript-promise-async-utils

KO | EN

gitlite — search

#typescript #llm #golang #android #machine-learning #rust #deep-learning #macos #nodejs #java #awesome #kubernetes #awesome-list #security

gdscript-promise-async-utils

(★ 31)

No description available.

gdscript-promise-async-utils 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GDScript Async Utils

This addons provides helpers for using the Promise class in GDScript to handle asynchronous operations.

Every function that must be `await` has a `async` prefix.

Developed and tested with Godot 4.1.3

# Setup

## Just copying Promise.gd
- Copy [promise.gd](addons/gdscript-async-utils/promise.gd) to your project

## Godot Asset Library
- Soon...

## Basic Promise Usage

These examples demonstrate different ways to create, resolve, and work with promises.

### Creating and Resolving a Promise

```gdscript
var promise = Promise.new()
promise.resolve()
await promise.async_awaiter()
```

### Resolving a Promise with Data

```gdscript
var promise = Promise.new()
promise.resolve_with_data(5)
var data = await promise.async_awaiter()
# data will be 5
```

### Resolving a Promise After a Delay

```gdscript
func wait_and_resolve_with_data(promise: Promise, data: Variant)
    await test.get_tree().create_timer(0.1).timeout
    promise.resolve_with_data(data)

var promise = Promise.new()
wait_and_resolve_with_data(promise, data)
var data = await promise.async_awaiter() # data will be 32 after some time
```

### Rejecting a Promise

```gdscript
var promise = Promise.new()
promise.reject("Rejected")
var result = await promise.async_awaiter()
if result is Promise.Error:
    prints("Promise rejected, error:", result.get_error())
```

### Using .then and .catch

```gdscript
var promise = Promise.new()
promise.resolve()
promise \
    .then(func (result):
        prints("Promise resolved", result)) \
    .catch(func (result):
        prints("Promise rejected", result))
```

| Note: If the promise was resolved/rejected, the callback is called inmediatly.

## Advanced Promise Usage

### Chaining promises

```gdscript
var promise1 = Promise.new()
var promise2 = Promise.new()
promise1.resolve_with_data(promise2)
promise2.resolve_with_data("Chained data")
var data = await promise1.async_awaiter()
print(data) # data will be "Chained data"
```

### Handling multiple promises (Promise.async_all, Promise.async_any, Promise.async_Race)

#### Waiting for All Promises (Promise.async_all)
```gdscript
func wait_and_resolve_with_data(promise: Promise, data: Variant)
    await test.get_tree().create_timer(0.1).timeout
    promise.resolve_with_data(data)

var promise1 = Promise.new()
var promise2 = Promise.new()
wait_and_resolve_with_data(promise1, "Data 1")
wait_and_resolve_with_data(promise2, "Data 2")
var results = await Promise.async_all([promise1, promise2])
# results will be an array ["Data 1", "Data 2"]
```

#### Waiting for Any Promise to Resolve (Promise.async_any) (ignores rejections)

```gdscript
func wait_and_resolve_with_data(promise: Promise, data: Variant, time_secs: float)
    await test.get_tree().create_timer(time_secs).timeout
    promise.resolve_with_data(data)

var promise1 = Promise.new()
var promise2 = Promise.new()
wait_and_resolve_with_data(promise1, "Data 1", 0.3) # takes more time...
wait_and_resolve_with_data(promise2, "Data 2", 0.1)
var result = await Promise.async_any([promise1, promise2])
# result will be "Data 2" since promise1 takes more time
```

#### Racing Promises (Promise.async_race) (doesn't ignore rejections)

```gdscript
func wait_and_resolve_with_data(promise: Promise, data: Variant)
    await test.get_tree().create_timer(0.1).timeout
    promise.resolve_with_data(data)

var promise1 = Promise.new()
var promise2 = Promise.new()
wait_and_resolve_with_data(self, promise1, "Data 1")
promise2.reject("Rejected")
var result = await Promise.async_race([promise1, promise2])
# result will be either Promise.Error, because was resolved first
```

## More examples

You can extract more examples in the [tests](test/test_promise.gd)

# Async custom linter

For having mandatory `async` or `_async` in the prefix of a `await` you can use this custom linter:

[Godot GDScript Toolkit with Async (fork)](https://github.com/kuruk-mm/godot-gdscript-toolkit)

## Install

pip3 install git+https://github.com/kuruk-mm/godot-gdscript-toolkit.git

## Usage

Linter (with async prefix requirement):
```bash
gdlint path
```

Format:
```bash
gdformat path
```

| Note: This is a fork from Scony repo https://github.com/Scony/godot-gdscript-toolkit

gdscript-promise-async-utils

gdscript-promise-async-utils 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

gdscript-promise-async-utils

gdscript-promise-async-utils 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README