mirror of
https://github.com/Insality/druid
synced 2025-06-27 18:37:45 +02:00
360 lines
9.1 KiB
HTML
360 lines
9.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<head>
|
|
<title>Defold Druid UI Library</title>
|
|
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div> <!-- id="product" -->
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
<!-- Menu -->
|
|
|
|
<div id="navigation">
|
|
<br/>
|
|
<h1>Druid</h1>
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Functions">Functions</a></li>
|
|
<li><a href="#Tables">Tables</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Modules</h2>
|
|
<ul class="nowrap">
|
|
<li><a href="../modules/druid.back_handler.html">druid.back_handler</a></li>
|
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
|
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
|
<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>
|
|
<li><a href="../modules/druid.radio_group.html">druid.radio_group</a></li>
|
|
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
|
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
|
<li><strong>druid.text</strong></li>
|
|
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
|
<li><a href="../modules/component.html">component</a></li>
|
|
<li><a href="../modules/druid.html">druid</a></li>
|
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
|
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
|
</ul>
|
|
<h2>Topics</h2>
|
|
<ul class="">
|
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
|
<li><a href="../topics/05-examples.md.html">Examples</a></li>
|
|
<li><a href="../topics/README.md.html">README</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>druid.text</code></h1>
|
|
<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="#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(color)</a></td>
|
|
<td class="summary">Set color</td>
|
|
</tr>
|
|
<tr>
|
|
<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(scale)</a></td>
|
|
<td class="summary">Set scale</td>
|
|
</tr>
|
|
<tr>
|
|
<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/>
|
|
|
|
|
|
<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. Default value is node text from GUI scene.
|
|
(<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(set_to)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set text to text field
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<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
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_color"></a>
|
|
<strong>set_color(color)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set color
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">color</span>
|
|
<span class="types"><span class="type">vector4</span></span>
|
|
Color for node
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_alpha"></a>
|
|
<strong>set_alpha(alpha)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set alpha
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">alpha</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
Alpha for node
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_scale"></a>
|
|
<strong>set_scale(scale)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set scale
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">scale</span>
|
|
<span class="types"><span class="type">vector3</span></span>
|
|
Scale for node
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_pivot"></a>
|
|
<strong>set_pivot(pivot)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set text pivot. Text will re-anchor inside
|
|
his text area
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">pivot</span>
|
|
<span class="types"><span class="type">gui.pivot</span></span>
|
|
Gui pivot constant
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</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-04-09 22:11:32 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|