Improve visuals and sound

* Adds initial gnd_skydome addon (solves #73)
* Adds initial gnd_sfx addon (solves #90)
* Adds initial gnd_weather addon for weather system (related to #74 and #73)
* Adds more sounds to SM42 demo

Author: marcinn

Makefile

@@ -126,4 +126,4 @@ docker-run-tests: docker-build-tests
 
 
 run-tests: compile
-	godot --path demo --headless -s addons/gut/gut_cmdln.gd -gdir=res://tests/ -gexit
+	godot --path demo --headless -s addons/gut/gut_cmdln.gd -gdir=res://tests/,res://addons/gnd_sfx/tests/ -gexit

README.md

@@ -137,7 +137,7 @@ git submodule update --init
 Then run tests from the command line (if you have `make` installed, you can use shortcut `make run-tests`):
 
 ```bash
-godot --path demo --headless -s addons/gut/gut_cmdln.gd -gdir=res://tests/ -gexit
+godot --path demo --headless -s addons/gut/gut_cmdln.gd -gdir=res://tests/,res://addons/gnd_sfx/tests/ -gexit
 ```
 
 

addons/libmaszyna/cabin/base_cabin_tool_3d.gd

@@ -18,6 +18,14 @@ func _process_dirty(delta):
 func _process_tool(delta):
     pass
 
+func get_cabin() -> Cabin3D:
+    var node = get_parent()
+    while node:
+        if node is Cabin3D:
+            return node
+        node = node.get_parent()
+    return null
+    
 func _process(delta):
     if _dirty:
         _dirty = false

addons/libmaszyna/cabin/cabin_3d.gd

@@ -7,6 +7,8 @@ var _dirty = true
 var _cabin_ready:bool = false
 var _e3d_instances:Array[E3DModelInstance] = []
 var _e3d_loaded_count:int = 0
+var controller: TrainController
+
 
 @export_node_path("TrainController") var controller_path:NodePath = NodePath(""):
     set(x):
@@ -18,11 +20,16 @@ var _e3d_loaded_count:int = 0
 @export var camera_bound_max = Vector3.ZERO
 @export var camera_bound_enabled:bool = false
 @export var driver_position = Vector3.ZERO
+@export var sound_bank:SfxBank
 
 func get_camera_transform():
     return global_transform.translated_local(driver_position)
 
+func is_cabin_ready() -> bool:
+    return _cabin_ready
+
 func _propagate_train_controller(node: Node, controller: TrainController):
+    self.controller = controller
     for child in node.get_children():
         _propagate_train_controller(child, controller)
         if "controller_path" in child:

addons/libmaszyna/cabin/cabin_button.gd

@@ -39,8 +39,7 @@ enum ControllerMode { OnOff, On, Off }
         if pushed:
             _target_mesh_rotation = x
 @export var speed = 10.0
-@export var sound_on:AudioStream
-@export var sound_off:AudioStream
+@export var sound_event = "cabin_button"
 @export var sound_max_distance:float = 3.0:
     set(x):
         sound_max_distance = x
@@ -59,17 +58,24 @@ var _t:float = 0.0
 
 var _enabled:bool = true
 var _setup_phase:bool = true
-var _sound:AudioStreamPlayer3D = AudioStreamPlayer3D.new()
+var _sound:SfxPlayer3D = SfxPlayer3D.new()
 
 func _ready():
-    add_child(_sound)
     _sound.max_distance = sound_max_distance
+    _sound.max_tracks = 2
+    var cabin = get_cabin()
+    if cabin:
+        _sound.bank = cabin.sound_bank
     connect("pushed_changed", self._on_pushed_changed)
     controller_changed.connect(_update_state)
     Console.console_toggled.connect(_on_console_toggled)
 
 func _enter_tree():
     _setup_phase = true
+    add_child(_sound)    
+
+func _exit_tree() -> void:
+    remove_child(_sound)
 
 func _on_console_toggled(visible:bool):
     _enabled = not visible
@@ -124,9 +130,10 @@ func _process_tool(delta):
         _mesh.position = _mesh_original_position + _current_position
 
 func _play_sound():
-    _sound.stream = sound_on if pushed else sound_off
-    if _sound.stream:
-        _sound.play()
+    if pushed:
+        _sound.play(sound_event)
+    else:
+        _sound.stop(sound_event)
 
 func _on_pushed_changed():
     if pushed:

addons/libmaszyna/cabin/cabin_button.tscn

@@ -1,6 +1,6 @@
-[gd_scene load_steps=2 format=3 uid="uid://c0toij1foexq6"]
+[gd_scene format=3 uid="uid://c0toij1foexq6"]
 
 [ext_resource type="Script" uid="uid://brys456def41l" path="res://addons/libmaszyna/cabin/cabin_button.gd" id="1_glqim"]
 
-[node name="CabinButton" type="Node3D"]
+[node name="CabinButton" type="Node3D" unique_id=167396750]
 script = ExtResource("1_glqim")

addons/libmaszyna/cabin/cabin_gauge.tscn

@@ -1,6 +1,6 @@
-[gd_scene load_steps=2 format=3 uid="uid://cfj82gn1nfl36"]
+[gd_scene format=3 uid="uid://cfj82gn1nfl36"]
 
 [ext_resource type="Script" uid="uid://c4lj08dvqxvhn" path="res://addons/libmaszyna/cabin/cabin_gauge.gd" id="1_5vh3x"]
 
-[node name="CabinGauge" type="Node3D"]
+[node name="CabinGauge" type="Node3D" unique_id=258192697]
 script = ExtResource("1_5vh3x")

addons/libmaszyna/cabin/cabin_sound_3d.gd

@@ -0,0 +1,32 @@
+extends BaseCabinTool3D
+class_name CabinHasler
+
+@export var sound_event : StringName = ""
+@export var speed_parameter : StringName = "speed"
+
+var _cabin:Cabin3D
+var _sfx:SfxPlayer3D
+
+func _ready() -> void:
+    _cabin = get_cabin()
+    if not _cabin:
+        return
+    _sfx = SfxPlayer3D.new()
+    add_child(_sfx)
+    _sfx.bank = _cabin.sound_bank
+        
+func _exit_tree() -> void:
+    if _sfx:
+        remove_child(_sfx)
+        _sfx = null
+    
+func _process_tool(delta):
+    if not _cabin or not _sfx or not _controller:
+        return
+    var speed = _controller.state.get("speed", 0.0)
+    if speed > 0.1 and not _sfx.is_playing(sound_event):
+        _sfx.play(sound_event, 0.0, {speed_parameter: speed})
+    elif speed <= 0.1 and _sfx.is_playing(sound_event):
+        _sfx.stop(sound_event, 0.0)
+    elif _sfx.is_playing(sound_event):
+        _sfx.modulate(sound_event, {speed_parameter: speed})

addons/libmaszyna/cabin/cabin_sound_3d.gd.uid

@@ -0,0 +1 @@
+uid://cigrhgepj7tlg

addons/libmaszyna/cabin/cabin_switch.gd

@@ -193,6 +193,7 @@ func _handle_position_change(prev, current) -> int:
             _controller.send_command(command_set, current)
 
     if state_property and _controller:
-        return _controller.state.get(state_property, current)
+        var state_value = _controller.state.get(state_property, current)
+        return state_value
     else:
         return current