Update docs

Insality · Oct 23, 2021 · c16c3e4 · c16c3e4
1 parent d2e4362
commit c16c3e4
Show file tree

Hide file tree

Showing 26 changed files with 36 additions and 35 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -169,7 +169,7 @@ <h2>Modules</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/BackHandler.html b/docs/modules/BackHandler.html
@@ -214,7 +214,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/BaseComponent.html b/docs/modules/BaseComponent.html
@@ -608,7 +608,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Blocker.html b/docs/modules/Blocker.html
@@ -212,7 +212,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Button.html b/docs/modules/Button.html
@@ -775,7 +775,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Checkbox.html b/docs/modules/Checkbox.html
@@ -333,7 +333,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/CheckboxGroup.html b/docs/modules/CheckboxGroup.html
@@ -245,7 +245,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/DataList.html b/docs/modules/DataList.html
@@ -499,7 +499,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Drag.html b/docs/modules/Drag.html
@@ -489,7 +489,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/DruidEvent.html b/docs/modules/DruidEvent.html
@@ -271,7 +271,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/DruidInstance.html b/docs/modules/DruidInstance.html
@@ -1360,7 +1360,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/DynamicGrid.html b/docs/modules/DynamicGrid.html
@@ -786,7 +786,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Hover.html b/docs/modules/Hover.html
@@ -330,7 +330,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Input.html b/docs/modules/Input.html
@@ -688,7 +688,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/LangText.html b/docs/modules/LangText.html
@@ -243,7 +243,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Progress.html b/docs/modules/Progress.html
@@ -522,7 +522,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/RadioGroup.html b/docs/modules/RadioGroup.html
@@ -245,7 +245,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Scroll.html b/docs/modules/Scroll.html
@@ -1118,7 +1118,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Slider.html b/docs/modules/Slider.html
@@ -421,7 +421,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/StaticGrid.html b/docs/modules/StaticGrid.html
@@ -877,7 +877,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Swipe.html b/docs/modules/Swipe.html
@@ -283,7 +283,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Text.html b/docs/modules/Text.html
@@ -814,7 +814,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/Timer.html b/docs/modules/Timer.html
@@ -403,7 +403,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/druid.helper.html b/docs/modules/druid.helper.html
@@ -387,7 +387,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/druid.html b/docs/modules/druid.html
@@ -314,7 +314,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-10-23 17:32:40 </i>
+<i style="float:right;">Last updated 2021-10-23 17:45:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs_md/changelog.md b/docs_md/changelog.md
@@ -236,19 +236,19 @@ Good luck!
 		- const.TEXT_ADJUST.SCALE_THEN_SCROLL - Combine two modes: first limited downscale, then scroll
 - **#110** [Button] Add `Button:set_check_function(check_function, failure_callback)` function to add your custom click condition to button.
 	- `Button:set_enabled` has more priority than this to check button availability
-	- The `check_function` should return _true_ of _false_. If true - button can be clicked
-	- The `failure_callback`will be called if `check_function` will return false. It's callback for you if button is not available
-	- Example with `set_check_function` exists in general:buttons example collection
+	- The `check_function` should return _true_ of _false_. If true - button can be clicked by user
+	- The `failure_callback` will be called if `check_function` will return false
+	- Example with `set_check_function` in general:buttons example collection
 - **#66** Add `druid:set_whitelist()` and `druid.set_blacklist()` functions. It's affects only on input process step, you can allow/forbid interact with list of specific components
-- **#125** Now `component:set_input_priority()` affects on all component's children too
-- **#111** Add autocheck for input and stencil nodes. To enable this feature, add `druid.stencil_check = 1` to your game.project file.
-	- Add `helper.get_closest_stencil_node` function to get closest parent non inverted stencil node
-	- Add `component.ON_LATE_INIT` interest. If component with with interest, it will call `component.on_late_init` function once after component init on update step. This can be used to do something after all gui components are was initialized and setup.
+	- You can pass array of components, single component or nil in these functions
+- **#111** Add autocheck for input and stencil nodes. To enable this feature, add `druid.stencil_check = 1` to your _game.project_ file.
 	- This feature is using for auto setup `component:set_click_zone` to restrict clicks outside scrolls zone for example. Now you can don't think about click zone and let Druid do it instead of you!
-- **#81** Add ability to interact with Druid input via messages
+	- Add `helper.get_closest_stencil_node` function to get closest parent of non inverted stencil node
+	- Add `component.ON_LATE_INIT` interest. Component with this will call `component.on_late_init` function once after component init on update step. This can be used to do something after all gui components are inited
+- **#81** Add ability to interact with Druid input via messages:
 	- Currently add for Button and Text component only:
 		- Send to _gui.script_ message: `druid_const.ON_MESSAGE_INPUT`. The message table params:
-			- `node_id` - the name of the node with button component on it
+			- `node_id` - the name of the node with component on it
 			- `action` - value from `druid_const.MESSAGE_INPUT`. Available values:
 				- **BUTTON_CLICK** - usual button click callback
 				- **BUTTON_LONG_CLICK** - button long click callback
@@ -262,8 +262,9 @@ Good luck!
 - **#131** [Static Grid] Add style param: `IS_DYNAMIC_NODE_POSES` (default: false). Always align by content size with node anchor.
 	- If true - Static Grid will by always align to content anchor.
 	- If false (currently behaviour) - all poses for static grid is predefined and not depends on element's count (see example: static grid and static grid with dynamic poses)
+- **#125** Now `component:set_input_priority()` affects on all component's children too
 - **#143** Update all lang components on `druid.set_text_function` call
-- **#112** Allow remap default Druid input bindings.
+- **#112** Allow remap default Druid input bindings via `game.project`
 - **#107** [Text] Better scale text adjust by height for multiline text nodes (but still not perfect)
 - **#144** [Scroll] Fix some glitches with scroll Points of Interest. Remove false detection of scroll stopped.
 - **#142** [Scroll] Add Scroll style param `WHEEL_SCROLL_BY_INERTION` (default - false). If true - mouse wheel will add inertion to scroll, if false - set position directly per mouse wheel event.