mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 18:37:44 +02:00
Update docs
This commit is contained in:
parent
179ac5c068
commit
4cd5c55155
@ -54,7 +54,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="topics/01-components.md.html">Druid components</a></li>
|
<li><a href="topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="topics/03-styles.md.html">Styles</a></li>
|
<li><a href="topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -185,7 +185,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -61,7 +61,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -440,7 +440,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -215,7 +215,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -234,7 +234,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -84,7 +84,7 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(node, callback[, params[, anim_node[, event]]])</a></td>
|
<td class="name" nowrap><a href="#init">init(node, callback[, params[, anim_node]])</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -133,7 +133,7 @@
|
|||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(node, callback[, params[, anim_node[, event]]])</strong>
|
<strong>init(node, callback[, params[, anim_node]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Component init function
|
Component init function
|
||||||
@ -159,11 +159,6 @@
|
|||||||
Button anim node (node, if not provided)
|
Button anim node (node, if not provided)
|
||||||
(<em>optional</em>)
|
(<em>optional</em>)
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">event</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
||||||
Button react event, const.ACTION_TOUCH by default
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
@ -291,23 +286,23 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_click</span>
|
<li><span class="parameter">on_click</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
On release button callback
|
(self, params, button_instance) On release button callback
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">on_repeated_click</span>
|
<li><span class="parameter">on_repeated_click</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
On repeated action button callback
|
(self, params, button<em>instance, click</em>amount) On repeated action button callback
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">on_long_click</span>
|
<li><span class="parameter">on_long_click</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
On long tap button callback
|
(self, params, button_instance, time) On long tap button callback
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">on_double_click</span>
|
<li><span class="parameter">on_double_click</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
On double tap button callback
|
(self, params, button<em>instance, click</em>amount) On double tap button callback
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">on_hold_callback</span>
|
<li><span class="parameter">on_hold_callback</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
On button hold before long_click callback
|
(self, params, button<em>instance, time) On button hold before long</em>click callback
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -409,7 +404,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -277,7 +277,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -88,7 +88,7 @@
|
|||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_state">set_state(state)</a></td>
|
<td class="name" nowrap><a href="#set_state">set_state(indexes)</a></td>
|
||||||
<td class="summary">Set checkbox group state</td>
|
<td class="summary">Set checkbox group state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -147,7 +147,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_state"></a>
|
<a name = "set_state"></a>
|
||||||
<strong>set_state(state)</strong>
|
<strong>set_state(indexes)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set checkbox group state
|
Set checkbox group state
|
||||||
@ -155,7 +155,7 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">state</span>
|
<li><span class="parameter">indexes</span>
|
||||||
<span class="types"><span class="type">bool[]</span></span>
|
<span class="types"><span class="type">bool[]</span></span>
|
||||||
Array of checkbox state
|
Array of checkbox state
|
||||||
</li>
|
</li>
|
||||||
@ -239,7 +239,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -370,7 +370,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -61,7 +61,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -236,7 +236,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -211,7 +211,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -61,7 +61,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -181,7 +181,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -57,7 +57,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -86,7 +86,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -240,7 +240,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -82,7 +82,7 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(node, key, init_value)</a></td>
|
<td class="name" nowrap><a href="#init">init(node, key[, init_value=1])</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -135,7 +135,7 @@
|
|||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(node, key, init_value)</strong>
|
<strong>init(node, key[, init_value=1])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Component init function
|
Component init function
|
||||||
@ -154,6 +154,7 @@
|
|||||||
<li><span class="parameter">init_value</span>
|
<li><span class="parameter">init_value</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Initial value of progress bar
|
Initial value of progress bar
|
||||||
|
(<em>default</em> 1)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -378,7 +379,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -88,7 +88,7 @@
|
|||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_state">set_state(state)</a></td>
|
<td class="name" nowrap><a href="#set_state">set_state(index)</a></td>
|
||||||
<td class="summary">Set radio group state</td>
|
<td class="summary">Set radio group state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -147,7 +147,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_state"></a>
|
<a name = "set_state"></a>
|
||||||
<strong>set_state(state)</strong>
|
<strong>set_state(index)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set radio group state
|
Set radio group state
|
||||||
@ -155,9 +155,9 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">state</span>
|
<li><span class="parameter">index</span>
|
||||||
<span class="types"><span class="type">bool[]</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Array of checkbox state
|
Index in radio group
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -178,8 +178,8 @@
|
|||||||
<h3>Returns:</h3>
|
<h3>Returns:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">bool[]</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Array if checkboxes state
|
Index in radio group
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -239,7 +239,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -389,7 +389,7 @@
|
|||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">on_point_scroll</span>
|
<li><span class="parameter">on_point_scroll</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
On scroll<em>to</em>index function callbck
|
On scroll<em>to</em>index function callback
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -507,7 +507,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -278,7 +278,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -142,7 +142,7 @@
|
|||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">value</span>
|
<li><span class="parameter">value</span>
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
Initial text
|
Initial text. Default value is node text from GUI scene.
|
||||||
(<em>optional</em>)
|
(<em>optional</em>)
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">no_adjust</span>
|
<li><span class="parameter">no_adjust</span>
|
||||||
@ -352,7 +352,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -293,7 +293,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -61,7 +61,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -239,7 +239,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -61,7 +61,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -107,6 +107,10 @@
|
|||||||
<td class="summary">Create new druid component</td>
|
<td class="summary">Create new druid component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:final">druid:final()</a></td>
|
||||||
|
<td class="summary">Call on final function on gui_script.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:remove">druid:remove(component)</a></td>
|
<td class="name" nowrap><a href="#druid:remove">druid:remove(component)</a></td>
|
||||||
<td class="summary">Remove component from druid instance.</td>
|
<td class="summary">Remove component from druid instance.</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -240,6 +244,21 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:final"></a>
|
||||||
|
<strong>druid:final()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Call on final function on gui<em>script. It will call on</em>remove
|
||||||
|
on all druid components
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "druid:remove"></a>
|
<a name = "druid:remove"></a>
|
||||||
@ -750,7 +769,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -52,7 +52,7 @@
|
|||||||
|
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><strong>Druid components</strong></li>
|
<li><strong>01-components</strong></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -88,46 +88,59 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1>Druid components</h1>
|
<h1>Druid components</h1>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Button"></a></p>
|
<p><a name="Button"></a></p>
|
||||||
<h2>Button</h2>
|
<h2>Button</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.button.html">Button API here</a></p>
|
||||||
|
|
||||||
<p>Basic Druid input component</p>
|
<h3>Overview</h3>
|
||||||
|
<p>Basic Druid input component. Handle input on node and provide different callbacks on touch events.</p>
|
||||||
|
|
||||||
<ul>
|
<h3>Setup</h3>
|
||||||
<li>Button callback have next params: (self, params, button_instance)
|
<p>Create button with druid: <code>button = druid:new_button(node_name, callback, [params], [animation_node])</code>
|
||||||
|
Where node name is name of node from GUI scene. You can use <code>node_name</code> as input trigger zone and point another node for animation via <code>animation_node</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Button callback have next params: (self, params, button_instance)</p>
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
- **self** - Druid self context
|
- **self** - Druid self context
|
||||||
- **params** - Additional params, specified on button creating
|
- **params** - Additional params, specified on button creating
|
||||||
- **button_instance** - button itself
|
- **button_instance** - button itself
|
||||||
</pre>
|
</pre>
|
||||||
</li>
|
|
||||||
<li>Button have next events:
|
<p>- You can set <em>params</em> on button callback on button creating: <code>druid:new_button("node_name", callback, params)</code>. This <em>params</em> will pass in callback as second argument
|
||||||
|
- Button have next events:</p>
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
- **on_click** - basic button callback
|
- **on_click** - basic button callback
|
||||||
- **on_repeated_click** - repeated click callback, <span class="keyword">while</span> holding the button, don<span class="string">'t trigger if callback is empty
|
- **on_repeated_click** - repeated click callback, <span class="keyword">while</span> holding the button, don<span class="string">'t trigger if callback is empty
|
||||||
- **on_long_click** - callback on long button tap, don'</span>t trigger <span class="keyword">if</span> callback is empty
|
- **on_long_click** - callback on long button tap, don'</span>t trigger <span class="keyword">if</span> callback is empty
|
||||||
- **on_hold_callback** - hold callback, before long_click trigger, don<span class="string">'t trigger if callback is empty
|
- **on_hold_click** - hold callback, before long_click trigger, don<span class="string">'t trigger if callback is empty
|
||||||
- **on_double_click** - different callback, if tap button 2+ in row, don'</span>t trigger <span class="keyword">if</span> callback is empty
|
- **on_double_click** - different callback, if tap button 2+ in row, don'</span>t trigger <span class="keyword">if</span> callback is empty
|
||||||
</pre>
|
</pre>
|
||||||
</li>
|
|
||||||
<li>If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use <a href="../modules/druid.button.html#set_click_zone">button:set_click_zone</a> to restrict button click zone</li>
|
<p>- If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use <a href="../modules/druid.button.html#set_click_zone">button:set_click_zone</a> to restrict button click zone
|
||||||
<li>Button can have key trigger to use then by key: <a href="../modules/druid.button.html#set_key_trigger">button:set_key_trigger</a></li>
|
- Button can have key trigger to use then by key: <a href="../modules/druid.button.html#set_key_trigger">button:set_key_trigger</a>
|
||||||
</ul>
|
- Animation node can be used for example to animate small icon on big panel. Node name of trigger zone will be <code>big panel</code> and animation node will be <code>small icon</code></p>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Text"></a></p>
|
<p><a name="Text"></a></p>
|
||||||
<h2>Text</h2>
|
<h2>Text</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.text.html">Text API here</a></p>
|
||||||
|
|
||||||
<p>Basic Druid text component</p>
|
<h3>Overview</h3>
|
||||||
|
<p>Basic Druid text component. Text components by default have the text size adjusting.</p>
|
||||||
|
|
||||||
<ul>
|
<h3>Setup</h3>
|
||||||
<li>Text component by default have auto adjust text sizing. Text never will be more, than text size, which you can setup in gui scene. It can be disabled on component creating</li>
|
<p>Create text node with druid: <code>text = druid:new_text(node_name, [initial_value])</code></p>
|
||||||
</ul>
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Text component by default have auto adjust text sizing. Text never will be bigger, than text node size, which you can setup in GUI scene. It can be disabled on component creating by settings argument <code>is_no_adjust</code> to <em>true</em></p>
|
||||||
|
|
||||||
<p><img src="../media/text_autosize.png" alt=""/></p>
|
<p><img src="../media/text_autosize.png" alt=""/></p>
|
||||||
|
|
||||||
@ -140,14 +153,17 @@
|
|||||||
|
|
||||||
<p><a name="Blocker"></a></p>
|
<p><a name="Blocker"></a></p>
|
||||||
<h2>Blocker</h2>
|
<h2>Blocker</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.button.html">Blocker API here</a></p>
|
||||||
|
|
||||||
<p>Druid component for block input</p>
|
<h3>Overview</h3>
|
||||||
|
<p>Druid component for block input. Use it to block input in special zone.</p>
|
||||||
|
|
||||||
<p>It can be used for block input in special zone.</p>
|
<h3>Setup</h3>
|
||||||
|
<p>Create blocker component with druid: <code>druid:new_blocker(node_name)</code></p>
|
||||||
|
|
||||||
<p>Example:</p>
|
<h3>Notes</h3>
|
||||||
|
<p>Explanation:
|
||||||
<p><img src="../media/blocker_scheme.png" alt=""/></p>
|
<img src="../media/blocker_scheme.png" alt=""/></p>
|
||||||
|
|
||||||
<p>Blue zone is <strong>button</strong> with close_window callback</p>
|
<p>Blue zone is <strong>button</strong> with close_window callback</p>
|
||||||
|
|
||||||
@ -155,62 +171,209 @@
|
|||||||
|
|
||||||
<p>So you can do the safe zones, when you have the big buttons</p>
|
<p>So you can do the safe zones, when you have the big buttons</p>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Back_Handler"></a></p>
|
<p><a name="Back_Handler"></a></p>
|
||||||
<h2>Back Handler</h2>
|
<h2>Back Handler</h2>
|
||||||
<p>Component to handle back button</p>
|
<p><a href="https://insality.github.io/druid/modules/druid.back_handler.html">Back handler API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
|
<p>Component to handle back button. It handle Android back button and Backspace key. Key triggers in <code>input.binding</code> should be setup for correct working.</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Setup callback with <code>druid:new_back_handler(callback)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
|
||||||
<p>It works on Android back button and Backspace. Key triggers in <code>input.binding</code> should be setup</p>
|
|
||||||
|
|
||||||
<p><a name="Lang_text"></a></p>
|
<p><a name="Lang_text"></a></p>
|
||||||
<h2>Lang text</h2>
|
<h2>Lang text</h2>
|
||||||
<p>Wrap on Text component to handle localization</p>
|
<p><a href="https://insality.github.io/druid/modules/druid.lang_text.html">Lang text API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
|
<p>Wrap on Text component to handle localization. It uses druid get<em>text</em>function to set text by it's id</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create lang text component with druid <code>text = druid:new_lang_text(node_name, locale_id)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Scroll"></a></p>
|
<p><a name="Scroll"></a></p>
|
||||||
<h2>Scroll</h2>
|
<h2>Scroll</h2>
|
||||||
<p>Basic Druid scroll component</p>
|
<p><a href="https://insality.github.io/druid/modules/druid.scroll.html">Scroll API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
|
<p>Basic Druid scroll component. Handle all scrolling stuff in druid GUI</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create scroll component with druid: <code>scroll = druid:new_scroll(scroll_parent, scroll_input)</code>.</p>
|
||||||
|
|
||||||
|
<p><em>Scroll parent</em> - is dynamic part. This node will change position by scroll system</p>
|
||||||
|
|
||||||
|
<p><em>Scroll input</em> - is static part. It capturing user input and recognize scrolling touches</p>
|
||||||
|
|
||||||
|
<p>Initial scroll size will be equal to <em>scroll parent</em> node size. The initial view box will be equal to <em>scroll input</em> node size</p>
|
||||||
|
|
||||||
|
<p>Usually, Place static input zone part, and as children add scroll parent part:
|
||||||
|
<img src="../media/scroll_scheme.png" alt=""/>
|
||||||
|
<img src="../media/scroll_outline.png" alt=""/></p>
|
||||||
|
|
||||||
|
<p>*Here scroll<em>content</em>zone below input zone, in game content zone be able to scroll left until end*</p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Scroll by default style have inertion and "back moving". It can be adjust via scroll <a href="https://insality.github.io/druid/modules/druid.scroll.html#Style">style settings</a>
|
||||||
|
- You can setup "points of interest". Scroll always will be centered on closes point of interest. It is able to create slider without inertion and points of interest on each scroll element.
|
||||||
|
- Scroll have next events:</p>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
- *on_scroll* On scroll move callback
|
||||||
|
- *on_scroll_to* On scroll_to <span class="keyword">function</span> callback
|
||||||
|
- *on_point_scroll* On scroll_to_index <span class="keyword">function</span> callback
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>- You can adjust scroll content size by <code>scroll:set_border(node_size)</code>. It will setup new size to content node.</p>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Progress"></a></p>
|
<p><a name="Progress"></a></p>
|
||||||
<h2>Progress</h2>
|
<h2>Progress</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.progress.html">Progress API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
<p>Basic Druid progress bar component</p>
|
<p>Basic Druid progress bar component</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create progress bar component with druid: <code>progress = druid:new_progress(node_name, key, init_value)</code></p>
|
||||||
|
|
||||||
|
<p>Node name should have maximum node size, so in GUI scene, node_name should be fully filled.
|
||||||
|
Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or just "y")</p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Progress correct working with 9slice nodes, it trying to set size by <em>set</em>size_ first, if it is not possible, it set up sizing via <em>set</em>scale_
|
||||||
|
- Progress bar can fill only by vertical or horizontal size. If you want make diagonal progress bar, just rotate node in GUI scene
|
||||||
|
- If you have glitchy or dark texture bug with progress bar, try to disable mipmaps in your texture profiles</p>
|
||||||
|
|
||||||
<p><a name="Slider"></a></p>
|
<p><a name="Slider"></a></p>
|
||||||
<h2>Slider</h2>
|
<h2>Slider</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.slider.html">Slider API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
<p>Basic Druid slider component</p>
|
<p>Basic Druid slider component</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create slider component with druid: <code>slider = druid:new_slider(node_name, end_pos, callback)</code></p>
|
||||||
|
|
||||||
|
<p>Pin node (node_name in params) should be placed in zero position (initial). It will be available to mode Pin node between start pos and end pos. </p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- You can setup points of interests on slider via <a href="../modules/druid.slider.html#set_steps">slider:set_steps</a>. If steps are exist, slider values will be only from this steps (notched slider)
|
||||||
|
- For now, start pos and end pos should be on vertical or horizontal line (their x or y value should be equal)</p>
|
||||||
|
|
||||||
<p><a name="Input"></a></p>
|
<p><a name="Input"></a></p>
|
||||||
<h2>Input</h2>
|
<h2>Input</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.input.html">Input API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
<p>Basic Druid text input component (unimplemented)</p>
|
<p>Basic Druid text input component (unimplemented)</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Checkbox"></a></p>
|
<p><a name="Checkbox"></a></p>
|
||||||
<h2>Checkbox</h2>
|
<h2>Checkbox</h2>
|
||||||
<p>Basic Druid checkbox component</p>
|
<p><a href="https://insality.github.io/druid/modules/druid.checkbox.html">Checkbox API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
|
<p>Basic Druid checkbox component.</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create checkbox component with druid: <code>checkbox = druid:new_checkbox(node, callback)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Checkbox uses button to handle click
|
||||||
|
- You can setup another node to handle input with click_node arg in component init: <code>druid:new_checkbox(node, callback, [click_node])</code></p>
|
||||||
|
|
||||||
<p><a name="Checkbox_group"></a></p>
|
<p><a name="Checkbox_group"></a></p>
|
||||||
<h2>Checkbox group</h2>
|
<h2>Checkbox group</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.checkbox_group.html">Checkbox group API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
<p>Several checkboxes in one group</p>
|
<p>Several checkboxes in one group</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create checkbox_group component with druid: <code>group = druid:new_checkbox_group(nodes[], callback)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Callback arguments: <code>function(self, checkbox_index)</code>. Index is equals in <em>nodes[]</em> array in component constructor
|
||||||
|
- You can get/set checkbox_group state with <code>group:set_state()</code> and <code>group:get_state()</code></p>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Radio_group"></a></p>
|
<p><a name="Radio_group"></a></p>
|
||||||
<h2>Radio group</h2>
|
<h2>Radio group</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.radio_group.html">Radio group API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
<p>Several checkboxes in one group with single choice</p>
|
<p>Several checkboxes in one group with single choice</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create radio_group component with druid: <code>group = druid:new_radio_group(nodes[], callback)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Callback arguments: <code>function(self, checkbox_index)</code>. Index is equals in <em>nodes[]</em> array in component constructor
|
||||||
|
- You can get/set radio_group state with <code>group:set_state()</code> and <code>group:get_state()</code>
|
||||||
|
- Only different from checkbox_group: on click another checkboxes in this group will be unchecked</p>
|
||||||
|
|
||||||
<p><a name="Timer"></a></p>
|
<p><a name="Timer"></a></p>
|
||||||
<h2>Timer</h2>
|
<h2>Timer</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.timer.html">Timer API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
<p>Handle timer work on gui text node</p>
|
<p>Handle timer work on gui text node</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create timer component with druid: <code>timer = druid:new_timer(text_node, from_seconds, to_seconds, callback)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Timer fires callback, when timer value equals to <em>to</em>seconds_
|
||||||
|
- Timer will setup text node with current timer value
|
||||||
|
- Timer uses update function to handle time</p>
|
||||||
|
|
||||||
<p><a name="Grid"></a></p>
|
<p><a name="Grid"></a></p>
|
||||||
<h2>Grid</h2>
|
<h2>Grid</h2>
|
||||||
<p>Component for manage node positions </p>
|
<p><a href="https://insality.github.io/druid/modules/druid.grid.html">Grid API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
|
<p>Component for manage node positions. Very simple implementation for nodes with equal size</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create grid component with druid: <code>grid = druid:new_grid(parent_node, prefab_node, max_in_row_elements)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<p>- Grid on <em>adding elements</em> will setup parent to <em>parent</em>node_
|
||||||
|
- You can get array of position of every element for setup points of interest in scroll component
|
||||||
|
- You can get size of all elements for setup size in scroll component
|
||||||
|
- You can adjust anchor and border between elements
|
||||||
|
- <em>Prefab node</em> in component init used to get grid item size</p>
|
||||||
|
|
||||||
<p><a name="Hover"></a></p>
|
<p><a name="Hover"></a></p>
|
||||||
<h2>Hover</h2>
|
<h2>Hover</h2>
|
||||||
|
<p><a href="https://insality.github.io/druid/modules/druid.hover.html">Hover API here</a></p>
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
<p>System Druid component, handle hover node state</p>
|
<p>System Druid component, handle hover node state</p>
|
||||||
|
|
||||||
|
<h3>Setup</h3>
|
||||||
|
<p>Create grid component with druid: <code>hover = druid:new_hover(node, callback)</code></p>
|
||||||
|
|
||||||
|
<h3>Notes</h3>
|
||||||
|
|
||||||
|
|
||||||
</div> <!-- id="content" -->
|
</div> <!-- id="content" -->
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -41,7 +41,7 @@
|
|||||||
|
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><strong>Creating custom components</strong></li>
|
<li><strong>Creating custom components</strong></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -120,6 +120,15 @@
|
|||||||
</span><span class="keyword">function</span> M.on_layout_change(self)
|
</span><span class="keyword">function</span> M.on_layout_change(self)
|
||||||
<span class="keyword">end</span>
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
|
<span class="comment">-- Call, if input was capturing before this component
|
||||||
|
</span><span class="comment">-- Example: scroll is start scrolling, so you need unhover button
|
||||||
|
</span><span class="keyword">function</span> M.on_input_interrupt(self)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
|
<span class="comment">-- Call on component remove or on druid:final
|
||||||
|
</span><span class="keyword">function</span> M.on_remove(self)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
<span class="keyword">return</span> M
|
<span class="keyword">return</span> M
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
@ -131,12 +140,26 @@
|
|||||||
<span class="keyword">local</span> druid = <span class="global">require</span>(<span class="string">"druid.druid"</span>)
|
<span class="keyword">local</span> druid = <span class="global">require</span>(<span class="string">"druid.druid"</span>)
|
||||||
<span class="keyword">local</span> my_component = <span class="global">require</span>(<span class="string">"my.amazing.component"</span>)
|
<span class="keyword">local</span> my_component = <span class="global">require</span>(<span class="string">"my.amazing.component"</span>)
|
||||||
|
|
||||||
<span class="keyword">local</span> <span class="keyword">function</span> init(self)
|
<span class="keyword">function</span> init(self)
|
||||||
druid.register(<span class="string">"my_component"</span>, my_component)
|
druid.register(<span class="string">"my_component"</span>, my_component)
|
||||||
<span class="keyword">end</span>
|
<span class="keyword">end</span>
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Registering make new function with "new<em>{component</em>name}". In our example it will be: <code>druid:new_my_component()</code></p>
|
||||||
|
|
||||||
|
<p>As component registered, you can create your component with next code:</p>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
<span class="keyword">local</span> druid = <span class="global">require</span>(<span class="string">"druid.druid"</span>)
|
||||||
|
|
||||||
|
<span class="keyword">function</span> init(self)
|
||||||
|
self.druid = druid.new(self)
|
||||||
|
<span class="keyword">local</span> my_component = self.druid:new_my_component(...)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
|
||||||
<h3>Interest</h3>
|
<h3>Interest</h3>
|
||||||
<p>Interest - is a way to indicate what events your component will respond to.
|
<p>Interest - is a way to indicate what events your component will respond to.
|
||||||
There is next interests in druid:
|
There is next interests in druid:
|
||||||
@ -202,7 +225,7 @@ There is next interests in druid:
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -40,7 +40,7 @@
|
|||||||
|
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><strong>Styles</strong></li>
|
<li><strong>Styles</strong></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -138,7 +138,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -38,7 +38,7 @@
|
|||||||
|
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><strong>Druid assets</strong></li>
|
<li><strong>Druid assets</strong></li>
|
||||||
@ -80,7 +80,7 @@
|
|||||||
<h2>Overview</h2>
|
<h2>Overview</h2>
|
||||||
<p>I've created <a href="https://github.com/Insality/druid-assets">druid-assets repository</a> to make a <em>marketplace</em> with custom styles and components.</p>
|
<p>I've created <a href="https://github.com/Insality/druid-assets">druid-assets repository</a> to make a <em>marketplace</em> with custom styles and components.</p>
|
||||||
|
|
||||||
<p>Any of druid users can push their own components and styles to share it with the other users</p>
|
<p>Any of Druid users can push their own components and styles to share it with the other users</p>
|
||||||
|
|
||||||
<p>Also, this marketplace is great example to how you can create your custom components</p>
|
<p>Also, this marketplace is great example to how you can create your custom components</p>
|
||||||
|
|
||||||
@ -89,7 +89,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -38,7 +38,7 @@
|
|||||||
|
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -87,7 +87,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
@ -36,6 +36,7 @@
|
|||||||
<li><a href="#Components">Components </a></li>
|
<li><a href="#Components">Components </a></li>
|
||||||
<li><a href="#Basic_usage">Basic usage </a></li>
|
<li><a href="#Basic_usage">Basic usage </a></li>
|
||||||
<li><a href="#Druid_Events">Druid Events </a></li>
|
<li><a href="#Druid_Events">Druid Events </a></li>
|
||||||
|
<li><a href="#Druid_lifecycle">Druid lifecycle </a></li>
|
||||||
<li><a href="#Features">Features </a></li>
|
<li><a href="#Features">Features </a></li>
|
||||||
<li><a href="#Examples">Examples </a></li>
|
<li><a href="#Examples">Examples </a></li>
|
||||||
<li><a href="#Documentation">Documentation </a></li>
|
<li><a href="#Documentation">Documentation </a></li>
|
||||||
@ -48,7 +49,7 @@
|
|||||||
|
|
||||||
<h2>Topics</h2>
|
<h2>Topics</h2>
|
||||||
<ul class="">
|
<ul class="">
|
||||||
<li><a href="../topics/01-components.md.html">Druid components</a></li>
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
||||||
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
||||||
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
||||||
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
||||||
@ -85,6 +86,8 @@
|
|||||||
|
|
||||||
<a href="https://insality.github.io/druid/"><img src="media/druid_logo.png" alt=""/></a></p>
|
<a href="https://insality.github.io/druid/"><img src="media/druid_logo.png" alt=""/></a></p>
|
||||||
|
|
||||||
|
<p><a href="https://github.com/Insality/druid/releases"><img src="https://img.shields.io/github/v/release/insality/druid" alt="GitHub release (latest by date)"/></a></p>
|
||||||
|
|
||||||
<p><strong>Druid</strong> - powerful defold component UI library. Use basic <strong>Druid</strong> components or make your own game-specific components to make amazing GUI in your games.</p>
|
<p><strong>Druid</strong> - powerful defold component UI library. Use basic <strong>Druid</strong> components or make your own game-specific components to make amazing GUI in your games.</p>
|
||||||
|
|
||||||
|
|
||||||
@ -107,8 +110,8 @@
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>Mouse trigger - <code>Button 1</code> -> <code>touch</code> <em>For basic input components</em></li>
|
<li>Mouse trigger - <code>Button 1</code> -> <code>touch</code> <em>For basic input components</em></li>
|
||||||
<li>Key trigger - <code>Backspace</code> -> <code>backspace</code> <em>For back</em>handler component_</li>
|
<li>Key trigger - <code>Backspace</code> -> <code>back</code> <em>For back</em>handler component_</li>
|
||||||
<li>Key trigger - <code>Back</code> -> <a href="../modules/druid.text.html#">text</a> <em>For back</em>handler component, Android back button_</li>
|
<li>Key trigger - <code>Back</code> -> <code>back</code> <em>For back</em>handler component, Android back button_</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<p><img src="media/input_binding.png" alt=""/></p>
|
<p><img src="media/input_binding.png" alt=""/></p>
|
||||||
@ -193,14 +196,6 @@
|
|||||||
self.druid:new_button(<span class="string">"button_node_name"</span>, button_callback)
|
self.druid:new_button(<span class="string">"button_node_name"</span>, button_callback)
|
||||||
<span class="keyword">end</span>
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
<span class="keyword">function</span> update(self, dt)
|
|
||||||
self.druid:update(dt)
|
|
||||||
<span class="keyword">end</span>
|
|
||||||
|
|
||||||
<span class="keyword">function</span> on_message(self, message_id, message, sender)
|
|
||||||
self.druid:on_message(message_id, message, sender)
|
|
||||||
<span class="keyword">end</span>
|
|
||||||
|
|
||||||
<span class="keyword">function</span> on_input(self, action_id, action)
|
<span class="keyword">function</span> on_input(self, action_id, action)
|
||||||
<span class="keyword">return</span> self.druid:on_input(action_id, action)
|
<span class="keyword">return</span> self.druid:on_input(action_id, action)
|
||||||
<span class="keyword">end</span>
|
<span class="keyword">end</span>
|
||||||
@ -210,7 +205,7 @@
|
|||||||
<p><a name="Druid_Events"></a></p>
|
<p><a name="Druid_Events"></a></p>
|
||||||
<h2>Druid Events</h2>
|
<h2>Druid Events</h2>
|
||||||
|
|
||||||
<p>Any <strong>Druid</strong> components as callbacks uses Druid Events. In component API (<a href="https://insality.github.io/druid/modules/druid.button.html#Events">button example</a>) pointed list of component events. You can manually subscribe on this events by next API:</p>
|
<p>Any <strong>Druid</strong> components as callbacks uses <a href="https://insality.github.io/druid/modules/druid_event.html">Druid Events</a>. In component API (<a href="https://insality.github.io/druid/modules/druid.button.html#Events">button example</a>) pointed list of component events. You can manually subscribe on this events by next API:</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p><strong>event:subscribe</strong>(callback)</p></li>
|
<li><p><strong>event:subscribe</strong>(callback)</p></li>
|
||||||
@ -220,6 +215,47 @@
|
|||||||
|
|
||||||
<p>Any events can handle several callbacks, if needed.</p>
|
<p>Any events can handle several callbacks, if needed.</p>
|
||||||
|
|
||||||
|
|
||||||
|
<p><a name="Druid_lifecycle"></a></p>
|
||||||
|
<h2>Druid lifecycle</h2>
|
||||||
|
|
||||||
|
<p>Here is full druid lifecycle setup in your <strong>*.gui_script</strong> file:</p>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
<span class="keyword">local</span> druid = <span class="global">require</span>(<span class="string">"druid.druid"</span>)
|
||||||
|
|
||||||
|
<span class="keyword">function</span> init(self)
|
||||||
|
self.druid = druid.new(self)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
|
<span class="keyword">function</span> final(self)
|
||||||
|
self.druid:final()
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
|
<span class="keyword">function</span> update(self, dt)
|
||||||
|
self.druid:update(dt)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
|
<span class="keyword">function</span> on_input(self, action_id, action)
|
||||||
|
<span class="keyword">return</span> self.druid:on_input(action_id, action)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
|
||||||
|
<span class="keyword">function</span> on_message(self, message_id, message, sender)
|
||||||
|
self.druid:on_message(message_id, message, sender)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>*on_input* used for almost all basic druid components</li>
|
||||||
|
<li><em>update</em> used for progress bar, scroll and timer base components</li>
|
||||||
|
<li>*on_message* used for specific druid events, like language change or layout change (TODO: in future)</li>
|
||||||
|
<li><em>final</em> used for custom components, what have to do several action before destroy</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>Recommended is fully integrate al druid lifecycles functions</p>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Features"></a></p>
|
<p><a name="Features"></a></p>
|
||||||
<h2>Features</h2>
|
<h2>Features</h2>
|
||||||
|
|
||||||
@ -228,10 +264,11 @@
|
|||||||
<li>Don't forget about <code>return</code> in <code>on_input</code>: <code>return self.druid:on_input()</code>. It need, if you have more than 1 acquire inputs (several druid, other input system, etc)</li>
|
<li>Don't forget about <code>return</code> in <code>on_input</code>: <code>return self.druid:on_input()</code>. It need, if you have more than 1 acquire inputs (several druid, other input system, etc)</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<p><a name="Examples"></a></p>
|
<p><a name="Examples"></a></p>
|
||||||
<h2>Examples</h2>
|
<h2>Examples</h2>
|
||||||
|
|
||||||
<p>See the <a href="https://github.com/insality/druid/tree/develop/example/kenney">example folder</a> for examples of how to use <strong>Druid</strong></p>
|
<p>See the <a href="https://github.com/Insality/druid/tree/develop/example">example folder</a> for examples of how to use <strong>Druid</strong></p>
|
||||||
|
|
||||||
<p>See the <a href="https://github.com/insality/druid-assets">druid-assets repository</a> for examples of how to create custom components and styles</p>
|
<p>See the <a href="https://github.com/insality/druid-assets">druid-assets repository</a> for examples of how to create custom components and styles</p>
|
||||||
|
|
||||||
@ -291,7 +328,7 @@ https://insality.github.io/druid/</p>
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2020-03-22 15:31:43 </i>
|
<i style="float:right;">Last updated 2020-04-09 22:11:32 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user