mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 18:37:44 +02:00
Update docs, updated ldoc generated files
This commit is contained in:
Insality
parent
ca78b10794
commit
b7e58950aa
@ -1,7 +1,12 @@
|
|||||||
project='Druid'
|
project='Druid'
|
||||||
title='Defold Druid UI Library'
|
title='Defold Druid UI Library'
|
||||||
description='Documentation for Druid Library'
|
description='Documentation for Druid Library'
|
||||||
file={"./druid"}
|
file={"./druid",
|
||||||
|
exclude = {
|
||||||
|
"./druid/styles/",
|
||||||
|
"./druid/system/middleclass.lua"
|
||||||
|
}
|
||||||
|
}
|
||||||
package='druid'
|
package='druid'
|
||||||
sort=false
|
sort=false
|
||||||
dir='./docs'
|
dir='./docs'
|
||||||
|
|||||||
@ -37,6 +37,7 @@
|
|||||||
<li><a href="modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="modules/druid.input.html">druid.input</a></li>
|
<li><a href="modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -67,7 +68,7 @@
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.blocker.html">druid.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>
|
<td class="summary">Component to block input on specify zone by node</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.button.html">druid.button</a></td>
|
<td class="name" nowrap><a href="modules/druid.button.html">druid.button</a></td>
|
||||||
@ -79,16 +80,20 @@
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.checkbox_group.html">druid.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>
|
<td class="summary">Checkbox group module</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.grid.html">druid.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>
|
<td class="summary">Component to handle placing components by row and columns.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.input.html">druid.input</a></td>
|
<td class="name" nowrap><a href="modules/druid.hover.html">druid.hover</a></td>
|
||||||
<td class="summary">Component to handle hover node interaction</td>
|
<td class="summary">Component to handle hover node interaction</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/druid.input.html">druid.input</a></td>
|
||||||
|
<td class="summary">Druid input text component.</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.lang_text.html">druid.lang_text</a></td>
|
<td class="name" nowrap><a href="modules/druid.lang_text.html">druid.lang_text</a></td>
|
||||||
<td class="summary">Component to handle all GUI texts
|
<td class="summary">Component to handle all GUI texts
|
||||||
@ -96,7 +101,7 @@
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.progress.html">druid.progress</a></td>
|
<td class="name" nowrap><a href="modules/druid.progress.html">druid.progress</a></td>
|
||||||
<td class="summary">Basic progress bar component</td>
|
<td class="summary">Basic progress bar component.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.radio_group.html">druid.radio_group</a></td>
|
<td class="name" nowrap><a href="modules/druid.radio_group.html">druid.radio_group</a></td>
|
||||||
@ -104,7 +109,7 @@
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.scroll.html">druid.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>
|
<td class="summary">Component to handle scroll content.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.slider.html">druid.slider</a></td>
|
<td class="name" nowrap><a href="modules/druid.slider.html">druid.slider</a></td>
|
||||||
@ -112,12 +117,11 @@
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.text.html">druid.text</a></td>
|
<td class="name" nowrap><a href="modules/druid.text.html">druid.text</a></td>
|
||||||
<td class="summary">Component to handle all GUI texts
|
<td class="summary">Component to handle all GUI texts.</td>
|
||||||
Good working with localization system</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.timer.html">druid.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>
|
<td class="summary">Component to handle GUI timers.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/component.html">component</a></td>
|
<td class="name" nowrap><a href="modules/component.html">component</a></td>
|
||||||
@ -145,7 +149,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-21 20:02:23 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -44,6 +44,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -396,7 +397,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -33,6 +33,7 @@
|
|||||||
<h2>Contents</h2>
|
<h2>Contents</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#Functions">Functions</a></li>
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
@ -44,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -73,7 +75,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(self, callback[, Callback])</a></td>
|
<td class="name" nowrap><a href="#init">init(callback[, Callback])</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -81,6 +83,17 @@
|
|||||||
<td class="summary">Input handler for component</td>
|
<td class="summary">Input handler for component</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
@ -91,7 +104,7 @@
|
|||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, callback[, Callback])</strong>
|
<strong>init(callback[, Callback])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Component init function
|
Component init function
|
||||||
@ -99,10 +112,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">callback</span>
|
<li><span class="parameter">callback</span>
|
||||||
<span class="types"><span class="type">callback</span></span>
|
<span class="types"><span class="type">callback</span></span>
|
||||||
On back button
|
On back button
|
||||||
@ -143,6 +152,52 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_back</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On back handler callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">params</span>
|
||||||
|
<span class="types"><span class="type">any</span></span>
|
||||||
|
Params to click callbacks
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -151,7 +206,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -30,6 +30,11 @@
|
|||||||
<li><a href="../index.html">Index</a></li>
|
<li><a href="../index.html">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
@ -40,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -60,24 +66,166 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.blocker</code></h1>
|
<h1>Module <code>druid.blocker</code></h1>
|
||||||
<p>Component to block input on specify zone (node)</p>
|
<p>Component to block input on specify zone by node</p>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(node)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_enabled">set_enabled(state)</a></td>
|
||||||
|
<td class="summary">Set enabled blocker component state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#is_enabled">is_enabled()</a></td>
|
||||||
|
<td class="summary">Return blocked enabled state</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_enabled"></a>
|
||||||
|
<strong>set_enabled(state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set enabled blocker component state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Enabled state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "is_enabled"></a>
|
||||||
|
<strong>is_enabled()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return blocked enabled state
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
True, if blocker is enabled
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_click</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On release button callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_enable_change</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On enable/disable callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Trigger node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
</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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -45,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -74,19 +75,27 @@
|
|||||||
<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(self, node, callback[, params[, anim_node[, event]]])</a></td>
|
<td class="name" nowrap><a href="#init">init(node, callback[, params[, anim_node[, event]]])</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#disable_animation">disable_animation(self)</a></td>
|
<td class="name" nowrap><a href="#set_enabled">set_enabled(state)</a></td>
|
||||||
<td class="summary">Disable all button animations</td>
|
<td class="summary">Set enabled button component state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
<td class="name" nowrap><a href="#is_enabled">is_enabled()</a></td>
|
||||||
|
<td class="summary">Return button enabled state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(zone)</a></td>
|
||||||
<td class="summary">Strict button click area.</td>
|
<td class="summary">Strict button click area.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_key_trigger">get_key_trigger(self)</a></td>
|
<td class="name" nowrap><a href="#set_key_trigger">set_key_trigger(key)</a></td>
|
||||||
|
<td class="summary">Set key-code to trigger this button</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_key_trigger">get_key_trigger()</a></td>
|
||||||
<td class="summary">Get key-code to trigger this button</td>
|
<td class="summary">Get key-code to trigger this button</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
@ -115,7 +124,7 @@
|
|||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node, callback[, params[, anim_node[, event]]])</strong>
|
<strong>init(node, callback[, params[, anim_node[, event]]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Component init function
|
Component init function
|
||||||
@ -123,10 +132,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
Gui node
|
Gui node
|
||||||
@ -158,18 +163,18 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "disable_animation"></a>
|
<a name = "set_enabled"></a>
|
||||||
<strong>disable_animation(self)</strong>
|
<strong>set_enabled(state)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Disable all button animations
|
Set enabled button component state
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">state</span>
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
Component instance
|
Enabled state
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -177,10 +182,30 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "is_enabled"></a>
|
||||||
|
<strong>is_enabled()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return button enabled state
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
True, if button is enabled
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_click_zone"></a>
|
<a name = "set_click_zone"></a>
|
||||||
<strong>set_click_zone(self, zone)</strong>
|
<strong>set_click_zone(zone)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Strict button click area. Useful for
|
Strict button click area. Useful for
|
||||||
@ -189,10 +214,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">zone</span>
|
<li><span class="parameter">zone</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
Gui node
|
Gui node
|
||||||
@ -203,24 +224,43 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_key_trigger"></a>
|
||||||
|
<strong>set_key_trigger(key)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set key-code to trigger this button
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">key</span>
|
||||||
|
<span class="types"><span class="type">hash</span></span>
|
||||||
|
The action_id of the key
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_key_trigger"></a>
|
<a name = "get_key_trigger"></a>
|
||||||
<strong>get_key_trigger(self)</strong>
|
<strong>get_key_trigger()</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Get key-code to trigger this button
|
Get key-code to trigger this button
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">hash</span></span>
|
||||||
</li>
|
The action_id of the key
|
||||||
</ul>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -294,10 +334,6 @@
|
|||||||
<span class="types"><span class="type">any</span></span>
|
<span class="types"><span class="type">any</span></span>
|
||||||
Params to click callbacks
|
Params to click callbacks
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">hover_anim</span>
|
|
||||||
<span class="types"><span class="type">boolean</span></span>
|
|
||||||
Is hover anim enabled
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">hover</span>
|
<li><span class="parameter">hover</span>
|
||||||
<span class="types"><span class="type">druid.hover</span></span>
|
<span class="types"><span class="type">druid.hover</span></span>
|
||||||
Druid hover logic component
|
Druid hover logic component
|
||||||
@ -360,7 +396,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -30,6 +30,11 @@
|
|||||||
<li><a href="../index.html">Index</a></li>
|
<li><a href="../index.html">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
@ -40,6 +45,7 @@
|
|||||||
<li><strong>druid.checkbox</strong></li>
|
<li><strong>druid.checkbox</strong></li>
|
||||||
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</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.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -66,18 +72,203 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(node, callback[, click=node])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_state">set_state(state, is_silent)</a></td>
|
||||||
|
<td class="summary">Set checkbox state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_state">get_state()</a></td>
|
||||||
|
<td class="summary">Return checkbox state</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||||
|
<td class="summary">Component style params</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node, callback[, click=node])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Checkbox callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">click</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
node Trigger node, by default equals to node
|
||||||
|
(<em>default</em> node)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_state"></a>
|
||||||
|
<strong>set_state(state, is_silent)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set checkbox state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Checkbox state
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_silent</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Don't trigger on<em>change</em>state if true
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_state"></a>
|
||||||
|
<strong>get_state()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return checkbox state
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Checkbox state
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change_state</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On change state callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Visual node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">click_node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Button trigger node
|
||||||
|
(<em>default</em> node)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">button</span>
|
||||||
|
<span class="types"><span class="type">druid.button</span></span>
|
||||||
|
Button component from click_node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Style"></a>
|
||||||
|
<strong>Style</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component style params
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change_state</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
(self, node, state)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
</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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -30,6 +30,11 @@
|
|||||||
<li><a href="../index.html">Index</a></li>
|
<li><a href="../index.html">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
@ -40,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
||||||
<li><strong>druid.checkbox_group</strong></li>
|
<li><strong>druid.checkbox_group</strong></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -60,24 +66,171 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.checkbox_group</code></h1>
|
<h1>Module <code>druid.checkbox_group</code></h1>
|
||||||
<p>Checkboux group module</p>
|
<p>Checkbox group module</p>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(node, callback[, click=node])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_state">set_state(state)</a></td>
|
||||||
|
<td class="summary">Set checkbox group state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_state">get_state()</a></td>
|
||||||
|
<td class="summary">Return checkbox group state</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node, callback[, click=node])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
|
Array of gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Checkbox callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">click</span>
|
||||||
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
|
node Array of trigger nodes, by default equals to nodes
|
||||||
|
(<em>default</em> node)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_state"></a>
|
||||||
|
<strong>set_state(state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set checkbox group state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool[]</span></span>
|
||||||
|
Array of checkbox state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_state"></a>
|
||||||
|
<strong>get_state()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return checkbox group state
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool[]</span></span>
|
||||||
|
Array if checkboxes state
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_checkbox_click</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On any checkbox click
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">checkboxes</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Array of checkbox components
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
</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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -30,6 +30,11 @@
|
|||||||
<li><a href="../index.html">Index</a></li>
|
<li><a href="../index.html">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
@ -40,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><strong>druid.grid</strong></li>
|
<li><strong>druid.grid</strong></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -64,18 +70,298 @@
|
|||||||
<p> Grid can anchor your elements, get content size and other</p>
|
<p> Grid can anchor your elements, get content size and other</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(parent, element[, in_row=1])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_offset">set_offset(offset)</a></td>
|
||||||
|
<td class="summary">Set grid items offset, the distance between items</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_anchor">set_anchor(acnhor)</a></td>
|
||||||
|
<td class="summary">Set grid anchor</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#add">add(item[, index])</a></td>
|
||||||
|
<td class="summary">Add new item to the grid</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_size">get_size()</a></td>
|
||||||
|
<td class="summary">Return grid content size</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_all_pos">get_all_pos()</a></td>
|
||||||
|
<td class="summary">Return array of all node positions</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#clear">clear()</a></td>
|
||||||
|
<td class="summary">Clear all items from the grid</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(parent, element[, in_row=1])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">parent</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
The gui node parent, where items will be placed
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">element</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Element prefab. Need to get it size
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">in_row</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
How many nodes in row can be placed
|
||||||
|
(<em>default</em> 1)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_offset"></a>
|
||||||
|
<strong>set_offset(offset)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set grid items offset, the distance between items
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">offset</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Offset
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_anchor"></a>
|
||||||
|
<strong>set_anchor(acnhor)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set grid anchor
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">acnhor</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Anchor
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "add"></a>
|
||||||
|
<strong>add(item[, index])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Add new item to the grid
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">item</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">index</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The item position. By default add as last item
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_size"></a>
|
||||||
|
<strong>get_size()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return grid content size
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
The grid content size
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_all_pos"></a>
|
||||||
|
<strong>get_all_pos()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return array of all node positions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3[]</span></span>
|
||||||
|
All grid node positions
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "clear"></a>
|
||||||
|
<strong>clear()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Clear all items from the grid
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_add_item</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On item add callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_remove_item</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On item remove callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_clear</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On grid clear callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_update_positions</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On update item positions callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">parent</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Parent gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">nodes</span>
|
||||||
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
|
List of all grid nodes
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">offset</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Item distance between each other items
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">anchor</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Item anchor
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">node_size</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Item size
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">border</span>
|
||||||
|
<span class="types"><span class="type">vector4</span></span>
|
||||||
|
The size of item content
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">border_offer</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
The border offset for correct anchor calculations
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
</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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -44,6 +44,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -226,7 +227,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
209
docs/modules/druid.hover.html
Normal file
209
docs/modules/druid.hover.html
Normal file
@ -0,0 +1,209 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||||
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
|
<html>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
|
<head>
|
||||||
|
<title>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<div id="container">
|
||||||
|
|
||||||
|
<div id="product">
|
||||||
|
<div id="product_logo"></div>
|
||||||
|
<div id="product_name"><big><b></b></big></div>
|
||||||
|
<div id="product_description"></div>
|
||||||
|
</div> <!-- id="product" -->
|
||||||
|
|
||||||
|
|
||||||
|
<div id="main">
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Menu -->
|
||||||
|
|
||||||
|
<div id="navigation">
|
||||||
|
<br/>
|
||||||
|
<h1>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<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/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><strong>druid.hover</strong></li>
|
||||||
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</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/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
|
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
||||||
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>druid.hover</code></h1>
|
||||||
|
<p>Component to handle hover node interaction</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(node, on_hover_callback)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_hover">set_hover(state)</a></td>
|
||||||
|
<td class="summary">Set hover state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(zone)</a></td>
|
||||||
|
<td class="summary">Strict button click area.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node, on_hover_callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_hover_callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Hover callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_hover"></a>
|
||||||
|
<strong>set_hover(state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set hover state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
The hover state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_click_zone"></a>
|
||||||
|
<strong>set_click_zone(zone)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Strict button click area. Useful for
|
||||||
|
no click events outside stencil node
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">zone</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_hover</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On hover callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2020-03-21 21:42:52 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -44,6 +44,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -68,8 +69,8 @@
|
|||||||
<p>
|
<p>
|
||||||
|
|
||||||
<p> Powerful Defold component based UI library. Use standart
|
<p> Powerful Defold component based UI library. Use standart
|
||||||
components or make your own game-specific to make amazing
|
components or make your own game-specific components to
|
||||||
GUI in your games.</p>
|
make amazing GUI in your games.</p>
|
||||||
|
|
||||||
<p> Contains the several basic components and examples
|
<p> Contains the several basic components and examples
|
||||||
to how to do your custom complex components to
|
to how to do your custom complex components to
|
||||||
@ -171,7 +172,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -30,10 +30,6 @@
|
|||||||
<li><a href="../index.html">Index</a></li>
|
<li><a href="../index.html">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2>Contents</h2>
|
|
||||||
<ul>
|
|
||||||
<li><a href="#Functions">Functions</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
@ -44,6 +40,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><strong>druid.input</strong></li>
|
<li><strong>druid.input</strong></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -64,94 +61,23 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.input</code></h1>
|
<h1>Module <code>druid.input</code></h1>
|
||||||
<p>Component to handle hover node interaction</p>
|
<p>Druid input text component.</p>
|
||||||
<p>
|
<p> Carry on user text input
|
||||||
|
UNIMPLEMENTED</p>
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
|
||||||
<table class="function_list">
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#hover:init">hover:init(self, node, on_hover_callback)</a></td>
|
|
||||||
<td class="summary">Component init function</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#button:set_click_zone">button:set_click_zone(self, zone)</a></td>
|
|
||||||
<td class="summary">Strict button click area.</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
||||||
|
|
||||||
<dl class="function">
|
|
||||||
<dt>
|
|
||||||
<a name = "hover:init"></a>
|
|
||||||
<strong>hover:init(self, node, on_hover_callback)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Component init function
|
|
||||||
|
|
||||||
|
|
||||||
<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">node</span>
|
|
||||||
<span class="types"><span class="type">node</span></span>
|
|
||||||
Gui node
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">on_hover_callback</span>
|
|
||||||
<span class="types"><span class="type">function</span></span>
|
|
||||||
Hover callback
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "button:set_click_zone"></a>
|
|
||||||
<strong>button:set_click_zone(self, zone)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
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
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">zone</span>
|
|
||||||
<span class="types"><span class="type">node</span></span>
|
|
||||||
Gui node
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
|
|
||||||
|
|
||||||
</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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -33,6 +33,7 @@
|
|||||||
<h2>Contents</h2>
|
<h2>Contents</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#Functions">Functions</a></li>
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
@ -44,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><strong>druid.lang_text</strong></li>
|
<li><strong>druid.lang_text</strong></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -74,10 +76,29 @@
|
|||||||
<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="#text:translate">text:translate(self, locale_id)</a></td>
|
<td class="name" nowrap><a href="#init">init(node, locale_id, no_adjust)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_to">set_to(text)</a></td>
|
||||||
|
<td class="summary">Setup raw text to lang_text component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#translate">translate(locale_id)</a></td>
|
||||||
<td class="summary">Translate the text by locale_id</td>
|
<td class="summary">Translate the text by locale_id</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
@ -87,8 +108,58 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "text:translate"></a>
|
<a name = "init"></a>
|
||||||
<strong>text:translate(self, locale_id)</strong>
|
<strong>init(node, locale_id, no_adjust)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
The text node
|
||||||
|
</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>
|
||||||
|
Default locale id
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">no_adjust</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
If true, will not correct text size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_to"></a>
|
||||||
|
<strong>set_to(text)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Setup raw text to lang_text component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">text</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Text for text node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "translate"></a>
|
||||||
|
<strong>translate(locale_id)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Translate the text by locale_id
|
Translate the text by locale_id
|
||||||
@ -96,10 +167,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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>
|
<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>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
Locale id
|
Locale id
|
||||||
@ -110,6 +177,52 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On change text callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">text</span>
|
||||||
|
<span class="types"><span class="type">druid.text</span></span>
|
||||||
|
The text component
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -118,7 +231,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -33,6 +33,7 @@
|
|||||||
<h2>Contents</h2>
|
<h2>Contents</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#Functions">Functions</a></li>
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
@ -44,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><strong>druid.progress</strong></li>
|
<li><strong>druid.progress</strong></li>
|
||||||
@ -64,43 +66,56 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.progress</code></h1>
|
<h1>Module <code>druid.progress</code></h1>
|
||||||
<p>Basic progress bar component</p>
|
<p>Basic progress bar component.</p>
|
||||||
<p>
|
<p> For correct progress bar init it should be in max size from gui</p>
|
||||||
|
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
<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(self, node, key, init_value)</a></td>
|
<td class="name" nowrap><a href="#init">init(node, key, init_value)</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
<td class="name" nowrap><a href="#fill">fill()</a></td>
|
||||||
<td class="summary">Fill a progress bar and stop progress animation</td>
|
<td class="summary">Fill a progress bar and stop progress animation</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
<td class="name" nowrap><a href="#empty">empty()</a></td>
|
||||||
<td class="summary">Empty a progress bar</td>
|
<td class="summary">Empty a progress bar</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_to">set_to(self, to)</a></td>
|
<td class="name" nowrap><a href="#set_to">set_to(to)</a></td>
|
||||||
<td class="summary">Instant fill progress bar to value</td>
|
<td class="summary">Instant fill progress bar to value</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get">get(self)</a></td>
|
<td class="name" nowrap><a href="#get">get()</a></td>
|
||||||
<td class="summary">Return current progress bar value</td>
|
<td class="summary">Return current progress bar value</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_steps">set_steps(self, steps, callback)</a></td>
|
<td class="name" nowrap><a href="#set_steps">set_steps(steps, callback)</a></td>
|
||||||
<td class="summary">Set points on progress bar to fire the callback</td>
|
<td class="summary">Set points on progress bar to fire the callback</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
|
<td class="name" nowrap><a href="#to">to(to[, callback])</a></td>
|
||||||
<td class="summary">Start animation of a progress bar</td>
|
<td class="summary">Start animation of a progress bar</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||||
|
<td class="summary">Component style params</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
@ -111,7 +126,7 @@
|
|||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node, key, init_value)</strong>
|
<strong>init(node, key, init_value)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Component init function
|
Component init function
|
||||||
@ -119,17 +134,13 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">node</span>
|
<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>
|
<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>
|
||||||
<li><span class="parameter">key</span>
|
<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>
|
<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: const.SIDE.X or const.SIDE.Y
|
||||||
</li>
|
</li>
|
||||||
<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>
|
||||||
@ -143,20 +154,13 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "empty"></a>
|
<a name = "fill"></a>
|
||||||
<strong>empty(self)</strong>
|
<strong>fill()</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Fill a progress bar and stop progress animation
|
Fill a progress bar and stop progress animation
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -165,19 +169,12 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "empty"></a>
|
<a name = "empty"></a>
|
||||||
<strong>empty(self)</strong>
|
<strong>empty()</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Empty a progress bar
|
Empty a progress bar
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -186,7 +183,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "set_to"></a>
|
||||||
<strong>set_to(self, to)</strong>
|
<strong>set_to(to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Instant fill progress bar to value
|
Instant fill progress bar to value
|
||||||
@ -194,10 +191,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">to</span>
|
<li><span class="parameter">to</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Progress bar value, from 0 to 1
|
Progress bar value, from 0 to 1
|
||||||
@ -211,19 +204,12 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get"></a>
|
<a name = "get"></a>
|
||||||
<strong>get(self)</strong>
|
<strong>get()</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return current progress bar value
|
Return current progress bar value
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -232,7 +218,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_steps"></a>
|
<a name = "set_steps"></a>
|
||||||
<strong>set_steps(self, steps, callback)</strong>
|
<strong>set_steps(steps, callback)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set points on progress bar to fire the callback
|
Set points on progress bar to fire the callback
|
||||||
@ -240,12 +226,8 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">steps</span>
|
<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>
|
<span class="types"><span class="type">number[]</span></span>
|
||||||
Array of progress bar values
|
Array of progress bar values
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">callback</span>
|
<li><span class="parameter">callback</span>
|
||||||
@ -257,11 +239,15 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">progress:set_steps({<span class="number">0</span>, <span class="number">0.3</span>, <span class="number">0.6</span>, <span class="number">1</span>}, <span class="keyword">function</span>(self, step) <span class="keyword">end</span>)</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "to"></a>
|
<a name = "to"></a>
|
||||||
<strong>to(self, to[, callback])</strong>
|
<strong>to(to[, callback])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Start animation of a progress bar
|
Start animation of a progress bar
|
||||||
@ -269,10 +255,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">to</span>
|
<li><span class="parameter">to</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
value between 0..1
|
value between 0..1
|
||||||
@ -288,6 +270,97 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On progress bar change callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Progress bar fill node
|
||||||
|
</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>
|
||||||
|
The progress bar direction
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">scale</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current progress bar scale
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">size</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current progress bar size
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">max_size</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Maximum size of progress bar
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">slice</span>
|
||||||
|
<span class="types"><span class="type">vector4</span></span>
|
||||||
|
Progress bar slice9 settings
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Style"></a>
|
||||||
|
<strong>Style</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component style params
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">SPEED</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Progress bas fill rate. More -> faster
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">MIN_DELTA</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Minimum step to fill progress bar
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -296,7 +369,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -30,6 +30,11 @@
|
|||||||
<li><a href="../index.html">Index</a></li>
|
<li><a href="../index.html">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
@ -40,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -66,18 +72,165 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(node, callback[, click=node])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_state">set_state(state)</a></td>
|
||||||
|
<td class="summary">Set radio group state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_state">get_state()</a></td>
|
||||||
|
<td class="summary">Return radio group state</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node, callback[, click=node])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
|
Array of gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Radio callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">click</span>
|
||||||
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
|
node Array of trigger nodes, by default equals to nodes
|
||||||
|
(<em>default</em> node)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_state"></a>
|
||||||
|
<strong>set_state(state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set radio group state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool[]</span></span>
|
||||||
|
Array of checkbox state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_state"></a>
|
||||||
|
<strong>get_state()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return radio group state
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool[]</span></span>
|
||||||
|
Array if checkboxes state
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_radio_click</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On any checkbox click
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">checkboxes</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Array of checkbox components
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
</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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -33,6 +33,7 @@
|
|||||||
<h2>Contents</h2>
|
<h2>Contents</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#Functions">Functions</a></li>
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
@ -44,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -64,38 +66,68 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.scroll</code></h1>
|
<h1>Module <code>druid.scroll</code></h1>
|
||||||
<p>Component to handle scroll content</p>
|
<p>Component to handle scroll content.</p>
|
||||||
<p>
|
<p> Scroll consist from two nodes: scroll parent and scroll input
|
||||||
|
Scroll input the user input zone, it's static
|
||||||
</p>
|
Scroll parent the scroll moving part, it will change position.
|
||||||
|
Setup initial scroll size by changing scroll parent size. If scroll parent
|
||||||
|
size will be less than scroll_input size, no scroll is available. For scroll
|
||||||
|
parent size should be more than input size</p>
|
||||||
|
|
||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(scroll_parent, input_zone)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#scroll_to">scroll_to(vector3[, is_instant])</a></td>
|
<td class="name" nowrap><a href="#scroll_to">scroll_to(vector3[, is_instant])</a></td>
|
||||||
<td class="summary">Start scroll to target point</td>
|
<td class="summary">Start scroll to target point</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, index[, skip_cb])</a></td>
|
<td class="name" nowrap><a href="#scroll_to_percent">scroll_to_percent(vector3[, is_instant])</a></td>
|
||||||
|
<td class="summary">Start scroll to target scroll percent</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(index[, skip_cb])</a></td>
|
||||||
<td class="summary">Scroll to item in scroll by point index</td>
|
<td class="summary">Scroll to item in scroll by point index</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_points">set_points(self, points)</a></td>
|
<td class="name" nowrap><a href="#set_points">set_points(points)</a></td>
|
||||||
<td class="summary">Set points of interest.</td>
|
<td class="summary">Set points of interest.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_inert">set_inert(self, state)</a></td>
|
<td class="name" nowrap><a href="#set_inert">set_inert(state)</a></td>
|
||||||
<td class="summary">Enable or disable scroll inert.</td>
|
<td class="summary">Enable or disable scroll inert.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_point_move">on_point_move(self, callback)</a></td>
|
<td class="name" nowrap><a href="#on_point_move">on_point_move(callback)</a></td>
|
||||||
<td class="summary">Set the callback on scrolling to point (if exist)</td>
|
<td class="summary">Set the callback on scrolling to point (if exist)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_border">set_border(self, border)</a></td>
|
<td class="name" nowrap><a href="#set_border">set_border(border)</a></td>
|
||||||
<td class="summary">Set the scroll possibly area</td>
|
<td class="summary">Set the scroll possibly area</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_scroll_percent">get_scroll_percent()</a></td>
|
||||||
|
<td class="summary">Return current scroll progress</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||||
|
<td class="summary">Component style params</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -105,6 +137,31 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(scroll_parent, input_zone)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">scroll_parent</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node where placed scroll content. This node will change position
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">input_zone</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node where input is catched
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "scroll_to"></a>
|
<a name = "scroll_to"></a>
|
||||||
<strong>scroll_to(vector3[, is_instant])</strong>
|
<strong>scroll_to(vector3[, is_instant])</strong>
|
||||||
@ -135,10 +192,40 @@
|
|||||||
<li><pre class="example">scroll:scroll_to(vmath.vector3(<span class="number">0</span>), <span class="keyword">true</span>)</pre></li>
|
<li><pre class="example">scroll:scroll_to(vmath.vector3(<span class="number">0</span>), <span class="keyword">true</span>)</pre></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "scroll_to_percent"></a>
|
||||||
|
<strong>scroll_to_percent(vector3[, is_instant])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Start scroll to target scroll percent
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">vector3</span>
|
||||||
|
<span class="types"><span class="type">point</span></span>
|
||||||
|
target percent
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_instant</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
instant scroll flag
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">scroll:scroll_to_percent(vmath.vector3(<span class="number">0.5</span>, <span class="number">0</span>, <span class="number">0</span>))</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, index[, skip_cb])</strong>
|
<strong>init(index[, skip_cb])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Scroll to item in scroll by point index
|
Scroll to item in scroll by point index
|
||||||
@ -146,16 +233,12 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">index</span>
|
<li><span class="parameter">index</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Point index
|
Point index
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">skip_cb</span>
|
<li><span class="parameter">skip_cb</span>
|
||||||
<span class="types"><span class="type">boolean</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
If true, skip the point callback
|
If true, skip the point callback
|
||||||
(<em>optional</em>)
|
(<em>optional</em>)
|
||||||
</li>
|
</li>
|
||||||
@ -168,7 +251,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_points"></a>
|
<a name = "set_points"></a>
|
||||||
<strong>set_points(self, points)</strong>
|
<strong>set_points(points)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set points of interest.
|
Set points of interest.
|
||||||
@ -177,10 +260,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">points</span>
|
<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>
|
<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
|
||||||
@ -194,7 +273,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_inert"></a>
|
<a name = "set_inert"></a>
|
||||||
<strong>set_inert(self, state)</strong>
|
<strong>set_inert(state)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Enable or disable scroll inert.
|
Enable or disable scroll inert.
|
||||||
@ -204,12 +283,8 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">state</span>
|
<li><span class="parameter">state</span>
|
||||||
<span class="types"><span class="type">boolean</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
Inert scroll state
|
Inert scroll state
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -221,7 +296,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_point_move"></a>
|
<a name = "on_point_move"></a>
|
||||||
<strong>on_point_move(self, callback)</strong>
|
<strong>on_point_move(callback)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set the callback on scrolling to point (if exist)
|
Set the callback on scrolling to point (if exist)
|
||||||
@ -229,10 +304,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">callback</span>
|
<li><span class="parameter">callback</span>
|
||||||
<span class="types"><span class="type">function</span></span>
|
<span class="types"><span class="type">function</span></span>
|
||||||
Callback on scroll to point of interest
|
Callback on scroll to point of interest
|
||||||
@ -246,7 +317,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_border"></a>
|
<a name = "set_border"></a>
|
||||||
<strong>set_border(self, border)</strong>
|
<strong>set_border(border)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set the scroll possibly area
|
Set the scroll possibly area
|
||||||
@ -254,12 +325,8 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">border</span>
|
<li><span class="parameter">border</span>
|
||||||
<span class="types"><span class="type">vmath.vector3</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
Size of scrolling area
|
Size of scrolling area
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -268,6 +335,161 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_scroll_percent"></a>
|
||||||
|
<strong>get_scroll_percent()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return current scroll progress
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Scroll progress
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_scroll</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On scroll move callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_scroll_to</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On scroll_to function callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_point_scroll</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On scroll<em>to</em>index function callbck
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Scroll parent node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">input_zone</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Scroll input node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">zone_size</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current scroll content size
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">soft_size</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Soft zone size from style table
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">center_offset</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Distance from node to node's center
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_inert</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Flag, if scroll now moving by inertion
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">inert</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current inert speed
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current scroll posisition
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">target</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current scroll target position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Style"></a>
|
||||||
|
<strong>Style</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component style params
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">FRICT_HOLD</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Multiplier for inertion, while touching
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">FRICT</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Multiplier for free inertion
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">INERT_THRESHOLD</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Scroll speed to stop inertion
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">INERT_SPEED</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Multiplier for inertion speed
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">DEADZONE</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Deadzone for start scrol in pixels
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">SOFT_ZONE_SIZE</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Size of outside zone in pixels (for scroll back moving)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">BACK_SPEED</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Scroll back returning lerp speed
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">ANIM_SPEED</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Scroll gui.animation speed for scroll_to function
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -276,7 +498,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -30,6 +30,11 @@
|
|||||||
<li><a href="../index.html">Index</a></li>
|
<li><a href="../index.html">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
@ -40,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -66,18 +72,174 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(node, end_pos[, callback])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set">set(value[, is_silent])</a></td>
|
||||||
|
<td class="summary">Set value for slider</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node, end_pos[, callback])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui pin node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">end_pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
The end position of slider
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
On slider change callback
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set"></a>
|
||||||
|
<strong>set(value[, is_silent])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set value for slider
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">value</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Value from 0 to 1
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_silent</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Don't trigger event if true
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change_value</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On change value callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Slider pin node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">start_pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Start pin node position
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current pin node position
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">target_pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Targer pin node position
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">end_pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
End pin node position
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">dist</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Length between start and end position
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_drag</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Current drag state
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">value</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Current slider value
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
</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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -33,6 +33,7 @@
|
|||||||
<h2>Contents</h2>
|
<h2>Contents</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#Functions">Functions</a></li>
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
@ -44,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -64,36 +66,49 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.text</code></h1>
|
<h1>Module <code>druid.text</code></h1>
|
||||||
<p>Component to handle all GUI texts
|
<p>Component to handle all GUI texts.</p>
|
||||||
Good working with localization system</p>
|
<p> Druid text can adjust itself for text node size
|
||||||
<p>
|
Text will never will be outside of his text size (even multiline)</p>
|
||||||
|
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
<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="#set_to">set_to(self, set_to)</a></td>
|
<td class="name" nowrap><a href="#init">init(node[, value[, no_adjust]])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_to">set_to(set_to)</a></td>
|
||||||
<td class="summary">Set text to text field</td>
|
<td class="summary">Set text to text field</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_color">set_color(self, color)</a></td>
|
<td class="name" nowrap><a href="#set_color">set_color(color)</a></td>
|
||||||
<td class="summary">Set color</td>
|
<td class="summary">Set color</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_alpha">set_alpha(self, alpha)</a></td>
|
<td class="name" nowrap><a href="#set_alpha">set_alpha(alpha)</a></td>
|
||||||
<td class="summary">Set alpha</td>
|
<td class="summary">Set alpha</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_scale">set_scale(self, scale)</a></td>
|
<td class="name" nowrap><a href="#set_scale">set_scale(scale)</a></td>
|
||||||
<td class="summary">Set scale</td>
|
<td class="summary">Set scale</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_pivot">set_pivot(self, pivot)</a></td>
|
<td class="name" nowrap><a href="#set_pivot">set_pivot(pivot)</a></td>
|
||||||
<td class="summary">Set text pivot.</td>
|
<td class="summary">Set text pivot.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
@ -102,9 +117,40 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node[, value[, no_adjust]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui text node
|
||||||
|
</li>
|
||||||
|
<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>
|
||||||
|
Initial text
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">no_adjust</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
If true, text will be not auto-adjust size
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "set_to"></a>
|
||||||
<strong>set_to(self, set_to)</strong>
|
<strong>set_to(set_to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text to text field
|
Set text to text field
|
||||||
@ -112,10 +158,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">set_to</span>
|
<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>
|
<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
|
||||||
@ -129,7 +171,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_color"></a>
|
<a name = "set_color"></a>
|
||||||
<strong>set_color(self, color)</strong>
|
<strong>set_color(color)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set color
|
Set color
|
||||||
@ -137,12 +179,8 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">color</span>
|
<li><span class="parameter">color</span>
|
||||||
<span class="types"><span class="type">vmath.vector4</span></span>
|
<span class="types"><span class="type">vector4</span></span>
|
||||||
Color for node
|
Color for node
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -154,7 +192,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_alpha"></a>
|
<a name = "set_alpha"></a>
|
||||||
<strong>set_alpha(self, alpha)</strong>
|
<strong>set_alpha(alpha)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set alpha
|
Set alpha
|
||||||
@ -162,10 +200,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">alpha</span>
|
<li><span class="parameter">alpha</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Alpha for node
|
Alpha for node
|
||||||
@ -179,7 +213,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_scale"></a>
|
<a name = "set_scale"></a>
|
||||||
<strong>set_scale(self, scale)</strong>
|
<strong>set_scale(scale)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set scale
|
Set scale
|
||||||
@ -187,12 +221,8 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">scale</span>
|
<li><span class="parameter">scale</span>
|
||||||
<span class="types"><span class="type">vmath.vector3</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
Scale for node
|
Scale for node
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -204,7 +234,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_pivot"></a>
|
<a name = "set_pivot"></a>
|
||||||
<strong>set_pivot(self, pivot)</strong>
|
<strong>set_pivot(pivot)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text pivot. Text will re-anchor inside
|
Set text pivot. Text will re-anchor inside
|
||||||
@ -213,10 +243,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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>
|
<li><span class="parameter">pivot</span>
|
||||||
<span class="types"><span class="type">gui.pivot</span></span>
|
<span class="types"><span class="type">gui.pivot</span></span>
|
||||||
Gui pivot constant
|
Gui pivot constant
|
||||||
@ -227,6 +253,88 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_set_text</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On set text callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_update_text_scale</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On adjust text size callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_set_pivot</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On change pivot callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Text node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current text position
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">start_scale</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Initial text node scale
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">scale</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current text node scale
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">start_size</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Initial text node size
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">text_area</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current text node available are
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_no_adjust</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Current text size adjust settings
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">color</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Current text color
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -235,7 +343,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -33,6 +33,7 @@
|
|||||||
<h2>Contents</h2>
|
<h2>Contents</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#Functions">Functions</a></li>
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
<li><a href="#Tables">Tables</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
@ -44,6 +45,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -64,27 +66,41 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.timer</code></h1>
|
<h1>Module <code>druid.timer</code></h1>
|
||||||
<p>Component to handle GUI timers</p>
|
<p>Component to handle GUI timers.</p>
|
||||||
<p>
|
<p> Timer updating by game delta time. If game is not focused -
|
||||||
|
timer will be not updated.</p>
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
<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="#set_to">set_to(self, set_to)</a></td>
|
<td class="name" nowrap><a href="#init">init(node, seconds_from[, seconds_to=0[, callback]])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_to">set_to(set_to)</a></td>
|
||||||
<td class="summary">Set text to text field</td>
|
<td class="summary">Set text to text field</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_state">set_state(self, is_on)</a></td>
|
<td class="name" nowrap><a href="#set_state">set_state(is_on)</a></td>
|
||||||
<td class="summary">Called when update</td>
|
<td class="summary">Called when update</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_interval">set_interval(self, from, to)</a></td>
|
<td class="name" nowrap><a href="#set_interval">set_interval(from, to)</a></td>
|
||||||
<td class="summary">Set time interval</td>
|
<td class="summary">Set time interval</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
||||||
|
<td class="summary">Component events</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
||||||
|
<td class="summary">Component fields</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
@ -93,9 +109,44 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(node, seconds_from[, seconds_to=0[, callback]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui text node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">seconds_from</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Start timer value in seconds
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">seconds_to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
End timer value in seconds
|
||||||
|
(<em>default</em> 0)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Function on timer end
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "set_to"></a>
|
||||||
<strong>set_to(self, set_to)</strong>
|
<strong>set_to(set_to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text to text field
|
Set text to text field
|
||||||
@ -103,10 +154,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">set_to</span>
|
<li><span class="parameter">set_to</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Value in seconds
|
Value in seconds
|
||||||
@ -120,7 +167,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_state"></a>
|
<a name = "set_state"></a>
|
||||||
<strong>set_state(self, is_on)</strong>
|
<strong>set_state(is_on)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Called when update
|
Called when update
|
||||||
@ -128,12 +175,8 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">is_on</span>
|
<li><span class="parameter">is_on</span>
|
||||||
<span class="types"><span class="type">boolean</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
Timer enable state
|
Timer enable state
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -145,7 +188,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_interval"></a>
|
<a name = "set_interval"></a>
|
||||||
<strong>set_interval(self, from, to)</strong>
|
<strong>set_interval(from, to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set time interval
|
Set time interval
|
||||||
@ -153,10 +196,6 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<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">from</span>
|
<li><span class="parameter">from</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Start time in seconds
|
Start time in seconds
|
||||||
@ -171,6 +210,86 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Events"></a>
|
||||||
|
<strong>Events</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component events
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_tick</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On timer tick callback. Fire every second
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_set_enabled</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On timer change enabled state callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_timer_end</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
On timer end callback
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "Fields"></a>
|
||||||
|
<strong>Fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Trigger node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">anim_node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Animation node
|
||||||
|
(<em>default</em> node)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">scale_from</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Initial scale of anim_node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Initial pos of anim_node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">params</span>
|
||||||
|
<span class="types"><span class="type">any</span></span>
|
||||||
|
Params to click callbacks
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">hover</span>
|
||||||
|
<span class="types"><span class="type">druid.hover</span></span>
|
||||||
|
Druid hover logic component
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">click_zone</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Restriction zone
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -179,7 +298,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -44,6 +44,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -72,6 +73,10 @@
|
|||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#Event">Event(initial_callback)</a></td>
|
||||||
|
<td class="summary">Event constructur</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#event:subscribe">event:subscribe(callback)</a></td>
|
<td class="name" nowrap><a href="#event:subscribe">event:subscribe(callback)</a></td>
|
||||||
<td class="summary">Subscribe callback on event</td>
|
<td class="summary">Subscribe callback on event</td>
|
||||||
@ -81,6 +86,14 @@
|
|||||||
<td class="summary">Unsubscribe callback on event</td>
|
<td class="summary">Unsubscribe callback on event</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#event:is_exist">event:is_exist()</a></td>
|
||||||
|
<td class="summary">Return true, if event have at lease one handler</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#event:clear">event:clear()</a></td>
|
||||||
|
<td class="summary">Clear the all event handlers</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#event:trigger">event:trigger(...)</a></td>
|
<td class="name" nowrap><a href="#event:trigger">event:trigger(...)</a></td>
|
||||||
<td class="summary">Trigger the event and call all subscribed callbacks</td>
|
<td class="summary">Trigger the event and call all subscribed callbacks</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -93,6 +106,27 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "Event"></a>
|
||||||
|
<strong>Event(initial_callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Event constructur
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">initial_callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Subscribe the callback on new event, if callback exist
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "event:subscribe"></a>
|
<a name = "event:subscribe"></a>
|
||||||
<strong>event:subscribe(callback)</strong>
|
<strong>event:subscribe(callback)</strong>
|
||||||
@ -134,6 +168,40 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "event:is_exist"></a>
|
||||||
|
<strong>event:is_exist()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return true, if event have at lease one handler
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
True if event have handlers
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "event:clear"></a>
|
||||||
|
<strong>event:clear()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Clear the all event handlers
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "event:trigger"></a>
|
<a name = "event:trigger"></a>
|
||||||
@ -162,7 +230,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -44,6 +44,7 @@
|
|||||||
<li><a href="../modules/druid.checkbox.html">druid.checkbox</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.checkbox_group.html">druid.checkbox_group</a></li>
|
||||||
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
||||||
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
||||||
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
<li><a href="../modules/druid.input.html">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
@ -740,7 +741,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-02-24 00:03:02 </i>
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -17,6 +17,9 @@ local component = require("druid.component")
|
|||||||
local M = component.create("blocker", { const.ON_INPUT_HIGH })
|
local M = component.create("blocker", { const.ON_INPUT_HIGH })
|
||||||
|
|
||||||
|
|
||||||
|
--- Component init function
|
||||||
|
-- @function blocker:init
|
||||||
|
-- @tparam node node Gui node
|
||||||
function M.init(self, node)
|
function M.init(self, node)
|
||||||
self.node = self:get_node(node)
|
self.node = self:get_node(node)
|
||||||
|
|
||||||
|
|||||||
@ -72,7 +72,7 @@ end
|
|||||||
|
|
||||||
--- Strict button click area. Useful for
|
--- Strict button click area. Useful for
|
||||||
-- no click events outside stencil node
|
-- no click events outside stencil node
|
||||||
-- @function button:set_click_zone
|
-- @function hover:set_click_zone
|
||||||
-- @tparam node zone Gui node
|
-- @tparam node zone Gui node
|
||||||
function M.set_click_zone(self, zone)
|
function M.set_click_zone(self, zone)
|
||||||
self.click_zone = self:get_node(zone)
|
self.click_zone = self:get_node(zone)
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
--- Druid input text component.
|
--- Druid input text component.
|
||||||
-- Carry on user text input
|
-- Carry on user text input
|
||||||
-- @local unimplemented
|
-- UNIMPLEMENTED
|
||||||
-- @module druid.input
|
-- @module druid.input
|
||||||
|
|
||||||
local component = require("druid.component")
|
local component = require("druid.component")
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
--- Druid UI Library.
|
--- Druid UI Library.
|
||||||
-- Powerful Defold component based UI library. Use standart
|
-- Powerful Defold component based UI library. Use standart
|
||||||
-- components or make your own game-specific to make amazing
|
-- components or make your own game-specific components to
|
||||||
-- GUI in your games.
|
-- make amazing GUI in your games.
|
||||||
--
|
--
|
||||||
-- Contains the several basic components and examples
|
-- Contains the several basic components and examples
|
||||||
-- to how to do your custom complex components to
|
-- to how to do your custom complex components to
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user