Druid-Extension/docs/modules/.druidtimer.html
2020-02-05 02:42:58 +03:00

187 lines
5.0 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_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/.druidback_handler.html">.druidback_handler</a></li>
<li><a href="../modules/.druidblocker.html">.druidblocker</a></li>
<li><a href="../modules/.druidbutton.html">.druidbutton</a></li>
<li><a href="../modules/.druidcheckbox.html">.druidcheckbox</a></li>
<li><a href="../modules/.druidcheckbox_group.html">.druidcheckbox_group</a></li>
<li><a href="../modules/.druidgrid.html">.druidgrid</a></li>
<li><a href="../modules/.druidtext.html">.druidtext</a></li>
<li><a href="../modules/.druidprogress.html">.druidprogress</a></li>
<li><a href="../modules/.druidcheckbox_group.html">.druidcheckbox_group</a></li>
<li><a href="../modules/.druidscroll.html">.druidscroll</a></li>
<li><a href="../modules/.druidslider.html">.druidslider</a></li>
<li><a href="../modules/.druidtext.html">.druidtext</a></li>
<li><strong>.druidtimer</strong></li>
<li><a href="../modules/const.html">const</a></li>
<li><a href="../modules/druid.html">druid</a></li>
<li><a href="../modules/helper.html">helper</a></li>
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/settings.html">settings</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>.druidtimer</code></h1>
<p>Component to handle GUI timers</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#timer:set_to">timer:set_to(self, set_to)</a></td>
<td class="summary">Set text to text field</td>
</tr>
<tr>
<td class="name" nowrap><a href="#timer:set_state">timer:set_state(self, is_on)</a></td>
<td class="summary">Called when update</td>
</tr>
<tr>
<td class="name" nowrap><a href="#timer:set_interval">timer:set_interval(self, from, to)</a></td>
<td class="summary">Set time interval</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "timer:set_to"></a>
<strong>timer:set_to(self, set_to)</strong>
</dt>
<dd>
Set text to text field
<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">set_to</span>
<span class="types"><span class="type">number</span></span>
Value in seconds
</li>
</ul>
</dd>
<dt>
<a name = "timer:set_state"></a>
<strong>timer:set_state(self, is_on)</strong>
</dt>
<dd>
Called when update
<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">is_on</span>
<span class="types"><span class="type">boolean</span></span>
Timer enable state
</li>
</ul>
</dd>
<dt>
<a name = "timer:set_interval"></a>
<strong>timer:set_interval(self, from, to)</strong>
</dt>
<dd>
Set time interval
<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">from</span>
<span class="types"><span class="type">number</span></span>
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>
</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-02-04 23:48:07 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>