Update ldoc

This commit is contained in:
Insality
2020-03-22 12:55:17 +03:00
parent 7b2578c0ef
commit d650c2393b
27 changed files with 167 additions and 60 deletions

View File

@@ -92,23 +92,66 @@
<p><a name="Button"></a></p>
<h2>Button</h2>
<p>Basic game button</p>
<p>Basic Druid input component</p>
<ul>
<li>Button callback have next params: (self, params, button_instance)
<pre>
- **self** - Druid self context
- **params** - Additional params, specified on button creating
- **button_instance** - button itself
</pre>
</li>
<li>Button have next events:
<pre>
- **on_click** - basic button callback
- **on_repeated_click** - repeated click callback, <span class="keyword">while</span> holding the button, don<span class="string">'t trigger if callback is empty
- **on_long_click** - callback on long button tap, don'</span>t trigger <span class="keyword">if</span> callback is empty
- **on_hold_click** - hold callback, before long_click trigger, don<span class="string">'t trigger if callback is empty
- **on_double_click** - different callback, if tap button 2+ in row, don'</span>t trigger <span class="keyword">if</span> callback is empty
</pre>
</li>
<li>If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use <a href="../modules/druid.button.html#set_click_zone">button:set_click_zone</a> to restrict button click zone</li>
<li>Button can have key trigger to use then by key: <a href="../modules/druid.button.html#set_key_trigger">button:set_key_trigger</a></li>
</ul>
<p><a name="Text"></a></p>
<h2>Text</h2>
<p>Wrap on text node with text size adjusting</p>
<p>Basic Druid text component</p>
<ul>
<li>Text component by default have auto adjust text sizing. Text never will be more, than text size, which you can setup in gui scene. It can be disabled on component creating
<img src="media/text_autosize.png" alt=""/></li>
<li>Text pivot can be changed with <a href="../modules/druid.text.html#set_pivot">text:set_pivot</a>, and text will save their position inside their text size box:
<img src="media/text_anchor.gif" alt=""/></li>
</ul>
<p><a name="Blocker"></a></p>
<h2>Blocker</h2>
<p>Block input in node zone</p>
<p>Druid component for block input</p>
<p>It can be used for block input in special zone.</p>
<p>Example:
<img src="media/blocker_scheme.png" alt=""/></p>
<p>Blue zone is <strong>button</strong> with close_window callback </p>
<p>Yellow zone is blocker with window content</p>
<p>So you can do the safe zones, when you have the big buttons</p>
<p><a name="Back_Handler"></a></p>
<h2>Back Handler</h2>
<p>Handle back button (Android, backspace)</p>
<p>Component to handle back button</p>
<p>It works on Android back button and Backspace. Key triggers in <code>input.binding</code> should be setup</p>
<p><a name="Locale"></a></p>
<h2>Locale</h2>
<p>Text component with handle localization system</p>
<p>Wrap on Druid text component to handle localization</p>
<p><a name="Timer"></a></p>
<h2>Timer</h2>
@@ -155,7 +198,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 2020-03-22 02:23:51 </i>
<i style="float:right;">Last updated 2020-03-22 12:55:11 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>