mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 10:27:47 +02:00
Update ldoc
This commit is contained in:
Insality
parent
cb6fd3038a
commit
5c576e6059
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -37,7 +37,8 @@
|
|||||||
<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.locale.html">druid.locale</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="modules/druid.scroll.html">druid.scroll</a></li>
|
<li><a href="modules/druid.scroll.html">druid.scroll</a></li>
|
||||||
@ -46,8 +47,8 @@
|
|||||||
<li><a href="modules/druid.timer.html">druid.timer</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/component.html">component</a></li>
|
||||||
<li><a href="modules/druid.html">druid</a></li>
|
<li><a href="modules/druid.html">druid</a></li>
|
||||||
<li><a href="modules/helper.html">helper</a></li>
|
<li><a href="modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
<li><a href="modules/druid.helper.html">druid.helper</a></li>
|
||||||
<li><a href="modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -85,7 +86,11 @@
|
|||||||
<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.locale.html">druid.locale</a></td>
|
<td class="name" nowrap><a href="modules/druid.input.html">druid.input</a></td>
|
||||||
|
<td class="summary">Component to handle hover node interaction</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<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
|
||||||
Good working with localization system</td>
|
Good working with localization system</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -123,12 +128,12 @@
|
|||||||
<td class="summary">Druid UI Library.</td>
|
<td class="summary">Druid UI Library.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/helper.html">helper</a></td>
|
<td class="name" nowrap><a href="modules/druid_event.html">druid_event</a></td>
|
||||||
<td class="summary">Text node or icon node can be nil</td>
|
<td class="summary">Lua event small library</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.progress_rich.html">druid.progress_rich</a></td>
|
<td class="name" nowrap><a href="modules/druid.helper.html">druid.helper</a></td>
|
||||||
<td class="summary">Component for rich progress component</td>
|
<td class="summary">Text node or icon node can be nil</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid_instance.html">druid_instance</a></td>
|
<td class="name" nowrap><a href="modules/druid_instance.html">druid_instance</a></td>
|
||||||
@ -140,7 +145,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -147,16 +147,22 @@ table.index td { text-align: left; vertical-align: top; }
|
|||||||
|
|
||||||
#main {
|
#main {
|
||||||
background-color:#FFFFFF; // #f0f0f0;
|
background-color:#FFFFFF; // #f0f0f0;
|
||||||
//border-left: 2px solid #cccccc;
|
border-left: 1px solid #cccccc;
|
||||||
}
|
}
|
||||||
|
|
||||||
#navigation {
|
#navigation {
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
float: left;
|
float: left;
|
||||||
width: 14em;
|
width: 14em;
|
||||||
vertical-align: top;
|
vertical-align: top;
|
||||||
background-color:#FFFFFF; // #f0f0f0;
|
background-color:#FFFFFF; // #f0f0f0;
|
||||||
border-right: 2px solid #cccccc;
|
border-right: 2px solid #cccccc;
|
||||||
overflow: visible;
|
overflow: visible;
|
||||||
|
overflow-y: scroll;
|
||||||
|
height: 100%;
|
||||||
|
padding-left: 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
#navigation h2 {
|
#navigation h2 {
|
||||||
@ -165,7 +171,6 @@ table.index td { text-align: left; vertical-align: top; }
|
|||||||
color:#000000;
|
color:#000000;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
padding:0.2em;
|
padding:0.2em;
|
||||||
//border-top:1px solid #dddddd;
|
|
||||||
border-bottom:1px solid #dddddd;
|
border-bottom:1px solid #dddddd;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -189,6 +194,7 @@ table.index td { text-align: left; vertical-align: top; }
|
|||||||
#content {
|
#content {
|
||||||
margin-left: 14em;
|
margin-left: 14em;
|
||||||
padding: 1em;
|
padding: 1em;
|
||||||
|
padding-left: 2em;
|
||||||
width: 700px;
|
width: 700px;
|
||||||
border-left: 2px solid #cccccc;
|
border-left: 2px solid #cccccc;
|
||||||
// border-right: 2px solid #cccccc;
|
// border-right: 2px solid #cccccc;
|
||||||
@ -197,8 +203,10 @@ table.index td { text-align: left; vertical-align: top; }
|
|||||||
|
|
||||||
#about {
|
#about {
|
||||||
clear: both;
|
clear: both;
|
||||||
padding: 5px;
|
padding-left: 1em;
|
||||||
|
margin-left: 14em; // avoid the damn sidebar!
|
||||||
border-top: 2px solid #cccccc;
|
border-top: 2px solid #cccccc;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
background-color: #ffffff;
|
background-color: #ffffff;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><strong>component</strong></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><strong>component</strong></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -64,59 +65,58 @@
|
|||||||
|
|
||||||
<h1>Module <code>component</code></h1>
|
<h1>Module <code>component</code></h1>
|
||||||
<p>Basic class for all Druid components.</p>
|
<p>Basic class for all Druid components.</p>
|
||||||
<p>
|
<p> To create you component, use <a href="../modules/component.html#Component.create">component.create</a></p>
|
||||||
To create you component, use `component.create`</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="#setup_component">setup_component(table, table)</a></td>
|
<td class="name" nowrap><a href="#Component.create">Component.create(name, interest)</a></td>
|
||||||
<td class="summary">Setup component context and his style table</td>
|
<td class="summary">Create new component.</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_style">get_style()</a></td>
|
|
||||||
<td class="summary">Get current component style table</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_style">set_style(style)</a></td>
|
|
||||||
<td class="summary">Set current component style table</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_template">get_template()</a></td>
|
|
||||||
<td class="summary">Get current component template name</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_template">set_template(template)</a></td>
|
|
||||||
<td class="summary">Set current component template name</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_nodes">get_nodes()</a></td>
|
|
||||||
<td class="summary">Get current component nodes</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_nodes">set_nodes(nodes)</a></td>
|
|
||||||
<td class="summary">Set current component nodes</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_context">get_context()</a></td>
|
<td class="name" nowrap><a href="#get_context">get_context()</a></td>
|
||||||
<td class="summary">Get current component context</td>
|
<td class="summary">Get current component context</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_context">set_context(context)</a></td>
|
<td class="name" nowrap><a href="#get_druid">get_druid()</a></td>
|
||||||
<td class="summary">Set current component context</td>
|
<td class="summary">Return druid with context of calling component.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_interests">get_interests()</a></td>
|
<td class="name" nowrap><a href="#get_interests">get_interests()</a></td>
|
||||||
<td class="summary">Get current component interests</td>
|
<td class="summary">Get current component interests</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_druid">get_druid()</a></td>
|
<td class="name" nowrap><a href="#get_nodes">get_nodes()</a></td>
|
||||||
<td class="summary">Return druid with context of calling component.</td>
|
<td class="summary">Get current component nodes</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#Component.create">Component.create(name, interest)</a></td>
|
<td class="name" nowrap><a href="#get_style">get_style()</a></td>
|
||||||
<td class="summary">Create new component.</td>
|
<td class="summary">Get current component style table</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_template">get_template()</a></td>
|
||||||
|
<td class="summary">Get current component template name</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_context">set_context(context)</a></td>
|
||||||
|
<td class="summary">Set current component context</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_nodes">set_nodes(nodes)</a></td>
|
||||||
|
<td class="summary">Set current component nodes</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_style">set_style(style)</a></td>
|
||||||
|
<td class="summary">Set current component style table</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_template">set_template(template)</a></td>
|
||||||
|
<td class="summary">Set current component template name</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#setup_component">setup_component(table, table)</a></td>
|
||||||
|
<td class="summary">Setup component context and his style table</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -127,6 +127,237 @@
|
|||||||
<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 = "Component.create"></a>
|
||||||
|
<strong>Component.create(name, interest)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create new component. It will inheritance from basic
|
||||||
|
druid component.
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">name</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Component name
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">interest</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
List of component's interest
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_context"></a>
|
||||||
|
<strong>get_context()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get current component context
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component context
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_druid"></a>
|
||||||
|
<strong>get_druid()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return druid with context of calling component.
|
||||||
|
Use it to create component inside of other components.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Druid</span></span>
|
||||||
|
Druid instance with component context
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_interests"></a>
|
||||||
|
<strong>get_interests()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get current component interests
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
List of component interests
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_nodes"></a>
|
||||||
|
<strong>get_nodes()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get current component nodes
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component nodes table
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_style"></a>
|
||||||
|
<strong>get_style()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get current component style table
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component style table
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_template"></a>
|
||||||
|
<strong>get_template()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get current component template name
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Component template name
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_context"></a>
|
||||||
|
<strong>set_context(context)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set current component context
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">context</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Druid context. Usually it is self of script
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_nodes"></a>
|
||||||
|
<strong>set_nodes(nodes)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set current component nodes
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">nodes</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component nodes table
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_style"></a>
|
||||||
|
<strong>set_style(style)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set current component style table
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">style</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Druid style module
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_template"></a>
|
||||||
|
<strong>set_template(template)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set current component template name
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">template</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Component template name
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "setup_component"></a>
|
<a name = "setup_component"></a>
|
||||||
<strong>setup_component(table, table)</strong>
|
<strong>setup_component(table, table)</strong>
|
||||||
@ -157,237 +388,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_style"></a>
|
|
||||||
<strong>get_style()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Get current component style table
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Component style table
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_style"></a>
|
|
||||||
<strong>set_style(style)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set current component style table
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">style</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Druid style module
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_template"></a>
|
|
||||||
<strong>get_template()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Get current component template name
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
||||||
Component template name
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_template"></a>
|
|
||||||
<strong>set_template(template)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set current component template name
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">template</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
||||||
Component template name
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_nodes"></a>
|
|
||||||
<strong>get_nodes()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Get current component nodes
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Component nodes table
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_nodes"></a>
|
|
||||||
<strong>set_nodes(nodes)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set current component nodes
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">nodes</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Component nodes table
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_context"></a>
|
|
||||||
<strong>get_context()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Get current component context
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Component context
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_context"></a>
|
|
||||||
<strong>set_context(context)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set current component context
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">context</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Druid context. Usually it is self of script
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_interests"></a>
|
|
||||||
<strong>get_interests()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Get current component interests
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
List of component interests
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_druid"></a>
|
|
||||||
<strong>get_druid()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return druid with context of calling component.
|
|
||||||
Use it to create component inside of other components.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Druid</span></span>
|
|
||||||
Druid instance with component context
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "Component.create"></a>
|
|
||||||
<strong>Component.create(name, interest)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create new component. It will inheritance from basic
|
|
||||||
druid component.
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">name</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
||||||
Component name
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">interest</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
List of component's interest
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -396,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><strong>druid.back_handler</strong></li>
|
<li><strong>druid.back_handler</strong></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</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.button.html">druid.button</a></li>
|
||||||
<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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -64,7 +65,9 @@
|
|||||||
|
|
||||||
<h1>Module <code>druid.back_handler</code></h1>
|
<h1>Module <code>druid.back_handler</code></h1>
|
||||||
<p>Component to handle back key (android, backspace)</p>
|
<p>Component to handle back key (android, backspace)</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
@ -148,7 +151,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -34,23 +34,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><strong>druid.blocker</strong></li>
|
<li><strong>druid.blocker</strong></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -60,7 +61,9 @@
|
|||||||
|
|
||||||
<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 (node)</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -74,7 +77,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -33,28 +33,30 @@
|
|||||||
<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>
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><strong>druid.button</strong></li>
|
<li><strong>druid.button</strong></li>
|
||||||
<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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -64,23 +66,56 @@
|
|||||||
|
|
||||||
<h1>Module <code>druid.button</code></h1>
|
<h1>Module <code>druid.button</code></h1>
|
||||||
<p>Component to handle basic GUI button</p>
|
<p>Component to handle basic GUI button</p>
|
||||||
<p></p>
|
<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>
|
|
||||||
<td class="name" nowrap><a href="#init">init(self, node, callback[, params[, anim_node[, event]]])</a></td>
|
|
||||||
<td class="summary">Component init function</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#disable_animation">disable_animation(self)</a></td>
|
<td class="name" nowrap><a href="#disable_animation">disable_animation(self)</a></td>
|
||||||
<td class="summary">Disable all button animations</td>
|
<td class="summary">Disable all button animations</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_key_trigger">get_key_trigger(self)</a></td>
|
||||||
|
<td class="summary">Get key-code to trigger this button</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, node, callback[, params[, anim_node[, event]]])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_callback">set_callback(self, callback)</a></td>
|
||||||
|
<td class="summary">Set usual button callback</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
||||||
<td class="summary">Strict button click area.</td>
|
<td class="summary">Strict button click area.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_double_tap_callback">set_double_tap_callback(self, callback)</a></td>
|
||||||
|
<td class="summary">Get doubletap callback on this button</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_hold_callback">set_hold_callback(self, callback)</a></td>
|
||||||
|
<td class="summary">Repeat callback always, while holding button</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_long_tap_callback">set_long_tap_callback(self, callback)</a></td>
|
||||||
|
<td class="summary">Single callbacka after long_tap.</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>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -90,6 +125,49 @@
|
|||||||
<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 = "disable_animation"></a>
|
||||||
|
<strong>disable_animation(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Disable all button animations
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_key_trigger"></a>
|
||||||
|
<strong>get_key_trigger(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get key-code to trigger this button
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node, callback[, params[, anim_node[, event]]])</strong>
|
<strong>init(self, node, callback[, params[, anim_node[, event]]])</strong>
|
||||||
@ -135,18 +213,24 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "disable_animation"></a>
|
<a name = "set_callback"></a>
|
||||||
<strong>disable_animation(self)</strong>
|
<strong>set_callback(self, callback)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Disable all button animations
|
Set usual button callback
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<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>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -180,6 +264,153 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_double_tap_callback"></a>
|
||||||
|
<strong>set_double_tap_callback(self, callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get doubletap callback on this button
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_hold_callback"></a>
|
||||||
|
<strong>set_hold_callback(self, callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Repeat callback always, while holding button
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_long_tap_callback"></a>
|
||||||
|
<strong>set_long_tap_callback(self, callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Single callbacka after long_tap. No usual callback invoked
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</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_click</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_hold_click</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_long_click</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">on_double_click</span>
|
||||||
|
<span class="types"><span class="type">druid_event</span></span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "fields"></a>
|
||||||
|
<strong>fields</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component fields
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">Main</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -188,7 +419,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -34,23 +34,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
||||||
<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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -60,7 +61,9 @@
|
|||||||
|
|
||||||
<h1>Module <code>druid.checkbox</code></h1>
|
<h1>Module <code>druid.checkbox</code></h1>
|
||||||
<p>Druid checkbox component</p>
|
<p>Druid checkbox component</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -74,7 +77,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -34,23 +34,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -60,7 +61,9 @@
|
|||||||
|
|
||||||
<h1>Module <code>druid.checkbox_group</code></h1>
|
<h1>Module <code>druid.checkbox_group</code></h1>
|
||||||
<p>Checkboux group module</p>
|
<p>Checkboux group module</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -74,7 +77,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -34,23 +34,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -60,8 +61,7 @@
|
|||||||
|
|
||||||
<h1>Module <code>druid.grid</code></h1>
|
<h1>Module <code>druid.grid</code></h1>
|
||||||
<p>Component to handle placing components by row and columns.</p>
|
<p>Component to handle placing components by row and columns.</p>
|
||||||
<p>
|
<p> Grid can anchor your elements, get content size and other</p>
|
||||||
Grid can anchor your elements, get content size and other</p>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -75,7 +75,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><strong>druid.helper</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.progress.html">druid.progress</a></li>
|
||||||
<li><a href="../modules/druid.radio_group.html">druid.radio_group</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.scroll.html">druid.scroll</a></li>
|
||||||
<li><a href="../modules/druid.slider.html">druid.slider</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.text.html">druid.text</a></li>
|
||||||
<li><a href="../modules/druid.timer.html">druid.timer</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_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><strong>helper</strong></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -62,20 +63,30 @@
|
|||||||
|
|
||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>helper</code></h1>
|
<h1>Module <code>druid.helper</code></h1>
|
||||||
<p>Text node or icon node can be nil</p>
|
<p>Text node or icon node can be nil</p>
|
||||||
<p></p>
|
<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>
|
||||||
|
<td class="name" nowrap><a href="#centrate_icon_with_text">centrate_icon_with_text([icon_node[, text_node[, margin=0]]])</a></td>
|
||||||
|
<td class="summary">Center two nodes.</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#centrate_text_with_icon">centrate_text_with_icon([text_node][, icon_node], margin)</a></td>
|
<td class="name" nowrap><a href="#centrate_text_with_icon">centrate_text_with_icon([text_node][, icon_node], margin)</a></td>
|
||||||
<td class="summary">Center two nodes.</td>
|
<td class="summary">Center two nodes.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#centrate_icon_with_text">centrate_icon_with_text([icon_node[, text_node[, margin=0]]])</a></td>
|
<td class="name" nowrap><a href="#get_pivot_offset">get_pivot_offset(pivot)</a></td>
|
||||||
<td class="summary">Center two nodes.</td>
|
<td class="summary">Get node offset for given gui pivot</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#is_enabled">is_enabled(node)</a></td>
|
||||||
|
<td class="summary">Check if node is enabled in gui hierarchy.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -86,39 +97,6 @@
|
|||||||
<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 = "centrate_text_with_icon"></a>
|
|
||||||
<strong>centrate_text_with_icon([text_node][, icon_node], margin)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Center two nodes.
|
|
||||||
Nodes will be center around 0 x position
|
|
||||||
text_node will be first (at left side)
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">text_node</span>
|
|
||||||
<span class="types"><span class="type">text</span></span>
|
|
||||||
Gui text node
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">icon_node</span>
|
|
||||||
<span class="types"><span class="type">box</span></span>
|
|
||||||
Gui box node
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">margin</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Offset between nodes
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "centrate_icon_with_text"></a>
|
<a name = "centrate_icon_with_text"></a>
|
||||||
<strong>centrate_icon_with_text([icon_node[, text_node[, margin=0]]])</strong>
|
<strong>centrate_icon_with_text([icon_node[, text_node[, margin=0]]])</strong>
|
||||||
@ -152,6 +130,94 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "centrate_text_with_icon"></a>
|
||||||
|
<strong>centrate_text_with_icon([text_node][, icon_node], margin)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Center two nodes.
|
||||||
|
Nodes will be center around 0 x position
|
||||||
|
text_node will be first (at left side)
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">text_node</span>
|
||||||
|
<span class="types"><span class="type">text</span></span>
|
||||||
|
Gui text node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">icon_node</span>
|
||||||
|
<span class="types"><span class="type">box</span></span>
|
||||||
|
Gui box node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">margin</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Offset between nodes
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_pivot_offset"></a>
|
||||||
|
<strong>get_pivot_offset(pivot)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get node offset for given gui pivot
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">pivot</span>
|
||||||
|
<span class="types"><span class="type">gui.pivot</span></span>
|
||||||
|
The node pivot
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Vector offset with [-1..1] values
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "is_enabled"></a>
|
||||||
|
<strong>is_enabled(node)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Check if node is enabled in gui hierarchy.
|
||||||
|
Return false, if node or any his parent is disabled
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Is enabled in hierarchy
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -160,7 +226,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><strong>druid</strong></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><strong>druid</strong></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -65,25 +66,36 @@
|
|||||||
<h1>Module <code>druid</code></h1>
|
<h1>Module <code>druid</code></h1>
|
||||||
<p>Druid UI Library.</p>
|
<p>Druid UI Library.</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 to make amazing
|
||||||
GUI in your games.
|
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
|
||||||
separate UI game logic to small files
|
separate UI game logic to small files</p>
|
||||||
|
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
<span class="global">require</span>(<span class="string">"druid.druid"</span>)
|
||||||
|
<span class="keyword">function</span> init(self)
|
||||||
|
self.druid = druid.new(self)
|
||||||
|
<span class="keyword">end</span>
|
||||||
|
</pre>
|
||||||
|
|
||||||
</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>
|
|
||||||
<td class="name" nowrap><a href="#register">register(name, module)</a></td>
|
|
||||||
<td class="summary">Register external druid component.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#new">new(context[, style])</a></td>
|
<td class="name" nowrap><a href="#new">new(context[, style])</a></td>
|
||||||
<td class="summary">Create Druid instance.</td>
|
<td class="summary">Create Druid instance.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#register">register(name, module)</a></td>
|
||||||
|
<td class="summary">Register external druid component.</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -93,33 +105,6 @@
|
|||||||
<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 = "register"></a>
|
|
||||||
<strong>register(name, module)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Register external druid component.
|
|
||||||
After register you can create the component with
|
|
||||||
druid_instance:new_{name}. For example `druid:new_button(...)`
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">name</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
||||||
module name
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">module</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
lua table with component
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "new"></a>
|
<a name = "new"></a>
|
||||||
<strong>new(context[, style])</strong>
|
<strong>new(context[, style])</strong>
|
||||||
@ -151,6 +136,33 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "register"></a>
|
||||||
|
<strong>register(name, module)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Register external druid component.
|
||||||
|
After register you can create the component with
|
||||||
|
druid<em>instance:new</em>{name}. For example <code>druid:new_button(...)</code>
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">name</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
module name
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">module</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
lua table with component
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -159,7 +171,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</a></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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><strong>druid.progress_rich</strong></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -62,24 +63,22 @@
|
|||||||
|
|
||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.progress_rich</code></h1>
|
<h1>Module <code>druid.input</code></h1>
|
||||||
<p>Component for rich progress component</p>
|
<p>Component to handle hover node interaction</p>
|
||||||
<p></p>
|
<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, value)</a></td>
|
<td class="name" nowrap><a href="#button:set_click_zone">button:set_click_zone(self, zone)</a></td>
|
||||||
<td class="summary">Instant fill progress bar to value</td>
|
<td class="summary">Strict button click area.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
<td class="name" nowrap><a href="#hover:init">hover:init(self, node, on_hover_callback)</a></td>
|
||||||
<td class="summary">Empty a progress bar</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
|
|
||||||
<td class="summary">Start animation of a progress bar</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -91,11 +90,12 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "button:set_click_zone"></a>
|
||||||
<strong>set_to(self, value)</strong>
|
<strong>button:set_click_zone(self, zone)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Instant fill progress bar to value
|
Strict button click area. Useful for
|
||||||
|
no click events outside stencil node
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -104,9 +104,9 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">value</span>
|
<li><span class="parameter">zone</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
Progress bar value, from 0 to 1
|
Gui node
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -116,11 +116,11 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "empty"></a>
|
<a name = "hover:init"></a>
|
||||||
<strong>empty(self)</strong>
|
<strong>hover:init(self, node, on_hover_callback)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Empty a progress bar
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -129,35 +129,13 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "to"></a>
|
|
||||||
<strong>to(self, to[, callback])</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Start animation of 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>
|
</li>
|
||||||
<li><span class="parameter">to</span>
|
<li><span class="parameter">on_hover_callback</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
value between 0..1
|
|
||||||
</li>
|
|
||||||
<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 animation ends
|
Hover callback
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -173,7 +151,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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><strong>druid.locale</strong></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
||||||
|
<li><a href="../modules/druid.input.html">druid.input</a></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>
|
||||||
<li><a href="../modules/druid.radio_group.html">druid.radio_group</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.scroll.html">druid.scroll</a></li>
|
||||||
<li><a href="../modules/druid.slider.html">druid.slider</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.text.html">druid.text</a></li>
|
||||||
<li><a href="../modules/druid.timer.html">druid.timer</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_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -62,10 +63,12 @@
|
|||||||
|
|
||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>druid.locale</code></h1>
|
<h1>Module <code>druid.lang_text</code></h1>
|
||||||
<p>Component to handle all GUI texts
|
<p>Component to handle all GUI texts
|
||||||
Good working with localization system</p>
|
Good working with localization system</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
@ -115,7 +118,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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><strong>druid.progress</strong></li>
|
<li><strong>druid.progress</strong></li>
|
||||||
<li><a href="../modules/druid.radio_group.html">druid.radio_group</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.scroll.html">druid.scroll</a></li>
|
||||||
<li><a href="../modules/druid.slider.html">druid.slider</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.text.html">druid.text</a></li>
|
||||||
<li><a href="../modules/druid.timer.html">druid.timer</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_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -64,36 +65,38 @@
|
|||||||
|
|
||||||
<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>
|
<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="#empty">empty(self)</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Empty a progress bar</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
<td class="name" nowrap><a href="#empty">empty(self)</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="summary">Empty a progress bar</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_to">set_to(self, to)</a></td>
|
|
||||||
<td class="summary">Instant fill progress bar to value</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get">get(self)</a></td>
|
<td class="name" nowrap><a href="#get">get(self)</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="#init">init(self, node, key, init_value)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</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(self, 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="#set_to">set_to(self, to)</a></td>
|
||||||
|
<td class="summary">Instant fill progress bar to value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
|
<td class="name" nowrap><a href="#to">to(self, 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>
|
||||||
@ -106,6 +109,69 @@
|
|||||||
<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 = "empty"></a>
|
||||||
|
<strong>empty(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "empty"></a>
|
||||||
|
<strong>empty(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get"></a>
|
||||||
|
<strong>get(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node, key, init_value)</strong>
|
<strong>init(self, node, key, init_value)</strong>
|
||||||
@ -140,11 +206,11 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "empty"></a>
|
<a name = "set_steps"></a>
|
||||||
<strong>empty(self)</strong>
|
<strong>set_steps(self, steps, callback)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Fill a progress bar and stop progress animation
|
Set points on progress bar to fire the callback
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -153,26 +219,13 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
<li><span class="parameter">steps</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "empty"></a>
|
|
||||||
<strong>empty(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
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>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
Component instance
|
Array of progress bar values
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback on intersect step value
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -205,56 +258,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get"></a>
|
|
||||||
<strong>get(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_steps"></a>
|
|
||||||
<strong>set_steps(self, steps, callback)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set points on progress bar to fire the callback
|
|
||||||
|
|
||||||
|
|
||||||
<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">steps</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Array of progress bar values
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">callback</span>
|
|
||||||
<span class="types"><span class="type">function</span></span>
|
|
||||||
Callback on intersect step value
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "to"></a>
|
<a name = "to"></a>
|
||||||
@ -293,7 +296,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -34,23 +34,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
||||||
<li><strong>druid.radio_group</strong></li>
|
<li><strong>druid.radio_group</strong></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -60,7 +61,9 @@
|
|||||||
|
|
||||||
<h1>Module <code>druid.radio_group</code></h1>
|
<h1>Module <code>druid.radio_group</code></h1>
|
||||||
<p>Radio group module</p>
|
<p>Radio group module</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -74,7 +77,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><strong>druid.scroll</strong></li>
|
<li><strong>druid.scroll</strong></li>
|
||||||
<li><a href="../modules/druid.slider.html">druid.slider</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.text.html">druid.text</a></li>
|
||||||
<li><a href="../modules/druid.timer.html">druid.timer</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_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -64,35 +65,37 @@
|
|||||||
|
|
||||||
<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>
|
<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>
|
|
||||||
<td class="name" nowrap><a href="#scroll_to">scroll_to(vector3[, is_instant])</a></td>
|
|
||||||
<td class="summary">Start scroll to target point</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, index[, skip_cb])</a></td>
|
<td class="name" nowrap><a href="#init">init(self, 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="summary">Set points of interest.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_inert">set_inert(self, state)</a></td>
|
|
||||||
<td class="summary">Enable or disable scroll inert.</td>
|
|
||||||
</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(self, 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="#scroll_to">scroll_to(vector3[, is_instant])</a></td>
|
||||||
|
<td class="summary">Start scroll to target point</td>
|
||||||
|
</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(self, 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="#set_inert">set_inert(self, state)</a></td>
|
||||||
|
<td class="summary">Enable or disable scroll inert.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_points">set_points(self, points)</a></td>
|
||||||
|
<td class="summary">Set points of interest.</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -102,6 +105,61 @@
|
|||||||
<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(self, index[, skip_cb])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Scroll to item in scroll by point index
|
||||||
|
|
||||||
|
|
||||||
|
<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">index</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Point index
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">skip_cb</span>
|
||||||
|
<span class="types"><span class="type">boolean</span></span>
|
||||||
|
If true, skip the point callback
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_point_move"></a>
|
||||||
|
<strong>on_point_move(self, callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set the callback on scrolling to point (if exist)
|
||||||
|
|
||||||
|
|
||||||
|
<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">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback on scroll to point of interest
|
||||||
|
</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>
|
||||||
@ -134,11 +192,11 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "set_border"></a>
|
||||||
<strong>init(self, index[, skip_cb])</strong>
|
<strong>set_border(self, border)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Scroll to item in scroll by point index
|
Set the scroll possibly area
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -147,40 +205,9 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">index</span>
|
<li><span class="parameter">border</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">vmath.vector3</span></span>
|
||||||
Point index
|
Size of scrolling area
|
||||||
</li>
|
|
||||||
<li><span class="parameter">skip_cb</span>
|
|
||||||
<span class="types"><span class="type">boolean</span></span>
|
|
||||||
If true, skip the point callback
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_points"></a>
|
|
||||||
<strong>set_points(self, points)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set points of interest.
|
|
||||||
Scroll will always centered on closer points
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Component instance
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">points</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Array of vector3 points
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -217,11 +244,12 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_point_move"></a>
|
<a name = "set_points"></a>
|
||||||
<strong>on_point_move(self, callback)</strong>
|
<strong>set_points(self, points)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set the callback on scrolling to point (if exist)
|
Set points of interest.
|
||||||
|
Scroll will always centered on closer points
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -230,34 +258,9 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">callback</span>
|
<li><span class="parameter">points</span>
|
||||||
<span class="types"><span class="type">function</span></span>
|
|
||||||
Callback on scroll to point of interest
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_border"></a>
|
|
||||||
<strong>set_border(self, border)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set the scroll possibly area
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
Component instance
|
Array of vector3 points
|
||||||
</li>
|
|
||||||
<li><span class="parameter">border</span>
|
|
||||||
<span class="types"><span class="type">vmath.vector3</span></span>
|
|
||||||
Size of scrolling area
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -273,7 +276,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -34,23 +34,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
||||||
<li><strong>druid.slider</strong></li>
|
<li><strong>druid.slider</strong></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -60,7 +61,9 @@
|
|||||||
|
|
||||||
<h1>Module <code>druid.slider</code></h1>
|
<h1>Module <code>druid.slider</code></h1>
|
||||||
<p>Druid slider component</p>
|
<p>Druid slider component</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -74,7 +77,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><strong>druid.text</strong></li>
|
<li><strong>druid.text</strong></li>
|
||||||
<li><a href="../modules/druid.timer.html">druid.timer</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_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -65,30 +66,32 @@
|
|||||||
<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
|
||||||
Good working with localization system</p>
|
Good working with localization system</p>
|
||||||
<p></p>
|
<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="#set_alpha">set_alpha(self, alpha)</a></td>
|
||||||
<td class="summary">Set text to text field</td>
|
<td class="summary">Set alpha</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(self, 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_pivot">set_pivot(self, pivot)</a></td>
|
||||||
<td class="summary">Set alpha</td>
|
<td class="summary">Set text pivot.</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(self, 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_to">set_to(self, set_to)</a></td>
|
||||||
<td class="summary">Set text pivot.</td>
|
<td class="summary">Set text to text field</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -100,11 +103,11 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "set_alpha"></a>
|
||||||
<strong>set_to(self, set_to)</strong>
|
<strong>set_alpha(self, alpha)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text to text field
|
Set alpha
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -113,9 +116,9 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">set_to</span>
|
<li><span class="parameter">alpha</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"><span class="type">number</span></span>
|
||||||
Text for node
|
Alpha for node
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -150,11 +153,12 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_alpha"></a>
|
<a name = "set_pivot"></a>
|
||||||
<strong>set_alpha(self, alpha)</strong>
|
<strong>set_pivot(self, pivot)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set alpha
|
Set text pivot. Text will re-anchor inside
|
||||||
|
his text area
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -163,9 +167,9 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">alpha</span>
|
<li><span class="parameter">pivot</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">gui.pivot</span></span>
|
||||||
Alpha for node
|
Gui pivot constant
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -200,12 +204,11 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_pivot"></a>
|
<a name = "set_to"></a>
|
||||||
<strong>set_pivot(self, pivot)</strong>
|
<strong>set_to(self, set_to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text pivot. Text will re-anchor inside
|
Set text to text field
|
||||||
his text area
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -214,9 +217,9 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">pivot</span>
|
<li><span class="parameter">set_to</span>
|
||||||
<span class="types"><span class="type">gui.pivot</span></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
Gui pivot constant
|
Text for node
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -232,7 +235,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
||||||
<li><strong>druid.timer</strong></li>
|
<li><strong>druid.timer</strong></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -64,22 +65,24 @@
|
|||||||
|
|
||||||
<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>
|
<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="#set_interval">set_interval(self, from, to)</a></td>
|
||||||
<td class="summary">Set text to text field</td>
|
<td class="summary">Set time interval</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(self, 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_to">set_to(self, set_to)</a></td>
|
||||||
<td class="summary">Set time interval</td>
|
<td class="summary">Set text to text field</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -91,11 +94,11 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "set_interval"></a>
|
||||||
<strong>set_to(self, set_to)</strong>
|
<strong>set_interval(self, from, to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text to text field
|
Set time interval
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -104,9 +107,13 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">set_to</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>
|
||||||
Value in seconds
|
Start time in seconds
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Target time in seconds
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -141,11 +148,11 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_interval"></a>
|
<a name = "set_to"></a>
|
||||||
<strong>set_interval(self, from, to)</strong>
|
<strong>set_to(self, set_to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set time interval
|
Set text to text field
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
@ -154,13 +161,9 @@
|
|||||||
<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>
|
||||||
Component instance
|
Component instance
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">from</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>
|
||||||
Start time in seconds
|
Value in seconds
|
||||||
</li>
|
|
||||||
<li><span class="parameter">to</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Target time in seconds
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -176,7 +179,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -30,34 +30,28 @@
|
|||||||
<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="#Tables">Tables</a></li>
|
|
||||||
<li><a href="#Fields">Fields</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><strong>druid_event</strong></li>
|
||||||
<li><strong>const</strong></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -65,79 +59,25 @@
|
|||||||
|
|
||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>const</code></h1>
|
<h1>Module <code>druid_event</code></h1>
|
||||||
<p>Druid constants</p>
|
<p>Lua event small library</p>
|
||||||
<p></p>
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<h2><a href="#Tables">Tables</a></h2>
|
|
||||||
<table class="function_list">
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#pivots">pivots</a></td>
|
|
||||||
<td class="summary"></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
|
||||||
<table class="function_list">
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#ON_MESSAGE">ON_MESSAGE</a></td>
|
|
||||||
<td class="summary">Interests</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
|
||||||
|
|
||||||
<dl class="function">
|
|
||||||
<dt>
|
|
||||||
<a name = "pivots"></a>
|
|
||||||
<strong>pivots</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Fields:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">test</span>
|
|
||||||
test
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
|
||||||
|
|
||||||
<dl class="function">
|
|
||||||
<dt>
|
|
||||||
<a name = "ON_MESSAGE"></a>
|
|
||||||
<strong>ON_MESSAGE</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Interests
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</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-07 01:01:14 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
@ -4,7 +4,7 @@
|
|||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||||
<head>
|
<head>
|
||||||
<title>Defold Druid UI Library</title>
|
<title>Defold Druid UI Library</title>
|
||||||
<link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
@ -38,23 +38,24 @@
|
|||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/component.html">component</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.button.html">druid.button</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.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.locale.html">druid.locale</a></li>
|
<li><a href="../modules/druid.helper.html">druid.helper</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.progress.html">druid.progress</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.radio_group.html">druid.radio_group</a></li>
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</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.slider.html">druid.slider</a></li>
|
||||||
<li><a href="../modules/druid.text.html">druid.text</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/druid.timer.html">druid.timer</a></li>
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><strong>druid_instance</strong></li>
|
<li><strong>druid_instance</strong></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -71,8 +72,9 @@
|
|||||||
<li><a href="../modules/druid.button.html#">druid.button</a></li>
|
<li><a href="../modules/druid.button.html#">druid.button</a></li>
|
||||||
<li><a href="../modules/druid.blocker.html#">druid.blocker</a></li>
|
<li><a href="../modules/druid.blocker.html#">druid.blocker</a></li>
|
||||||
<li><a href="../modules/druid.back_handler.html#">druid.back_handler</a></li>
|
<li><a href="../modules/druid.back_handler.html#">druid.back_handler</a></li>
|
||||||
|
<li><a href="../modules/druid.input.html#">druid.input</a></li>
|
||||||
<li><a href="../modules/druid.text.html#">druid.text</a></li>
|
<li><a href="../modules/druid.text.html#">druid.text</a></li>
|
||||||
<li><a href="../modules/druid.locale.html#">druid.locale</a></li>
|
<li><a href="../modules/druid.lang_text.html#">druid.lang_text</a></li>
|
||||||
<li><a href="../modules/druid.timer.html#">druid.timer</a></li>
|
<li><a href="../modules/druid.timer.html#">druid.timer</a></li>
|
||||||
<li><a href="../modules/druid.progress.html#">druid.progress</a></li>
|
<li><a href="../modules/druid.progress.html#">druid.progress</a></li>
|
||||||
<li><a href="../modules/druid.grid.html#">druid.grid</a></li>
|
<li><a href="../modules/druid.grid.html#">druid.grid</a></li>
|
||||||
@ -86,69 +88,25 @@
|
|||||||
|
|
||||||
<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="#druid:initialize">druid:initialize(table, table)</a></td>
|
|
||||||
<td class="summary">Druid class constructor</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:create">druid:create(component, ...)</a></td>
|
<td class="name" nowrap><a href="#druid:create">druid:create(component, ...)</a></td>
|
||||||
<td class="summary">Create new druid component</td>
|
<td class="summary">Create new druid component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:remove">druid:remove(component)</a></td>
|
<td class="name" nowrap><a href="#druid:initialize">druid:initialize(table, table)</a></td>
|
||||||
<td class="summary">Remove component from druid instance.</td>
|
<td class="summary">Druid class constructor</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:update">druid:update(dt)</a></td>
|
|
||||||
<td class="summary">Druid update function</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:on_input">druid:on_input(action_id, action)</a></td>
|
|
||||||
<td class="summary">Druid on_input function</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:on_message">druid:on_message(message_id, message, sender)</a></td>
|
|
||||||
<td class="summary">Druid on_message function</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:new_button">druid:new_button(...)</a></td>
|
|
||||||
<td class="summary">Create button basic component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:new_blocker">druid:new_blocker(...)</a></td>
|
|
||||||
<td class="summary">Create blocker basic component</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:new_back_handler">druid:new_back_handler(...)</a></td>
|
<td class="name" nowrap><a href="#druid:new_back_handler">druid:new_back_handler(...)</a></td>
|
||||||
<td class="summary">Create back_handler basic component</td>
|
<td class="summary">Create back_handler basic component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:new_text">druid:new_text(...)</a></td>
|
<td class="name" nowrap><a href="#druid:new_blocker">druid:new_blocker(...)</a></td>
|
||||||
<td class="summary">Create text basic component</td>
|
<td class="summary">Create blocker basic component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:new_locale">druid:new_locale(...)</a></td>
|
<td class="name" nowrap><a href="#druid:new_button">druid:new_button(...)</a></td>
|
||||||
<td class="summary">Create locale basic component</td>
|
<td class="summary">Create button basic component</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:new_timer">druid:new_timer(...)</a></td>
|
|
||||||
<td class="summary">Create timer basic component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:new_progress">druid:new_progress(...)</a></td>
|
|
||||||
<td class="summary">Create progress basic component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:new_grid">druid:new_grid(...)</a></td>
|
|
||||||
<td class="summary">Create grid basic component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:new_scroll">druid:new_scroll(...)</a></td>
|
|
||||||
<td class="summary">Create scroll basic component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#druid:new_slider">druid:new_slider(...)</a></td>
|
|
||||||
<td class="summary">Create slider basic component</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:new_checkbox">druid:new_checkbox(...)</a></td>
|
<td class="name" nowrap><a href="#druid:new_checkbox">druid:new_checkbox(...)</a></td>
|
||||||
@ -159,12 +117,60 @@
|
|||||||
<td class="summary">Create checkbox_group basic component</td>
|
<td class="summary">Create checkbox_group basic component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_grid">druid:new_grid(...)</a></td>
|
||||||
|
<td class="summary">Create grid basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_hover">druid:new_hover(...)</a></td>
|
||||||
|
<td class="summary">Create hover basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_input">druid:new_input(...)</a></td>
|
||||||
|
<td class="summary">Create input basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_lang_text">druid:new_lang_text(...)</a></td>
|
||||||
|
<td class="summary">Create lang_text basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_progress">druid:new_progress(...)</a></td>
|
||||||
|
<td class="summary">Create progress basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:new_radio_group">druid:new_radio_group(...)</a></td>
|
<td class="name" nowrap><a href="#druid:new_radio_group">druid:new_radio_group(...)</a></td>
|
||||||
<td class="summary">Create radio_group basic component</td>
|
<td class="summary">Create radio_group basic component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#druid:new_progress_rich">druid:new_progress_rich(...)</a></td>
|
<td class="name" nowrap><a href="#druid:new_scroll">druid:new_scroll(...)</a></td>
|
||||||
<td class="summary">Create progress_rich basic component</td>
|
<td class="summary">Create scroll basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_slider">druid:new_slider(...)</a></td>
|
||||||
|
<td class="summary">Create slider basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_text">druid:new_text(...)</a></td>
|
||||||
|
<td class="summary">Create text basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:new_timer">druid:new_timer(...)</a></td>
|
||||||
|
<td class="summary">Create timer basic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:on_input">druid:on_input(action_id, action)</a></td>
|
||||||
|
<td class="summary">Druid on_input function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:on_message">druid:on_message(message_id, message, sender)</a></td>
|
||||||
|
<td class="summary">Druid on_message function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:remove">druid:remove(component)</a></td>
|
||||||
|
<td class="summary">Remove component from druid instance.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#druid:update">druid:update(dt)</a></td>
|
||||||
|
<td class="summary">Druid update function</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -175,31 +181,6 @@
|
|||||||
<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 = "druid:initialize"></a>
|
|
||||||
<strong>druid:initialize(table, table)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Druid class constructor
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">table</span>
|
|
||||||
<span class="types"><span class="type">style</span></span>
|
|
||||||
Druid style module
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">table</span>
|
|
||||||
<span class="types"><span class="type">style</span></span>
|
|
||||||
Druid style module
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "druid:create"></a>
|
<a name = "druid:create"></a>
|
||||||
<strong>druid:create(component, ...)</strong>
|
<strong>druid:create(component, ...)</strong>
|
||||||
@ -226,19 +207,22 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "druid:remove"></a>
|
<a name = "druid:initialize"></a>
|
||||||
<strong>druid:remove(component)</strong>
|
<strong>druid:initialize(table, table)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Remove component from druid instance.
|
Druid class constructor
|
||||||
Component `on_remove` function will be invoked, if exist.
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">component</span>
|
<li><span class="parameter">table</span>
|
||||||
<span class="types"><span class="type">Component</span></span>
|
<span class="types"><span class="type">style</span></span>
|
||||||
Component instance
|
Druid style module
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">table</span>
|
||||||
|
<span class="types"><span class="type">style</span></span>
|
||||||
|
Druid style module
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -248,93 +232,18 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "druid:update"></a>
|
<a name = "druid:new_back_handler"></a>
|
||||||
<strong>druid:update(dt)</strong>
|
<strong>druid:new_back_handler(...)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Druid update function
|
Create back_handler basic component
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">dt</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Delta time
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:on_input"></a>
|
|
||||||
<strong>druid:on_input(action_id, action)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Druid on_input function
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">action_id</span>
|
|
||||||
<span class="types"><span class="type">hash</span></span>
|
|
||||||
Action_id from on_input
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">action</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Action from on_input
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:on_message"></a>
|
|
||||||
<strong>druid:on_message(message_id, message, sender)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Druid on_message function
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">message_id</span>
|
|
||||||
<span class="types"><span class="type">hash</span></span>
|
|
||||||
Message_id from on_message
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">message</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Message from on_message
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">sender</span>
|
|
||||||
<span class="types"><span class="type">hash</span></span>
|
|
||||||
Sender from on_message
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_button"></a>
|
|
||||||
<strong>druid:new_button(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create button basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">...</span>
|
<li><span class="parameter">...</span>
|
||||||
<span class="types"><span class="type">args</span></span>
|
<span class="types"><span class="type">args</span></span>
|
||||||
button init args
|
back_handler init args
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -342,7 +251,7 @@
|
|||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
<span class="types"><span class="type">Component</span></span>
|
||||||
button component
|
back_handler component
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -377,18 +286,18 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "druid:new_back_handler"></a>
|
<a name = "druid:new_button"></a>
|
||||||
<strong>druid:new_back_handler(...)</strong>
|
<strong>druid:new_button(...)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Create back_handler basic component
|
Create button basic component
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">...</span>
|
<li><span class="parameter">...</span>
|
||||||
<span class="types"><span class="type">args</span></span>
|
<span class="types"><span class="type">args</span></span>
|
||||||
back_handler init args
|
button init args
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -396,196 +305,7 @@
|
|||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
<span class="types"><span class="type">Component</span></span>
|
||||||
back_handler component
|
button component
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_text"></a>
|
|
||||||
<strong>druid:new_text(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create text basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">...</span>
|
|
||||||
<span class="types"><span class="type">args</span></span>
|
|
||||||
text init args
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
|
||||||
text component
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_locale"></a>
|
|
||||||
<strong>druid:new_locale(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create locale basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">...</span>
|
|
||||||
<span class="types"><span class="type">args</span></span>
|
|
||||||
locale init args
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
|
||||||
locale component
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_timer"></a>
|
|
||||||
<strong>druid:new_timer(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create timer basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">...</span>
|
|
||||||
<span class="types"><span class="type">args</span></span>
|
|
||||||
timer init args
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
|
||||||
timer component
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_progress"></a>
|
|
||||||
<strong>druid:new_progress(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create progress basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">...</span>
|
|
||||||
<span class="types"><span class="type">args</span></span>
|
|
||||||
progress init args
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
|
||||||
progress component
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_grid"></a>
|
|
||||||
<strong>druid:new_grid(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create grid basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">...</span>
|
|
||||||
<span class="types"><span class="type">args</span></span>
|
|
||||||
grid init args
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
|
||||||
grid component
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_scroll"></a>
|
|
||||||
<strong>druid:new_scroll(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create scroll basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">...</span>
|
|
||||||
<span class="types"><span class="type">args</span></span>
|
|
||||||
scroll init args
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
|
||||||
scroll component
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "druid:new_slider"></a>
|
|
||||||
<strong>druid:new_slider(...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Create slider basic component
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">...</span>
|
|
||||||
<span class="types"><span class="type">args</span></span>
|
|
||||||
slider init args
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
|
||||||
slider component
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -645,6 +365,141 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_grid"></a>
|
||||||
|
<strong>druid:new_grid(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create grid basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
grid init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
grid component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_hover"></a>
|
||||||
|
<strong>druid:new_hover(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create hover basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
hover init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
hover component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_input"></a>
|
||||||
|
<strong>druid:new_input(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create input basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
input init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
input component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_lang_text"></a>
|
||||||
|
<strong>druid:new_lang_text(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create lang_text basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
lang_text init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
lang_text component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_progress"></a>
|
||||||
|
<strong>druid:new_progress(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create progress basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
progress init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
progress component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "druid:new_radio_group"></a>
|
<a name = "druid:new_radio_group"></a>
|
||||||
@ -674,18 +529,18 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "druid:new_progress_rich"></a>
|
<a name = "druid:new_scroll"></a>
|
||||||
<strong>druid:new_progress_rich(...)</strong>
|
<strong>druid:new_scroll(...)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Create progress_rich basic component
|
Create scroll basic component
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">...</span>
|
<li><span class="parameter">...</span>
|
||||||
<span class="types"><span class="type">args</span></span>
|
<span class="types"><span class="type">args</span></span>
|
||||||
progress_rich init args
|
scroll init args
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -693,12 +548,190 @@
|
|||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">Component</span></span>
|
<span class="types"><span class="type">Component</span></span>
|
||||||
progress_rich component
|
scroll component
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_slider"></a>
|
||||||
|
<strong>druid:new_slider(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create slider basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
slider init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
slider component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_text"></a>
|
||||||
|
<strong>druid:new_text(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create text basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
text init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
text component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:new_timer"></a>
|
||||||
|
<strong>druid:new_timer(...)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create timer basic component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">args</span></span>
|
||||||
|
timer init args
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
timer component
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:on_input"></a>
|
||||||
|
<strong>druid:on_input(action_id, action)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Druid on_input function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action_id</span>
|
||||||
|
<span class="types"><span class="type">hash</span></span>
|
||||||
|
Action<em>id from on</em>input
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">action</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Action from on_input
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:on_message"></a>
|
||||||
|
<strong>druid:on_message(message_id, message, sender)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Druid on_message function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">message_id</span>
|
||||||
|
<span class="types"><span class="type">hash</span></span>
|
||||||
|
Message<em>id from on</em>message
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">message</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Message from on_message
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">sender</span>
|
||||||
|
<span class="types"><span class="type">hash</span></span>
|
||||||
|
Sender from on_message
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:remove"></a>
|
||||||
|
<strong>druid:remove(component)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Remove component from druid instance.
|
||||||
|
Component <code>on_remove</code> function will be invoked, if exist.
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">component</span>
|
||||||
|
<span class="types"><span class="type">Component</span></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid:update"></a>
|
||||||
|
<strong>druid:update(dt)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Druid update function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">dt</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Delta time
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -707,7 +740,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-07 01:09:38 </i>
|
<i style="float:right;">Last updated 2020-02-23 13:01:03 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -1,191 +0,0 @@
|
|||||||
<!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_pale.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>
|
|
||||||
</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><a href="../modules/druid.locale.html">druid.locale</a></li>
|
|
||||||
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
|
||||||
<li><a href="../modules/druid.radio_group.html">druid.radio_group</a></li>
|
|
||||||
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
|
||||||
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
|
||||||
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
|
||||||
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
|
||||||
<li><a href="../modules/component.html">component</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/helper.html">helper</a></li>
|
|
||||||
<li><strong>helper.formats</strong></li>
|
|
||||||
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
||||||
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div id="content">
|
|
||||||
|
|
||||||
<h1>Module <code>helper.formats</code></h1>
|
|
||||||
<p>Druid module with utils on string formats</p>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
|
||||||
<table class="function_list">
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#add_prefix_zeros">add_prefix_zeros(num, count)</a></td>
|
|
||||||
<td class="summary">Return number with zero number prefix</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#second_string_min">second_string_min(sec)</a></td>
|
|
||||||
<td class="summary">Convert seconds to string minutes:seconds</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#second_string_min">second_string_min(s, tab)</a></td>
|
|
||||||
<td class="summary">Interpolate string with named Parameters in Table</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<br/>
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
|
|
||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
||||||
|
|
||||||
<dl class="function">
|
|
||||||
<dt>
|
|
||||||
<a name = "add_prefix_zeros"></a>
|
|
||||||
<strong>add_prefix_zeros(num, count)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return number with zero number prefix
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">num</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Number for conversion
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">count</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Count of numerals
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
string with need count of zero (1,3) -> 001
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "second_string_min"></a>
|
|
||||||
<strong>second_string_min(sec)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Convert seconds to string minutes:seconds
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">sec</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Seconds
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
string minutes:seconds
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "second_string_min"></a>
|
|
||||||
<strong>second_string_min(s, tab)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Interpolate string with named Parameters in Table
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">s</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
||||||
Target string
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">tab</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
||||||
Table with parameters
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
string with replaced parameters
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</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-02-07 01:01:59 </i>
|
|
||||||
</div> <!-- id="about" -->
|
|
||||||
</div> <!-- id="container" -->
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Loading…
x
Reference in New Issue
Block a user