Add code

Author: iwilliams

.gitignore

@@ -0,0 +1,2 @@
+# Godot 4+ specific ignores
+.godot/

LICENSE

@@ -19,3 +19,28 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+Godot License
+
+Copyright (c) 2014-present Godot Engine contributors.
+Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-- Godot Engine <https://godotengine.org>

README.md

@@ -1 +1,54 @@
-# godot-4-awaiter
+# godot-4-awaiter
+
+For when you need to `await` multiple signals. No idea if this is something you _should_ do, but at least now you _can_ :).
+
+**Godot 4 Only**
+
+## Setup
+Download and move `./addons/awaiter` to your godot project's `./addons` folder.
+
+
+## Examples
+
+
+Wait for all of the signals to fire:
+```
+var t1_finished = get_tree().create_timer(1.0).timeout
+var t2_finished = get_tree().create_timer(2.0).timeout
+
+# Expects an Array[Signal]
+await Awaiter.wait_for([t1_finished, t2_finished])
+
+print('All Finished!')
+```
+
+Wait until the first signal fires:
+```
+t1_finished = get_tree().create_timer(1.0).timeout
+t2_finished = get_tree().create_timer(2.0).timeout
+t2_finished.connect(func(): print("T2 Finished!"))
+
+# Expects an Array[Signal]
+await FirstAwaiter.wait_for([t1_finished, t2_finished])
+
+print('First Finished!')
+```
+
+Prevent waiting forever if the node you are waiting for goes away:
+```
+var t1 = Timer.new()
+t1.wait_time = 2.0
+t1.autostart = true
+
+var t2 = Timer.new()
+t2.wait_time = 1.0
+t2.autostart = true
+t2.timeout.connect(t1.queue_free)
+
+add_child(t1)
+add_child(t2)
+
+await FirstAwaiter.wait_for([t1.tree_exiting, t1.timeout])
+
+print("Did not wait forever!")
+```

addons/awaiter/awaiter.gd

@@ -0,0 +1,25 @@
+class_name Awaiter 
+extends Object
+
+signal finished
+
+var total = 0
+var total_done = 0
+
+static func wait_for(signals: Array[Signal]) -> Signal:
+	return new(signals).finished
+
+func _init(signals: Array[Signal]):
+	total = signals.size()
+	for sig in signals:
+		await_signal(sig)
+		
+func await_signal(sig: Signal):
+	await sig
+	total_done += 1
+	if _is_finished():
+		finished.emit()
+		call_deferred('free')
+	
+func _is_finished():
+	return total_done >= total

addons/awaiter/examples/example.gd

@@ -0,0 +1,33 @@
+extends Node
+
+func _ready():
+	var t1_finished = get_tree().create_timer(1.0).timeout
+	var t2_finished = get_tree().create_timer(2.0).timeout
+	
+	await Awaiter.wait_for([t1_finished, t2_finished])
+	
+	print('All Finished!')
+	
+	t1_finished = get_tree().create_timer(1.0).timeout
+	t2_finished = get_tree().create_timer(2.0).timeout
+	t2_finished.connect(func(): print("T2 Finished!"))
+	
+	await FirstAwaiter.wait_for([t1_finished, t2_finished])
+	
+	print('First Finished!')
+	
+	var t1 = Timer.new()
+	t1.wait_time = 2.0
+	t1.autostart = true
+	
+	var t2 = Timer.new()
+	t2.wait_time = 1.0
+	t2.autostart = true
+	t2.timeout.connect(t1.queue_free)
+	
+	add_child(t1)
+	add_child(t2)
+	
+	await FirstAwaiter.wait_for([t1.tree_exiting, t1.timeout])
+	
+	print("Did not wait forever!")

addons/awaiter/examples/example.tscn

@@ -0,0 +1,6 @@
+[gd_scene load_steps=2 format=3 uid="uid://be07pajuy7ua3"]
+
+[ext_resource type="Script" path="res://addons/awaiter/examples/example.gd" id="1_pajuv"]
+
+[node name="example" type="Node"]
+script = ExtResource("1_pajuv")

addons/awaiter/first_awaiter.gd

@@ -0,0 +1,12 @@
+class_name FirstAwaiter 
+extends Awaiter
+
+
+static func wait_for(signals: Array[Signal]) -> Signal:
+	return new(signals).finished
+
+
+func _is_finished():
+	var done = (total == 0 or total_done >= 1)
+	return done
+