Update docs, updated ldoc generated files

2025-09-27 18:12:19 +02:00 · 2020-03-21 21:43:06 +03:00
parent ca78b10794
commit b7e58950aa
26 changed files with 2354 additions and 316 deletions
--- a/docs/modules/druid.text.html
+++ b/docs/modules/druid.text.html
@@ -33,6 +33,7 @@
 <h2>Contents</h2>
 <ul>
 <li><a href="#Functions">Functions</a></li>
+<li><a href="#Tables">Tables</a></li>
 </ul>


@@ -44,6 +45,7 @@
  <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>
@@ -64,36 +66,49 @@
 <div id="content">

 <h1>Module <code>druid.text</code></h1>
-<p>Component to handle all GUI texts
- Good working with localization system</p>
-<p>
-
-</p>
+<p>Component to handle all GUI texts.</p>
+<p> Druid text can adjust itself for text node size
+ Text will never will be outside of his text size (even multiline)</p>


 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
+	<td class="name" nowrap><a href="#init">init(node[, value[, no_adjust]])</a></td>
+	<td class="summary">Component init function</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_to">set_to(set_to)</a></td>
 	<td class="summary">Set text to text field</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_color">set_color(self, color)</a></td>
+	<td class="name" nowrap><a href="#set_color">set_color(color)</a></td>
 	<td class="summary">Set color</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_alpha">set_alpha(self, alpha)</a></td>
+	<td class="name" nowrap><a href="#set_alpha">set_alpha(alpha)</a></td>
 	<td class="summary">Set alpha</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_scale">set_scale(self, scale)</a></td>
+	<td class="name" nowrap><a href="#set_scale">set_scale(scale)</a></td>
 	<td class="summary">Set scale</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_pivot">set_pivot(self, pivot)</a></td>
+	<td class="name" nowrap><a href="#set_pivot">set_pivot(pivot)</a></td>
 	<td class="summary">Set text pivot.</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>
+</table>

 <br/>
 <br/>
@@ -102,9 +117,40 @@
    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
+    <dt>
+    <a name = "init"></a>
+    <strong>init(node[, value[, no_adjust]])</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 text node
+        </li>
+        <li><span class="parameter">value</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+         Initial text
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">no_adjust</span>
+            <span class="types"><span class="type">bool</span></span>
+         If true, text will be not auto-adjust size
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
    <dt>
    <a name = "set_to"></a>
-    <strong>set_to(self, set_to)</strong>
+    <strong>set_to(set_to)</strong>
    </dt>
    <dd>
    Set text to text field
@@ -112,10 +158,6 @@

    <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"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
         Text for node
@@ -129,7 +171,7 @@
 </dd>
    <dt>
    <a name = "set_color"></a>
-    <strong>set_color(self, color)</strong>
+    <strong>set_color(color)</strong>
    </dt>
    <dd>
    Set color
@@ -137,12 +179,8 @@

    <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">color</span>
-            <span class="types"><span class="type">vmath.vector4</span></span>
+            <span class="types"><span class="type">vector4</span></span>
         Color for node
        </li>
    </ul>
@@ -154,7 +192,7 @@
 </dd>
    <dt>
    <a name = "set_alpha"></a>
-    <strong>set_alpha(self, alpha)</strong>
+    <strong>set_alpha(alpha)</strong>
    </dt>
    <dd>
    Set alpha
@@ -162,10 +200,6 @@

    <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">alpha</span>
            <span class="types"><span class="type">number</span></span>
         Alpha for node
@@ -179,7 +213,7 @@
 </dd>
    <dt>
    <a name = "set_scale"></a>
-    <strong>set_scale(self, scale)</strong>
+    <strong>set_scale(scale)</strong>
    </dt>
    <dd>
    Set scale
@@ -187,12 +221,8 @@

    <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">scale</span>
-            <span class="types"><span class="type">vmath.vector3</span></span>
+            <span class="types"><span class="type">vector3</span></span>
         Scale for node
        </li>
    </ul>
@@ -204,7 +234,7 @@
 </dd>
    <dt>
    <a name = "set_pivot"></a>
-    <strong>set_pivot(self, pivot)</strong>
+    <strong>set_pivot(pivot)</strong>
    </dt>
    <dd>
    Set text pivot.  Text will re-anchor inside
@@ -213,10 +243,6 @@

    <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">pivot</span>
            <span class="types"><span class="type">gui.pivot</span></span>
         Gui pivot constant
@@ -227,6 +253,88 @@



+</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_set_text</span>
+            <span class="types"><span class="type">druid_event</span></span>
+         On set text callback
+        </li>
+        <li><span class="parameter">on_update_text_scale</span>
+            <span class="types"><span class="type">druid_event</span></span>
+         On adjust text size callback
+        </li>
+        <li><span class="parameter">on_set_pivot</span>
+            <span class="types"><span class="type">druid_event</span></span>
+         On change pivot 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>
+         Text node
+        </li>
+        <li><span class="parameter">pos</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Current text position
+        </li>
+        <li><span class="parameter">start_scale</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Initial text node scale
+        </li>
+        <li><span class="parameter">scale</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Current text node scale
+        </li>
+        <li><span class="parameter">start_size</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Initial text node size
+        </li>
+        <li><span class="parameter">text_area</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Current text node available are
+        </li>
+        <li><span class="parameter">is_no_adjust</span>
+            <span class="types"><span class="type">bool</span></span>
+         Current text size adjust settings
+        </li>
+        <li><span class="parameter">color</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Current text color
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
 </dl>

@@ -235,7 +343,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-02-24 00:03:02 </i>
+<i style="float:right;">Last updated 2020-03-21 21:42:52 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>