Update README and docs

This commit is contained in:
Insality 2020-03-22 15:19:10 +03:00
parent ed39091a8e
commit a0e5abeffd
29 changed files with 141 additions and 118 deletions

View File

@ -58,37 +58,38 @@ druid.set_default_style(your_style)
## Components ## Components
**Druid** provides next basic components: **Druid** provides next basic components:
- **Button** - Basic game button
- **Text** - Wrap on text node with text size adjusting - **[Button](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#button)** - Basic Druid input component
- **Blocker** - Block input in node zone - **[Text](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#text)** - Basic Druid text component
- **Back Handler** - Handle back button (Android, backspace) - **Lang text** - Wrap on Text component to handle localization
- **Lang text** - Text component with handle localization system - **Scroll** - Basic Druid scroll component
- **Timer** - Run timer on text node - **Progress** - Basic Druid progress bar component
- **Progress** - Basic progress bar - **Slider** - Basic Druid slider component
- **Scroll** - Basic scroll component - **Input** - Basic Druid text input component (unimplemented)
- **Grid** - Component for manage node positions - **Checkbox** - Basic Druid checkbox component
- **Slider** - Basic slider component
- **Checkbox** - Basic checkbox component
- **Checkbox group** - Several checkboxes in one group - **Checkbox group** - Several checkboxes in one group
- **Radio group** - Several checkboxes in one group with single choice - **Radio group** - Several checkboxes in one group with single choice
- **Hover** - Trigger component for check node hover state - **[Blocker](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#blocker)** - Block input in node zone component
- **Input** - Component to process user text input - **Back Handler** - Handle back button (Android back, backspace)
Full info see on _components.md_ - **Timer** - Handle timer work on gui text node
- **Grid** - Component for manage node positions
- **Hover** - System Druid component, handle hover node state
Full info see on _[components.md](https://github.com/Insality/druid/blob/master/docs_md/01-components.md)_
## Basic usage ## Basic usage
@ -153,10 +154,10 @@ Try the [HTML5 version](https://insality.github.io/druid/druid/) of the example
## Documentation ## Documentation
To learn **Druid** better, read next documentation: To learn **Druid** better, read next documentation:
- [Druid components](https://insality.github.io/druid/topics/01-components.md.html) - [Druid components](https://github.com/Insality/druid/blob/master/docs_md/01-components.md)
- [Create custom components](https://insality.github.io/druid/topics/02-creating_custom_components.md.html) - [Create custom components](https://github.com/Insality/druid/blob/master/docs_md/02-creating_custom_components.md)
- [Druid styles](https://insality.github.io/druid/topics/03-styles.md.html) - [Druid styles](https://github.com/Insality/druid/blob/master/docs_md/03-styles.md)
- [Druid asset store](https://insality.github.io/druid/topics/04-druid_assets.md.html) - [Druid asset store](https://github.com/Insality/druid/blob/master/docs_md/04-druid_assets.md)
Full **Druid** documentation you can find here: Full **Druid** documentation you can find here:
https://insality.github.io/druid/ https://insality.github.io/druid/

View File

@ -185,7 +185,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -406,7 +406,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -215,7 +215,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -234,7 +234,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -405,7 +405,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -277,7 +277,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -239,7 +239,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -370,7 +370,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -236,7 +236,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -211,7 +211,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -181,7 +181,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -86,7 +86,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -240,7 +240,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -378,7 +378,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -239,7 +239,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -507,7 +507,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -278,7 +278,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -352,7 +352,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -307,7 +307,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -239,7 +239,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -750,7 +750,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -36,17 +36,17 @@
<li><a href="#Text">Text </a></li> <li><a href="#Text">Text </a></li>
<li><a href="#Blocker">Blocker </a></li> <li><a href="#Blocker">Blocker </a></li>
<li><a href="#Back_Handler">Back Handler </a></li> <li><a href="#Back_Handler">Back Handler </a></li>
<li><a href="#Locale">Locale </a></li> <li><a href="#Lang_text">Lang text </a></li>
<li><a href="#Timer">Timer </a></li>
<li><a href="#Progress">Progress </a></li>
<li><a href="#Scroll">Scroll </a></li> <li><a href="#Scroll">Scroll </a></li>
<li><a href="#Grid">Grid </a></li> <li><a href="#Progress">Progress </a></li>
<li><a href="#Slider">Slider </a></li> <li><a href="#Slider">Slider </a></li>
<li><a href="#Input">Input </a></li>
<li><a href="#Checkbox">Checkbox </a></li> <li><a href="#Checkbox">Checkbox </a></li>
<li><a href="#Checkbox_group">Checkbox group </a></li> <li><a href="#Checkbox_group">Checkbox group </a></li>
<li><a href="#Radio_group">Radio group </a></li> <li><a href="#Radio_group">Radio group </a></li>
<li><a href="#Timer">Timer </a></li>
<li><a href="#Grid">Grid </a></li>
<li><a href="#Hover">Hover </a></li> <li><a href="#Hover">Hover </a></li>
<li><a href="#Input">Input </a></li>
</ul> </ul>
@ -90,8 +90,10 @@
<h1>Druid components</h1> <h1>Druid components</h1>
<p><a name="Button"></a></p> <p><a name="Button"></a></p>
<h2>Button</h2> <h2>Button</h2>
<p>Basic Druid input component</p> <p>Basic Druid input component</p>
<ul> <ul>
@ -117,27 +119,37 @@
<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> <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> </ul>
<p><a name="Text"></a></p> <p><a name="Text"></a></p>
<h2>Text</h2> <h2>Text</h2>
<p>Basic Druid text component</p> <p>Basic Druid text component</p>
<ul> <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 <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</li>
<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> </ul>
<p><img src="../media/text_autosize.png" alt=""/></p>
<ul>
<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:</li>
</ul>
<p><img src="../media/text_anchor.gif" alt=""/></p>
<p><a name="Blocker"></a></p> <p><a name="Blocker"></a></p>
<h2>Blocker</h2> <h2>Blocker</h2>
<p>Druid component for block input</p> <p>Druid component for block input</p>
<p>It can be used for block input in special zone.</p> <p>It can be used for block input in special zone.</p>
<p>Example: <p>Example:</p>
<img src="media/blocker_scheme.png" alt=""/></p>
<p>Blue zone is <strong>button</strong> with close_window callback </p> <p><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>Yellow zone is blocker with window content</p>
@ -149,33 +161,29 @@
<p>It works on Android back button and Backspace. Key triggers in <code>input.binding</code> should be setup</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> <p><a name="Lang_text"></a></p>
<h2>Locale</h2> <h2>Lang text</h2>
<p>Wrap on Druid text component to handle localization</p> <p>Wrap on Text component to handle localization</p>
<p><a name="Timer"></a></p>
<h2>Timer</h2>
<p>Run timer on text node</p>
<p><a name="Progress"></a></p>
<h2>Progress</h2>
<p>Basic progress bar</p>
<p><a name="Scroll"></a></p> <p><a name="Scroll"></a></p>
<h2>Scroll</h2> <h2>Scroll</h2>
<p>Basic scroll component</p> <p>Basic Druid scroll component</p>
<p><a name="Grid"></a></p> <p><a name="Progress"></a></p>
<h2>Grid</h2> <h2>Progress</h2>
<p>Component for manage node positions</p> <p>Basic Druid progress bar component</p>
<p><a name="Slider"></a></p> <p><a name="Slider"></a></p>
<h2>Slider</h2> <h2>Slider</h2>
<p>Basic slider component</p> <p>Basic Druid slider component</p>
<p><a name="Input"></a></p>
<h2>Input</h2>
<p>Basic Druid text input component (unimplemented)</p>
<p><a name="Checkbox"></a></p> <p><a name="Checkbox"></a></p>
<h2>Checkbox</h2> <h2>Checkbox</h2>
<p>Basic checkbox component</p> <p>Basic Druid checkbox component</p>
<p><a name="Checkbox_group"></a></p> <p><a name="Checkbox_group"></a></p>
<h2>Checkbox group</h2> <h2>Checkbox group</h2>
@ -185,20 +193,24 @@
<h2>Radio group</h2> <h2>Radio group</h2>
<p>Several checkboxes in one group with single choice</p> <p>Several checkboxes in one group with single choice</p>
<p><a name="Timer"></a></p>
<h2>Timer</h2>
<p>Handle timer work on gui text node</p>
<p><a name="Grid"></a></p>
<h2>Grid</h2>
<p>Component for manage node positions </p>
<p><a name="Hover"></a></p> <p><a name="Hover"></a></p>
<h2>Hover</h2> <h2>Hover</h2>
<p>Trigger component for check node hover state</p> <p>System Druid component, handle hover node state</p>
<p><a name="Input"></a></p>
<h2>Input</h2>
<p>Component to process user text input</p>
</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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -202,7 +202,7 @@ There is next interests in druid:
</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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -138,7 +138,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -89,7 +89,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -87,7 +87,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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -148,27 +148,27 @@
<p><a name="Components"></a></p> <p><a name="Components"></a></p>
<h2>Components</h2> <h2>Components</h2>
<p><strong>Druid</strong> provides next basic components: <p><strong>Druid</strong> provides next basic components:</p>
- <strong>Button</strong> - Basic game button</p>
<ul> <ul>
<li><p><strong>Text</strong> - Wrap on text node with text size adjusting</p></li> <li><p><strong><a href="https://github.com/Insality/druid/blob/master/docs_md/01-components.md#button">Button</a></strong> - Basic Druid input component</p></li>
<li><p><strong>Blocker</strong> - Block input in node zone</p></li> <li><p><strong><a href="https://github.com/Insality/druid/blob/master/docs_md/01-components.md#text">Text</a></strong> - Basic Druid text component</p></li>
<li><p><strong>Back Handler</strong> - Handle back button (Android, backspace)</p></li> <li><p><strong>Lang text</strong> - Wrap on Text component to handle localization</p></li>
<li><p><strong>Lang text</strong> - Text component with handle localization system</p></li> <li><p><strong>Scroll</strong> - Basic Druid scroll component</p></li>
<li><p><strong>Timer</strong> - Run timer on text node</p></li> <li><p><strong>Progress</strong> - Basic Druid progress bar component</p></li>
<li><p><strong>Progress</strong> - Basic progress bar</p></li> <li><p><strong>Slider</strong> - Basic Druid slider component</p></li>
<li><p><strong>Scroll</strong> - Basic scroll component</p></li> <li><p><strong>Input</strong> - Basic Druid text input component (unimplemented)</p></li>
<li><p><strong>Grid</strong> - Component for manage node positions</p></li> <li><p><strong>Checkbox</strong> - Basic Druid checkbox component</p></li>
<li><p><strong>Slider</strong> - Basic slider component</p></li>
<li><p><strong>Checkbox</strong> - Basic checkbox component</p></li>
<li><p><strong>Checkbox group</strong> - Several checkboxes in one group</p></li> <li><p><strong>Checkbox group</strong> - Several checkboxes in one group</p></li>
<li><p><strong>Radio group</strong> - Several checkboxes in one group with single choice</p></li> <li><p><strong>Radio group</strong> - Several checkboxes in one group with single choice</p></li>
<li><p><strong>Hover</strong> - Trigger component for check node hover state</p></li> <li><p><strong><a href="https://github.com/Insality/druid/blob/master/docs_md/01-components.md#blocker">Blocker</a></strong> - Block input in node zone component</p></li>
<li><p><strong>Input</strong> - Component to process user text input</p></li> <li><p><strong>Back Handler</strong> - Handle back button (Android back, backspace)</p></li>
<li><p><strong>Timer</strong> - Handle timer work on gui text node</p></li>
<li><p><strong>Grid</strong> - Component for manage node positions </p></li>
<li><p><strong>Hover</strong> - System Druid component, handle hover node state</p></li>
</ul> </ul>
<p>Full info see on <em>components.md</em></p> <p>Full info see on <em><a href="https://github.com/Insality/druid/blob/master/docs_md/01-components.md">components.md</a></em></p>
<p><a name="Basic_usage"></a></p> <p><a name="Basic_usage"></a></p>
@ -242,10 +242,10 @@
<h2>Documentation</h2> <h2>Documentation</h2>
<p>To learn <strong>Druid</strong> better, read next documentation: <p>To learn <strong>Druid</strong> better, read next documentation:
- <a href="https://insality.github.io/druid/topics/01-components.md.html">Druid components</a> - <a href="https://github.com/Insality/druid/blob/master/docs_md/01-components.md">Druid components</a>
- <a href="https://insality.github.io/druid/topics/02-creating_custom_components.md.html">Create custom components</a> - <a href="https://github.com/Insality/druid/blob/master/docs_md/02-creating_custom_components.md">Create custom components</a>
- <a href="https://insality.github.io/druid/topics/03-styles.md.html">Druid styles</a> - <a href="https://github.com/Insality/druid/blob/master/docs_md/03-styles.md">Druid styles</a>
- <a href="https://insality.github.io/druid/topics/04-druid_assets.md.html">Druid asset store</a></p> - <a href="https://github.com/Insality/druid/blob/master/docs_md/04-druid_assets.md">Druid asset store</a></p>
<p>Full <strong>Druid</strong> documentation you can find here: <p>Full <strong>Druid</strong> documentation you can find here:
https://insality.github.io/druid/</p> https://insality.github.io/druid/</p>
@ -291,7 +291,7 @@ https://insality.github.io/druid/</p>
</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-03-22 12:55:11 </i> <i style="float:right;">Last updated 2020-03-22 15:19:02 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@ -1,6 +1,8 @@
# Druid components # Druid components
## Button ## Button
Basic Druid input component Basic Druid input component
- Button callback have next params: (self, params, button_instance) - Button callback have next params: (self, params, button_instance)
@ -16,23 +18,31 @@ Basic Druid input component
- If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use `button:set_click_zone` to restrict button click zone - If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use `button:set_click_zone` to restrict button click zone
- Button can have key trigger to use then by key: `button:set_key_trigger` - Button can have key trigger to use then by key: `button:set_key_trigger`
## Text ## Text
Basic Druid text component Basic Druid text component
- 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 - 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
![](../media/text_autosize.png) ![](../media/text_autosize.png)
- Text pivot can be changed with `text:set_pivot`, and text will save their position inside their text size box: - Text pivot can be changed with `text:set_pivot`, and text will save their position inside their text size box:
![](../media/text_anchor.gif) ![](../media/text_anchor.gif)
## Blocker ## Blocker
Druid component for block input Druid component for block input
It can be used for block input in special zone. It can be used for block input in special zone.
Example: Example:
![](../media/blocker_scheme.png) ![](../media/blocker_scheme.png)
Blue zone is **button** with close_window callback Blue zone is **button** with close_window callback
Yellow zone is blocker with window content Yellow zone is blocker with window content
@ -43,26 +53,23 @@ Component to handle back button
It works on Android back button and Backspace. Key triggers in `input.binding` should be setup It works on Android back button and Backspace. Key triggers in `input.binding` should be setup
## Locale ## Lang text
Wrap on Druid text component to handle localization Wrap on Text component to handle localization
## Timer
Run timer on text node
## Progress
Basic progress bar
## Scroll ## Scroll
Basic scroll component Basic Druid scroll component
## Grid ## Progress
Component for manage node positions Basic Druid progress bar component
## Slider ## Slider
Basic slider component Basic Druid slider component
## Input
Basic Druid text input component (unimplemented)
## Checkbox ## Checkbox
Basic checkbox component Basic Druid checkbox component
## Checkbox group ## Checkbox group
Several checkboxes in one group Several checkboxes in one group
@ -70,8 +77,11 @@ Several checkboxes in one group
## Radio group ## Radio group
Several checkboxes in one group with single choice Several checkboxes in one group with single choice
## Hover ## Timer
Trigger component for check node hover state Handle timer work on gui text node
## Input ## Grid
Component to process user text input Component for manage node positions
## Hover
System Druid component, handle hover node state