mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 10:27:47 +02:00
404 lines
10 KiB
HTML
404 lines
10 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<head>
|
|
<title>Defold Druid UI Library</title>
|
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div> <!-- id="product" -->
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
<!-- Menu -->
|
|
|
|
<div id="navigation">
|
|
<br/>
|
|
<h1>Druid</h1>
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Functions">Functions</a></li>
|
|
<li><a href="#Tables">Tables</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Modules</h2>
|
|
<ul class="nowrap">
|
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
|
<li><strong>druid.button</strong></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.hover.html">druid.hover</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.radio_group.html">druid.radio_group</a></li>
|
|
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
|
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
|
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
|
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
|
<li><a href="../modules/component.html">component</a></li>
|
|
<li><a href="../modules/druid.html">druid</a></li>
|
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
|
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>druid.button</code></h1>
|
|
<p>Component to handle basic GUI button</p>
|
|
<p>
|
|
|
|
</p>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#init">init(node, callback[, params[, anim_node[, event]]])</a></td>
|
|
<td class="summary">Component init function</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#set_enabled">set_enabled(state)</a></td>
|
|
<td class="summary">Set enabled button component state</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#is_enabled">is_enabled()</a></td>
|
|
<td class="summary">Return button enabled state</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(zone)</a></td>
|
|
<td class="summary">Strict button click area.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#set_key_trigger">set_key_trigger(key)</a></td>
|
|
<td class="summary">Set key-code to trigger this button</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#get_key_trigger">get_key_trigger()</a></td>
|
|
<td class="summary">Get key-code to trigger this button</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Tables">Tables</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
|
<td class="summary">Component events</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
|
<td class="summary">Component fields</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#Style">Style</a></td>
|
|
<td class="summary">Component style params</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "init"></a>
|
|
<strong>init(node, callback[, params[, anim_node[, event]]])</strong>
|
|
</dt>
|
|
<dd>
|
|
Component init function
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">node</span>
|
|
<span class="types"><span class="type">node</span></span>
|
|
Gui node
|
|
</li>
|
|
<li><span class="parameter">callback</span>
|
|
<span class="types"><span class="type">function</span></span>
|
|
Button callback
|
|
</li>
|
|
<li><span class="parameter">params</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
Button callback params
|
|
(<em>optional</em>)
|
|
</li>
|
|
<li><span class="parameter">anim_node</span>
|
|
<span class="types"><span class="type">node</span></span>
|
|
Button anim node (node, if not provided)
|
|
(<em>optional</em>)
|
|
</li>
|
|
<li><span class="parameter">event</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
Button react event, const.ACTION_TOUCH by default
|
|
(<em>optional</em>)
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_enabled"></a>
|
|
<strong>set_enabled(state)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set enabled button component state
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">state</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
Enabled state
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "is_enabled"></a>
|
|
<strong>is_enabled()</strong>
|
|
</dt>
|
|
<dd>
|
|
Return button enabled state
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">bool</span></span>
|
|
True, if button is enabled
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_click_zone"></a>
|
|
<strong>set_click_zone(zone)</strong>
|
|
</dt>
|
|
<dd>
|
|
Strict button click area. Useful for
|
|
no click events outside stencil node
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">zone</span>
|
|
<span class="types"><span class="type">node</span></span>
|
|
Gui node
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_key_trigger"></a>
|
|
<strong>set_key_trigger(key)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set key-code to trigger this button
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">key</span>
|
|
<span class="types"><span class="type">hash</span></span>
|
|
The action_id of the key
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "get_key_trigger"></a>
|
|
<strong>get_key_trigger()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get key-code to trigger this button
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">hash</span></span>
|
|
The action_id of the key
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "Events"></a>
|
|
<strong>Events</strong>
|
|
</dt>
|
|
<dd>
|
|
Component events
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">on_click</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
On release button callback
|
|
</li>
|
|
<li><span class="parameter">on_repeated_click</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
On repeated action button callback
|
|
</li>
|
|
<li><span class="parameter">on_long_click</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
On long tap button callback
|
|
</li>
|
|
<li><span class="parameter">on_double_click</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
On double tap button callback
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Fields"></a>
|
|
<strong>Fields</strong>
|
|
</dt>
|
|
<dd>
|
|
Component fields
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">node</span>
|
|
<span class="types"><span class="type">node</span></span>
|
|
Trigger node
|
|
</li>
|
|
<li><span class="parameter">anim_node</span>
|
|
<span class="types"><span class="type">node</span></span>
|
|
Animation node
|
|
(<em>default</em> node)
|
|
</li>
|
|
<li><span class="parameter">scale_from</span>
|
|
<span class="types"><span class="type">vector3</span></span>
|
|
Initial scale of anim_node
|
|
</li>
|
|
<li><span class="parameter">pos</span>
|
|
<span class="types"><span class="type">vector3</span></span>
|
|
Initial pos of anim_node
|
|
</li>
|
|
<li><span class="parameter">params</span>
|
|
<span class="types"><span class="type">any</span></span>
|
|
Params to click callbacks
|
|
</li>
|
|
<li><span class="parameter">hover</span>
|
|
<span class="types"><span class="type">druid.hover</span></span>
|
|
Druid hover logic component
|
|
</li>
|
|
<li><span class="parameter">click_zone</span>
|
|
<span class="types"><span class="type">node</span></span>
|
|
Restriction zone
|
|
(<em>optional</em>)
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Style"></a>
|
|
<strong>Style</strong>
|
|
</dt>
|
|
<dd>
|
|
Component style params
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">on_click</span>
|
|
<span class="types"><span class="type">function</span></span>
|
|
(self, node)
|
|
</li>
|
|
<li><span class="parameter">on_click_disabled</span>
|
|
<span class="types"><span class="type">function</span></span>
|
|
(self, node)
|
|
</li>
|
|
<li><span class="parameter">on_hover</span>
|
|
<span class="types"><span class="type">function</span></span>
|
|
(self, node, hover_state)
|
|
</li>
|
|
<li><span class="parameter">on_set_enabled</span>
|
|
<span class="types"><span class="type">function</span></span>
|
|
(self, node, enabled_state)
|
|
</li>
|
|
<li><span class="parameter">IS_HOVER</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
|
<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|