Add documentation on how to await a signal in C#

[Shadowblitz16]

Describe the project you are working on

A voxel game

Describe the problem or limitation you are having in your project

I need to await for a frame everytime a chunk generates

Describe the feature / enhancement and how it helps to overcome the problem or limitation

We need documentation on how to await signals in godot callbacks in C#

We can't just await in any method in C# due to C# methods needing to be a async Task.
This means we can't do things like await in ToolButton exports or an godot callbacks like _Process or _Ready

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Just give us examples on work around in the godot documentation.

If this enhancement will not be used often, can it be worked around with a few lines of script?

It's a core feature in godot and gdscript, C# should have some way to do it.

Is there a reason why this should be core and not an add-on in the asset library?

There doesn't seem be anyone who has solves this issue.
I have seen posts that describe making the method a async void but that's not awaitable you need the return type to be a Task or one of it's equivilents

[AThousandShips]

What would need to be added to the existing documentation?

[Shadowblitz16]

What would need to be added to the existing documentation?

I just need an example on how to correctly use it from non async/Task methods.
Godot's C# callbacks like _Ready are not Tasks so they are not awaitable

[AThousandShips]

Using await in those methods isn't really recommended though I'd say, especially if it works differently from GDScript where the caller is returned to and the method is resumed later

[Shadowblitz16]

Using await in those methods isn't really recommended though I'd say, especially if it works differently from GDScript where the caller is returned to and the method is resumed later

It needs to be valid somewhere and you can't safely call async methods of sync ones

[AThousandShips]

What do you mean "needs to be valid"? Would awaiting here block execution? If so it's not something you should do in callbacks

[Shadowblitz16]

What do you mean "needs to be valid"? Would awaiting here block execution? If so it's not something you should do in callbacks

It wouldn't block but you can't await on it since it has to return Task.
Also if not callbacks then what do we await in?

[AThousandShips]

Again, if we're talking about awaiting like GDScript does, i.e. not blocking but resuming execution after the await is done, then that's generally safe, but I'm not sure how this works in C#, there is the general Task.Wait method, but not sure if there's some way to do this asynchronously generally

I suspect these might be relevant as a solution:

• Add a way to convert SignalAwaiter as a Task godot-proposals#6944
• [C#] Make awaiting Signals cancelable: Implementation for SignalAwaiter.WaitAsync(CancellationToken ct) godot-proposals#11909

[AThousandShips]

Related:

• Godot hangs when using ".GetAwaiter().GetResult()" in overrided Godot's method (e.q. _Ready)  godot#94510

[Shadowblitz16]

Again, if we're talking about awaiting like GDScript does, i.e. not blocking but resuming execution after the await is done, then that's generally safe, but I'm not sure how this works in C#, there is the general Task.Wait method, but not sure if there's some way to do this asynchronously generally

I suspect these might be relevant as a solution:

* [Add a way to convert SignalAwaiter as a Task godot-proposals#6944](https://github.com/godotengine/godot-proposals/issues/6944)

* [[C#] Make awaiting Signals cancelable: Implementation for SignalAwaiter.WaitAsync(CancellationToken ct) godot-proposals#11909](https://github.com/godotengine/godot-proposals/issues/11909)

That's what I am saying. That's how it works in C#.
You can't await something that doesn't return a Task