Update docs, config generations, fix linter

2025-09-27 18:12:19 +02:00 · 2024-10-15 19:34:07 +03:00
parent 2f5336fa4f
commit 5848921cba
44 changed files with 1880 additions and 1336 deletions
--- a/docs/modules/RichText.html
+++ b/docs/modules/RichText.html
@@ -150,6 +150,10 @@ type druid.rich_text.metrics = {

 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#characters">characters(self, word)</a></td>
+	<td class="summary">Split a word into it's characters</td>
+	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#clear">clear()</a></td>
 	<td class="summary">Clear all created words.</td>
@@ -159,11 +163,15 @@ type druid.rich_text.metrics = {
 	<td class="summary">Get current line metrics</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#get_text">get_text(self)</a></td>
+	<td class="summary">Get current text</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#get_words">get_words()</a></td>
 	<td class="summary">Get all current words.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#init">init(self, template, nodes)</a></td>
+	<td class="name" nowrap><a href="#init">init(self, text_node, value)</a></td>
 	<td class="summary">The <a href="../modules/RichText.html#">RichText</a> constructor</td>
 	</tr>
 	<tr>
@@ -171,7 +179,7 @@ type druid.rich_text.metrics = {
 	<td class="summary">Set text for Rich Text</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#tagged">tagged(tag)</a></td>
+	<td class="name" nowrap><a href="#tagged">tagged(self, tag)</a></td>
 	<td class="summary">Get all words, which has a passed tag.</td>
 	</tr>
 </table>
@@ -188,6 +196,18 @@ type druid.rich_text.metrics = {
 	<td class="name" nowrap><a href="#druid">druid</a></td>
 	<td class="summary">The component druid instance</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#icon_prefab">icon_prefab</a></td>
+	<td class="summary">The icon prefab node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#root">root</a></td>
+	<td class="summary">The root node of the Rich Text</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#text_prefab">text_prefab</a></td>
+	<td class="summary">The text prefab node</td>
+	</tr>
 </table>

 <br/>
@@ -197,6 +217,37 @@ type druid.rich_text.metrics = {
    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
+    <dt>
+    <a name = "characters"></a>
+    <strong>characters(self, word)</strong>
+    </dt>
+    <dd>
+    Split a word into it's characters
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RichText</span></span>
+         <a href="../modules/RichText.html#">RichText</a>
+        </li>
+        <li><span class="parameter">word</span>
+            <span class="types"><span class="type">druid.rich_text.word</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">druid.rich_text.word[]</span></span>
+        characters
+    </ol>
+
+
+
+
+</dd>
    <dt>
    <a name = "clear"></a>
    <strong>clear()</strong>
@@ -230,6 +281,33 @@ type druid.rich_text.metrics = {



+</dd>
+    <dt>
+    <a name = "get_text"></a>
+    <strong>get_text(self)</strong>
+    </dt>
+    <dd>
+    Get current text
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RichText</span></span>
+         <a href="../modules/RichText.html#">RichText</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+        text
+    </ol>
+
+
+
+
 </dd>
    <dt>
    <a name = "get_words"></a>
@@ -253,7 +331,7 @@ type druid.rich_text.metrics = {
 </dd>
    <dt>
    <a name = "init"></a>
-    <strong>init(self, template, nodes)</strong>
+    <strong>init(self, text_node, value)</strong>
    </dt>
    <dd>
    The <a href="../modules/RichText.html#">RichText</a> constructor
@@ -265,13 +343,13 @@ type druid.rich_text.metrics = {
            <span class="types"><span class="type">RichText</span></span>
         <a href="../modules/RichText.html#">RichText</a>
        </li>
-        <li><span class="parameter">template</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         The Rich Text template name
+        <li><span class="parameter">text_node</span>
+            <span class="types"><span class="type">node</span> or <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The text node to make Rich Text
        </li>
-        <li><span class="parameter">nodes</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
-         The node table, if prefab was copied by gui.clone_tree()
+        <li><span class="parameter">value</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
+         The initial text value. Default will be gui.get_text(text_node)
        </li>
    </ul>

@@ -295,7 +373,7 @@ type druid.rich_text.metrics = {
         <a href="../modules/RichText.html#">RichText</a>
        </li>
        <li><span class="parameter">text</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
         The text to set
        </li>
    </ul>
@@ -361,7 +439,7 @@ Words &lt;nobr&gt;inside tag&lt;/nobr&gt; won't <span class="keyword">break</spa
 </dd>
    <dt>
    <a name = "tagged"></a>
-    <strong>tagged(tag)</strong>
+    <strong>tagged(self, tag)</strong>
    </dt>
    <dd>
    Get all words, which has a passed tag.
@@ -369,6 +447,10 @@ Words &lt;nobr&gt;inside tag&lt;/nobr&gt; won't <span class="keyword">break</spa

    <h3>Parameters:</h3>
    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RichText</span></span>
+         <a href="../modules/RichText.html#">RichText</a>
+        </li>
        <li><span class="parameter">tag</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>

@@ -444,6 +526,66 @@ Words &lt;nobr&gt;inside tag&lt;/nobr&gt; won't <span class="keyword">break</spa



+</dd>
+    <dt>
+    <a name = "icon_prefab"></a>
+    <strong>icon_prefab</strong>
+    </dt>
+    <dd>
+    The icon prefab node
+
+
+    <ul>
+        <li><span class="parameter">icon_prefab</span>
+            <span class="types"><span class="type">node</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "root"></a>
+    <strong>root</strong>
+    </dt>
+    <dd>
+    The root node of the Rich Text
+
+
+    <ul>
+        <li><span class="parameter">root</span>
+            <span class="types"><span class="type">node</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "text_prefab"></a>
+    <strong>text_prefab</strong>
+    </dt>
+    <dd>
+    The text prefab node
+
+
+    <ul>
+        <li><span class="parameter">text_prefab</span>
+            <span class="types"><span class="type">node</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
 </dl>