Merge pull request #17 from nndda/dev

v0.3.6-alpha

Author: nndda

addons/Theatre/classes/Dialogue.gd

@@ -14,7 +14,7 @@ class Parser extends RefCounted:
     var output : Array[Dictionary]
 
     const REGEX_DLG_TAGS :=\
-        r"\{\s*(\w+)\s*=\s*(.+?)\s*\}"
+        r"\{\s*(?<tag>\w+)\s*(\=\s*(?<arg>.+?)\s*)*\}"
     const REGEX_FUNC_CALL :=\
         r"(?<caller>\w+)\.(?<name>\w+)\((?<args>.*)\)$"
     const REGEX_PLACEHOLDER :=\
@@ -73,10 +73,12 @@ class Parser extends RefCounted:
                     if dlg_raw.size() < i + 1:
                         assert(false, "Error: Dialogue name exists without a body")
 
-                    setsl["actor"] = n.trim_suffix(":")
+                    setsl["actor"] = n.strip_edges().trim_suffix(":")
 
                     if setsl["actor"] == "_":
                         setsl["actor"] = ""
+                    elif setsl["actor"] == "":
+                        setsl["actor"] = output[output.size() - 1]["actor"]
 
                     output.append(setsl)
                     body_pos = output.size() - 1
@@ -85,7 +87,7 @@ class Parser extends RefCounted:
                 # Function calls
                 var regex_func := RegEx.new()
                 regex_func.compile(REGEX_FUNC_CALL)
-                var regex_func_match := regex_func.search(dlg_raw[i].dedent())
+                var regex_func_match := regex_func.search(dlg_raw[i].strip_edges())
 
                 if regex_func_match != null:
                     var func_dict := FUNC_TEMPLATE.duplicate(true)
@@ -110,7 +112,7 @@ class Parser extends RefCounted:
 
                 # Dialogue text body
                 else:
-                    var dlg_body := dlg_raw[i].dedent() + " "
+                    var dlg_body := dlg_raw[i].strip_edges() + " "
 
                     output[body_pos]["line_raw"] += dlg_body
                     output[body_pos]["line"] += dlg_body
@@ -126,7 +128,7 @@ class Parser extends RefCounted:
 
     ## Check if [param string] is indented with tabs or spaces.
     func is_indented(string : String) -> bool:
-        return string.begins_with(" ") or string.begins_with("\t")
+        return string != string.lstrip(" \t")
 
     ## Check if [param string] is written in a valid Dialogue string format/syntax or not.
     static func is_valid_source(string : String) -> bool:
@@ -167,15 +169,17 @@ class Parser extends RefCounted:
             string = string.replace(b.strings[0], "")
 
             var tag_pos : int = b.get_start() - tag_pos_offset
-            var tag_key := b.strings[1].to_upper()
-            var tag_value := b.strings[2]
+            var tag_key := b.get_string("tag").to_upper()
+            var tag_value := b.get_string("arg")
 
             tag_pos_offset += b.strings[0].length()
 
             if ["DELAY", "WAIT", "D", "W"].has(tag_key):
                 tags["delays"][tag_pos] = float(tag_value)
             elif ["SPEED", "SPD", "S"].has(tag_key):
-                tags["speeds"][tag_pos] = float(tag_value)
+                tags["speeds"][tag_pos] = float(
+                    1.0 if tag_value.is_empty() else tag_value
+                )
             else:
                 push_warning("Unknown tags: ", b.strings[0])
 
@@ -239,10 +243,10 @@ static func load(dlg_src : String) -> Dialogue:
         # Find filename alias
         var dlg_compiled := dlg_src.trim_suffix(".txt")
 
-        if FileAccess.file_exists(dlg_compiled + ".dlg.res"):
-            dlg_compiled += ".dlg.res"
-        elif FileAccess.file_exists(dlg_compiled + ".dlg.tres"):
-            dlg_compiled += ".dlg.tres"
+        if FileAccess.file_exists(dlg_compiled + ".res"):
+            dlg_compiled += ".res"
+        elif FileAccess.file_exists(dlg_compiled + ".tres"):
+            dlg_compiled += ".tres"
 
         print("Getting Dialogue from file: ", dlg_compiled)
 

addons/Theatre/classes/DialogueLabel.gd

@@ -2,7 +2,6 @@ class_name DialogueLabel
 extends RichTextLabel
 
 var current_stage : Stage
-var offset_queue : PackedInt32Array = []
 var delay_queue : PackedInt32Array = []
 var speed_queue : PackedInt32Array = []
 
@@ -35,12 +34,19 @@ func start_render() -> void:
 
     speed_queue = current_stage.current_dialogue_set["tags"]["speeds"].keys()
     delay_queue = current_stage.current_dialogue_set["tags"]["delays"].keys()
-    offset_queue = current_stage.current_dialogue_set["offsets"].keys()
 
-func rerender() -> void:
-    visible_characters = 0
+func clear_render() -> void:
+    delay_queue.clear()
+    speed_queue.clear()
+
     delay_timer.stop()
     characters_ticker.stop()
+
+    visible_ratio = 0
+    visible_characters = -1
+
+func rerender() -> void:
+    clear_render()
     start_render()
 
 func characters_ticker_timeout() -> void:
@@ -70,3 +76,6 @@ func characters_ticker_timeout() -> void:
         characters_ticker.stop()
         text_rendered.emit(text)
         characters_ticker.wait_time = characters_draw_tick_scaled
+
+    if current_stage.step == -1:
+        clear_render()

addons/Theatre/classes/Stage.gd

@@ -3,6 +3,8 @@ extends Object
 
 var allow_skip := true
 
+var allow_cancel := true
+
 var allow_func := true
 
 var auto := false
@@ -44,7 +46,7 @@ var actor_label : Label
 
 var caller : Dictionary = {}
 
-## [RichTextLabel] node that displays the dialogue body [member Dialogue.set_current.dlg]. This element is [b]required[/b] for the dialogue to run.
+## [DialogueLabel] node that displays the dialogue body [member Dialogue.set_current.dlg]. This is [b]required[/b] for the dialogue to run
 var dialogue_label : DialogueLabel
 
 ## Current progress of the Dialogue.
@@ -95,6 +97,7 @@ func _init(parameters : Dictionary):
 
         var constructor_property : PackedStringArray = [
             "allow_skip",
+            "allow_cancel",
             "allow_func",
             "auto",
             "auto_delay",
@@ -108,8 +111,6 @@ func _init(parameters : Dictionary):
                 else:
                     push_error("Error constructing Stage, `%s` does not exists" % property)
 
-    Theatre.locale_changed.connect(switch_lang)
-
 ## Emitted when [Dialogue] started ([member step] == 0)
 signal started
 ## Emitted when [Dialogue] finished ([member step] == [member step.size()])
@@ -127,19 +128,23 @@ func get_current_set() -> Dictionary:
 func is_playing() -> bool:
     return step >= 0
 
-## Progress the [Dialogue] by 1 step. If [member progress_tween] is still running, [member progress_tween.stop()] and [member progress_tween_reset] will be called, and the [Dialogue] will not progressed.
+## Progress the [Dialogue] by 1 step.
 func progress() -> void:
-    if current_dialogue != null:
+    if current_dialogue == null:
+        push_warning("No Dialogue present")
+    else:
         # Skip dialogue
         if dialogue_label.visible_ratio < 1.0:
             if allow_skip:
-                dialogue_label.visible_characters = current_dialogue_set["line"].length()
+                dialogue_label.clear_render()
+                dialogue_label.visible_ratio = 1.0
 
         # Progress dialogue
         else:
             if step + 1 < current_dialogue_length:
+                dialogue_label.clear_render()
+
                 step += 1
-                dialogue_label.visible_characters = 0
                 current_dialogue_set = current_dialogue.sets[step]
                 body_text_length = current_dialogue_set["line"].length()
 
@@ -167,8 +172,7 @@ func progress() -> void:
                             else:
                                 caller[f["caller"]].callv(f["name"], f["args"])
 
-                if dialogue_label != null:
-                    dialogue_label.start_render()
+                dialogue_label.start_render()
 
                 progressed.emit(step, current_dialogue_set)
 
@@ -177,36 +181,46 @@ func progress() -> void:
                 finished.emit()
 
 ## Stop Dialogue and resets everything
-func reset(keep_dialogue : bool = false) -> void:
-    print("Resetting Dialogue [%s]..." % current_dialogue.source_path)
-    resetted.emit(step,
-        current_dialogue.sets[step] if step != -1 else\
-        Dialogue.Parser.SETS_TEMPLATE
-    )
+func reset() -> void:
+    if !allow_cancel:
+        print("Resetting Dialogue is not allowed")
+    else:
+        if current_dialogue != null:
+            print("Resetting Dialogue [%s]..." % current_dialogue.source_path)
+            resetted.emit(step,
+                current_dialogue.sets[step] if step != -1 else\
+                Dialogue.Parser.SETS_TEMPLATE
+            )
 
-    if !keep_dialogue:
-        current_dialogue = null
-    step = -1
+            step = -1
 
-    if actor_label != null:
-        actor_label.text = ""
-    dialogue_label.text = ""
+            if actor_label != null:
+                actor_label.text = ""
+
+            dialogue_label.clear_render()
+            dialogue_label.text = ""
+
+            current_dialogue = null
 
 ## Start the [Dialogue] at step 0 or at defined preprogress parameter.
 ## If no parameter (or null) is passed, it will run the [member current_dialogue] if present
 func start(dialogue : Dialogue = null) -> void:
-    if dialogue != null:
-        current_dialogue = dialogue
-
-    if current_dialogue == null:
-        push_error("Cannot start the Stage: `current_dialogue` is null")
+    if is_playing():
+        push_warning("Theres already a running Dialogue!")
     else:
-        print("Starting Dialogue [%s]..." % current_dialogue.source_path)
-        current_dialogue_length = current_dialogue.sets.size()
+        if dialogue != null:
+            current_dialogue = dialogue
+
+        if current_dialogue == null:
+            push_error("Cannot start the Stage: `current_dialogue` is null")
+        else:
+            print("Starting Dialogue [%s]..." % current_dialogue.source_path)
+            current_dialogue_length = current_dialogue.sets.size()
 
-        progress()
-        started.emit()
+            progress()
+            started.emit()
 
+# TODO
 func switch_lang(lang : String = "") -> void:
     if current_dialogue == null:
         push_error("Failed switching lang: current_dialogue is null")
@@ -242,8 +256,7 @@ func switch_lang(lang : String = "") -> void:
                     if is_playing():
                         current_dialogue_set = current_dialogue.sets[step]
                         update_display()
-                        if dialogue_label != null:
-                            dialogue_label.rerender()
+                        dialogue_label.rerender()
 
 func add_caller(id : String, node : Node) -> void:
     caller[id] = node

addons/Theatre/classes/Theatre.gd

@@ -1,16 +1,11 @@
 @icon("res://addons/Theatre/assets/icons/Theatre.svg")
-extends Node
+extends Object
+class_name Theatre
 
-var speed_scale : float = 1.0
+static var speed_scale : float = 1.0
 
-var lamg : String = ""
-var default_lang : String = "en"
+static var lamg : String = ""
+static var default_lang : String = "en"
 
-signal locale_changed(lang : String)
-
-# TODO: would be nice if this can be triggered when `TranslationServer.set_locale()` is called
-func set_locale(lang : String = "") -> void:
-    locale_changed.emit(lang)
-
-func print_silly() -> void:
+static func print_silly() -> void:
     print("silly :p")

addons/Theatre/classes/TheatrePlugin.gd

@@ -40,7 +40,6 @@ class Config extends RefCounted:
         if err != OK:
             push_error("Error saving Theatre config: ", err)
 
-# BUG: theres a black rectangle on top left corner when Godot starts
 var plugin_submenu : PopupMenu = preload(
     "res://addons/Theatre/components/tool_submenu.tscn"
 ).instantiate()
@@ -60,9 +59,6 @@ func _enter_tree() -> void:
     plugin_submenu.id_pressed.connect(tool_submenu_id_pressed)
     add_tool_submenu_item("🎭 Theatre", plugin_submenu)
 
-    # Add Theatre singleton
-    add_autoload_singleton("Theatre", "res://addons/Theatre/classes/Theatre.gd")
-
 func _exit_tree() -> void:
     print("🎭 Disabling Theatre...")
     # Clear project settings
@@ -72,9 +68,6 @@ func _exit_tree() -> void:
     plugin_submenu.id_pressed.disconnect(tool_submenu_id_pressed)
     remove_tool_menu_item("🎭 Theatre")
 
-    # Remove Theatre singleton
-    remove_autoload_singleton("Theatre")
-
 func crawl(path : String = "res://") -> void:
     var dir := DirAccess.open(path)
     var ignored_directories : PackedStringArray = (ProjectSettings.get_setting(
@@ -98,9 +91,9 @@ func crawl(path : String = "res://") -> void:
                             print("Crawling " + new_dir + " for dialogue resources...")
                         crawl(new_dir)
             else:
-                if file_name.ends_with(".txt"):
+                if file_name.ends_with(".dlg.txt"):
                     var file := path + "/" + file_name
-                    var file_com := file.trim_suffix(".txt") + ".dlg.res"
+                    var file_com := file.trim_suffix(".txt") + ".res"
 
                     if FileAccess.file_exists(file_com):
                         var rem_err := DirAccess.remove_absolute(file_com)

addons/Theatre/plugin.cfg

@@ -3,5 +3,5 @@
 name="Theatre"
 description="Text based dialogue plugin"
 author="nnda"
-version="0.0.1-alpha.6"
+version="0.3.6-alpha"
 script="classes/TheatrePlugin.gd"

project.godot

@@ -15,10 +15,6 @@ run/main_scene="res://theatre_demo/intro_1.tscn"
 config/features=PackedStringArray("4.2")
 config/icon="res://addons/Theatre/assets/icons/Theatre.svg"
 
-[autoload]
-
-Theatre="*res://addons/Theatre/classes/Theatre.gd"
-
 [display]
 
 window/stretch/mode="canvas_items"

theatre_demo/demo_dialogue.dlg.txt

@@ -0,0 +1,28 @@
+Dia:
+    "Welcome to the Theatre!{d = 0.5} Hi there!{d = 0.4}
+    this is a demo dialogue to demonstrate Theatre addon's core feature."
+
+:
+    "There are 5 main classes that makes part of Theatre plugin:{delay = 0.7}
+    Dialogue, {d = 0.7}
+    DialogueLabel, {d = 0.7}
+    Stage, {d = 0.7}
+    Theatre, {d = 0.7}
+    & TheatrePlugin."
+
+:
+    "Lets start with Dialogue:{d = 0.8} Its a resource, containing the writing of
+    your{s = 0.035}...{s}{d = 0.5} well,{d = 0.8} dialogue!{d = 1.0}
+    You write them in a plain text file,{d = 0.9}
+    the written dialogue then get parsed to a resource,{d = 0.9}
+    that you can then use in your project"
+
+:
+    "And {s = 0.9}um{s = 0.04}...{s} Thats it!{s = 0.035}...{s} for now."
+
+:
+    "We also have an official documentation page,{d = 0.85}
+    live at nndda.github.io/Theatre"
+
+:
+    "Stay tuned for the next updates!"