mirror of
https://github.com/Insality/druid
synced 2025-06-27 10:27:48 +02:00
Update docs
This commit is contained in:
parent
9ae07b4784
commit
f619b25ba8
@ -1,7 +1,6 @@
|
||||
project='Druid'
|
||||
title='Defold Druid UI Library'
|
||||
description='Documentation for Druid Library'
|
||||
format='lunamark'
|
||||
file={"./druid"}
|
||||
dir='./docs'
|
||||
style='!pale'
|
||||
|
@ -31,25 +31,26 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="modules/base.back_handler.html">base.back_handler</a></li>
|
||||
<li><a href="modules/base.blocker.html">base.blocker</a></li>
|
||||
<li><a href="modules/base.button.html">base.button</a></li>
|
||||
<li><a href="modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="modules/base.text.html">base.text</a></li>
|
||||
<li><a href="modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="modules/constants.html">constants</a></li>
|
||||
<li><a href="modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||
<li><a href="modules/druid.blocker.html">druid.blocker</a></li>
|
||||
<li><a href="modules/druid.button.html">druid.button</a></li>
|
||||
<li><a href="modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||
<li><a href="modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="modules/druid.grid.html">druid.grid</a></li>
|
||||
<li><a href="modules/druid.locale.html">druid.locale</a></li>
|
||||
<li><a href="modules/druid.progress.html">druid.progress</a></li>
|
||||
<li><a href="modules/druid.radio_group.html">druid.radio_group</a></li>
|
||||
<li><a href="modules/druid.scroll.html">druid.scroll</a></li>
|
||||
<li><a href="modules/druid.slider.html">druid.slider</a></li>
|
||||
<li><a href="modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="modules/druid.timer.html">druid.timer</a></li>
|
||||
<li><a href="modules/const.html">const</a></li>
|
||||
<li><a href="modules/druid.html">druid</a></li>
|
||||
<li><a href="modules/helper.html">helper</a></li>
|
||||
<li><a href="modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="modules/settings.html">settings</a></li>
|
||||
<li><a href="modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
||||
<li><a href="modules/component.html">component</a></li>
|
||||
<li><a href="modules/druid_instance.html">druid_instance</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -62,55 +63,61 @@
|
||||
<h2>Modules</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.back_handler.html">base.back_handler</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.back_handler.html">druid.back_handler</a></td>
|
||||
<td class="summary">Component to handle back key (android, backspace)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.blocker.html">base.blocker</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.blocker.html">druid.blocker</a></td>
|
||||
<td class="summary">Component to block input on specify zone (node)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.button.html">base.button</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.button.html">druid.button</a></td>
|
||||
<td class="summary">Component to handle basic GUI button</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.checkbox.html">base.checkbox</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.checkbox.html">druid.checkbox</a></td>
|
||||
<td class="summary">Druid checkbox component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.checkbox_group.html">base.checkbox_group</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.checkbox_group.html">druid.checkbox_group</a></td>
|
||||
<td class="summary">Checkboux group module</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.grid.html">base.grid</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.grid.html">druid.grid</a></td>
|
||||
<td class="summary">Component to handle placing components by row and columns.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.progress.html">base.progress</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.locale.html">druid.locale</a></td>
|
||||
<td class="summary">Component to handle all GUI texts
|
||||
Good working with localization system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/druid.progress.html">druid.progress</a></td>
|
||||
<td class="summary">Basic progress bar component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.checkbox_group.html">base.checkbox_group</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.radio_group.html">druid.radio_group</a></td>
|
||||
<td class="summary">Radio group module</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.scroll.html">base.scroll</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.scroll.html">druid.scroll</a></td>
|
||||
<td class="summary">Component to handle scroll content</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.slider.html">base.slider</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.slider.html">druid.slider</a></td>
|
||||
<td class="summary">Druid slider component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.text.html">base.text</a></td>
|
||||
<td class="summary">Component to handle all GUI texts Good working with localization system</td>
|
||||
<td class="name" nowrap><a href="modules/druid.text.html">druid.text</a></td>
|
||||
<td class="summary">Component to handle all GUI texts
|
||||
Good working with localization system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/base.timer.html">base.timer</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.timer.html">druid.timer</a></td>
|
||||
<td class="summary">Component to handle GUI timers</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/constants.html">constants</a></td>
|
||||
<td class="name" nowrap><a href="modules/const.html">const</a></td>
|
||||
<td class="summary">Druid constants</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -119,23 +126,23 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/helper.html">helper</a></td>
|
||||
<td class="summary">Druid helper module</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/helper.animate.html">helper.animate</a></td>
|
||||
<td class="summary">Druid helper module for animating GUI nodes</td>
|
||||
<td class="summary">Text node or icon node can be nil</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/helper.formats.html">helper.formats</a></td>
|
||||
<td class="summary">Druid module with utils on string formats</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/rich.progress_rich.html">rich.progress_rich</a></td>
|
||||
<td class="name" nowrap><a href="modules/druid.progress_rich.html">druid.progress_rich</a></td>
|
||||
<td class="summary">Component for rich progress component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/settings.html">settings</a></td>
|
||||
<td class="summary">Druid settings file</td>
|
||||
<td class="name" nowrap><a href="modules/component.html">component</a></td>
|
||||
<td class="summary">Basic class for all Druid components.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/druid_instance.html">druid_instance</a></td>
|
||||
<td class="summary">Druid main class.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@ -143,7 +150,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-05 02:41:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -44,18 +44,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -99,15 +101,15 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">callback</span></span>
|
||||
On back button
|
||||
On back button
|
||||
</li>
|
||||
<li><span class="parameter">Callback</span>
|
||||
<span class="types"><span class="type">params</span></span>
|
||||
argument
|
||||
argument
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
@ -129,11 +131,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">action_id</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
on_input action id
|
||||
on_input action id
|
||||
</li>
|
||||
<li><span class="parameter">action</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
on_input action
|
||||
on_input action
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -149,7 +151,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -40,18 +40,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -75,7 +77,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -44,18 +44,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -103,29 +105,29 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">node</span>
|
||||
<span class="types"><span class="type">node</span></span>
|
||||
Gui node
|
||||
Gui node
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
Button callback
|
||||
Button callback
|
||||
</li>
|
||||
<li><span class="parameter">params</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Button callback params
|
||||
Button callback params
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">anim_node</span>
|
||||
<span class="types"><span class="type">node</span></span>
|
||||
Button anim node (node, if not provided)
|
||||
Button anim node (node, if not provided)
|
||||
(<em>optional</em>)
|
||||
</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
|
||||
Button react event, const.ACTION_TOUCH by default
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
@ -147,7 +149,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -161,18 +163,19 @@
|
||||
<strong>set_click_zone(self, zone)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Strict button click area. Useful for no click events outside stencil node
|
||||
Strict button click area. Useful for
|
||||
no click events outside stencil node
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">zone</span>
|
||||
<span class="types"><span class="type">node</span></span>
|
||||
Gui node
|
||||
Gui node
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -188,7 +191,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -40,18 +40,20 @@
|
||||
<li><strong>base.checkbox</strong></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -75,7 +77,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -40,18 +40,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><strong>base.checkbox_group</strong></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><strong>base.checkbox_group</strong></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -75,7 +77,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -40,18 +40,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><strong>base.grid</strong></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -61,7 +63,8 @@
|
||||
|
||||
<h1>Module <code>base.grid</code></h1>
|
||||
<p>Component to handle placing components by row and columns.</p>
|
||||
<p>Grid can anchor your elements, get content size and other</p>
|
||||
<p>
|
||||
Grid can anchor your elements, get content size and other</p>
|
||||
|
||||
|
||||
|
||||
@ -75,7 +78,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -44,18 +44,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><strong>base.progress</strong></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -119,19 +121,19 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">node</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a> or <span class="type">node</span></span>
|
||||
Progress bar fill node or node name
|
||||
Progress bar fill node or node name
|
||||
</li>
|
||||
<li><span class="parameter">key</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Progress bar direction (x or y)
|
||||
Progress bar direction (x or y)
|
||||
</li>
|
||||
<li><span class="parameter">init_value</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Initial value of progress bar
|
||||
Initial value of progress bar
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -152,7 +154,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -173,7 +175,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -194,11 +196,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Progress bar value, from 0 to 1
|
||||
Progress bar value, from 0 to 1
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -219,7 +221,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -240,15 +242,15 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">steps</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Array of progress bar values
|
||||
Array of progress bar values
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
Callback on intersect step value
|
||||
Callback on intersect step value
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -269,15 +271,15 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
value between 0..1
|
||||
value between 0..1
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
Callback on animation ends
|
||||
Callback on animation ends
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
@ -294,7 +296,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -44,18 +44,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><strong>base.scroll</strong></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -115,11 +117,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">vector3</span>
|
||||
<span class="types"><span class="type">point</span></span>
|
||||
target point
|
||||
target point
|
||||
</li>
|
||||
<li><span class="parameter">is_instant</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
instant scroll flag
|
||||
instant scroll flag
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
@ -146,15 +148,15 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">index</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Point index
|
||||
Point index
|
||||
</li>
|
||||
<li><span class="parameter">skip_cb</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
If true, skip the point callback
|
||||
If true, skip the point callback
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
@ -169,18 +171,19 @@
|
||||
<strong>set_points(self, points)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set points of interest. Scroll will always centered on closer points
|
||||
Set points of interest.
|
||||
Scroll will always centered on closer points
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">points</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Array of vector3 points
|
||||
Array of vector3 points
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -194,18 +197,20 @@
|
||||
<strong>set_inert(self, state)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Enable or disable scroll inert. If disabled, scroll through points (if exist) If no points, just simple drag without inertion
|
||||
Enable or disable scroll inert.
|
||||
If disabled, scroll through points (if exist)
|
||||
If no points, just simple drag without inertion
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
Inert scroll state
|
||||
Inert scroll state
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -226,11 +231,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
Callback on scroll to point of interest
|
||||
Callback on scroll to point of interest
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -251,11 +256,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">border</span>
|
||||
<span class="types"><span class="type">vmath.vector3</span></span>
|
||||
Size of scrolling area
|
||||
Size of scrolling area
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -271,7 +276,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -40,18 +40,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><strong>base.slider</strong></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -75,7 +77,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -44,18 +44,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><strong>base.text</strong></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><strong>base.text</strong></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -64,16 +66,13 @@
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>base.text</code></h1>
|
||||
<p>Component to handle all GUI texts Good working with localization system</p>
|
||||
<p>Component to handle all GUI texts
|
||||
Good working with localization system</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#translate">translate(self, locale_id)</a></td>
|
||||
<td class="summary">Translate the text by locale_id</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
|
||||
<td class="summary">Set text to text field</td>
|
||||
@ -90,6 +89,10 @@
|
||||
<td class="name" nowrap><a href="#set_scale">set_scale(self, scale)</a></td>
|
||||
<td class="summary">Set scale</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_pivot">set_pivot(self, pivot)</a></td>
|
||||
<td class="summary">Set text pivot.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
@ -99,31 +102,6 @@
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "translate"></a>
|
||||
<strong>translate(self, locale_id)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Translate the text by locale_id
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">locale_id</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Locale id
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_to"></a>
|
||||
<strong>set_to(self, set_to)</strong>
|
||||
@ -136,11 +114,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">set_to</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Text for node
|
||||
Text for node
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -161,11 +139,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><span class="type">vmath.vector4</span></span>
|
||||
Color for node
|
||||
Color for node
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -186,11 +164,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">alpha</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Alpha for node
|
||||
Alpha for node
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -211,11 +189,37 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">scale</span>
|
||||
<span class="types"><span class="type">vmath.vector3</span></span>
|
||||
Scale for node
|
||||
Scale for node
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_pivot"></a>
|
||||
<strong>set_pivot(self, pivot)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set text pivot. Text will re-anchor inside
|
||||
his text area
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">pivot</span>
|
||||
<span class="types"><span class="type">gui.pivot</span></span>
|
||||
Gui pivot constant
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -231,7 +235,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -44,18 +44,20 @@
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><strong>base.timer</strong></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -103,11 +105,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">set_to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Value in seconds
|
||||
Value in seconds
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -128,11 +130,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">is_on</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
Timer enable state
|
||||
Timer enable state
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -153,15 +155,15 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">from</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Start time in seconds
|
||||
Start time in seconds
|
||||
</li>
|
||||
<li><span class="parameter">to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Target time in seconds
|
||||
Target time in seconds
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -177,7 +179,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -33,31 +33,31 @@
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||
<li><a href="../modules/druid.locale.html">druid.locale</a></li>
|
||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||
<li><a href="../modules/druid.radio_group.html">druid.radio_group</a></li>
|
||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
||||
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><strong>druid</strong></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -66,37 +66,25 @@
|
||||
|
||||
<h1>Module <code>druid</code></h1>
|
||||
<p>Druid UI Library.</p>
|
||||
<p>Component based UI library to make your life easier. Contains a lot of base components and give API to create your own rich components.</p>
|
||||
<p>
|
||||
Powerful Defold component based UI library. Use standart
|
||||
components or make your own game-specific to make amazing
|
||||
GUI in your games.
|
||||
<p> Contains the several basic components and examples
|
||||
to how to do your custom complex components to
|
||||
separate UI game logic to small files
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#register">register(name, module)</a></td>
|
||||
<td class="summary">Register external module</td>
|
||||
<td class="summary">Register external druid component.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#new">new(component_script)</a></td>
|
||||
<td class="summary">Create UI instance for ui elements</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#_fct_metatable.on_message">_fct_metatable.on_message(self, message_id, message, sender)</a></td>
|
||||
<td class="summary">Called on_message</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#_fct_metatable.on_input">_fct_metatable.on_input(self, action_id, action)</a></td>
|
||||
<td class="summary">Called ON_INPUT</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#_fct_metatable.update">_fct_metatable.update(self, dt)</a></td>
|
||||
<td class="summary">Called on_update</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#comps">comps</a></td>
|
||||
<td class="summary">Basic components</td>
|
||||
<td class="name" nowrap><a href="#new">new(context[, style])</a></td>
|
||||
<td class="summary">Create Druid instance.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@ -112,18 +100,20 @@
|
||||
<strong>register(name, module)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register external module
|
||||
Register external druid component.
|
||||
After register you can create the component with
|
||||
druid_instance:new_{name}. For example `druid:new_button(...)`
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
module name
|
||||
module name
|
||||
</li>
|
||||
<li><span class="parameter">module</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
lua table with module
|
||||
lua table with component
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -134,166 +124,35 @@
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "new"></a>
|
||||
<strong>new(component_script)</strong>
|
||||
<strong>new(context[, style])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Create UI instance for ui elements
|
||||
Create Druid instance.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">component_script</span>
|
||||
|
||||
<li><span class="parameter">context</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Druid context. Usually it is self of script
|
||||
</li>
|
||||
<li><span class="parameter">style</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Druid style module
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
instance with all ui components
|
||||
<span class="types"><span class="type">druid_instance</span></span>
|
||||
Druid instance
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "_fct_metatable.on_message"></a>
|
||||
<strong>_fct_metatable.on_message(self, message_id, message, sender)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Called on_message
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">message_id</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">message</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">sender</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "_fct_metatable.on_input"></a>
|
||||
<strong>_fct_metatable.on_input(self, action_id, action)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Called ON_INPUT
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">action_id</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">action</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "_fct_metatable.update"></a>
|
||||
<strong>_fct_metatable.update(self, dt)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Called on_update
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">dt</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "comps"></a>
|
||||
<strong>comps</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Basic components
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">button</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">blocker</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">back_handler</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">text</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">timer</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">progress</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">grid</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">scroll</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">slider</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">checkbox</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">checkbox_group</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">radio_group</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">progress_rich</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@ -302,7 +161,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-05 02:41:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -34,25 +34,27 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
||||
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><strong>helper.animate</strong></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -75,7 +77,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-05 00:14:12 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -38,25 +38,26 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||
<li><a href="../modules/druid.locale.html">druid.locale</a></li>
|
||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||
<li><a href="../modules/druid.radio_group.html">druid.radio_group</a></li>
|
||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
||||
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><strong>helper.formats</strong></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -103,18 +104,18 @@
|
||||
<ul>
|
||||
<li><span class="parameter">num</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Number for conversion
|
||||
Number for conversion
|
||||
</li>
|
||||
<li><span class="parameter">count</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Count of numerals
|
||||
Count of numerals
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
string with need count of zero (1,3) -> 001
|
||||
string with need count of zero (1,3) -> 001
|
||||
</ol>
|
||||
|
||||
|
||||
@ -133,7 +134,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">sec</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Seconds
|
||||
Seconds
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -159,11 +160,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">s</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Target string
|
||||
Target string
|
||||
</li>
|
||||
<li><span class="parameter">tab</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Table with parameters
|
||||
Table with parameters
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -184,7 +185,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-05 02:41:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -38,25 +38,26 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||
<li><a href="../modules/druid.locale.html">druid.locale</a></li>
|
||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||
<li><a href="../modules/druid.radio_group.html">druid.radio_group</a></li>
|
||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
||||
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><strong>helper</strong></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -64,7 +65,7 @@
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>helper</code></h1>
|
||||
<p>Druid helper module</p>
|
||||
<p>Text node or icon node can be nil</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
@ -146,7 +147,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-05 02:41:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -38,24 +38,26 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
||||
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><strong>rich.progress_rich</strong></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/settings.html">settings</a></li>
|
||||
</ul>
|
||||
|
||||
@ -103,11 +105,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Progress bar value, from 0 to 1
|
||||
Progress bar value, from 0 to 1
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -128,7 +130,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -149,15 +151,15 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component instance
|
||||
Component instance
|
||||
</li>
|
||||
<li><span class="parameter">to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
value between 0..1
|
||||
value between 0..1
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
Callback on animation ends
|
||||
Callback on animation ends
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
@ -174,7 +176,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-05 00:02:17 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@ -34,24 +34,26 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||
<li><a href="../modules/constants.html">constants</a></li>
|
||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
||||
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
||||
<li><a href="../modules/const.html">const</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/helper.html">helper</a></li>
|
||||
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><strong>settings</strong></li>
|
||||
</ul>
|
||||
|
||||
@ -75,7 +77,7 @@
|
||||
</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 2019-12-05 22:04:11 </i>
|
||||
<i style="float:right;">Last updated 2020-02-05 00:02:17 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
Loading…
x
Reference in New Issue
Block a user