From f163009ba8dcf2d5524de851adf1d3004d7a9dbd Mon Sep 17 00:00:00 2001 From: Cake Date: Tue, 5 Mar 2024 16:25:23 +0100 Subject: [PATCH] Improve docs. --- addons/dialogic/Modules/Voice/subsystem_voice.gd | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/addons/dialogic/Modules/Voice/subsystem_voice.gd b/addons/dialogic/Modules/Voice/subsystem_voice.gd index 04004be56..d289a123b 100644 --- a/addons/dialogic/Modules/Voice/subsystem_voice.gd +++ b/addons/dialogic/Modules/Voice/subsystem_voice.gd @@ -103,7 +103,7 @@ func set_bus(bus_name: String) -> void: voice_player.bus = bus_name -## Stops the current voiceline from playing. +## Stops the current voice line from playing. func stop_audio() -> void: if voice_player.playing: voiceline_stopped.emit({'file':current_audio_file, 'remaining_time':get_remaining_time()}) @@ -111,15 +111,15 @@ func stop_audio() -> void: voice_player.stop() -## Called when the voiceline finishes playing. -## Connected to [signal finished]. +## Called when the voice line finishes playing. +## Connected to [signal finished] on [member voice_player] func _on_voice_finished() -> void: voiceline_finished.emit({'file':current_audio_file, 'remaining_time':get_remaining_time()}) -## Returns the remaining time of the current voiceline in seconds. +## Returns the remaining time of the current voice line in seconds. ## -## If there is no voiceline playing, returns `0`. +## If there is no voice line playing, returns `0`. func get_remaining_time() -> float: if not voice_player or not voice_player.playing: return 0.0