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

Update docs

Browse Source
This commit is contained in:
Insality
2023-08-05 19:32:47 +03:00
parent 37fff52aa5
commit d7dd4a86b8
16 changed files with 273 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/modules/Button.html
View File

@@ -111,7 +111,7 @@ local button = self.druid:new_button("button_name", on_button_click, c
</tr>
<tr>
<td class="name" nowrap><a href="#init">init(self, node, callback[, custom_args[, anim_node]])</a></td>
<td class="summary"><a href="../modules/Button.html#">Button</a> constructor</td>
<td class="summary">The <a href="../modules/Button.html#">Button</a> constructor</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
@@ -157,7 +157,7 @@ local button = self.druid:new_button(&quot;button_name&quot;, on_button_click, c
</tr>
<tr>
<td class="name" nowrap><a href="#hover">hover</a></td>
<td class="summary"><a href="../modules/Hover.html#">Hover</a>: Button Hover component</td>
<td class="summary">The <a href="../modules/Hover.html#">Hover</a>: Button Hover component</td>
</tr>
<tr>
<td class="name" nowrap><a href="#node">node</a></td>
@@ -169,31 +169,31 @@ local button = self.druid:new_button(&quot;button_name&quot;, on_button_click, c
</tr>
<tr>
<td class="name" nowrap><a href="#on_click">on_click</a></td>
<td class="summary"><a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on successful release action over button.</td>
<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on successful release action over button.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#on_click_outside">on_click_outside</a></td>
<td class="summary"><a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls if click event was outside of button.</td>
<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls if click event was outside of button.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#on_double_click">on_double_click</a></td>
<td class="summary"><a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on double tap action over button.</td>
<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on double tap action over button.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#on_hold_callback">on_hold_callback</a></td>
<td class="summary"><a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls every frame before on_long_click event.</td>
<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls every frame before on_long_click event.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#on_long_click">on_long_click</a></td>
<td class="summary"><a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on long tap action over button.</td>
<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on long tap action over button.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#on_pressed">on_pressed</a></td>
<td class="summary"><a href="../modules/DruidEvent.html#">DruidEvent</a>: Event triggered if button was pressed by user.</td>
<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event triggered if button was pressed by user.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#on_repeated_click">on_repeated_click</a></td>
<td class="summary"><a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on repeated action over button.</td>
<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on repeated action over button.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#params">params</a></td>
@@ -244,7 +244,7 @@ local button = self.druid:new_button(&quot;button_name&quot;, on_button_click, c
<strong>init(self, node, callback[, custom_args[, anim_node]])</strong>
</dt>
<dd>
<a href="../modules/Button.html#">Button</a> constructor
The <a href="../modules/Button.html#">Button</a> constructor
<h3>Parameters:</h3>
@@ -607,7 +607,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>hover</strong>
</dt>
<dd>
<a href="../modules/Hover.html#">Hover</a>: Button Hover component
The <a href="../modules/Hover.html#">Hover</a>: Button Hover component
<ul>
@@ -667,7 +667,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>on_click</strong>
</dt>
<dd>
<a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on successful release action over button.
The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on successful release action over button.
<ul>
@@ -694,7 +694,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>on_click_outside</strong>
</dt>
<dd>
<a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls if click event was outside of button.
The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls if click event was outside of button.
<p> This event will be triggered for each button what was not clicked on user click action
<p> Usecase: Hide the popup when click outside
@@ -723,7 +723,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>on_double_click</strong>
</dt>
<dd>
<a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on double tap action over button.
The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on double tap action over button.
<p> If secondary click was too fast after previous one, the double
click will be called instead usual click (if on_double_click subscriber exists)
@@ -752,7 +752,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>on_hold_callback</strong>
</dt>
<dd>
<a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls every frame before on_long_click event.
The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls every frame before on_long_click event.
<p> If long_click subscriber exists, the on_hold_callback will be called before long_click trigger.
<p> Usecase: Animate button progress of long tap
@@ -781,7 +781,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>on_long_click</strong>
</dt>
<dd>
<a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on long tap action over button.
The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on long tap action over button.
<p> This callback will be triggered if user pressed the button and hold the some amount of time.
The amount of time picked from button style param: LONGTAP_TIME
@@ -810,7 +810,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>on_pressed</strong>
</dt>
<dd>
<a href="../modules/DruidEvent.html#">DruidEvent</a>: Event triggered if button was pressed by user.
The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event triggered if button was pressed by user.
<ul>
@@ -837,7 +837,7 @@ button:set_enabled(<span class="keyword">true</span>)</pre>
<strong>on_repeated_click</strong>
</dt>
<dd>
<a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on repeated action over button.
The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on repeated action over button.
<p> This callback will be triggered if user hold the button. The repeat rate pick from `input.repeat_interval` in game.project