Merge pull request #26 from Lyaaaaaaaaaaaaaaa/Develop

Release 1.0.2

Author: Lyaaaaaaaaaaaaaaa

Godot/addons/file_downloader/file_downloader.gd

@@ -86,6 +86,17 @@
 #--
 #--   - 15/11/2023 Lyaaaaa
 #--    - Updated _downloads_done to call _reset before emitting "downloads_finished"
+#--
+#--   - 18/12/2023 Lyaaaaa
+#--    - Replaced the prints by push_error when needed.
+#--    - Replaced the _downloading var by _is_busy.
+#--    - Added is_busy method.
+#--    - is_downloading is now depreciated and calls is_busy.
+#--    - Updated _download_next_file to set busy to true.
+#--
+#--   - 05/02/2024 Lyaaaaa
+#--    - Added use_threads = true in _init to always have it on. It is important
+#--        for download speed
 #------------------------------------------------------------------------------
 class_name FileDownloader
 extends HTTPRequest
@@ -112,11 +123,13 @@ var _downloaded_size    : float = 0
 
 var _last_method : int
 
-var _downloading : bool = false:
-    get = is_downloading
+var _busy : bool = false:
+    get = is_busy,
+    set = set_busy
 
 
 func _init() -> void:
+    use_threads = true
     set_process(false)
     connect("request_completed", Callable(self, "_on_request_completed"))
 
@@ -134,7 +147,8 @@ func start_download(p_urls       : PackedStringArray = file_urls,
     file_urls = p_urls
     save_path = p_save_path
     _create_directory()
-    _download_next_file()
+    if not is_busy():
+        _download_next_file()
 
 
 func get_stats() -> Dictionary:
@@ -147,15 +161,23 @@ func get_stats() -> Dictionary:
 
 
 func is_downloading() -> bool:
-    return _downloading
+    # Depreciated. Will be removed in next release
+    return is_busy()
+
+
+func is_busy() -> bool:
+    return _busy
+
+func set_busy(p_busy : bool) -> void:
+    _busy = p_busy
 
 
 func _reset() -> void:
     _current_url = ""
     _current_url_index = 0
     _downloaded_percent = 0
     _downloaded_size = 0
-    _downloading = false
+    set_busy(false)
 
 
 func _downloads_done() -> void:
@@ -178,14 +200,13 @@ func _send_get_request() -> void:
     var error = request(_current_url, _headers, HTTPClient.METHOD_GET)
     if error == OK:
         emit_signal("downloads_started")
-        _downloading = true
         _last_method = HTTPClient.METHOD_GET
         set_process(true)
 
     elif error == ERR_INVALID_PARAMETER:
-        print("Given string isn't a valid url ")
+        push_error("Given string isn't a valid url: ", _current_url)
     elif error == ERR_CANT_CONNECT:
-        print("Can't connect to host")
+        push_error("Can't connect to host")
 
 
 func _update_stats() -> void:
@@ -214,6 +235,7 @@ func _create_directory() -> void:
 
 func _download_next_file() -> void:
     if _current_url_index < file_urls.size():
+        set_busy(true)
         _current_url  = file_urls[_current_url_index]
         _file_name    = _current_url.get_file()
         download_file = save_path.path_join(_file_name)
@@ -253,7 +275,7 @@ func _on_request_completed(p_result,
             emit_signal("file_downloaded", _file_name)
             _download_next_file()
     else:
-        print("HTTP Request error: ", p_result)
+        push_error("HTTP Request error: ", p_result)
 
 
 func _on_file_downloaded() -> void:
@@ -266,3 +288,4 @@ func _on_file_downloaded() -> void:
 
     else:
         _downloads_done()
+

Godot/addons/file_downloader/plugin.cfg

@@ -3,5 +3,5 @@
 name="FileDownloader"
 description="An easy to use file downloader class"
 author="Lyaaaaaaaaaaaaaaa"
-version="1.0.2"
+version="1.0.3"
 script="plugin.gd"

Godot/node_example/demo.tscn

@@ -13,7 +13,6 @@ script = ExtResource("2")
 [node name="FileDownloader" type="HTTPRequest" parent="."]
 use_threads = true
 script = ExtResource("1")
-save_path = "user://cache/"
 file_urls = PackedStringArray("https://godotengine.org/assets/home/features/cross-platform.svg", "https://godotengine.org/assets/home/features/oss.svg", "https://godotengine.org/assets/showcase/dome-keeper.jpg", "https://godotengine.org/assets/showcase/brotato-2.jpg")
 
 [node name="Button" type="Button" parent="."]

Godot/project.godot

@@ -12,7 +12,7 @@ config_version=5
 
 config/name="File Downloader"
 run/main_scene="res://node_example/demo.tscn"
-config/features=PackedStringArray("4.1")
+config/features=PackedStringArray("4.2")
 config/icon="res://icon.png"
 
 [debug]