Partydeck/Druid-Extension
3
0
Fork 0
mirror of https://github.com/Insality/druid synced 2025-09-27 18:12:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update annotations

Browse Source
This commit is contained in:
Insality
2024-08-27 17:45:09 +03:00
parent 5f2ae1eb0d
commit 11ae63a9f6
42 changed files with 275 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/modules/DruidInstance.html
View File

@@ -162,7 +162,7 @@ end
<td class="summary">Create <a href="../modules/Checkbox.html#">Checkbox</a> component</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new_checkbox_group">new_checkbox_group(self, nodes, callback[, click_nodes=node])</a></td>
<td class="name" nowrap><a href="#new_checkbox_group">new_checkbox_group(self, nodes, callback, click_nodes)</a></td>
<td class="summary">Create <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a> component</td>
</tr>
<tr>
@@ -194,7 +194,7 @@ end
<td class="summary">Create <a href="../modules/LangText.html#">LangText</a> component</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new_layout">new_layout(self, node, mode)</a></td>
<td class="name" nowrap><a href="#new_layout">new_layout(self, node, mode, on_size_changed_callback)</a></td>
<td class="summary">Create <a href="../modules/Layout.html#">Layout</a> component</td>
</tr>
<tr>
@@ -202,7 +202,7 @@ end
<td class="summary">Create <a href="../modules/Progress.html#">Progress</a> component</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new_radio_group">new_radio_group(self, nodes, callback[, click_nodes=node])</a></td>
<td class="name" nowrap><a href="#new_radio_group">new_radio_group(self, nodes, callback, click_nodes)</a></td>
<td class="summary">Create <a href="../modules/RadioGroup.html#">RadioGroup</a> component</td>
</tr>
<tr>
@@ -246,11 +246,11 @@ end
<td class="summary">Remove created component from Druid instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_blacklist">set_blacklist(self[, blacklist_components=nil])</a></td>
<td class="name" nowrap><a href="#set_blacklist">set_blacklist(self, blacklist_components)</a></td>
<td class="summary">Set blacklist components for input processing.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_whitelist">set_whitelist(self[, whitelist_components=nil])</a></td>
<td class="name" nowrap><a href="#set_whitelist">set_whitelist(self, whitelist_components)</a></td>
<td class="summary">Set whitelist components for input processing.</td>
</tr>
<tr>
@@ -415,7 +415,7 @@ end
Button callback params
</li>
<li><span class="parameter">anim_node</span>
<span class="types"><span class="type">node</span> or <span class="type">nil</span></span>
<span class="types"><span class="type">node</span>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
Button anim node (node, if not provided)
</li>
</ul>
@@ -476,7 +476,7 @@ end
</dd>
<dt>
<a name = "new_checkbox_group"></a>
<strong>new_checkbox_group(self, nodes, callback[, click_nodes=node])</strong>
<strong>new_checkbox_group(self, nodes, callback, click_nodes)</strong>
</dt>
<dd>
Create <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a> component
@@ -489,7 +489,7 @@ end
</li>
<li><span class="parameter">nodes</span>
<span class="types"><span class="type">node[]</span></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>
Array of gui node
</li>
<li><span class="parameter">callback</span>
@@ -497,9 +497,8 @@ end
Checkbox callback
</li>
<li><span class="parameter">click_nodes</span>
<span class="types"><span class="type">node[]</span></span>
<span class="types"><span class="type">(node</span>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string)[]</a> or <span class="type">nil</span></span>
Array of trigger nodes, by default equals to nodes
(<em>default</em> node)
</li>
</ul>
@@ -712,7 +711,7 @@ end
Button node to enabled input component
</li>
<li><span class="parameter">text_node</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">node</span></span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a>, <span class="type">node</span> or <span class="type">druid.text</span></span>
Text node what will be changed on user input
</li>
<li><span class="parameter">keyboard_type</span>
@@ -773,7 +772,7 @@ end
</dd>
<dt>
<a name = "new_layout"></a>
<strong>new_layout(self, node, mode)</strong>
<strong>new_layout(self, node, mode, on_size_changed_callback)</strong>
</dt>
<dd>
Create <a href="../modules/Layout.html#">Layout</a> component
@@ -793,6 +792,10 @@ end
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
The layout mode
</li>
<li><span class="parameter">on_size_changed_callback</span>
<span class="types"><span class="type">function</span> or <span class="type">nil</span></span>
The callback on window resize
</li>
</ul>
<h3>Returns:</h3>
@@ -847,7 +850,7 @@ end
</dd>
<dt>
<a name = "new_radio_group"></a>
<strong>new_radio_group(self, nodes, callback[, click_nodes=node])</strong>
<strong>new_radio_group(self, nodes, callback, click_nodes)</strong>
</dt>
<dd>
Create <a href="../modules/RadioGroup.html#">RadioGroup</a> component
@@ -860,7 +863,7 @@ end
</li>
<li><span class="parameter">nodes</span>
<span class="types"><span class="type">node[]</span></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>
Array of gui node
</li>
<li><span class="parameter">callback</span>
@@ -868,9 +871,8 @@ end
Radio callback
</li>
<li><span class="parameter">click_nodes</span>
<span class="types"><span class="type">node[]</span></span>
<span class="types"><span class="type">(node</span>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string)[]</a> or <span class="type">nil</span></span>
Array of trigger nodes, by default equals to nodes
(<em>default</em> node)
</li>
</ul>
@@ -1249,7 +1251,7 @@ end
</dd>
<dt>
<a name = "set_blacklist"></a>
<strong>set_blacklist(self[, blacklist_components=nil])</strong>
<strong>set_blacklist(self, blacklist_components)</strong>
</dt>
<dd>
Set blacklist components for input processing.
@@ -1264,9 +1266,8 @@ end
<a href="../modules/DruidInstance.html#">DruidInstance</a>
</li>
<li><span class="parameter">blacklist_components</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <span class="type">BaseComponent</span></span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a>, <span class="type">BaseComponent</span> or <span class="type">nil</span></span>
The array of component to blacklist
(<em>default</em> nil)
</li>
</ul>
@@ -1283,7 +1284,7 @@ end
</dd>
<dt>
<a name = "set_whitelist"></a>
<strong>set_whitelist(self[, whitelist_components=nil])</strong>
<strong>set_whitelist(self, whitelist_components)</strong>
</dt>
<dd>
Set whitelist components for input processing.
@@ -1298,9 +1299,8 @@ end
</li>
<li><span class="parameter">whitelist_components</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <span class="type">BaseComponent</span></span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a>, <span class="type">BaseComponent</span> or <span class="type">nil</span></span>
The array of component to whitelist
(<em>default</em> nil)
</li>
</ul>