Update docs

This commit is contained in:
Insality
2020-02-05 02:42:36 +03:00
parent 9ae07b4784
commit f619b25ba8
19 changed files with 333 additions and 431 deletions

View File

@@ -44,18 +44,20 @@
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
<li><a href="../modules/base.grid.html">base.grid</a></li>
<li><a href="../modules/base.text.html">base.text</a></li>
<li><a href="../modules/base.progress.html">base.progress</a></li>
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
<li><strong>base.scroll</strong></li>
<li><a href="../modules/base.slider.html">base.slider</a></li>
<li><a href="../modules/base.text.html">base.text</a></li>
<li><a href="../modules/base.timer.html">base.timer</a></li>
<li><a href="../modules/constants.html">constants</a></li>
<li><a href="../modules/const.html">const</a></li>
<li><a href="../modules/druid.html">druid</a></li>
<li><a href="../modules/helper.html">helper</a></li>
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/settings.html">settings</a></li>
</ul>
@@ -115,11 +117,11 @@
<ul>
<li><span class="parameter">vector3</span>
<span class="types"><span class="type">point</span></span>
target point
target point
</li>
<li><span class="parameter">is_instant</span>
<span class="types"><span class="type">bool</span></span>
instant scroll flag
instant scroll flag
(<em>optional</em>)
</li>
</ul>
@@ -146,15 +148,15 @@
<ul>
<li><span class="parameter">self</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Component instance
Component instance
</li>
<li><span class="parameter">index</span>
<span class="types"><span class="type">number</span></span>
Point index
Point index
</li>
<li><span class="parameter">skip_cb</span>
<span class="types"><span class="type">boolean</span></span>
If true, skip the point callback
If true, skip the point callback
(<em>optional</em>)
</li>
</ul>
@@ -169,18 +171,19 @@
<strong>set_points(self, points)</strong>
</dt>
<dd>
Set points of interest. Scroll will always centered on closer points
Set points of interest.
Scroll will always centered on closer points
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">self</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Component instance
Component instance
</li>
<li><span class="parameter">points</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Array of vector3 points
Array of vector3 points
</li>
</ul>
@@ -194,18 +197,20 @@
<strong>set_inert(self, state)</strong>
</dt>
<dd>
Enable or disable scroll inert. If disabled, scroll through points (if exist) If no points, just simple drag without inertion
Enable or disable scroll inert.
If disabled, scroll through points (if exist)
If no points, just simple drag without inertion
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">self</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Component instance
Component instance
</li>
<li><span class="parameter">state</span>
<span class="types"><span class="type">boolean</span></span>
Inert scroll state
Inert scroll state
</li>
</ul>
@@ -226,11 +231,11 @@
<ul>
<li><span class="parameter">self</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Component instance
Component instance
</li>
<li><span class="parameter">callback</span>
<span class="types"><span class="type">function</span></span>
Callback on scroll to point of interest
Callback on scroll to point of interest
</li>
</ul>
@@ -251,11 +256,11 @@
<ul>
<li><span class="parameter">self</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Component instance
Component instance
</li>
<li><span class="parameter">border</span>
<span class="types"><span class="type">vmath.vector3</span></span>
Size of scrolling area
Size of scrolling area
</li>
</ul>
@@ -271,7 +276,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-12-05 22:04:11 </i>
<i style="float:right;">Last updated 2020-02-04 23:46:10 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>