Release 1.2.7 Add template argument to druid.get_widget

Author: Insality

README.md

@@ -48,7 +48,7 @@ https://github.com/Insality/defold-event/archive/refs/tags/14.zip
 **[Druid](https://github.com/Insality/druid/)**
 
 ```
-https://github.com/Insality/druid/archive/refs/tags/1.2.6.zip
+https://github.com/Insality/druid/archive/refs/tags/1.2.7.zip
 ```
 
 After that, select `Project ▸ Fetch Libraries` to update [library dependencies]((https://defold.com/manuals/libraries/#setting-up-library-dependencies)). This happens automatically whenever you open a project so you will only need to do this if the dependencies change without re-opening the project.

api/druid_api.md

@@ -127,7 +127,7 @@ It will notify all Druid instances to update the lang text components.
 
 ---
 ```lua
-druid.get_widget(widget_class, gui_url, [params])
+druid.get_widget(widget_class, gui_url, [params], [template])
 ```
 
 Create a widget from the bound Druid GUI instance.
@@ -139,6 +139,7 @@ Widget class here is your lua file for the GUI scene (widgets in Druid)
 	- `widget_class` *(<T:druid.widget>)*: The class of the widget to return
 	- `gui_url` *(string|url)*: GUI url or string of component name near current script
 	- `[params]` *(any)*: Additional parameters to pass to the widget's init function
+	- `[template]` *(string)*: The GUI template name used by the widget nodes
 
 - **Returns:**
 	- `widget` *(<T:druid.widget>)*: The new created widget,

druid/druid.lua

@@ -164,8 +164,9 @@ end
 ---@param widget_class T The class of the widget to return
 ---@param gui_url url|string GUI url or string of component name near current script
 ---@param params any|nil Additional parameters to pass to the widget's init function
+---@param template string|nil The GUI template name used by the widget nodes
 ---@return T widget The new created widget,
-function M.get_widget(widget_class, gui_url, params)
+function M.get_widget(widget_class, gui_url, params, template)
 	if type(gui_url) == "string" then
 		gui_url = msg.url(nil, nil, gui_url)
 	end
@@ -177,7 +178,7 @@ function M.get_widget(widget_class, gui_url, params)
 	for index = 1, #registered_druids do
 		local druid = registered_druids[index]
 		if druid.fragment == gui_url.fragment and druid.path == gui_url.path then
-			return druid.new_widget(widget_class, nil, nil, params)
+			return druid.new_widget(widget_class, template, nil, params)
 		end
 	end
 

game.project

@@ -14,7 +14,7 @@ update_frequency = 60
 
 [project]
 title = Druid
-version = 1.2.6
+version = 1.2.7
 publisher = Insality
 developer = Maksim Tuprikov
 custom_resources = /example/locales

wiki/changelog.md

@@ -843,3 +843,8 @@ Please support me if you like this project! It will help me keep engaged to upda
 - [System] Add `druid_instance:set_style(style)` to set the style of the Druid instance
 	- The style is applied to the components created after this call, already created components keep their style
 	- Allows to set the style from a game object script: `druid.get_druid(url):set_style(my_style)`
+
+### Druid 1.2.7
+- [System] Add `template` argument to `druid.get_widget(widget_class, gui_url, [params], [template])`
+	- The template name is passed to the `new_widget` of the bound Druid instance, so widgets placed inside a GUI template can be created from a game object script
+	- The argument is optional, existing calls are not affected

wiki/widgets.md

@@ -307,3 +307,16 @@ function M:init(params)
     self.show_badges = params.show_badges
 end
 ```
+
+If the widget nodes are placed inside a GUI template, pass the template name as the last argument:
+`druid.get_widget(widget, gui_url, [params], [template])`. It is used to resolve the widget nodes, the same way as
+in `druid:new_widget(widget_class, template, nodes, params)`.
+
+```lua
+function on_message(self, message_id, message, sender)
+    if message_id == hash("late_init") then
+        local gui_url = msg.url(nil, nil, "go_widget")
+        self.go_widget = druid.get_widget(my_widget, gui_url, nil, "my_widget_template")
+    end
+end
+```