Release 1.2.6 Add get_druid from registered druid widgets for various… - #346
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR prepares the 1.2.6 release by introducing a new way to retrieve a registered Druid instance from game object scripts (druid.get_druid) and adding an instance-level style setter (druid_instance:set_style), alongside the usual version/documentation bumps.
Changes:
- Add
druid.get_druid(gui_url)to return the registered Druid instance (without cross-context event wrapping). - Add
druid_instance:set_style(style)to change the style used for subsequently created components. - Bump project/version references and record the new APIs in the changelog.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| wiki/changelog.md | Adds 1.2.6 release notes describing the new APIs. |
| README.md | Updates dependency ZIP tag to 1.2.6. |
| game.project | Bumps project version to 1.2.6. |
| druid/system/druid_instance.lua | Adds set_style on the Druid instance to change the style for future components. |
| druid/druid.lua | Adds get_druid and stores registered instance in widget registration entries. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+839
to
+845
| ### Druid 1.2.6 | ||
| - [System] Add `druid.get_druid(gui_url)` to get the Druid instance bound with `druid.register_druid_as_widget()` from a game object script | ||
| - Returns the instance as is, without cross-context events wrapping, unlike `druid.get_widget()` | ||
| - Returns `nil` if there is no Druid instance registered for this url | ||
| - [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)` |
Comment on lines
+135
to
+154
| function M.get_druid(gui_url) | ||
| if type(gui_url) == "string" then | ||
| gui_url = msg.url(nil, nil, gui_url) | ||
| end | ||
|
|
||
| gui_url = gui_url or msg.url() | ||
| local registered_druids = REGISTERED_GUI_WIDGETS[gui_url.socket] | ||
| if not registered_druids then | ||
| return nil | ||
| end | ||
|
|
||
| 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.instance | ||
| end | ||
| end | ||
|
|
||
| return nil | ||
| end |
Comment on lines
+291
to
+299
| ---Set a style of Druid instance. Pass nil to reset to the default style. | ||
| ---The style is applied to the components created after this call, already created components keep their style. | ||
| ---@param style table|nil The Druid style table | ||
| ---@return druid.instance self The Druid instance itself for chaining | ||
| function M:set_style(style) | ||
| self._style = style or settings.default_style | ||
|
|
||
| return self | ||
| end |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #346 +/- ##
==========================================
- Coverage 70.75% 70.57% -0.19%
==========================================
Files 32 32
Lines 4562 4577 +15
==========================================
+ Hits 3228 3230 +2
- Misses 1334 1347 +13 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
… manipulations