mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 10:27:47 +02:00
Update docs
This commit is contained in:
Insality
parent
18eb52b92b
commit
58a877f8a7
@ -5,7 +5,8 @@ file={"./druid",
|
|||||||
exclude = {
|
exclude = {
|
||||||
"./druid/styles/",
|
"./druid/styles/",
|
||||||
"./druid/system/middleclass.lua",
|
"./druid/system/middleclass.lua",
|
||||||
"./druid/templates/"
|
"./druid/templates/",
|
||||||
|
"./druid/annotations.lua",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
package='druid'
|
package='druid'
|
||||||
|
|||||||
@ -1 +1 @@
|
|||||||
{"content":[{"name":"game.projectc","size":3748,"pieces":[{"name":"game.projectc0","offset":0}]},{"name":"game.arci","size":13488,"pieces":[{"name":"game.arci0","offset":0}]},{"name":"game.arcd","size":948433,"pieces":[{"name":"game.arcd0","offset":0}]},{"name":"game.dmanifest","size":13875,"pieces":[{"name":"game.dmanifest0","offset":0}]},{"name":"game.public.der","size":162,"pieces":[{"name":"game.public.der0","offset":0}]}]}
|
{"content":[{"name":"game.projectc","size":3808,"pieces":[{"name":"game.projectc0","offset":0}]},{"name":"game.arci","size":17168,"pieces":[{"name":"game.arci0","offset":0}]},{"name":"game.arcd","size":999541,"pieces":[{"name":"game.arcd0","offset":0}]},{"name":"game.dmanifest","size":17838,"pieces":[{"name":"game.dmanifest0","offset":0}]},{"name":"game.public.der","size":162,"pieces":[{"name":"game.public.der0","offset":0}]}]}
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,12 +1,13 @@
|
|||||||
[project]
|
[project]
|
||||||
title = druid
|
title = druid
|
||||||
version = 0.8.519
|
version = 0.8.559
|
||||||
write_log = 0
|
write_log = 0
|
||||||
compress_archive = 1
|
compress_archive = 1
|
||||||
publisher = Insality
|
publisher = Insality
|
||||||
developer = Insality
|
developer = Insality
|
||||||
commit_sha = 4e0fd264b169693d088a47f2bb53376a1808fb1e
|
commit_sha = 18eb52b92b9cfd7cfaface2a7e6c4d094ff7de00
|
||||||
build_time = 2022-02-12T15:15:53Z
|
build_date = 2022-03-11T18:55:39Z
|
||||||
|
title_as_file_name = druid
|
||||||
|
|
||||||
[display]
|
[display]
|
||||||
width = 600
|
width = 600
|
||||||
@ -16,8 +17,8 @@ samples = 0
|
|||||||
fullscreen = 0
|
fullscreen = 0
|
||||||
update_frequency = 0
|
update_frequency = 0
|
||||||
vsync = 1
|
vsync = 1
|
||||||
display_profiles = /builtins/render/default.display_profilesc
|
display_profiles = /example/custom.display_profilesc
|
||||||
dynamic_orientation = 0
|
dynamic_orientation = 1
|
||||||
display_device_info = 0
|
display_device_info = 0
|
||||||
|
|
||||||
[render]
|
[render]
|
||||||
@ -43,6 +44,7 @@ contact_impulse_limit = 0
|
|||||||
ray_cast_limit_2d = 64
|
ray_cast_limit_2d = 64
|
||||||
ray_cast_limit_3d = 128
|
ray_cast_limit_3d = 128
|
||||||
trigger_overlap_capacity = 16
|
trigger_overlap_capacity = 16
|
||||||
|
velocity_threshold = 1
|
||||||
|
|
||||||
[bootstrap]
|
[bootstrap]
|
||||||
main_collection = /example/example.collectionc
|
main_collection = /example/example.collectionc
|
||||||
@ -85,9 +87,6 @@ use_accelerometer = 0
|
|||||||
max_count = 128
|
max_count = 128
|
||||||
subpixels = 1
|
subpixels = 1
|
||||||
|
|
||||||
[spine]
|
|
||||||
max_count = 128
|
|
||||||
|
|
||||||
[model]
|
[model]
|
||||||
max_count = 128
|
max_count = 128
|
||||||
|
|
||||||
@ -121,7 +120,7 @@ default_language = en
|
|||||||
localizations = en
|
localizations = en
|
||||||
|
|
||||||
[android]
|
[android]
|
||||||
version_code = 519
|
version_code = 559
|
||||||
minimum_sdk_version = 16
|
minimum_sdk_version = 16
|
||||||
target_sdk_version = 30
|
target_sdk_version = 30
|
||||||
package = com.insality.druid
|
package = com.insality.druid
|
||||||
@ -156,6 +155,7 @@ splash_image = /media/druid_logo.png
|
|||||||
|
|
||||||
[particle_fx]
|
[particle_fx]
|
||||||
max_count = 64
|
max_count = 64
|
||||||
|
max_emitter_count = 64
|
||||||
max_particle_count = 1024
|
max_particle_count = 1024
|
||||||
|
|
||||||
[iap]
|
[iap]
|
||||||
@ -193,6 +193,7 @@ run_while_iconified = 0
|
|||||||
[druid]
|
[druid]
|
||||||
no_auto_input = 0
|
no_auto_input = 0
|
||||||
stencil_check = 0
|
stencil_check = 0
|
||||||
|
no_auto_template = 0
|
||||||
input_text = text
|
input_text = text
|
||||||
input_touch = touch
|
input_touch = touch
|
||||||
input_marked_text = marked_text
|
input_marked_text = marked_text
|
||||||
|
|||||||
Binary file not shown.
@ -113,9 +113,9 @@ var EngineLoader = {
|
|||||||
asmjs_from: 0,
|
asmjs_from: 0,
|
||||||
asmjs_to: 50,
|
asmjs_to: 50,
|
||||||
|
|
||||||
// load .wasm and set Module.instantiateWasm to use the loaded .wasm file
|
stream_wasm: true,
|
||||||
// https://github.com/emscripten-core/emscripten/blob/master/tests/manual_wasm_instantiate.html#L170
|
|
||||||
loadWasmAsync: function(src, fromProgress, toProgress, callback) {
|
loadAndInstantiateWasmAsync: function(src, fromProgress, toProgress, callback) {
|
||||||
FileLoader.load(src, "arraybuffer", EngineLoader.wasm_size,
|
FileLoader.load(src, "arraybuffer", EngineLoader.wasm_size,
|
||||||
function(loaded, total) { Progress.calculateProgress(fromProgress, toProgress, loaded, total); },
|
function(loaded, total) { Progress.calculateProgress(fromProgress, toProgress, loaded, total); },
|
||||||
function(error) { throw error; },
|
function(error) { throw error; },
|
||||||
@ -133,6 +133,31 @@ var EngineLoader = {
|
|||||||
});
|
});
|
||||||
},
|
},
|
||||||
|
|
||||||
|
streamAndInstantiateWasmAsync: function(src, fromProgress, toProgress, callback) {
|
||||||
|
Module.instantiateWasm = function(imports, successCallback) {
|
||||||
|
WebAssembly.instantiateStreaming(fetch(src), imports).then(function(output) {
|
||||||
|
Progress.calculateProgress(fromProgress, toProgress, 1, 1);
|
||||||
|
successCallback(output.instance);
|
||||||
|
}).catch(function(e) {
|
||||||
|
console.log('wasm streaming instantiation failed! ' + e);
|
||||||
|
throw e;
|
||||||
|
});
|
||||||
|
return {}; // Compiling asynchronously, no exports.
|
||||||
|
}
|
||||||
|
callback();
|
||||||
|
},
|
||||||
|
|
||||||
|
// instantiate the .wasm file either by streaming it or first loading and then instantiate it
|
||||||
|
// https://github.com/emscripten-core/emscripten/blob/master/tests/manual_wasm_instantiate.html#L170
|
||||||
|
loadWasmAsync: function(src, fromProgress, toProgress, callback) {
|
||||||
|
if (EngineLoader.stream_wasm && (typeof WebAssembly.instantiateStreaming === "function")) {
|
||||||
|
EngineLoader.streamAndInstantiateWasmAsync(src, fromProgress, toProgress, callback);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
EngineLoader.loadAndInstantiateWasmAsync(src, fromProgress, toProgress, callback);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
// load and start engine script (asm.js or wasm.js)
|
// load and start engine script (asm.js or wasm.js)
|
||||||
loadScriptAsync: function(src, estimatedSize, fromProgress, toProgress) {
|
loadScriptAsync: function(src, estimatedSize, fromProgress, toProgress) {
|
||||||
FileLoader.load(src, "text", estimatedSize,
|
FileLoader.load(src, "text", estimatedSize,
|
||||||
@ -457,35 +482,6 @@ var Progress = {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/* ********************************************************************* */
|
|
||||||
/* Default input override */
|
|
||||||
/* ********************************************************************* */
|
|
||||||
|
|
||||||
var CanvasInput = {
|
|
||||||
arrowKeysHandler : function(e) {
|
|
||||||
switch(e.keyCode) {
|
|
||||||
case 37: case 38: case 39: case 40: // Arrow keys
|
|
||||||
case 32: e.preventDefault(); e.stopPropagation(); // Space
|
|
||||||
default: break; // do not block other keys
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
onFocusIn : function(e) {
|
|
||||||
window.addEventListener("keydown", CanvasInput.arrowKeysHandler, false);
|
|
||||||
},
|
|
||||||
|
|
||||||
onFocusOut: function(e) {
|
|
||||||
window.removeEventListener("keydown", CanvasInput.arrowKeysHandler, false);
|
|
||||||
},
|
|
||||||
|
|
||||||
addToCanvas : function(canvas) {
|
|
||||||
canvas.addEventListener("focus", CanvasInput.onFocusIn, false);
|
|
||||||
canvas.addEventListener("blur", CanvasInput.onFocusOut, false);
|
|
||||||
canvas.focus();
|
|
||||||
CanvasInput.onFocusIn();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/* ********************************************************************* */
|
/* ********************************************************************* */
|
||||||
/* Module is Emscripten namespace */
|
/* Module is Emscripten namespace */
|
||||||
/* ********************************************************************* */
|
/* ********************************************************************* */
|
||||||
@ -578,30 +574,6 @@ var Module = {
|
|||||||
return webgl_support;
|
return webgl_support;
|
||||||
},
|
},
|
||||||
|
|
||||||
handleVisibilityChange: function () {
|
|
||||||
GLFW.onFocusChanged(document[Module.hiddenProperty] ? 0 : 1);
|
|
||||||
},
|
|
||||||
|
|
||||||
getHiddenProperty: function () {
|
|
||||||
if ('hidden' in document) return 'hidden';
|
|
||||||
var prefixes = ['webkit','moz','ms','o'];
|
|
||||||
for (var i = 0; i < prefixes.length; i++) {
|
|
||||||
if ((prefixes[i] + 'Hidden') in document)
|
|
||||||
return prefixes[i] + 'Hidden';
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
},
|
|
||||||
|
|
||||||
setupVisibilityChangeListener: function() {
|
|
||||||
Module.hiddenProperty = Module.getHiddenProperty();
|
|
||||||
if( Module.hiddenProperty ) {
|
|
||||||
var eventName = Module.hiddenProperty.replace(/[H|h]idden/,'') + 'visibilitychange';
|
|
||||||
document.addEventListener(eventName, Module.handleVisibilityChange, false);
|
|
||||||
} else {
|
|
||||||
console.log("No document.hidden property found. The focus events won't be enabled.")
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
setupCanvas: function(appCanvasId) {
|
setupCanvas: function(appCanvasId) {
|
||||||
appCanvasId = (typeof appCanvasId === 'undefined') ? 'canvas' : appCanvasId;
|
appCanvasId = (typeof appCanvasId === 'undefined') ? 'canvas' : appCanvasId;
|
||||||
Module.canvas = document.getElementById(appCanvasId);
|
Module.canvas = document.getElementById(appCanvasId);
|
||||||
@ -672,10 +644,7 @@ var Module = {
|
|||||||
Module.fullScreenContainer = fullScreenContainer || Module.canvas;
|
Module.fullScreenContainer = fullScreenContainer || Module.canvas;
|
||||||
|
|
||||||
if (Module.hasWebGLSupport()) {
|
if (Module.hasWebGLSupport()) {
|
||||||
// Override game keys
|
Module.canvas.focus();
|
||||||
CanvasInput.addToCanvas(Module.canvas);
|
|
||||||
|
|
||||||
Module.setupVisibilityChangeListener();
|
|
||||||
|
|
||||||
// Add context menu hide-handler if requested
|
// Add context menu hide-handler if requested
|
||||||
if (params["disable_context_menu"])
|
if (params["disable_context_menu"])
|
||||||
|
|||||||
Binary file not shown.
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -7,7 +7,7 @@
|
|||||||
<meta name="apple-mobile-web-app-capable" content="yes">
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
||||||
<!-- The above 4 meta tags *must* come first in the head; any other head content must come *after* these tags -->
|
<!-- The above 4 meta tags *must* come first in the head; any other head content must come *after* these tags -->
|
||||||
|
|
||||||
<title>druid 0.8.519</title>
|
<title>druid 0.8.559</title>
|
||||||
<style type='text/css'>
|
<style type='text/css'>
|
||||||
/* Disable user selection to avoid strange bug in Chrome on Windows:
|
/* Disable user selection to avoid strange bug in Chrome on Windows:
|
||||||
* Selecting a text outside the canvas, then clicking+draging would
|
* Selecting a text outside the canvas, then clicking+draging would
|
||||||
|
|||||||
@ -41,6 +41,8 @@
|
|||||||
<li><a href="modules/Swipe.html">Swipe</a></li>
|
<li><a href="modules/Swipe.html">Swipe</a></li>
|
||||||
<li><a href="modules/Text.html">Text</a></li>
|
<li><a href="modules/Text.html">Text</a></li>
|
||||||
<li><a href="modules/BaseComponent.html">BaseComponent</a></li>
|
<li><a href="modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
|
<li><a href="modules/PinKnob.html">PinKnob</a></li>
|
||||||
|
<li><a href="modules/RichInput.html">RichInput</a></li>
|
||||||
<li><a href="modules/druid.html">druid</a></li>
|
<li><a href="modules/druid.html">druid</a></li>
|
||||||
<li><a href="modules/DruidEvent.html">DruidEvent</a></li>
|
<li><a href="modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
<li><a href="modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="modules/Checkbox.html">Checkbox</a></li>
|
||||||
@ -53,7 +55,7 @@
|
|||||||
<li><a href="modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
<li><a href="modules/Slider.html">Slider</a></li>
|
<li><a href="modules/Slider.html">Slider</a></li>
|
||||||
<li><a href="modules/Timer.html">Timer</a></li>
|
<li><a href="modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="modules/Helper.html">Helper</a></li>
|
||||||
<li><a href="modules/DruidInstance.html">DruidInstance</a></li>
|
<li><a href="modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -106,13 +108,21 @@
|
|||||||
<td class="name" nowrap><a href="modules/BaseComponent.html">BaseComponent</a></td>
|
<td class="name" nowrap><a href="modules/BaseComponent.html">BaseComponent</a></td>
|
||||||
<td class="summary">Basic class for all Druid components.</td>
|
<td class="summary">Basic class for all Druid components.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/PinKnob.html">PinKnob</a></td>
|
||||||
|
<td class="summary">Druid pin knob custom component.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/RichInput.html">RichInput</a></td>
|
||||||
|
<td class="summary">Druid Rich Input custom component.</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.html">druid</a></td>
|
<td class="name" nowrap><a href="modules/druid.html">druid</a></td>
|
||||||
<td class="summary">Druid UI Library.</td>
|
<td class="summary">Druid UI Library.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/DruidEvent.html">DruidEvent</a></td>
|
<td class="name" nowrap><a href="modules/DruidEvent.html">DruidEvent</a></td>
|
||||||
<td class="summary">Lua event small library</td>
|
<td class="summary">Druid lua event library</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/Checkbox.html">Checkbox</a></td>
|
<td class="name" nowrap><a href="modules/Checkbox.html">Checkbox</a></td>
|
||||||
@ -156,8 +166,8 @@
|
|||||||
<td class="summary">Component to handle GUI timers.</td>
|
<td class="summary">Component to handle GUI timers.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/druid.helper.html">druid.helper</a></td>
|
<td class="name" nowrap><a href="modules/Helper.html">Helper</a></td>
|
||||||
<td class="summary">Text node or icon node can be nil</td>
|
<td class="summary">Druid helper module for gui layouts</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="modules/DruidInstance.html">DruidInstance</a></td>
|
<td class="name" nowrap><a href="modules/DruidInstance.html">DruidInstance</a></td>
|
||||||
@ -169,7 +179,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><strong>BackHandler</strong></li>
|
<li><strong>BackHandler</strong></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -116,7 +118,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BackHandler</span></span>
|
<span class="types"><span class="type">BackHandler</span></span>
|
||||||
|
<a href="../modules/BackHandler.html#">BackHandler</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">callback</span>
|
<li><span class="parameter">callback</span>
|
||||||
<span class="types"><span class="type">callback</span></span>
|
<span class="types"><span class="type">callback</span></span>
|
||||||
@ -146,7 +148,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BackHandler</span></span>
|
<span class="types"><span class="type">BackHandler</span></span>
|
||||||
|
<a href="../modules/BackHandler.html#">BackHandler</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">action_id</span>
|
<li><span class="parameter">action_id</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></span>
|
||||||
@ -177,8 +179,8 @@
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_back</span>
|
<li><span class="parameter">on_back</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -214,7 +216,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><strong>BaseComponent</strong></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><strong>BaseComponent</strong></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -78,64 +80,77 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_style">set_style(self, druid_style)</a></td>
|
<td class="name" nowrap><a href="#get_childrens">get_childrens(self)</a></td>
|
||||||
<td class="summary">Set current component style table.</td>
|
<td class="summary">Return all children components, recursive (protected)</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_template">set_template(self, template)</a></td>
|
|
||||||
<td class="summary">Set current component template name</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_nodes">set_nodes(self, nodes)</a></td>
|
|
||||||
<td class="summary">Set current component nodes</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_context">get_context(self)</a></td>
|
<td class="name" nowrap><a href="#get_context">get_context(self)</a></td>
|
||||||
<td class="summary">Get current component context</td>
|
<td class="summary">Get current component context (protected)</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_node">get_node(self, node_or_name)</a></td>
|
|
||||||
<td class="summary">Get node for component by name.</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_druid">get_druid(self)</a></td>
|
<td class="name" nowrap><a href="#get_druid">get_druid(self)</a></td>
|
||||||
<td class="summary">Return druid with context of calling component.</td>
|
<td class="summary">Return druid with context of calling component (protected).</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_name">get_name(self)</a></td>
|
|
||||||
<td class="summary">Return component name</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_input_priority">get_input_priority(self)</a></td>
|
<td class="name" nowrap><a href="#get_input_priority">get_input_priority(self)</a></td>
|
||||||
<td class="summary">Return component input priority</td>
|
<td class="summary">Return component input priority</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_input_priority">set_input_priority(self, value)</a></td>
|
<td class="name" nowrap><a href="#get_name">get_name(self)</a></td>
|
||||||
<td class="summary">Set component input priority</td>
|
<td class="summary">Return component name</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_node">get_node(self, node_or_name)</a></td>
|
||||||
|
<td class="summary">Get node for component by name.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_parent_component">get_parent_component(self)</a></td>
|
||||||
|
<td class="summary">Return the parent for current component (protected)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_parent_name">get_parent_name(self)</a></td>
|
||||||
|
<td class="summary">Return parent component name</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_template">get_template(self)</a></td>
|
||||||
|
<td class="summary">Get current component template name (protected)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_uid">get_uid(self)</a></td>
|
||||||
|
<td class="summary">Return component uid (protected).</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#log_message">log_message(self, message, context)</a></td>
|
||||||
|
<td class="summary">Print log information if debug mode is enabled (protected)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#reset_input_priority">reset_input_priority(self)</a></td>
|
<td class="name" nowrap><a href="#reset_input_priority">reset_input_priority(self)</a></td>
|
||||||
<td class="summary">Reset component input priority to default value</td>
|
<td class="summary">Reset component input priority to default value</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_uid">get_uid(self)</a></td>
|
<td class="name" nowrap><a href="#set_debug">set_debug(self, is_debug)</a></td>
|
||||||
<td class="summary">Return component uid.</td>
|
<td class="summary">Set debug logs for component enabled or disabled</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_input_enabled">set_input_enabled(self, state)</a></td>
|
<td class="name" nowrap><a href="#set_input_enabled">set_input_enabled(self, state)</a></td>
|
||||||
<td class="summary">Set component input state.</td>
|
<td class="summary">Set component input state.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_parent_component">get_parent_component(self)</a></td>
|
<td class="name" nowrap><a href="#set_input_priority">set_input_priority(self, value)</a></td>
|
||||||
<td class="summary">Return the parent for current component</td>
|
<td class="summary">Set component input priority</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#setup_component">setup_component(self, druid_instance, context, style)</a></td>
|
<td class="name" nowrap><a href="#set_nodes">set_nodes(self, nodes)</a></td>
|
||||||
<td class="summary">Setup component context and his style table</td>
|
<td class="summary">Set current component nodes (protected)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_childrens">get_childrens(self)</a></td>
|
<td class="name" nowrap><a href="#set_style">set_style(self, druid_style)</a></td>
|
||||||
<td class="summary">Return all children components, recursive</td>
|
<td class="summary">Set current component style table (protected).</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_template">set_template(self, template)</a></td>
|
||||||
|
<td class="summary">Set current component template name (protected)
|
||||||
|
It will check parent template name to build full template name</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
@ -154,77 +169,27 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_style"></a>
|
<a name = "get_childrens"></a>
|
||||||
<strong>set_style(self, druid_style)</strong>
|
<strong>get_childrens(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set current component style table.
|
Return all children components, recursive (protected)
|
||||||
Invoke `on_style_change` on component, if exist. BaseComponent should handle
|
|
||||||
their style changing and store all style params
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">druid_style</span>
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
Druid style module
|
Array of childrens if the Druid component instance
|
||||||
</li>
|
</ol>
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_template"></a>
|
|
||||||
<strong>set_template(self, template)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set current component template name
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
|
||||||
|
|
||||||
</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>
|
|
||||||
BaseComponent template name
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_nodes"></a>
|
|
||||||
<strong>set_nodes(self, nodes)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set current component nodes
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
|
||||||
|
|
||||||
</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>
|
|
||||||
BaseComponent nodes table
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -235,14 +200,14 @@
|
|||||||
<strong>get_context(self)</strong>
|
<strong>get_context(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Get current component context
|
Get current component context (protected)
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -256,6 +221,88 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_druid"></a>
|
||||||
|
<strong>get_druid(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return druid with context of calling component (protected).
|
||||||
|
Use it to create component inside of other components.
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Druid</span></span>
|
||||||
|
Druid instance with component context
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_input_priority"></a>
|
||||||
|
<strong>get_input_priority(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return component input priority
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The component input priority
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_name"></a>
|
||||||
|
<strong>get_name(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return component name
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</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>
|
||||||
|
The component name
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_node"></a>
|
<a name = "get_node"></a>
|
||||||
@ -265,14 +312,15 @@
|
|||||||
Get node for component by name.
|
Get node for component by name.
|
||||||
If component has nodes, node_or_name should be string
|
If component has nodes, node_or_name should be string
|
||||||
It auto pick node by template name or from nodes by clone_tree
|
It auto pick node by template name or from nodes by clone_tree
|
||||||
if they was setup via component:set_nodes, component:set_template
|
if they was setup via component:set_nodes, component:set_template.
|
||||||
|
If node is not found, the exception will fired
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node_or_name</span>
|
<li><span class="parameter">node_or_name</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> or <span class="type">node</span></span>
|
||||||
@ -292,27 +340,26 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_druid"></a>
|
<a name = "get_parent_component"></a>
|
||||||
<strong>get_druid(self)</strong>
|
<strong>get_parent_component(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return druid with context of calling component.
|
Return the parent for current component (protected)
|
||||||
Use it to create component inside of other components.
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
<h3>Returns:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">Druid</span></span>
|
<span class="types"><span class="type">BaseComponent</span> or <span class="type">nil</span></span>
|
||||||
Druid instance with component context
|
The druid component instance or nil
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -320,18 +367,45 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_name"></a>
|
<a name = "get_parent_name"></a>
|
||||||
<strong>get_name(self)</strong>
|
<strong>get_parent_name(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return component name
|
Return parent component name
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</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> or <span class="type">nil</span></span>
|
||||||
|
The parent component name if exist or bil
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_template"></a>
|
||||||
|
<strong>get_template(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get current component template name (protected)
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -339,7 +413,7 @@
|
|||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<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></span>
|
||||||
The component name
|
Component full template name
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -347,18 +421,19 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_input_priority"></a>
|
<a name = "get_uid"></a>
|
||||||
<strong>get_input_priority(self)</strong>
|
<strong>get_uid(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return component input priority
|
Return component uid (protected).
|
||||||
|
UID generated in component creation order
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -366,7 +441,7 @@
|
|||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
The component input priority
|
The component uid
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -374,31 +449,29 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_input_priority"></a>
|
<a name = "log_message"></a>
|
||||||
<strong>set_input_priority(self, value)</strong>
|
<strong>log_message(self, message, context)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set component input priority
|
Print log information if debug mode is enabled (protected)
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">message</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">value</span>
|
<li><span class="parameter">context</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
The new input priority value
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
The component input priority
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -416,7 +489,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -432,27 +505,25 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_uid"></a>
|
<a name = "set_debug"></a>
|
||||||
<strong>get_uid(self)</strong>
|
<strong>set_debug(self, is_debug)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return component uid. UID generated in component creation order
|
Set debug logs for component enabled or disabled
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_debug</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
The component uid
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -471,7 +542,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">state</span>
|
<li><span class="parameter">state</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
@ -491,26 +562,30 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_parent_component"></a>
|
<a name = "set_input_priority"></a>
|
||||||
<strong>get_parent_component(self)</strong>
|
<strong>set_input_priority(self, value)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return the parent for current component
|
Set component input priority
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">value</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The new input priority value
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
<h3>Returns:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">druid.base_component</span> or <span class="type">nil</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
The druid component instance or nil
|
The component input priority
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -518,65 +593,89 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "setup_component"></a>
|
<a name = "set_nodes"></a>
|
||||||
<strong>setup_component(self, druid_instance, context, style)</strong>
|
<strong>set_nodes(self, nodes)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Setup component context and his style table
|
Set current component nodes (protected)
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
|
</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>
|
||||||
|
BaseComponent nodes table
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_style"></a>
|
||||||
|
<strong>set_style(self, druid_style)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set current component style table (protected).
|
||||||
|
Invoke `on_style_change` on component, if exist. BaseComponent should handle
|
||||||
|
their style changing and store all style params
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">druid_instance</span>
|
<li><span class="parameter">druid_style</span>
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
||||||
The parent druid instance
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">context</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
||||||
Druid context. Usually it is self of script
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">style</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
Druid style module
|
Druid style module
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">component</span></span>
|
|
||||||
BaseComponent itself
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_childrens"></a>
|
<a name = "set_template"></a>
|
||||||
<strong>get_childrens(self)</strong>
|
<strong>set_template(self, template)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return all children components, recursive
|
Set current component template name (protected)
|
||||||
|
It will check parent template name to build full template name
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">BaseComponent</span></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
|
<a href="../modules/BaseComponent.html#">BaseComponent</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>
|
||||||
|
BaseComponent template name
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
<h3>Returns:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
<span class="types"><span class="type">BaseComponent</span></span>
|
||||||
Array of childrens if the Druid component instance
|
<a href="../modules/BaseComponent.html#">BaseComponent</a>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -608,7 +707,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><strong>Blocker</strong></li>
|
<li><strong>Blocker</strong></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,13 +83,13 @@
|
|||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
|
|
||||||
<td class="summary">Set enabled blocker component state</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
|
<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
|
||||||
<td class="summary">Return blocked enabled state</td>
|
<td class="summary">Return blocked enabled state</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
|
||||||
|
<td class="summary">Set enabled blocker component state</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
@ -116,7 +118,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Blocker</span></span>
|
<span class="types"><span class="type">Blocker</span></span>
|
||||||
|
<a href="../modules/Blocker.html#">Blocker</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><a class="type" href="../modules/Blocker.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Blocker.html#node">node</a></span>
|
||||||
@ -128,31 +130,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_enabled"></a>
|
|
||||||
<strong>set_enabled(self, state)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set enabled blocker component state
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Blocker</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">state</span>
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
|
||||||
Enabled state
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "is_enabled"></a>
|
<a name = "is_enabled"></a>
|
||||||
@ -166,7 +143,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Blocker</span></span>
|
<span class="types"><span class="type">Blocker</span></span>
|
||||||
|
<a href="../modules/Blocker.html#">Blocker</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -180,6 +157,31 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_enabled"></a>
|
||||||
|
<strong>set_enabled(self, state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set enabled blocker component state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Blocker</span></span>
|
||||||
|
<a href="../modules/Blocker.html#">Blocker</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Enabled state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
@ -212,7 +214,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -41,29 +41,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><strong>Button</strong></li>
|
<li><strong>Button</strong></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -78,33 +80,33 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, node, callback[, params[, anim_node]])</a></td>
|
<td class="name" nowrap><a href="#get_key_trigger">get_key_trigger(self)</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Get key-code to trigger this button</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
|
<td class="name" nowrap><a href="#init">init(self, node, callback[, params[, anim_node]])</a></td>
|
||||||
<td class="summary">Set enabled button component state</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
|
<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
|
||||||
<td class="summary">Return button enabled state</td>
|
<td class="summary">Return button enabled state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_check_function">set_check_function(self[, check_function[, failure_callback]])</a></td>
|
||||||
|
<td class="summary">Set function for additional check for button click availability</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
||||||
<td class="summary">Strict button click area.</td>
|
<td class="summary">Strict button click area.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
|
||||||
|
<td class="summary">Set enabled button component state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_key_trigger">set_key_trigger(self, key)</a></td>
|
<td class="name" nowrap><a href="#set_key_trigger">set_key_trigger(self, key)</a></td>
|
||||||
<td class="summary">Set key-code to trigger this button</td>
|
<td class="summary">Set key-code to trigger this button</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_key_trigger">get_key_trigger(self)</a></td>
|
|
||||||
<td class="summary">Get key-code to trigger this button</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_check_function">set_check_function([check_function[, failure_callback]])</a></td>
|
|
||||||
<td class="summary">Set function for additional check for button click availability</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Tables">Tables</a></h2>
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
@ -115,17 +117,33 @@
|
|||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#anim_node">anim_node</a></td>
|
||||||
|
<td class="summary">Animation node</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#click_zone">click_zone</a></td>
|
||||||
|
<td class="summary">Restriction zone</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#hash">hash</a></td>
|
||||||
|
<td class="summary">The hash of trigger node</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#hover">hover</a></td>
|
||||||
|
<td class="summary">Druid hover logic component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
|
<td class="summary">Trigger node</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_click">on_click</a></td>
|
<td class="name" nowrap><a href="#on_click">on_click</a></td>
|
||||||
<td class="summary">On release button callback(self, params, button_instance)</td>
|
<td class="summary">On release button callback(self, params, button_instance)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_repeated_click">on_repeated_click</a></td>
|
<td class="name" nowrap><a href="#on_click_outside">on_click_outside</a></td>
|
||||||
<td class="summary">On repeated action button callback(self, params, button_instance, click_amount)</td>
|
<td class="summary">On click outside of button(self, params, button_instance)</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_long_click">on_long_click</a></td>
|
|
||||||
<td class="summary">On long tap button callback(self, params, button_instance, time)</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_double_click">on_double_click</a></td>
|
<td class="name" nowrap><a href="#on_double_click">on_double_click</a></td>
|
||||||
@ -136,44 +154,28 @@
|
|||||||
<td class="summary">On button hold before long_click callback(self, params, button_instance, time)</td>
|
<td class="summary">On button hold before long_click callback(self, params, button_instance, time)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_click_outside">on_click_outside</a></td>
|
<td class="name" nowrap><a href="#on_long_click">on_long_click</a></td>
|
||||||
<td class="summary">On click outside of button(self, params, button_instance)</td>
|
<td class="summary">On long tap button callback(self, params, button_instance, time)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#node">node</a></td>
|
<td class="name" nowrap><a href="#on_repeated_click">on_repeated_click</a></td>
|
||||||
<td class="summary">Trigger node</td>
|
<td class="summary">On repeated action button callback(self, params, button_instance, click_amount)</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#hash">hash</a></td>
|
|
||||||
<td class="summary">The hash of trigger node</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#anim_node">anim_node</a></td>
|
|
||||||
<td class="summary">Animation node</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#start_scale">start_scale</a></td>
|
|
||||||
<td class="summary">Initial scale of anim_node</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#start_pos">start_pos</a></td>
|
|
||||||
<td class="summary">Initial pos of anim_node</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#pos">pos</a></td>
|
|
||||||
<td class="summary">Initial pos of anim_node</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#params">params</a></td>
|
<td class="name" nowrap><a href="#params">params</a></td>
|
||||||
<td class="summary">Params to click callbacks</td>
|
<td class="summary">Params to click callbacks</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#hover">hover</a></td>
|
<td class="name" nowrap><a href="#pos">pos</a></td>
|
||||||
<td class="summary">Druid hover logic component</td>
|
<td class="summary">Initial pos of anim_node</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#click_zone">click_zone</a></td>
|
<td class="name" nowrap><a href="#start_pos">start_pos</a></td>
|
||||||
<td class="summary">Restriction zone</td>
|
<td class="summary">Initial pos of anim_node</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#start_scale">start_scale</a></td>
|
||||||
|
<td class="summary">Initial scale of anim_node</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -184,166 +186,6 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
|
||||||
<a name = "init"></a>
|
|
||||||
<strong>init(self, node, callback[, params[, anim_node]])</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Component init function
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">node</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
|
||||||
Gui node
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">callback</span>
|
|
||||||
<span class="types"><span class="type">function</span></span>
|
|
||||||
Button callback
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">params</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
||||||
Button callback params
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">anim_node</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
|
||||||
Button anim node (node, if not provided)
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_enabled"></a>
|
|
||||||
<strong>set_enabled(self, state)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set enabled button component state
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">state</span>
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
|
||||||
Enabled state
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
Current button instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "is_enabled"></a>
|
|
||||||
<strong>is_enabled(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return button enabled state
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
|
||||||
True, if button is enabled
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_click_zone"></a>
|
|
||||||
<strong>set_click_zone(self, zone)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Strict button click area. Useful for
|
|
||||||
no click events outside stencil node
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">zone</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
|
||||||
Gui node
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
Current button instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_key_trigger"></a>
|
|
||||||
<strong>set_key_trigger(self, key)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set key-code to trigger this button
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">key</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Button.html#hash">hash</a></span>
|
|
||||||
The action_id of the key
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Button</span></span>
|
|
||||||
Current button instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_key_trigger"></a>
|
<a name = "get_key_trigger"></a>
|
||||||
<strong>get_key_trigger(self)</strong>
|
<strong>get_key_trigger(self)</strong>
|
||||||
@ -370,10 +212,76 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, node, callback[, params[, anim_node]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
<a href="../modules/Button.html#">Button</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Button callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">params</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
Button callback params
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">anim_node</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
||||||
|
Button anim node (node, if not provided)
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "is_enabled"></a>
|
||||||
|
<strong>is_enabled(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return button enabled state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
<a href="../modules/Button.html#">Button</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
True, if button is enabled
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_check_function"></a>
|
<a name = "set_check_function"></a>
|
||||||
<strong>set_check_function([check_function[, failure_callback]])</strong>
|
<strong>set_check_function(self[, check_function[, failure_callback]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set function for additional check for button click availability
|
Set function for additional check for button click availability
|
||||||
@ -381,6 +289,10 @@
|
|||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
<li><span class="parameter">check_function</span>
|
<li><span class="parameter">check_function</span>
|
||||||
<span class="types"><span class="type">function</span></span>
|
<span class="types"><span class="type">function</span></span>
|
||||||
Should return true or false. If true - button can be pressed.
|
Should return true or false. If true - button can be pressed.
|
||||||
@ -403,6 +315,100 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_click_zone"></a>
|
||||||
|
<strong>set_click_zone(self, zone)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Strict button click area. Useful for
|
||||||
|
no click events outside stencil node
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
<a href="../modules/Button.html#">Button</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">zone</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
Current button instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_enabled"></a>
|
||||||
|
<strong>set_enabled(self, state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set enabled button component state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
<a href="../modules/Button.html#">Button</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Enabled state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
Current button instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_key_trigger"></a>
|
||||||
|
<strong>set_key_trigger(self, key)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set key-code to trigger this button
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
<a href="../modules/Button.html#">Button</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">key</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Button.html#hash">hash</a></span>
|
||||||
|
The action_id of the key
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
Current button instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
@ -467,137 +473,39 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_click"></a>
|
<a name = "anim_node"></a>
|
||||||
<strong>on_click</strong>
|
<strong>anim_node</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On release button callback(self, params, button_instance)
|
Animation node
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_click</span>
|
<li><span class="parameter">anim_node</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_repeated_click"></a>
|
|
||||||
<strong>on_repeated_click</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On repeated action button callback(self, params, button_instance, click_amount)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_repeated_click</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_long_click"></a>
|
|
||||||
<strong>on_long_click</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On long tap button callback(self, params, button_instance, time)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_long_click</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_double_click"></a>
|
|
||||||
<strong>on_double_click</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On double tap button callback(self, params, button_instance, click_amount)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_double_click</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_hold_callback"></a>
|
|
||||||
<strong>on_hold_callback</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On button hold before long_click callback(self, params, button_instance, time)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_hold_callback</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_click_outside"></a>
|
|
||||||
<strong>on_click_outside</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On click outside of button(self, params, button_instance)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_click_outside</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "node"></a>
|
|
||||||
<strong>node</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Trigger node
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">node</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
||||||
|
|
||||||
|
(<em>default</em> node)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "click_zone"></a>
|
||||||
|
<strong>click_zone</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Restriction zone
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">click_zone</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
||||||
|
|
||||||
|
(<em>optional</em>)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -627,18 +535,17 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "anim_node"></a>
|
<a name = "hover"></a>
|
||||||
<strong>anim_node</strong>
|
<strong>hover</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Animation node
|
Druid hover logic component
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">anim_node</span>
|
<li><span class="parameter">hover</span>
|
||||||
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
<span class="types"><span class="type">Hover</span></span>
|
||||||
|
<a href="../modules/Hover.html#">Hover</a>
|
||||||
(<em>default</em> node)
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -648,15 +555,175 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "start_scale"></a>
|
<a name = "node"></a>
|
||||||
<strong>start_scale</strong>
|
<strong>node</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Initial scale of anim_node
|
Trigger node
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">start_scale</span>
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_click"></a>
|
||||||
|
<strong>on_click</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On release button callback(self, params, button_instance)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_click</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_click_outside"></a>
|
||||||
|
<strong>on_click_outside</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On click outside of button(self, params, button_instance)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_click_outside</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_double_click"></a>
|
||||||
|
<strong>on_double_click</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On double tap button callback(self, params, button_instance, click_amount)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_double_click</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_hold_callback"></a>
|
||||||
|
<strong>on_hold_callback</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On button hold before long_click callback(self, params, button_instance, time)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_hold_callback</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_long_click"></a>
|
||||||
|
<strong>on_long_click</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On long tap button callback(self, params, button_instance, time)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_long_click</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_repeated_click"></a>
|
||||||
|
<strong>on_repeated_click</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On repeated action button callback(self, params, button_instance, click_amount)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_repeated_click</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "params"></a>
|
||||||
|
<strong>params</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Params to click callbacks
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">params</span>
|
||||||
|
<span class="types"><span class="type">any</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "pos"></a>
|
||||||
|
<strong>pos</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Initial pos of anim_node
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">pos</span>
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -688,15 +755,15 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "pos"></a>
|
<a name = "start_scale"></a>
|
||||||
<strong>pos</strong>
|
<strong>start_scale</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Initial pos of anim_node
|
Initial scale of anim_node
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">pos</span>
|
<li><span class="parameter">start_scale</span>
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -706,67 +773,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "params"></a>
|
|
||||||
<strong>params</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Params to click callbacks
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">params</span>
|
|
||||||
<span class="types"><span class="type">any</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "hover"></a>
|
|
||||||
<strong>hover</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Druid hover logic component
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">hover</span>
|
|
||||||
<span class="types"><span class="type">druid.hover</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "click_zone"></a>
|
|
||||||
<strong>click_zone</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Restriction zone
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">click_zone</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
|
|
||||||
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -775,7 +781,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -41,29 +41,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><strong>Checkbox</strong></li>
|
<li><strong>Checkbox</strong></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -77,6 +79,10 @@
|
|||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
|
||||||
|
<td class="summary">Return checkbox state</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, node, callback[, click_node=node[, initial_state=false]])</a></td>
|
<td class="name" nowrap><a href="#init">init(self, node, callback[, click_node=node[, initial_state=false]])</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
@ -85,10 +91,6 @@
|
|||||||
<td class="name" nowrap><a href="#set_state">set_state(self, state, is_silent, is_instant)</a></td>
|
<td class="name" nowrap><a href="#set_state">set_state(self, state, is_silent, is_instant)</a></td>
|
||||||
<td class="summary">Set checkbox state</td>
|
<td class="summary">Set checkbox state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
|
|
||||||
<td class="summary">Return checkbox state</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Tables">Tables</a></h2>
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
@ -100,20 +102,20 @@
|
|||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_change_state">on_change_state</a></td>
|
<td class="name" nowrap><a href="#button">button</a></td>
|
||||||
<td class="summary">On change state callback(self, state)</td>
|
<td class="summary">Button component from click_node</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#node">node</a></td>
|
|
||||||
<td class="summary">Visual node</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#click_node">click_node</a></td>
|
<td class="name" nowrap><a href="#click_node">click_node</a></td>
|
||||||
<td class="summary">Button trigger node</td>
|
<td class="summary">Button trigger node</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#button">button</a></td>
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
<td class="summary">Button component from click_node</td>
|
<td class="summary">Visual node</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_change_state">on_change_state</a></td>
|
||||||
|
<td class="summary">On change state callback(self, state)</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -124,6 +126,33 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "get_state"></a>
|
||||||
|
<strong>get_state(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return checkbox state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Checkbox</span></span>
|
||||||
|
<a href="../modules/Checkbox.html#">Checkbox</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Checkbox state
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node, callback[, click_node=node[, initial_state=false]])</strong>
|
<strong>init(self, node, callback[, click_node=node[, initial_state=false]])</strong>
|
||||||
@ -136,7 +165,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Checkbox</span></span>
|
<span class="types"><span class="type">Checkbox</span></span>
|
||||||
|
<a href="../modules/Checkbox.html#">Checkbox</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
|
||||||
@ -175,7 +204,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Checkbox</span></span>
|
<span class="types"><span class="type">Checkbox</span></span>
|
||||||
|
<a href="../modules/Checkbox.html#">Checkbox</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">state</span>
|
<li><span class="parameter">state</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
@ -195,33 +224,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_state"></a>
|
|
||||||
<strong>get_state(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return checkbox state
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Checkbox</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
|
||||||
Checkbox state
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
@ -255,37 +257,17 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_change_state"></a>
|
<a name = "button"></a>
|
||||||
<strong>on_change_state</strong>
|
<strong>button</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On change state callback(self, state)
|
Button component from click_node
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_change_state</span>
|
<li><span class="parameter">button</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
<a href="../modules/Button.html#">Button</a>
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "node"></a>
|
|
||||||
<strong>node</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Visual node
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">node</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -316,16 +298,16 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "button"></a>
|
<a name = "node"></a>
|
||||||
<strong>button</strong>
|
<strong>node</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Button component from click_node
|
Visual node
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">button</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><span class="type">Button</span></span>
|
<span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -334,6 +316,26 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_change_state"></a>
|
||||||
|
<strong>on_change_state</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On change state callback(self, state)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change_state</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -342,7 +344,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><strong>CheckboxGroup</strong></li>
|
<li><strong>CheckboxGroup</strong></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,6 +78,10 @@
|
|||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
|
||||||
|
<td class="summary">Return checkbox group state</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, nodes, callback[, click_nodes=node])</a></td>
|
<td class="name" nowrap><a href="#init">init(self, nodes, callback[, click_nodes=node])</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
@ -84,21 +90,17 @@
|
|||||||
<td class="name" nowrap><a href="#set_state">set_state(self, indexes, is_instant)</a></td>
|
<td class="name" nowrap><a href="#set_state">set_state(self, indexes, is_instant)</a></td>
|
||||||
<td class="summary">Set checkbox group state</td>
|
<td class="summary">Set checkbox group state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
|
|
||||||
<td class="summary">Return checkbox group state</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_checkbox_click">on_checkbox_click</a></td>
|
|
||||||
<td class="summary">On any checkbox click callback(self, index)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#checkboxes">checkboxes</a></td>
|
<td class="name" nowrap><a href="#checkboxes">checkboxes</a></td>
|
||||||
<td class="summary">Array of checkbox components</td>
|
<td class="summary">Array of checkbox components</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_checkbox_click">on_checkbox_click</a></td>
|
||||||
|
<td class="summary">On any checkbox click callback(self, index)</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -108,6 +110,33 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "get_state"></a>
|
||||||
|
<strong>get_state(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return checkbox group state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">CheckboxGroup</span></span>
|
||||||
|
<a href="../modules/CheckboxGroup.html#">CheckboxGroup</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool[]</span></span>
|
||||||
|
Array if checkboxes state
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, nodes, callback[, click_nodes=node])</strong>
|
<strong>init(self, nodes, callback[, click_nodes=node])</strong>
|
||||||
@ -120,7 +149,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">CheckboxGroup</span></span>
|
<span class="types"><span class="type">CheckboxGroup</span></span>
|
||||||
|
<a href="../modules/CheckboxGroup.html#">CheckboxGroup</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">nodes</span>
|
<li><span class="parameter">nodes</span>
|
||||||
<span class="types"><span class="type">node[]</span></span>
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
@ -154,7 +183,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">CheckboxGroup</span></span>
|
<span class="types"><span class="type">CheckboxGroup</span></span>
|
||||||
|
<a href="../modules/CheckboxGroup.html#">CheckboxGroup</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">indexes</span>
|
<li><span class="parameter">indexes</span>
|
||||||
<span class="types"><span class="type">bool[]</span></span>
|
<span class="types"><span class="type">bool[]</span></span>
|
||||||
@ -170,58 +199,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_state"></a>
|
|
||||||
<strong>get_state(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return checkbox group state
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">CheckboxGroup</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">bool[]</span></span>
|
|
||||||
Array if checkboxes state
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
|
||||||
<a name = "on_checkbox_click"></a>
|
|
||||||
<strong>on_checkbox_click</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On any checkbox click callback(self, index)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_checkbox_click</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "checkboxes"></a>
|
<a name = "checkboxes"></a>
|
||||||
<strong>checkboxes</strong>
|
<strong>checkboxes</strong>
|
||||||
@ -233,7 +215,27 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">checkboxes</span>
|
<li><span class="parameter">checkboxes</span>
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
<a href="../modules/Checkbox.html#">Checkbox</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_checkbox_click"></a>
|
||||||
|
<strong>on_checkbox_click</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On any checkbox click callback(self, index)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_checkbox_click</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -249,7 +251,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><strong>DataList</strong></li>
|
<li><strong>DataList</strong></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -77,18 +79,6 @@
|
|||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#init">init(self, scroll, grid, create_function)</a></td>
|
|
||||||
<td class="summary">Data list constructor</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_remove">on_remove(self)</a></td>
|
|
||||||
<td class="summary">Druid System on_remove function</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_data">set_data(self, data)</a></td>
|
|
||||||
<td class="summary">Set new data set for DataList component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#clear">clear(self)</a></td>
|
<td class="name" nowrap><a href="#clear">clear(self)</a></td>
|
||||||
<td class="summary">Clear the DataList and refresh visuals</td>
|
<td class="summary">Clear the DataList and refresh visuals</td>
|
||||||
@ -98,6 +88,10 @@
|
|||||||
<td class="summary">Return first index from data.</td>
|
<td class="summary">Return first index from data.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_index">get_index(self, data)</a></td>
|
||||||
|
<td class="summary">Return index for data value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_last_index">get_last_index(self)</a></td>
|
<td class="name" nowrap><a href="#get_last_index">get_last_index(self)</a></td>
|
||||||
<td class="summary">Return last index from data</td>
|
<td class="summary">Return last index from data</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -106,39 +100,47 @@
|
|||||||
<td class="summary">Return amount of data</td>
|
<td class="summary">Return amount of data</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_index">get_index(self, data)</a></td>
|
<td class="name" nowrap><a href="#init">init(self, scroll, grid, create_function)</a></td>
|
||||||
<td class="summary">Return index for data value</td>
|
<td class="summary">Data list constructor</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_remove">on_remove(self)</a></td>
|
||||||
|
<td class="summary">Druid System on_remove function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#scroll_to_index">scroll_to_index(self, index)</a></td>
|
<td class="name" nowrap><a href="#scroll_to_index">scroll_to_index(self, index)</a></td>
|
||||||
<td class="summary">Instant scroll to element with passed index</td>
|
<td class="summary">Instant scroll to element with passed index</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_data">set_data(self, data)</a></td>
|
||||||
|
<td class="summary">Set new data set for DataList component</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#scroll">scroll</a></td>
|
|
||||||
<td class="summary">The Druid scroll component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#grid">grid</a></td>
|
<td class="name" nowrap><a href="#grid">grid</a></td>
|
||||||
<td class="summary">The Druid Grid component</td>
|
<td class="summary">The Druid Grid component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#top_index">top_index</a></td>
|
|
||||||
<td class="summary">The current visual top data index</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#last_index">last_index</a></td>
|
<td class="name" nowrap><a href="#last_index">last_index</a></td>
|
||||||
<td class="summary">The current visual last data index</td>
|
<td class="summary">The current visual last data index</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_scroll_progress_change">on_scroll_progress_change</a></td>
|
||||||
|
<td class="summary">Event triggered when scroll progress is changed; event(self, progress_value)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#scroll">scroll</a></td>
|
||||||
|
<td class="summary">The Druid scroll component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#scroll_progress">scroll_progress</a></td>
|
<td class="name" nowrap><a href="#scroll_progress">scroll_progress</a></td>
|
||||||
<td class="summary">The current progress of scroll posititon</td>
|
<td class="summary">The current progress of scroll posititon</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_scroll_progress_change">on_scroll_progress_change</a></td>
|
<td class="name" nowrap><a href="#top_index">top_index</a></td>
|
||||||
<td class="summary">Event triggered when scroll progress is changed; event(self, progress_value)</td>
|
<td class="summary">The current visual top data index</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -149,6 +151,115 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "clear"></a>
|
||||||
|
<strong>clear(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Clear the DataList and refresh visuals
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_first_index"></a>
|
||||||
|
<strong>get_first_index(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return first index from data. It not always equals to 1
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_index"></a>
|
||||||
|
<strong>get_index(self, data)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return index for data value
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">data</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_last_index"></a>
|
||||||
|
<strong>get_last_index(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return last index from data
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_length"></a>
|
||||||
|
<strong>get_length(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return amount of data
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, scroll, grid, create_function)</strong>
|
<strong>init(self, scroll, grid, create_function)</strong>
|
||||||
@ -161,15 +272,15 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">scroll</span>
|
<li><span class="parameter">scroll</span>
|
||||||
<span class="types"><span class="type">druid.scroll</span></span>
|
<span class="types"><span class="type">Scroll</span></span>
|
||||||
The Scroll instance for Data List component
|
The <a href="../modules/Scroll.html#">Scroll</a> instance for Data List component
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">grid</span>
|
<li><span class="parameter">grid</span>
|
||||||
<span class="types"><span class="type">druid.grid</span></span>
|
<span class="types"><span class="type">StaticGrid</span> or <span class="type">DynamicGrid</span></span>
|
||||||
The Grid instance for Data List component
|
The <a href="../modules/StaticGrid.html#">StaticGrid</a> or <a href="../modules/DynamicGrid.html#">DynamicGrid</a> instance for Data List component
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">create_function</span>
|
<li><span class="parameter">create_function</span>
|
||||||
<span class="types"><span class="type">function</span></span>
|
<span class="types"><span class="type">function</span></span>
|
||||||
@ -194,6 +305,31 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "scroll_to_index"></a>
|
||||||
|
<strong>scroll_to_index(self, index)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Instant scroll to element with passed index
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">index</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -215,7 +351,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
<span class="types"><span class="type">DataList</span></span>
|
||||||
|
<a href="../modules/DataList.html#">DataList</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">data</span>
|
<li><span class="parameter">data</span>
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
@ -233,165 +369,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "clear"></a>
|
|
||||||
<strong>clear(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Clear the DataList and refresh visuals
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_first_index"></a>
|
|
||||||
<strong>get_first_index(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return first index from data. It not always equals to 1
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_last_index"></a>
|
|
||||||
<strong>get_last_index(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return last index from data
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_length"></a>
|
|
||||||
<strong>get_length(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return amount of data
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_index"></a>
|
|
||||||
<strong>get_index(self, data)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return index for data value
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">data</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "scroll_to_index"></a>
|
|
||||||
<strong>scroll_to_index(self, index)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Instant scroll to element with passed index
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DataList</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">index</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
|
||||||
<a name = "scroll"></a>
|
|
||||||
<strong>scroll</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
The Druid scroll component
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">scroll</span>
|
|
||||||
<span class="types"><span class="type">druid.scroll</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "grid"></a>
|
<a name = "grid"></a>
|
||||||
<strong>grid</strong>
|
<strong>grid</strong>
|
||||||
@ -402,28 +384,8 @@
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">grid</span>
|
<li><span class="parameter">grid</span>
|
||||||
<span class="types"><span class="type">druid.static_grid</span></span>
|
<span class="types"><span class="type">StaticGrid</span> or <span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/StaticGrid.html#">StaticGrid</a>, <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "top_index"></a>
|
|
||||||
<strong>top_index</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
The current visual top data index
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">top_index</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -451,6 +413,46 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_scroll_progress_change"></a>
|
||||||
|
<strong>on_scroll_progress_change</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Event triggered when scroll progress is changed; event(self, progress_value)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_scroll_progress_change</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "scroll"></a>
|
||||||
|
<strong>scroll</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
The Druid scroll component
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">scroll</span>
|
||||||
|
<span class="types"><span class="type">Scroll</span></span>
|
||||||
|
<a href="../modules/Scroll.html#">Scroll</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "scroll_progress"></a>
|
<a name = "scroll_progress"></a>
|
||||||
@ -473,16 +475,16 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_scroll_progress_change"></a>
|
<a name = "top_index"></a>
|
||||||
<strong>on_scroll_progress_change</strong>
|
<strong>top_index</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Event triggered when scroll progress is changed; event(self, progress_value)
|
The current visual top data index
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_scroll_progress_change</span>
|
<li><span class="parameter">top_index</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -499,7 +501,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -41,29 +41,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><strong>Drag</strong></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><strong>Drag</strong></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -99,16 +101,20 @@
|
|||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_touch_start">on_touch_start</a></td>
|
<td class="name" nowrap><a href="#can_x">can_x</a></td>
|
||||||
<td class="summary">Event on touch start callback(self)</td>
|
<td class="summary">Is drag component process vertical dragging.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_touch_end">on_touch_end</a></td>
|
<td class="name" nowrap><a href="#can_y">can_y</a></td>
|
||||||
<td class="summary">Event on touch end callback(self)</td>
|
<td class="summary">Is drag component process horizontal.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_drag_start">on_drag_start</a></td>
|
<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
|
||||||
<td class="summary">Event on drag start callback(self)</td>
|
<td class="summary">Is component now dragging</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#is_touch">is_touch</a></td>
|
||||||
|
<td class="summary">Is component now touching</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_drag">on_drag</a></td>
|
<td class="name" nowrap><a href="#on_drag">on_drag</a></td>
|
||||||
@ -119,20 +125,20 @@
|
|||||||
<td class="summary">Event on drag end callback(self)</td>
|
<td class="summary">Event on drag end callback(self)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#is_touch">is_touch</a></td>
|
<td class="name" nowrap><a href="#on_drag_start">on_drag_start</a></td>
|
||||||
<td class="summary">Is component now touching</td>
|
<td class="summary">Event on drag start callback(self)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
|
<td class="name" nowrap><a href="#on_touch_end">on_touch_end</a></td>
|
||||||
<td class="summary">Is component now dragging</td>
|
<td class="summary">Event on touch end callback(self)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#can_x">can_x</a></td>
|
<td class="name" nowrap><a href="#on_touch_start">on_touch_start</a></td>
|
||||||
<td class="summary">Is drag component process vertical dragging.</td>
|
<td class="summary">Event on touch start callback(self)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#can_y">can_y</a></td>
|
<td class="name" nowrap><a href="#touch_start_pos">touch_start_pos</a></td>
|
||||||
<td class="summary">Is drag component process horizontal.</td>
|
<td class="summary">Touch start position</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#x">x</a></td>
|
<td class="name" nowrap><a href="#x">x</a></td>
|
||||||
@ -142,10 +148,6 @@
|
|||||||
<td class="name" nowrap><a href="#y">y</a></td>
|
<td class="name" nowrap><a href="#y">y</a></td>
|
||||||
<td class="summary">Current touch y position</td>
|
<td class="summary">Current touch y position</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#touch_start_pos">touch_start_pos</a></td>
|
|
||||||
<td class="summary">Touch start position</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -167,7 +169,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Drag</span></span>
|
<span class="types"><span class="type">Drag</span></span>
|
||||||
|
<a href="../modules/Drag.html#">Drag</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
@ -197,7 +199,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Drag</span></span>
|
<span class="types"><span class="type">Drag</span></span>
|
||||||
|
<a href="../modules/Drag.html#">Drag</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
@ -243,16 +245,16 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_touch_start"></a>
|
<a name = "can_x"></a>
|
||||||
<strong>on_touch_start</strong>
|
<strong>can_x</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Event on touch start callback(self)
|
Is drag component process vertical dragging. Default - true
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_touch_start</span>
|
<li><span class="parameter">can_x</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -263,95 +265,15 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_touch_end"></a>
|
<a name = "can_y"></a>
|
||||||
<strong>on_touch_end</strong>
|
<strong>can_y</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Event on touch end callback(self)
|
Is drag component process horizontal. Default - true
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_touch_end</span>
|
<li><span class="parameter">can_y</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_drag_start"></a>
|
|
||||||
<strong>on_drag_start</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Event on drag start callback(self)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_drag_start</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_drag"></a>
|
|
||||||
<strong>on_drag</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
on drag progress callback(self, dx, dy)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_drag</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
Event
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_drag_end"></a>
|
|
||||||
<strong>on_drag_end</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Event on drag end callback(self)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_drag_end</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "is_touch"></a>
|
|
||||||
<strong>is_touch</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Is component now touching
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">is_touch</span>
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -383,15 +305,15 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "can_x"></a>
|
<a name = "is_touch"></a>
|
||||||
<strong>can_x</strong>
|
<strong>is_touch</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Is drag component process vertical dragging. Default - true
|
Is component now touching
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">can_x</span>
|
<li><span class="parameter">is_touch</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -403,16 +325,116 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "can_y"></a>
|
<a name = "on_drag"></a>
|
||||||
<strong>can_y</strong>
|
<strong>on_drag</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Is drag component process horizontal. Default - true
|
on drag progress callback(self, dx, dy)
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">can_y</span>
|
<li><span class="parameter">on_drag</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
Event <a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_drag_end"></a>
|
||||||
|
<strong>on_drag_end</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Event on drag end callback(self)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_drag_end</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_drag_start"></a>
|
||||||
|
<strong>on_drag_start</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Event on drag start callback(self)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_drag_start</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_touch_end"></a>
|
||||||
|
<strong>on_touch_end</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Event on touch end callback(self)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_touch_end</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_touch_start"></a>
|
||||||
|
<strong>on_touch_start</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Event on touch start callback(self)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_touch_start</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "touch_start_pos"></a>
|
||||||
|
<strong>touch_start_pos</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Touch start position
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">touch_start_pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -461,26 +483,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "touch_start_pos"></a>
|
|
||||||
<strong>touch_start_pos</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Touch start position
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">touch_start_pos</span>
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -489,7 +491,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -39,29 +39,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><strong>DruidEvent</strong></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><strong>DruidEvent</strong></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -69,36 +71,36 @@
|
|||||||
<div id="content">
|
<div id="content">
|
||||||
|
|
||||||
<h1>Module <code>DruidEvent</code></h1>
|
<h1>Module <code>DruidEvent</code></h1>
|
||||||
<p>Lua event small library</p>
|
<p>Druid lua event library</p>
|
||||||
<p></p>
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#clear">clear(self)</a></td>
|
||||||
|
<td class="summary">Clear the all event handlers</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#initialize">initialize(self, initial_callback)</a></td>
|
<td class="name" nowrap><a href="#initialize">initialize(self, initial_callback)</a></td>
|
||||||
<td class="summary">Event constructur</td>
|
<td class="summary">Event constructur</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#subscribe">subscribe(self, callback, context)</a></td>
|
|
||||||
<td class="summary">Subscribe callback on event</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#unsubscribe">unsubscribe(self, callback, context)</a></td>
|
|
||||||
<td class="summary">Unsubscribe callback on event</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#is_exist">is_exist(self)</a></td>
|
<td class="name" nowrap><a href="#is_exist">is_exist(self)</a></td>
|
||||||
<td class="summary">Return true, if event have at lease one handler</td>
|
<td class="summary">Return true, if event have at lease one handler</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#clear">clear(self)</a></td>
|
<td class="name" nowrap><a href="#subscribe">subscribe(self, callback, context)</a></td>
|
||||||
<td class="summary">Clear the all event handlers</td>
|
<td class="summary">Subscribe callback on event</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#trigger">trigger(self, ...)</a></td>
|
<td class="name" nowrap><a href="#trigger">trigger(self, ...)</a></td>
|
||||||
<td class="summary">Trigger the event and call all subscribed callbacks</td>
|
<td class="summary">Trigger the event and call all subscribed callbacks</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#unsubscribe">unsubscribe(self, callback, context)</a></td>
|
||||||
|
<td class="summary">Unsubscribe callback on event</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -108,6 +110,27 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "clear"></a>
|
||||||
|
<strong>clear(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Clear the all event handlers
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "initialize"></a>
|
<a name = "initialize"></a>
|
||||||
<strong>initialize(self, initial_callback)</strong>
|
<strong>initialize(self, initial_callback)</strong>
|
||||||
@ -120,7 +143,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DruidEvent</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">initial_callback</span>
|
<li><span class="parameter">initial_callback</span>
|
||||||
<span class="types"><span class="type">function</span></span>
|
<span class="types"><span class="type">function</span></span>
|
||||||
@ -132,64 +155,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "subscribe"></a>
|
|
||||||
<strong>subscribe(self, callback, context)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Subscribe callback on event
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DruidEvent</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">callback</span>
|
|
||||||
<span class="types"><span class="type">function</span></span>
|
|
||||||
Callback itself
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">context</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
||||||
Additional context as first param to callback call
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "unsubscribe"></a>
|
|
||||||
<strong>unsubscribe(self, callback, context)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Unsubscribe callback on event
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DruidEvent</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">callback</span>
|
|
||||||
<span class="types"><span class="type">function</span></span>
|
|
||||||
Callback itself
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">context</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
||||||
Additional context as first param to callback call
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "is_exist"></a>
|
<a name = "is_exist"></a>
|
||||||
@ -203,7 +168,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DruidEvent</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -219,18 +184,26 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "clear"></a>
|
<a name = "subscribe"></a>
|
||||||
<strong>clear(self)</strong>
|
<strong>subscribe(self, callback, context)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Clear the all event handlers
|
Subscribe callback on event
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DruidEvent</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback itself
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">context</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
Additional context as first param to callback call
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -251,7 +224,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DruidEvent</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">...</span>
|
<li><span class="parameter">...</span>
|
||||||
<span class="types"><span class="type">any</span></span>
|
<span class="types"><span class="type">any</span></span>
|
||||||
@ -263,6 +236,35 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "unsubscribe"></a>
|
||||||
|
<strong>unsubscribe(self, callback, context)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Unsubscribe callback on event
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback itself
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">context</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
Additional context as first param to callback call
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -271,7 +273,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><strong>DynamicGrid</strong></li>
|
<li><strong>DynamicGrid</strong></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -77,28 +79,20 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, parent)</a></td>
|
<td class="name" nowrap><a href="#_get_side_vector">_get_side_vector(self, side, is_forward)</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Return side vector to correct node shifting</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_pos">get_pos(self, index, node[, origin_index])</a></td>
|
<td class="name" nowrap><a href="#add">add(self, node[, index[, shift_policy=SHIFT.RIGHT[, is_instant=false]]])</a></td>
|
||||||
<td class="summary">Return pos for grid node index</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#add">add(self, node[, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]])</a></td>
|
|
||||||
<td class="summary">Add new node to the grid</td>
|
<td class="summary">Add new node to the grid</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#remove">remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]])</a></td>
|
<td class="name" nowrap><a href="#clear">clear(self)</a></td>
|
||||||
<td class="summary">Remove the item from the grid.</td>
|
<td class="summary">Clear grid nodes array.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_size">get_size(self, border)</a></td>
|
<td class="name" nowrap><a href="#get_all_pos">get_all_pos(self)</a></td>
|
||||||
<td class="summary">Return grid content size</td>
|
<td class="summary">Return array of all node positions</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_offset">get_offset(self)</a></td>
|
|
||||||
<td class="summary">Return DynamicGrid offset, where DynamicGrid content starts.</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_borders">get_borders(self)</a></td>
|
<td class="name" nowrap><a href="#get_borders">get_borders(self)</a></td>
|
||||||
@ -109,51 +103,35 @@
|
|||||||
<td class="summary">Return grid index by node</td>
|
<td class="summary">Return grid index by node</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_all_pos">get_all_pos(self)</a></td>
|
<td class="name" nowrap><a href="#get_offset">get_offset(self)</a></td>
|
||||||
<td class="summary">Return array of all node positions</td>
|
<td class="summary">Return DynamicGrid offset, where DynamicGrid content starts.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_pos">get_pos(self, index, node[, origin_index])</a></td>
|
||||||
|
<td class="summary">Return pos for grid node index</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_size">get_size(self, border)</a></td>
|
||||||
|
<td class="summary">Return grid content size</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, parent)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove">remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instant=false]])</a></td>
|
||||||
|
<td class="summary">Remove the item from the grid.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_position_function">set_position_function(self, callback)</a></td>
|
<td class="name" nowrap><a href="#set_position_function">set_position_function(self, callback)</a></td>
|
||||||
<td class="summary">Change set position function for grid nodes.</td>
|
<td class="summary">Change set position function for grid nodes.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#clear">clear(self)</a></td>
|
|
||||||
<td class="summary">Clear grid nodes array.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#_get_side_vector">_get_side_vector(self, side, is_forward)</a></td>
|
|
||||||
<td class="summary">Return side vector to correct node shifting</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_add_item">on_add_item</a></td>
|
<td class="name" nowrap><a href="#border">border</a></td>
|
||||||
<td class="summary">On item add callback(self, node, index)</td>
|
<td class="summary">The size of item content</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_remove_item">on_remove_item</a></td>
|
|
||||||
<td class="summary">On item remove callback(self, index)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_change_items">on_change_items</a></td>
|
|
||||||
<td class="summary">On item add or remove callback(self, index)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_clear">on_clear</a></td>
|
|
||||||
<td class="summary">On grid clear callback(self)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_update_positions">on_update_positions</a></td>
|
|
||||||
<td class="summary">On update item positions callback(self)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#parent">parent</a></td>
|
|
||||||
<td class="summary">Parent gui node</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#nodes">nodes</a></td>
|
|
||||||
<td class="summary">List of all grid elements.</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#first_index">first_index</a></td>
|
<td class="name" nowrap><a href="#first_index">first_index</a></td>
|
||||||
@ -168,8 +146,32 @@
|
|||||||
<td class="summary">Item size</td>
|
<td class="summary">Item size</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#border">border</a></td>
|
<td class="name" nowrap><a href="#nodes">nodes</a></td>
|
||||||
<td class="summary">The size of item content</td>
|
<td class="summary">List of all grid elements.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_add_item">on_add_item</a></td>
|
||||||
|
<td class="summary">On item add callback(self, node, index)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_change_items">on_change_items</a></td>
|
||||||
|
<td class="summary">On item add or remove callback(self, index)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_clear">on_clear</a></td>
|
||||||
|
<td class="summary">On grid clear callback(self)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_remove_item">on_remove_item</a></td>
|
||||||
|
<td class="summary">On item remove callback(self, index)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_update_positions">on_update_positions</a></td>
|
||||||
|
<td class="summary">On update item positions callback(self)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#parent">parent</a></td>
|
||||||
|
<td class="summary">Parent gui node</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -181,22 +183,63 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "_get_side_vector"></a>
|
||||||
<strong>init(self, parent)</strong>
|
<strong>_get_side_vector(self, side, is_forward)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Component init function
|
Return side vector to correct node shifting
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">side</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_forward</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "add"></a>
|
||||||
|
<strong>add(self, node[, index[, shift_policy=SHIFT.RIGHT[, is_instant=false]]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Add new node to the grid
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">parent</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
The gui node parent, where items will be placed
|
Gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">index</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The node position. By default add as last node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">shift_policy</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
How shift nodes, if required. See const.SHIFT
|
||||||
|
(<em>default</em> SHIFT.RIGHT)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_instant</span>
|
||||||
|
<span class="types"><span class="type">boolean</span></span>
|
||||||
|
If true, update node positions instantly
|
||||||
|
(<em>default</em> false)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -204,6 +247,146 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "clear"></a>
|
||||||
|
<strong>clear(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Clear grid nodes array. GUI nodes will be not deleted!
|
||||||
|
If you want to delete GUI nodes, use dynamic_grid.nodes array before grid:clear
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">druid.dynamic_grid</span></span>
|
||||||
|
Current grid instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_all_pos"></a>
|
||||||
|
<strong>get_all_pos(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return array of all node positions
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3[]</span></span>
|
||||||
|
All grid node positions
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_borders"></a>
|
||||||
|
<strong>get_borders(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return grid content borders
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
The grid content borders
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_index_by_node"></a>
|
||||||
|
<strong>get_index_by_node(self, node)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return grid index by node
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
The gui node in the grid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The node index
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_offset"></a>
|
||||||
|
<strong>get_offset(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return DynamicGrid offset, where DynamicGrid content starts.
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a> The DynamicGrid instance
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
The DynamicGrid offset
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_pos"></a>
|
<a name = "get_pos"></a>
|
||||||
@ -217,7 +400,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">index</span>
|
<li><span class="parameter">index</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
@ -244,87 +427,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "add"></a>
|
|
||||||
<strong>add(self, node[, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]])</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Add new node to the grid
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">node</span>
|
|
||||||
<span class="types"><span class="type">node</span></span>
|
|
||||||
Gui node
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">index</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
The node position. By default add as last node
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">shift_policy</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
How shift nodes, if required. See const.SHIFT
|
|
||||||
(<em>default</em> SHIFT.RIGHT)
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">is_instance</span>
|
|
||||||
<span class="types"><span class="type">boolean</span></span>
|
|
||||||
If true, update node positions instantly
|
|
||||||
(<em>default</em> false)
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "remove"></a>
|
|
||||||
<strong>remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]])</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Remove the item from the grid. Note that gui node will be not deleted
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">index</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
The grid node index to remove
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">shift_policy</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
How shift nodes, if required. See const.SHIFT
|
|
||||||
(<em>default</em> SHIFT.RIGHT)
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">is_instance</span>
|
|
||||||
<span class="types"><span class="type">boolean</span></span>
|
|
||||||
If true, update node positions instantly
|
|
||||||
(<em>default</em> false)
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Node</span></span>
|
|
||||||
The deleted gui node from grid
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_size"></a>
|
<a name = "get_size"></a>
|
||||||
@ -338,7 +440,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">border</span>
|
<li><span class="parameter">border</span>
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
@ -358,111 +460,65 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_offset"></a>
|
<a name = "init"></a>
|
||||||
<strong>get_offset(self)</strong>
|
<strong>init(self, parent)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return DynamicGrid offset, where DynamicGrid content starts.
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
The DynamicGrid instance
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
<li><span class="parameter">parent</span>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
The DynamicGrid offset
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_borders"></a>
|
|
||||||
<strong>get_borders(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return grid content borders
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
The grid content borders
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_index_by_node"></a>
|
|
||||||
<strong>get_index_by_node(self, node)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return grid index by node
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">node</span>
|
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
The gui node in the grid
|
The gui node parent, where items will be placed
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
The node index
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_all_pos"></a>
|
<a name = "remove"></a>
|
||||||
<strong>get_all_pos(self)</strong>
|
<strong>remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instant=false]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return array of all node positions
|
Remove the item from the grid. Note that gui node will be not deleted
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">index</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The grid node index to remove
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">shift_policy</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
How shift nodes, if required. See const.SHIFT
|
||||||
|
(<em>default</em> SHIFT.RIGHT)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_instant</span>
|
||||||
|
<span class="types"><span class="type">boolean</span></span>
|
||||||
|
If true, update node positions instantly
|
||||||
|
(<em>default</em> false)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
<h3>Returns:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<span class="types"><span class="type">vector3[]</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
All grid node positions
|
The deleted gui node from grid
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -482,7 +538,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
<span class="types"><span class="type">DynamicGrid</span></span>
|
||||||
|
<a href="../modules/DynamicGrid.html#">DynamicGrid</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">callback</span>
|
<li><span class="parameter">callback</span>
|
||||||
<span class="types"><span class="type">function</span></span>
|
<span class="types"><span class="type">function</span></span>
|
||||||
@ -500,196 +556,22 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "clear"></a>
|
|
||||||
<strong>clear(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Clear grid nodes array. GUI nodes will be not deleted!
|
|
||||||
If you want to delete GUI nodes, use dynamic_grid.nodes array before grid:clear
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">DynamicGrid</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">druid.dynamic_grid</span></span>
|
|
||||||
Current grid instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "_get_side_vector"></a>
|
|
||||||
<strong>_get_side_vector(self, side, is_forward)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return side vector to correct node shifting
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">side</span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">is_forward</span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_add_item"></a>
|
<a name = "border"></a>
|
||||||
<strong>on_add_item</strong>
|
<strong>border</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On item add callback(self, node, index)
|
The size of item content
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_add_item</span>
|
<li><span class="parameter">border</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">vector4</span></span>
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_remove_item"></a>
|
|
||||||
<strong>on_remove_item</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On item remove callback(self, index)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_remove_item</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_change_items"></a>
|
|
||||||
<strong>on_change_items</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On item add or remove callback(self, index)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_change_items</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_clear"></a>
|
|
||||||
<strong>on_clear</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On grid clear callback(self)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_clear</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_update_positions"></a>
|
|
||||||
<strong>on_update_positions</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On update item positions callback(self)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_update_positions</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "parent"></a>
|
|
||||||
<strong>parent</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Parent gui node
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">parent</span>
|
|
||||||
<span class="types"><span class="type">node</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "nodes"></a>
|
|
||||||
<strong>nodes</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
List of all grid elements. Contains from node, pos, size, pivot
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">nodes</span>
|
|
||||||
<span class="types"><span class="type">node[]</span></span>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -760,16 +642,136 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "border"></a>
|
<a name = "nodes"></a>
|
||||||
<strong>border</strong>
|
<strong>nodes</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
The size of item content
|
List of all grid elements. Contains from node, pos, size, pivot
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">border</span>
|
<li><span class="parameter">nodes</span>
|
||||||
<span class="types"><span class="type">vector4</span></span>
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_add_item"></a>
|
||||||
|
<strong>on_add_item</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On item add callback(self, node, index)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_add_item</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_change_items"></a>
|
||||||
|
<strong>on_change_items</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On item add or remove callback(self, index)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change_items</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_clear"></a>
|
||||||
|
<strong>on_clear</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On grid clear callback(self)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_clear</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_remove_item"></a>
|
||||||
|
<strong>on_remove_item</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On item remove callback(self, index)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_remove_item</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_update_positions"></a>
|
||||||
|
<strong>on_update_positions</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On update item positions callback(self)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_update_positions</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "parent"></a>
|
||||||
|
<strong>parent</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Parent gui node
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">parent</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -786,7 +788,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
427
docs/modules/Helper.html
Normal file
427
docs/modules/Helper.html
Normal file
@ -0,0 +1,427 @@
|
|||||||
|
<!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>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><strong>Helper</strong></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>Helper</code></h1>
|
||||||
|
<p>Druid helper module for gui layouts</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.centrate_icon_with_text">helper.centrate_icon_with_text([icon_node[, text_node[, margin=0]]])</a></td>
|
||||||
|
<td class="summary">Center two nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.centrate_nodes">helper.centrate_nodes([margin=0[, ...]])</a></td>
|
||||||
|
<td class="summary">Center several nodes nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.centrate_text_with_icon">helper.centrate_text_with_icon([text_node][, icon_node], margin)</a></td>
|
||||||
|
<td class="summary">Center two nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.deprecated">helper.deprecated(message)</a></td>
|
||||||
|
<td class="summary">Show deprecated message.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.get_border">helper.get_border(node, offset)</a></td>
|
||||||
|
<td class="summary">Distance from node position to his borders</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.get_closest_stencil_node">helper.get_closest_stencil_node(node)</a></td>
|
||||||
|
<td class="summary">Return closest non inverted clipping parent node for node</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.get_pivot_offset">helper.get_pivot_offset(pivot)</a></td>
|
||||||
|
<td class="summary">Get node offset for given gui pivot</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.is_enabled">helper.is_enabled(node)</a></td>
|
||||||
|
<td class="summary">Check if node is enabled in gui hierarchy.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.is_mobile">helper.is_mobile()</a></td>
|
||||||
|
<td class="summary">Check if device is mobile (Android or iOS)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#helper.is_web">helper.is_web()</a></td>
|
||||||
|
<td class="summary">Check if device is HTML5</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#table_to_string">table_to_string(t)</a></td>
|
||||||
|
<td class="summary">Transform table to oneline string</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.centrate_icon_with_text"></a>
|
||||||
|
<strong>helper.centrate_icon_with_text([icon_node[, text_node[, margin=0]]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Center two nodes.
|
||||||
|
Nodes will be center around 0 x position
|
||||||
|
icon_node will be first (at left side)
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">icon_node</span>
|
||||||
|
<span class="types"><span class="type">box</span></span>
|
||||||
|
Gui box node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">text_node</span>
|
||||||
|
<span class="types"><span class="type">text</span></span>
|
||||||
|
Gui text node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">margin</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Offset between nodes
|
||||||
|
(<em>default</em> 0)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.centrate_nodes"></a>
|
||||||
|
<strong>helper.centrate_nodes([margin=0[, ...]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Center several nodes nodes.
|
||||||
|
Nodes will be center around 0 x position
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">margin</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Offset between nodes
|
||||||
|
(<em>default</em> 0)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">...</span>
|
||||||
|
<span class="types"><span class="type">Node</span></span>
|
||||||
|
Any count of gui Node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.centrate_text_with_icon"></a>
|
||||||
|
<strong>helper.centrate_text_with_icon([text_node][, icon_node], margin)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Center two nodes.
|
||||||
|
Nodes will be center around 0 x position
|
||||||
|
text_node will be first (at left side)
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">text_node</span>
|
||||||
|
<span class="types"><span class="type">text</span></span>
|
||||||
|
Gui text node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">icon_node</span>
|
||||||
|
<span class="types"><span class="type">box</span></span>
|
||||||
|
Gui box node
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">margin</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Offset between nodes
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.deprecated"></a>
|
||||||
|
<strong>helper.deprecated(message)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Show deprecated message. Once time per message
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">message</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
The deprecated message
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.get_border"></a>
|
||||||
|
<strong>helper.get_border(node, offset)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Distance from node position to his borders
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
The gui node to check
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">offset</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
The offset to add to result
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
vector4 Vector with distance to node border: (left, top, right, down)
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.get_closest_stencil_node"></a>
|
||||||
|
<strong>helper.get_closest_stencil_node(node)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return closest non inverted clipping parent node for node
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">node</span> or <span class="type">nil</span></span>
|
||||||
|
The clipping node
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.get_pivot_offset"></a>
|
||||||
|
<strong>helper.get_pivot_offset(pivot)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Get node offset for given gui pivot
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">pivot</span>
|
||||||
|
<span class="types"><span class="type">gui.pivot</span></span>
|
||||||
|
The node pivot
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Vector offset with [-1..1] values
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.is_enabled"></a>
|
||||||
|
<strong>helper.is_enabled(node)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Check if node is enabled in gui hierarchy.
|
||||||
|
Return false, if node or any his parent is disabled
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Is enabled in hierarchy
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.is_mobile"></a>
|
||||||
|
<strong>helper.is_mobile()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Check if device is mobile (Android or iOS)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "helper.is_web"></a>
|
||||||
|
<strong>helper.is_web()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Check if device is HTML5
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "table_to_string"></a>
|
||||||
|
<strong>table_to_string(t)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Transform table to oneline string
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">t</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
|
||||||
|
</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>
|
||||||
|
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</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 2022-03-11 20:55:29 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><strong>Hover</strong></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><strong>Hover</strong></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,12 +83,8 @@
|
|||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_hover">set_hover(self, state)</a></td>
|
<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
|
||||||
<td class="summary">Set hover state</td>
|
<td class="summary">Return current hover enabled state</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_mouse_hover">set_mouse_hover(self, state)</a></td>
|
|
||||||
<td class="summary">Set mouse hover state</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
||||||
@ -97,8 +95,12 @@
|
|||||||
<td class="summary">Set enable state of hover component.</td>
|
<td class="summary">Set enable state of hover component.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
|
<td class="name" nowrap><a href="#set_hover">set_hover(self, state)</a></td>
|
||||||
<td class="summary">Return current hover enabled state</td>
|
<td class="summary">Set hover state</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_mouse_hover">set_mouse_hover(self, state)</a></td>
|
||||||
|
<td class="summary">Set mouse hover state</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
@ -132,7 +134,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Hover</span></span>
|
<span class="types"><span class="type">Hover</span></span>
|
||||||
|
<a href="../modules/Hover.html#">Hover</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
@ -150,50 +152,27 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_hover"></a>
|
<a name = "is_enabled"></a>
|
||||||
<strong>set_hover(self, state)</strong>
|
<strong>is_enabled(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set hover state
|
Return current hover enabled state
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Hover</span></span>
|
<span class="types"><span class="type">Hover</span></span>
|
||||||
|
<a href="../modules/Hover.html#">Hover</a>
|
||||||
</li>
|
|
||||||
<li><span class="parameter">state</span>
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
|
||||||
The hover state
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_mouse_hover"></a>
|
|
||||||
<strong>set_mouse_hover(self, state)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set mouse hover state
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Hover</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">state</span>
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
The mouse hover state
|
The hover enabled state
|
||||||
</li>
|
</ol>
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -212,7 +191,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Hover</span></span>
|
<span class="types"><span class="type">Hover</span></span>
|
||||||
|
<a href="../modules/Hover.html#">Hover</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">zone</span>
|
<li><span class="parameter">zone</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
@ -239,7 +218,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Hover</span></span>
|
<span class="types"><span class="type">Hover</span></span>
|
||||||
|
<a href="../modules/Hover.html#">Hover</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">state</span>
|
<li><span class="parameter">state</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
@ -253,27 +232,50 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "is_enabled"></a>
|
<a name = "set_hover"></a>
|
||||||
<strong>is_enabled(self)</strong>
|
<strong>set_hover(self, state)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return current hover enabled state
|
Set hover state
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Hover</span></span>
|
<span class="types"><span class="type">Hover</span></span>
|
||||||
|
<a href="../modules/Hover.html#">Hover</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
The hover state
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_mouse_hover"></a>
|
||||||
|
<strong>set_mouse_hover(self, state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set mouse hover state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Hover</span></span>
|
||||||
|
<a href="../modules/Hover.html#">Hover</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
The hover enabled state
|
The mouse hover state
|
||||||
</ol>
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -293,8 +295,8 @@
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_hover</span>
|
<li><span class="parameter">on_hover</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -313,8 +315,8 @@
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_mouse_hover</span>
|
<li><span class="parameter">on_mouse_hover</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -330,7 +332,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -41,29 +41,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><strong>Input</strong></li>
|
<li><strong>Input</strong></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -83,32 +85,36 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_text">set_text(self, input_text)</a></td>
|
<td class="name" nowrap><a href="#get_text">get_text(self)</a></td>
|
||||||
<td class="summary">Set text for input field</td>
|
<td class="summary">Return current input field text</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, click_node, text_node[, keyboard_type])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#reset_changes">reset_changes(self)</a></td>
|
||||||
|
<td class="summary">Reset current input selection and return previous value</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#select">select(self)</a></td>
|
<td class="name" nowrap><a href="#select">select(self)</a></td>
|
||||||
<td class="summary">Select input field.</td>
|
<td class="summary">Select input field.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#unselect">unselect(self)</a></td>
|
<td class="name" nowrap><a href="#set_allowed_characters">set_allowed_characters(self, characters)</a></td>
|
||||||
<td class="summary">Remove selection from input.</td>
|
<td class="summary">Set allowed charaters for input field.</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_text">get_text(self)</a></td>
|
|
||||||
<td class="summary">Return current input field text</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_max_length">set_max_length(self, max_length)</a></td>
|
<td class="name" nowrap><a href="#set_max_length">set_max_length(self, max_length)</a></td>
|
||||||
<td class="summary">Set maximum length for input field.</td>
|
<td class="summary">Set maximum length for input field.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_allowed_characters">set_allowed_characters(self, characters)</a></td>
|
<td class="name" nowrap><a href="#set_text">set_text(self, input_text)</a></td>
|
||||||
<td class="summary">Set allowed charaters for input field.</td>
|
<td class="summary">Set text for input field</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#reset_changes">reset_changes(self)</a></td>
|
<td class="name" nowrap><a href="#unselect">unselect(self)</a></td>
|
||||||
<td class="summary">Reset current input selection and return previous value</td>
|
<td class="summary">Remove selection from input.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Tables">Tables</a></h2>
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
@ -121,16 +127,28 @@
|
|||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_input_select">on_input_select</a></td>
|
<td class="name" nowrap><a href="#allowerd_characters">allowerd_characters</a></td>
|
||||||
<td class="summary">On input field select callback(self, button_node)</td>
|
<td class="summary">Pattern matching for user input</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_input_unselect">on_input_unselect</a></td>
|
<td class="name" nowrap><a href="#button">button</a></td>
|
||||||
<td class="summary">On input field unselect callback(self, input_text)</td>
|
<td class="summary">Button component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_input_text">on_input_text</a></td>
|
<td class="name" nowrap><a href="#is_empty">is_empty</a></td>
|
||||||
<td class="summary">On input field text change callback(self, input_text)</td>
|
<td class="summary">Is current input is empty now</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#is_selected">is_selected</a></td>
|
||||||
|
<td class="summary">Is current input selected now</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#keyboard_type">keyboard_type</a></td>
|
||||||
|
<td class="summary">Gui keyboard type for input field</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#max_length">max_length</a></td>
|
||||||
|
<td class="summary">Max length for input text</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_input_empty">on_input_empty</a></td>
|
<td class="name" nowrap><a href="#on_input_empty">on_input_empty</a></td>
|
||||||
@ -141,6 +159,18 @@
|
|||||||
<td class="summary">On input field text change to max length string callback(self, input_text)</td>
|
<td class="summary">On input field text change to max length string callback(self, input_text)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_input_select">on_input_select</a></td>
|
||||||
|
<td class="summary">On input field select callback(self, button_node)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_input_text">on_input_text</a></td>
|
||||||
|
<td class="summary">On input field text change callback(self, input_text)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_input_unselect">on_input_unselect</a></td>
|
||||||
|
<td class="summary">On input field unselect callback(self, input_text)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_input_wrong">on_input_wrong</a></td>
|
<td class="name" nowrap><a href="#on_input_wrong">on_input_wrong</a></td>
|
||||||
<td class="summary">On trying user input with not allowed character callback(self, params, button_instance)</td>
|
<td class="summary">On trying user input with not allowed character callback(self, params, button_instance)</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -148,30 +178,6 @@
|
|||||||
<td class="name" nowrap><a href="#text">text</a></td>
|
<td class="name" nowrap><a href="#text">text</a></td>
|
||||||
<td class="summary">Text component</td>
|
<td class="summary">Text component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#button">button</a></td>
|
|
||||||
<td class="summary">Button component</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#is_selected">is_selected</a></td>
|
|
||||||
<td class="summary">Is current input selected now</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#is_empty">is_empty</a></td>
|
|
||||||
<td class="summary">Is current input is empty now</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#max_length">max_length</a></td>
|
|
||||||
<td class="summary">Max length for input text</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#allowerd_characters">allowerd_characters</a></td>
|
|
||||||
<td class="summary">Pattern matching for user input</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#keyboard_type">keyboard_type</a></td>
|
|
||||||
<td class="summary">Gui keyboard type for input field</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -182,22 +188,79 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_text"></a>
|
<a name = "get_text"></a>
|
||||||
<strong>set_text(self, input_text)</strong>
|
<strong>get_text(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text for input field
|
Return current input field text
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Input</span></span>
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">input_text</span>
|
</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>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
The string to apply for input field
|
The current input field text
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, click_node, text_node[, keyboard_type])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">click_node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Button node to enabled input component
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">text_node</span>
|
||||||
|
<span class="types"><span class="type">node</span> or <span class="type">Text</span></span>
|
||||||
|
Text node what will be changed on user input. You can pass text component instead of text node name <a href="../modules/Text.html#">Text</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">keyboard_type</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Gui keyboard type for input field
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "reset_changes"></a>
|
||||||
|
<strong>reset_changes(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Reset current input selection and return previous value
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -218,7 +281,97 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Input</span></span>
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_allowed_characters"></a>
|
||||||
|
<strong>set_allowed_characters(self, characters)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set allowed charaters for input field.
|
||||||
|
See: https://defold.com/ref/stable/string/
|
||||||
|
ex: [%a%d] for alpha and numeric
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">characters</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Regulax exp. for validate user input
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">druid.input</span></span>
|
||||||
|
Current input instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_max_length"></a>
|
||||||
|
<strong>set_max_length(self, max_length)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set maximum length for input field.
|
||||||
|
Pass nil to make input field unliminted (by default)
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">max_length</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Maximum length for input text field
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">druid.input</span></span>
|
||||||
|
Current input instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_text"></a>
|
||||||
|
<strong>set_text(self, input_text)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set text for input field
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">input_text</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
The string to apply for input field
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -239,120 +392,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Input</span></span>
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_text"></a>
|
|
||||||
<strong>get_text(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return current input field text
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Input</span></span>
|
|
||||||
|
|
||||||
</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>
|
|
||||||
The current input field text
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_max_length"></a>
|
|
||||||
<strong>set_max_length(self, max_length)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set maximum length for input field.
|
|
||||||
Pass nil to make input field unliminted (by default)
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Input</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">max_length</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Maximum length for input text field
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">druid.input</span></span>
|
|
||||||
Current input instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_allowed_characters"></a>
|
|
||||||
<strong>set_allowed_characters(self, characters)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set allowed charaters for input field.
|
|
||||||
See: https://defold.com/ref/stable/string/
|
|
||||||
ex: [%a%d] for alpha and numeric
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Input</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">characters</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
||||||
Regulax exp. for validate user input
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">druid.input</span></span>
|
|
||||||
Current input instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "reset_changes"></a>
|
|
||||||
<strong>reset_changes(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Reset current input selection and return previous value
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Input</span></span>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -420,137 +460,18 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_input_select"></a>
|
<a name = "allowerd_characters"></a>
|
||||||
<strong>on_input_select</strong>
|
<strong>allowerd_characters</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On input field select callback(self, button_node)
|
Pattern matching for user input
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_input_select</span>
|
<li><span class="parameter">allowerd_characters</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_input_unselect"></a>
|
|
||||||
<strong>on_input_unselect</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On input field unselect callback(self, input_text)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_input_unselect</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_input_text"></a>
|
|
||||||
<strong>on_input_text</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On input field text change callback(self, input_text)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_input_text</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_input_empty"></a>
|
|
||||||
<strong>on_input_empty</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On input field text change to empty string callback(self, input_text)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_input_empty</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_input_full"></a>
|
|
||||||
<strong>on_input_full</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On input field text change to max length string callback(self, input_text)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_input_full</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_input_wrong"></a>
|
|
||||||
<strong>on_input_wrong</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On trying user input with not allowed character callback(self, params, button_instance)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_input_wrong</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "text"></a>
|
|
||||||
<strong>text</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Text component
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">text</span>
|
|
||||||
<span class="types"><span class="type">druid.text</span></span>
|
|
||||||
|
|
||||||
|
(<em>optional</em>)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -569,7 +490,27 @@
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">button</span>
|
<li><span class="parameter">button</span>
|
||||||
<span class="types"><span class="type">druid.button</span></span>
|
<span class="types"><span class="type">Button</span></span>
|
||||||
|
<a href="../modules/Button.html#">Button</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "is_empty"></a>
|
||||||
|
<strong>is_empty</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Is current input is empty now
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">is_empty</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -600,16 +541,16 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "is_empty"></a>
|
<a name = "keyboard_type"></a>
|
||||||
<strong>is_empty</strong>
|
<strong>keyboard_type</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Is current input is empty now
|
Gui keyboard type for input field
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">is_empty</span>
|
<li><span class="parameter">keyboard_type</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -641,18 +582,17 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "allowerd_characters"></a>
|
<a name = "on_input_empty"></a>
|
||||||
<strong>allowerd_characters</strong>
|
<strong>on_input_empty</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Pattern matching for user input
|
On input field text change to empty string callback(self, input_text)
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">allowerd_characters</span>
|
<li><span class="parameter">on_input_empty</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"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -662,17 +602,117 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "keyboard_type"></a>
|
<a name = "on_input_full"></a>
|
||||||
<strong>keyboard_type</strong>
|
<strong>on_input_full</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Gui keyboard type for input field
|
On input field text change to max length string callback(self, input_text)
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">keyboard_type</span>
|
<li><span class="parameter">on_input_full</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_input_select"></a>
|
||||||
|
<strong>on_input_select</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On input field select callback(self, button_node)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_input_select</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_input_text"></a>
|
||||||
|
<strong>on_input_text</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On input field text change callback(self, input_text)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_input_text</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_input_unselect"></a>
|
||||||
|
<strong>on_input_unselect</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On input field unselect callback(self, input_text)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_input_unselect</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_input_wrong"></a>
|
||||||
|
<strong>on_input_wrong</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On trying user input with not allowed character callback(self, params, button_instance)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_input_wrong</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "text"></a>
|
||||||
|
<strong>text</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Text component
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">text</span>
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -688,7 +728,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><strong>LangText</strong></li>
|
<li><strong>LangText</strong></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -77,6 +79,10 @@
|
|||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#format">format(self[, a[, b[, c[, d[, e[, f[, g]]]]]]])</a></td>
|
||||||
|
<td class="summary">Format string with new text params on localized text</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, node, locale_id, no_adjust)</a></td>
|
<td class="name" nowrap><a href="#init">init(self, node, locale_id, no_adjust)</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
@ -86,13 +92,9 @@
|
|||||||
<td class="summary">Setup raw text to lang_text component</td>
|
<td class="summary">Setup raw text to lang_text component</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#translate">translate(self, locale_id, ...)</a></td>
|
<td class="name" nowrap><a href="#translate">translate(self, locale_id[, a[, b[, c[, d[, e[, f[, g]]]]]]])</a></td>
|
||||||
<td class="summary">Translate the text by locale_id</td>
|
<td class="summary">Translate the text by locale_id</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#format">format(self, ...)</a></td>
|
|
||||||
<td class="summary">Format string with new text params on localized text</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
@ -113,6 +115,68 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "format"></a>
|
||||||
|
<strong>format(self[, a[, b[, c[, d[, e[, f[, g]]]]]]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Format string with new text params on localized text
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">LangText</span></span>
|
||||||
|
<a href="../modules/LangText.html#">LangText</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">a</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">b</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">c</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">d</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">e</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">f</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">g</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">LangText</span></span>
|
||||||
|
Current instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node, locale_id, no_adjust)</strong>
|
<strong>init(self, node, locale_id, no_adjust)</strong>
|
||||||
@ -125,7 +189,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">LangText</span></span>
|
<span class="types"><span class="type">LangText</span></span>
|
||||||
|
<a href="../modules/LangText.html#">LangText</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><span class="type">node</span></span>
|
<span class="types"><span class="type">node</span></span>
|
||||||
@ -158,7 +222,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">LangText</span></span>
|
<span class="types"><span class="type">LangText</span></span>
|
||||||
|
<a href="../modules/LangText.html#">LangText</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">text</span>
|
<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></span>
|
||||||
@ -179,7 +243,7 @@
|
|||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "translate"></a>
|
<a name = "translate"></a>
|
||||||
<strong>translate(self, locale_id, ...)</strong>
|
<strong>translate(self, locale_id[, a[, b[, c[, d[, e[, f[, g]]]]]]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Translate the text by locale_id
|
Translate the text by locale_id
|
||||||
@ -189,46 +253,46 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">LangText</span></span>
|
<span class="types"><span class="type">LangText</span></span>
|
||||||
|
<a href="../modules/LangText.html#">LangText</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">locale_id</span>
|
<li><span class="parameter">locale_id</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></span>
|
||||||
Locale id
|
Locale id
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">...</span>
|
<li><span class="parameter">a</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></span>
|
||||||
Locale arguments to pass in text function
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
<li><span class="parameter">b</span>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">LangText</span></span>
|
|
||||||
Current instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "format"></a>
|
|
||||||
<strong>format(self, ...)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Format string with new text params on localized text
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">LangText</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">...</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></span>
|
||||||
Locale arguments to pass in text function
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">c</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">d</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">e</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">f</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">g</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Optional param to string.format
|
||||||
|
(<em>optional</em>)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -257,8 +321,8 @@
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_change</span>
|
<li><span class="parameter">on_change</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -278,7 +342,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">text</span>
|
<li><span class="parameter">text</span>
|
||||||
<span class="types"><span class="type">Text</span></span>
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -294,7 +358,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
297
docs/modules/PinKnob.html
Normal file
297
docs/modules/PinKnob.html
Normal file
@ -0,0 +1,297 @@
|
|||||||
|
<!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="#Fields">Fields</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><strong>PinKnob</strong></li>
|
||||||
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>PinKnob</code></h1>
|
||||||
|
<p>Druid pin knob custom component.</p>
|
||||||
|
<p>
|
||||||
|
It's simple rotating input element</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, callback, template, nodes)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_angle">set_angle(self, cur_value, min, max)</a></td>
|
||||||
|
<td class="summary">Set current and min/max angles for component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_friction">set_friction(self[, value=1])</a></td>
|
||||||
|
<td class="summary">Set current and min/max angles for component</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<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="#is_drag">is_drag</a></td>
|
||||||
|
<td class="summary">Is currently under user control</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
|
<td class="summary">The pin node</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(self, callback, template, nodes)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">PinKnob</span></span>
|
||||||
|
<a href="../modules/PinKnob.html#">PinKnob</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback(self, value) on value changed
|
||||||
|
</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 template string name
|
||||||
|
</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>
|
||||||
|
Nodes table from gui.clone_tree
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_angle"></a>
|
||||||
|
<strong>set_angle(self, cur_value, min, max)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set current and min/max angles for component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">PinKnob</span></span>
|
||||||
|
<a href="../modules/PinKnob.html#">PinKnob</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">cur_value</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The new value for pin knob
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">min</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The minimum value for pin knob
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">max</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The maximum value for pin knob
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">PinKnob</span></span>
|
||||||
|
<a href="../modules/PinKnob.html#">PinKnob</a>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_friction"></a>
|
||||||
|
<strong>set_friction(self[, value=1])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set current and min/max angles for component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">PinKnob</span></span>
|
||||||
|
<a href="../modules/PinKnob.html#">PinKnob</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">value</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The spin speed multiplier
|
||||||
|
(<em>default</em> 1)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">PinKnob</span></span>
|
||||||
|
<a href="../modules/PinKnob.html#">PinKnob</a>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "druid"></a>
|
||||||
|
<strong>druid</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
The component druid instance
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">druid</span>
|
||||||
|
<span class="types"><span class="type">DruidInstance</span></span>
|
||||||
|
<a href="../modules/DruidInstance.html#">DruidInstance</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "is_drag"></a>
|
||||||
|
<strong>is_drag</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Is currently under user control
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">is_drag</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "node"></a>
|
||||||
|
<strong>node</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
The pin node
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/PinKnob.html#node">node</a></span>
|
||||||
|
|
||||||
|
</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 2022-03-11 20:55:29 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -41,29 +41,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><strong>Progress</strong></li>
|
<li><strong>Progress</strong></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -79,30 +81,30 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, node, key[, init_value=1])</a></td>
|
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Empty a progress bar</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#fill">fill(self)</a></td>
|
<td class="name" nowrap><a href="#fill">fill(self)</a></td>
|
||||||
<td class="summary">Fill a progress bar and stop progress animation</td>
|
<td class="summary">Fill a progress bar and stop progress animation</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
|
||||||
<td class="summary">Empty a progress bar</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_to">set_to(self, to)</a></td>
|
|
||||||
<td class="summary">Instant fill progress bar to value</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get">get(self)</a></td>
|
<td class="name" nowrap><a href="#get">get(self)</a></td>
|
||||||
<td class="summary">Return current progress bar value</td>
|
<td class="summary">Return current progress bar value</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, node, key[, init_value=1])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_steps">set_steps(self, steps, callback)</a></td>
|
<td class="name" nowrap><a href="#set_steps">set_steps(self, steps, callback)</a></td>
|
||||||
<td class="summary">Set points on progress bar to fire the callback</td>
|
<td class="summary">Set points on progress bar to fire the callback</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_to">set_to(self, to)</a></td>
|
||||||
|
<td class="summary">Instant fill progress bar to value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
|
<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
|
||||||
<td class="summary">Start animation of a progress bar</td>
|
<td class="summary">Start animation of a progress bar</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -117,16 +119,20 @@
|
|||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_change">on_change</a></td>
|
<td class="name" nowrap><a href="#key">key</a></td>
|
||||||
<td class="summary">On progress bar change callback(self, new_value)</td>
|
<td class="summary">The progress bar direction</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#max_size">max_size</a></td>
|
||||||
|
<td class="summary">Maximum size of progress bar</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#node">node</a></td>
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
<td class="summary">Progress bar fill node</td>
|
<td class="summary">Progress bar fill node</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#key">key</a></td>
|
<td class="name" nowrap><a href="#on_change">on_change</a></td>
|
||||||
<td class="summary">The progress bar direction</td>
|
<td class="summary">On progress bar change callback(self, new_value)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#scale">scale</a></td>
|
<td class="name" nowrap><a href="#scale">scale</a></td>
|
||||||
@ -137,10 +143,6 @@
|
|||||||
<td class="summary">Current progress bar size</td>
|
<td class="summary">Current progress bar size</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#max_size">max_size</a></td>
|
|
||||||
<td class="summary">Maximum size of progress bar</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#slice">slice</a></td>
|
<td class="name" nowrap><a href="#slice">slice</a></td>
|
||||||
<td class="summary">Progress bar slice9 settings</td>
|
<td class="summary">Progress bar slice9 settings</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -153,6 +155,69 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "empty"></a>
|
||||||
|
<strong>empty(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Empty a progress bar
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Progress</span></span>
|
||||||
|
<a href="../modules/Progress.html#">Progress</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "fill"></a>
|
||||||
|
<strong>fill(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Fill a progress bar and stop progress animation
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Progress</span></span>
|
||||||
|
<a href="../modules/Progress.html#">Progress</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get"></a>
|
||||||
|
<strong>get(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return current progress bar value
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Progress</span></span>
|
||||||
|
<a href="../modules/Progress.html#">Progress</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node, key[, init_value=1])</strong>
|
<strong>init(self, node, key[, init_value=1])</strong>
|
||||||
@ -165,7 +230,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Progress</span></span>
|
<span class="types"><span class="type">Progress</span></span>
|
||||||
|
<a href="../modules/Progress.html#">Progress</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <a class="type" href="../modules/Progress.html#node">node</a></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <a class="type" href="../modules/Progress.html#node">node</a></span>
|
||||||
@ -186,94 +251,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "fill"></a>
|
|
||||||
<strong>fill(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Fill a progress bar and stop progress animation
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Progress</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "empty"></a>
|
|
||||||
<strong>empty(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Empty a progress bar
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Progress</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_to"></a>
|
|
||||||
<strong>set_to(self, to)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Instant fill progress bar to value
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Progress</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">to</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Progress bar value, from 0 to 1
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get"></a>
|
|
||||||
<strong>get(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return current progress bar value
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Progress</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_steps"></a>
|
<a name = "set_steps"></a>
|
||||||
@ -287,7 +264,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Progress</span></span>
|
<span class="types"><span class="type">Progress</span></span>
|
||||||
|
<a href="../modules/Progress.html#">Progress</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">steps</span>
|
<li><span class="parameter">steps</span>
|
||||||
<span class="types"><span class="type">number[]</span></span>
|
<span class="types"><span class="type">number[]</span></span>
|
||||||
@ -307,6 +284,31 @@
|
|||||||
<pre class="example">progress:set_steps({<span class="number">0</span>, <span class="number">0.3</span>, <span class="number">0.6</span>, <span class="number">1</span>}, <span class="keyword">function</span>(self, step) <span class="keyword">end</span>)</pre>
|
<pre class="example">progress:set_steps({<span class="number">0</span>, <span class="number">0.3</span>, <span class="number">0.6</span>, <span class="number">1</span>}, <span class="keyword">function</span>(self, step) <span class="keyword">end</span>)</pre>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_to"></a>
|
||||||
|
<strong>set_to(self, to)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Instant fill progress bar to value
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Progress</span></span>
|
||||||
|
<a href="../modules/Progress.html#">Progress</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Progress bar value, from 0 to 1
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "to"></a>
|
<a name = "to"></a>
|
||||||
@ -320,7 +322,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Progress</span></span>
|
<span class="types"><span class="type">Progress</span></span>
|
||||||
|
<a href="../modules/Progress.html#">Progress</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">to</span>
|
<li><span class="parameter">to</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
@ -376,16 +378,36 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_change"></a>
|
<a name = "key"></a>
|
||||||
<strong>on_change</strong>
|
<strong>key</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On progress bar change callback(self, new_value)
|
The progress bar direction
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_change</span>
|
<li><span class="parameter">key</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "max_size"></a>
|
||||||
|
<strong>max_size</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Maximum size of progress bar
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">max_size</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -416,17 +438,17 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "key"></a>
|
<a name = "on_change"></a>
|
||||||
<strong>key</strong>
|
<strong>on_change</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
The progress bar direction
|
On progress bar change callback(self, new_value)
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">key</span>
|
<li><span class="parameter">on_change</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"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -474,26 +496,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "max_size"></a>
|
|
||||||
<strong>max_size</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Maximum size of progress bar
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">max_size</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "slice"></a>
|
<a name = "slice"></a>
|
||||||
@ -522,7 +524,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><strong>RadioGroup</strong></li>
|
<li><strong>RadioGroup</strong></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,6 +78,10 @@
|
|||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
|
||||||
|
<td class="summary">Return radio group state</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, nodes, callback[, click_nodes=node])</a></td>
|
<td class="name" nowrap><a href="#init">init(self, nodes, callback[, click_nodes=node])</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
@ -84,21 +90,17 @@
|
|||||||
<td class="name" nowrap><a href="#set_state">set_state(self, index, is_instant)</a></td>
|
<td class="name" nowrap><a href="#set_state">set_state(self, index, is_instant)</a></td>
|
||||||
<td class="summary">Set radio group state</td>
|
<td class="summary">Set radio group state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
|
|
||||||
<td class="summary">Return radio group state</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_radio_click">on_radio_click</a></td>
|
|
||||||
<td class="summary">On any checkbox click</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#checkboxes">checkboxes</a></td>
|
<td class="name" nowrap><a href="#checkboxes">checkboxes</a></td>
|
||||||
<td class="summary">Array of checkbox components</td>
|
<td class="summary">Array of checkbox components</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_radio_click">on_radio_click</a></td>
|
||||||
|
<td class="summary">On any checkbox click</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -108,6 +110,33 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "get_state"></a>
|
||||||
|
<strong>get_state(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return radio group state
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">RadioGroup</span></span>
|
||||||
|
<a href="../modules/RadioGroup.html#">RadioGroup</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Index in radio group
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, nodes, callback[, click_nodes=node])</strong>
|
<strong>init(self, nodes, callback[, click_nodes=node])</strong>
|
||||||
@ -120,7 +149,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">RadioGroup</span></span>
|
<span class="types"><span class="type">RadioGroup</span></span>
|
||||||
|
<a href="../modules/RadioGroup.html#">RadioGroup</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">nodes</span>
|
<li><span class="parameter">nodes</span>
|
||||||
<span class="types"><span class="type">node[]</span></span>
|
<span class="types"><span class="type">node[]</span></span>
|
||||||
@ -154,7 +183,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">RadioGroup</span></span>
|
<span class="types"><span class="type">RadioGroup</span></span>
|
||||||
|
<a href="../modules/RadioGroup.html#">RadioGroup</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">index</span>
|
<li><span class="parameter">index</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
@ -170,58 +199,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "get_state"></a>
|
|
||||||
<strong>get_state(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return radio group state
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">RadioGroup</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Index in radio group
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
|
||||||
<a name = "on_radio_click"></a>
|
|
||||||
<strong>on_radio_click</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On any checkbox click
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_radio_click</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "checkboxes"></a>
|
<a name = "checkboxes"></a>
|
||||||
<strong>checkboxes</strong>
|
<strong>checkboxes</strong>
|
||||||
@ -241,6 +223,26 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_radio_click"></a>
|
||||||
|
<strong>on_radio_click</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On any checkbox click
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_radio_click</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -249,7 +251,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
267
docs/modules/RichInput.html
Normal file
267
docs/modules/RichInput.html
Normal file
@ -0,0 +1,267 @@
|
|||||||
|
<!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="#Fields">Fields</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><strong>RichInput</strong></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>RichInput</code></h1>
|
||||||
|
<p>Druid Rich Input custom component.</p>
|
||||||
|
<p>
|
||||||
|
It's wrapper on Input component with cursor and placeholder text</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, template, nodes)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_placeholder">set_placeholder(self, placeholder_text)</a></td>
|
||||||
|
<td class="summary">Set placeholder text</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cursor">cursor</a></td>
|
||||||
|
<td class="summary">On input field text change to empty string callback(self, input_text)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<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="#input">input</a></td>
|
||||||
|
<td class="summary">On input field text change callback(self, input_text)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#placeholder">placeholder</a></td>
|
||||||
|
<td class="summary">On input field text change to max length string callback(self, input_text)</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(self, template, nodes)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">RichInput</span></span>
|
||||||
|
<a href="../modules/RichInput.html#">RichInput</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 template string name
|
||||||
|
</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>
|
||||||
|
Nodes table from gui.clone_tree
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_placeholder"></a>
|
||||||
|
<strong>set_placeholder(self, placeholder_text)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set placeholder text
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">RichInput</span></span>
|
||||||
|
<a href="../modules/RichInput.html#">RichInput</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">placeholder_text</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
The placeholder text
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cursor"></a>
|
||||||
|
<strong>cursor</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On input field text change to empty string callback(self, input_text)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">cursor</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "druid"></a>
|
||||||
|
<strong>druid</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
The component druid instance
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">druid</span>
|
||||||
|
<span class="types"><span class="type">DruidInstance</span></span>
|
||||||
|
<a href="../modules/DruidInstance.html#">DruidInstance</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "input"></a>
|
||||||
|
<strong>input</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On input field text change callback(self, input_text)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">input</span>
|
||||||
|
<span class="types"><span class="type">Input</span></span>
|
||||||
|
<a href="../modules/Input.html#">Input</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "placeholder"></a>
|
||||||
|
<strong>placeholder</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On input field text change to max length string callback(self, input_text)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">placeholder</span>
|
||||||
|
<span class="types"><span class="type">druid.text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
|
</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 2022-03-11 20:55:29 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
File diff suppressed because it is too large
Load Diff
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><strong>Slider</strong></li>
|
<li><strong>Slider</strong></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -85,6 +87,10 @@
|
|||||||
<td class="summary">Set value for slider</td>
|
<td class="summary">Set value for slider</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_input_node">set_input_node(self, input_node)</a></td>
|
||||||
|
<td class="summary">Set input zone for slider.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_steps">set_steps(self, steps)</a></td>
|
<td class="name" nowrap><a href="#set_steps">set_steps(self, steps)</a></td>
|
||||||
<td class="summary">Set slider steps.</td>
|
<td class="summary">Set slider steps.</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -92,38 +98,38 @@
|
|||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_change_value">on_change_value</a></td>
|
<td class="name" nowrap><a href="#dist">dist</a></td>
|
||||||
<td class="summary">On change value callback(self, value)</td>
|
<td class="summary">Length between start and end position</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#node">node</a></td>
|
|
||||||
<td class="summary">Slider pin node</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#start_pos">start_pos</a></td>
|
|
||||||
<td class="summary">Start pin node position</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#pos">pos</a></td>
|
|
||||||
<td class="summary">Current pin node position</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#target_pos">target_pos</a></td>
|
|
||||||
<td class="summary">Targer pin node position</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#end_pos">end_pos</a></td>
|
<td class="name" nowrap><a href="#end_pos">end_pos</a></td>
|
||||||
<td class="summary">End pin node position</td>
|
<td class="summary">End pin node position</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#dist">dist</a></td>
|
|
||||||
<td class="summary">Length between start and end position</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
|
<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
|
||||||
<td class="summary">Current drag state</td>
|
<td class="summary">Current drag state</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
|
<td class="summary">Slider pin node</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_change_value">on_change_value</a></td>
|
||||||
|
<td class="summary">On change value callback(self, value)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#pos">pos</a></td>
|
||||||
|
<td class="summary">Current pin node position</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#start_pos">start_pos</a></td>
|
||||||
|
<td class="summary">Start pin node position</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#target_pos">target_pos</a></td>
|
||||||
|
<td class="summary">Targer pin node position</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#value">value</a></td>
|
<td class="name" nowrap><a href="#value">value</a></td>
|
||||||
<td class="summary">Current slider value</td>
|
<td class="summary">Current slider value</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -148,7 +154,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Slider</span></span>
|
<span class="types"><span class="type">Slider</span></span>
|
||||||
|
<a href="../modules/Slider.html#">Slider</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
|
||||||
@ -182,7 +188,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Slider</span></span>
|
<span class="types"><span class="type">Slider</span></span>
|
||||||
|
<a href="../modules/Slider.html#">Slider</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">value</span>
|
<li><span class="parameter">value</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
@ -199,6 +205,40 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_input_node"></a>
|
||||||
|
<strong>set_input_node(self, input_node)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set input zone for slider.
|
||||||
|
User can touch any place of node, pin instantly will
|
||||||
|
move at this position and node drag will start.
|
||||||
|
This function require the Defold version 1.3.0+
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Slider</span></span>
|
||||||
|
<a href="../modules/Slider.html#">Slider</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">input_node</span>
|
||||||
|
<span class="types"><span class="type">Node</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Slider</span></span>
|
||||||
|
<a href="../modules/Slider.html#">Slider</a>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_steps"></a>
|
<a name = "set_steps"></a>
|
||||||
@ -213,7 +253,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Slider</span></span>
|
<span class="types"><span class="type">Slider</span></span>
|
||||||
|
<a href="../modules/Slider.html#">Slider</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">steps</span>
|
<li><span class="parameter">steps</span>
|
||||||
<span class="types"><span class="type">number[]</span></span>
|
<span class="types"><span class="type">number[]</span></span>
|
||||||
@ -221,6 +261,12 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Slider</span></span>
|
||||||
|
<a href="../modules/Slider.html#">Slider</a>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -235,96 +281,16 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_change_value"></a>
|
<a name = "dist"></a>
|
||||||
<strong>on_change_value</strong>
|
<strong>dist</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On change value callback(self, value)
|
Length between start and end position
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_change_value</span>
|
<li><span class="parameter">dist</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "node"></a>
|
|
||||||
<strong>node</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Slider pin node
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">node</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "start_pos"></a>
|
|
||||||
<strong>start_pos</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Start pin node position
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">start_pos</span>
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "pos"></a>
|
|
||||||
<strong>pos</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Current pin node position
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">pos</span>
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "target_pos"></a>
|
|
||||||
<strong>target_pos</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Targer pin node position
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">target_pos</span>
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -353,26 +319,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "dist"></a>
|
|
||||||
<strong>dist</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Length between start and end position
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">dist</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "is_drag"></a>
|
<a name = "is_drag"></a>
|
||||||
@ -393,6 +339,106 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "node"></a>
|
||||||
|
<strong>node</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Slider pin node
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_change_value"></a>
|
||||||
|
<strong>on_change_value</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On change value callback(self, value)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_change_value</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "pos"></a>
|
||||||
|
<strong>pos</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Current pin node position
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "start_pos"></a>
|
||||||
|
<strong>start_pos</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Start pin node position
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">start_pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "target_pos"></a>
|
||||||
|
<strong>target_pos</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Targer pin node position
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">target_pos</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "value"></a>
|
<a name = "value"></a>
|
||||||
@ -421,7 +467,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -41,29 +41,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><strong>Swipe</strong></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><strong>Swipe</strong></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -97,17 +99,17 @@
|
|||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#node">node</a></td>
|
|
||||||
<td class="summary">Swipe node</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#click_zone">click_zone</a></td>
|
<td class="name" nowrap><a href="#click_zone">click_zone</a></td>
|
||||||
<td class="summary">Restriction zone</td>
|
<td class="summary">Restriction zone</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
|
<td class="summary">Swipe node</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_swipe">on_swipe</a></td>
|
<td class="name" nowrap><a href="#on_swipe">on_swipe</a></td>
|
||||||
<td class="summary">Trigger on swipe event(self, swipe_side, dist, delta_time</td>
|
<td class="summary">Trigger on swipe event(self, swipe_side, dist, delta_time)</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -130,7 +132,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Swipe</span></span>
|
<span class="types"><span class="type">Swipe</span></span>
|
||||||
|
<a href="../modules/Swipe.html#">Swipe</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
|
||||||
@ -160,7 +162,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Swipe</span></span>
|
<span class="types"><span class="type">Swipe</span></span>
|
||||||
|
<a href="../modules/Swipe.html#">Swipe</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">zone</span>
|
<li><span class="parameter">zone</span>
|
||||||
<span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
|
||||||
@ -215,26 +217,6 @@
|
|||||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
|
||||||
<a name = "node"></a>
|
|
||||||
<strong>node</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Swipe node
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">node</span>
|
|
||||||
<span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "click_zone"></a>
|
<a name = "click_zone"></a>
|
||||||
<strong>click_zone</strong>
|
<strong>click_zone</strong>
|
||||||
@ -255,19 +237,39 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "node"></a>
|
||||||
|
<strong>node</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Swipe node
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_swipe"></a>
|
<a name = "on_swipe"></a>
|
||||||
<strong>on_swipe</strong>
|
<strong>on_swipe</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Trigger on swipe event(self, swipe_side, dist, delta_time
|
Trigger on swipe event(self, swipe_side, dist, delta_time)
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_swipe</span>
|
<li><span class="parameter">on_swipe</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
)
|
) <a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -283,7 +285,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -41,29 +41,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><strong>Text</strong></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><strong>Text</strong></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -80,48 +82,48 @@
|
|||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#init">init(self, node[, value[, adjust_type=0]])</a></td>
|
<td class="name" nowrap><a href="#get_text_adjust">get_text_adjust(self, adjust_type)</a></td>
|
||||||
<td class="summary">Component init function</td>
|
<td class="summary">Return current text adjust type</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_text_width">get_text_width(self[, text])</a></td>
|
<td class="name" nowrap><a href="#get_text_size">get_text_size(self[, text])</a></td>
|
||||||
<td class="summary">Calculate text width with font with respect to trailing space</td>
|
<td class="summary">Calculate text width with font with respect to trailing space</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
|
<td class="name" nowrap><a href="#init">init(self, node[, value[, adjust_type=0]])</a></td>
|
||||||
<td class="summary">Set text to text field</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_color">set_color(self, 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="summary">Set alpha</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_scale">set_scale(self, 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="summary">Set text pivot.</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#is_multiline">is_multiline(self)</a></td>
|
<td class="name" nowrap><a href="#is_multiline">is_multiline(self)</a></td>
|
||||||
<td class="summary">Return true, if text with line break</td>
|
<td class="summary">Return true, if text with line break</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_text_adjust">set_text_adjust(self[, adjust_type[, minimal_scale]])</a></td>
|
<td class="name" nowrap><a href="#set_alpha">set_alpha(self, alpha)</a></td>
|
||||||
<td class="summary">Set text adjust, refresh the current text visuals, if needed</td>
|
<td class="summary">Set alpha</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_color">set_color(self, color)</a></td>
|
||||||
|
<td class="summary">Set color</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_minimal_scale">set_minimal_scale(self, minimal_scale)</a></td>
|
<td class="name" nowrap><a href="#set_minimal_scale">set_minimal_scale(self, minimal_scale)</a></td>
|
||||||
<td class="summary">Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types</td>
|
<td class="summary">Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get_text_adjust">get_text_adjust(self, adjust_type)</a></td>
|
<td class="name" nowrap><a href="#set_pivot">set_pivot(self, pivot)</a></td>
|
||||||
<td class="summary">Return current text adjust type</td>
|
<td class="summary">Set text pivot.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_scale">set_scale(self, scale)</a></td>
|
||||||
|
<td class="summary">Set scale</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_text_adjust">set_text_adjust(self[, adjust_type[, minimal_scale]])</a></td>
|
||||||
|
<td class="summary">Set text adjust, refresh the current text visuals, if needed</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
|
||||||
|
<td class="summary">Set text to text field</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Tables">Tables</a></h2>
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
@ -134,16 +136,12 @@
|
|||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_set_text">on_set_text</a></td>
|
<td class="name" nowrap><a href="#adjust_type">adjust_type</a></td>
|
||||||
<td class="summary">On set text callback(self, text)</td>
|
<td class="summary">Current text size adjust settings</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_update_text_scale">on_update_text_scale</a></td>
|
<td class="name" nowrap><a href="#color">color</a></td>
|
||||||
<td class="summary">On adjust text size callback(self, new_scale)</td>
|
<td class="summary">Current text color</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_set_pivot">on_set_pivot</a></td>
|
|
||||||
<td class="summary">On change pivot callback(self, pivot)</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#node">node</a></td>
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
@ -154,18 +152,30 @@
|
|||||||
<td class="summary">The node id of text node</td>
|
<td class="summary">The node id of text node</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_set_pivot">on_set_pivot</a></td>
|
||||||
|
<td class="summary">On change pivot callback(self, pivot)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_set_text">on_set_text</a></td>
|
||||||
|
<td class="summary">On set text callback(self, text)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_update_text_scale">on_update_text_scale</a></td>
|
||||||
|
<td class="summary">On adjust text size callback(self, new_scale)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#pos">pos</a></td>
|
<td class="name" nowrap><a href="#pos">pos</a></td>
|
||||||
<td class="summary">Current text position</td>
|
<td class="summary">Current text position</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#start_scale">start_scale</a></td>
|
|
||||||
<td class="summary">Initial text node scale</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#scale">scale</a></td>
|
<td class="name" nowrap><a href="#scale">scale</a></td>
|
||||||
<td class="summary">Current text node scale</td>
|
<td class="summary">Current text node scale</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#start_scale">start_scale</a></td>
|
||||||
|
<td class="summary">Initial text node scale</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td class="name" nowrap><a href="#start_size">start_size</a></td>
|
<td class="name" nowrap><a href="#start_size">start_size</a></td>
|
||||||
<td class="summary">Initial text node size</td>
|
<td class="summary">Initial text node size</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -173,14 +183,6 @@
|
|||||||
<td class="name" nowrap><a href="#text_area">text_area</a></td>
|
<td class="name" nowrap><a href="#text_area">text_area</a></td>
|
||||||
<td class="summary">Current text node available are</td>
|
<td class="summary">Current text node available are</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#adjust_type">adjust_type</a></td>
|
|
||||||
<td class="summary">Current text size adjust settings</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#color">color</a></td>
|
|
||||||
<td class="summary">Current text color</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -190,6 +192,70 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "get_text_adjust"></a>
|
||||||
|
<strong>get_text_adjust(self, adjust_type)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return current text adjust type
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">adjust_type</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
The current text adjust type
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get_text_size"></a>
|
||||||
|
<strong>get_text_size(self[, text])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Calculate text width with font with respect to trailing space
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</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>
|
||||||
|
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Width</li>
|
||||||
|
<li>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Height</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "init"></a>
|
<a name = "init"></a>
|
||||||
<strong>init(self, node[, value[, adjust_type=0]])</strong>
|
<strong>init(self, node[, value[, adjust_type=0]])</strong>
|
||||||
@ -202,7 +268,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Text</span></span>
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><a class="type" href="../modules/Text.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Text.html#node">node</a></span>
|
||||||
@ -226,48 +292,49 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_text_width"></a>
|
<a name = "is_multiline"></a>
|
||||||
<strong>get_text_width(self[, text])</strong>
|
<strong>is_multiline(self)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Calculate text width with font with respect to trailing space
|
Return true, if text with line break
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Text</span></span>
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</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>
|
|
||||||
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
Is text node with line break
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "set_alpha"></a>
|
||||||
<strong>set_to(self, set_to)</strong>
|
<strong>set_alpha(self, alpha)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text to text field
|
Set alpha
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Text</span></span>
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">set_to</span>
|
<li><span class="parameter">alpha</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"><span class="type">number</span></span>
|
||||||
Text for node
|
Alpha for node
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -294,7 +361,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Text</span></span>
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">color</span>
|
<li><span class="parameter">color</span>
|
||||||
<span class="types"><span class="type">vector4</span></span>
|
<span class="types"><span class="type">vector4</span></span>
|
||||||
@ -312,163 +379,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_alpha"></a>
|
|
||||||
<strong>set_alpha(self, alpha)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set alpha
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">alpha</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Alpha for node
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
Current text instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_scale"></a>
|
|
||||||
<strong>set_scale(self, scale)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set scale
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">scale</span>
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
Scale for node
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
Current text instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_pivot"></a>
|
|
||||||
<strong>set_pivot(self, pivot)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set text pivot. Text will re-anchor inside text area
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">pivot</span>
|
|
||||||
<span class="types"><span class="type">gui.pivot</span></span>
|
|
||||||
Gui pivot constant
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
Current text instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "is_multiline"></a>
|
|
||||||
<strong>is_multiline(self)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Return true, if text with line break
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">bool</span></span>
|
|
||||||
Is text node with line break
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_text_adjust"></a>
|
|
||||||
<strong>set_text_adjust(self[, adjust_type[, minimal_scale]])</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set text adjust, refresh the current text visuals, if needed
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">self</span>
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">adjust_type</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
See const.TEXT_ADJUST. If pass nil - use current adjust type
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">minimal_scale</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
If pass nil - not use minimal scale
|
|
||||||
(<em>optional</em>)
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
|
||||||
<ol>
|
|
||||||
|
|
||||||
<span class="types"><span class="type">Text</span></span>
|
|
||||||
Current text instance
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_minimal_scale"></a>
|
<a name = "set_minimal_scale"></a>
|
||||||
@ -482,7 +392,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Text</span></span>
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">minimal_scale</span>
|
<li><span class="parameter">minimal_scale</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
@ -502,28 +412,129 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get_text_adjust"></a>
|
<a name = "set_pivot"></a>
|
||||||
<strong>get_text_adjust(self, adjust_type)</strong>
|
<strong>set_pivot(self, pivot)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Return current text adjust type
|
Set text pivot. Text will re-anchor inside text area
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">adjust_type</span>
|
<li><span class="parameter">pivot</span>
|
||||||
|
<span class="types"><span class="type">gui.pivot</span></span>
|
||||||
|
Gui pivot constant
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Returns:</h3>
|
<h3>Returns:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
Current text instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_scale"></a>
|
||||||
|
<strong>set_scale(self, scale)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set scale
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">scale</span>
|
||||||
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
Scale for node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
Current text instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_text_adjust"></a>
|
||||||
|
<strong>set_text_adjust(self[, adjust_type[, minimal_scale]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set text adjust, refresh the current text visuals, if needed
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">adjust_type</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
The current text adjust type
|
See const.TEXT_ADJUST. If pass nil - use current adjust type
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">minimal_scale</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
If pass nil - not use minimal scale
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
Current text instance
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_to"></a>
|
||||||
|
<strong>set_to(self, set_to)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set text to text field
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
<a href="../modules/Text.html#">Text</a>
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">set_to</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Text for node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
<span class="types"><span class="type">Text</span></span>
|
||||||
|
Current text instance
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
@ -568,16 +579,16 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_set_text"></a>
|
<a name = "adjust_type"></a>
|
||||||
<strong>on_set_text</strong>
|
<strong>adjust_type</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On set text callback(self, text)
|
Current text size adjust settings
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_set_text</span>
|
<li><span class="parameter">adjust_type</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -588,36 +599,16 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_update_text_scale"></a>
|
<a name = "color"></a>
|
||||||
<strong>on_update_text_scale</strong>
|
<strong>color</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On adjust text size callback(self, new_scale)
|
Current text color
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_update_text_scale</span>
|
<li><span class="parameter">color</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_set_pivot"></a>
|
|
||||||
<strong>on_set_pivot</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On change pivot callback(self, pivot)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_set_pivot</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -666,6 +657,66 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_set_pivot"></a>
|
||||||
|
<strong>on_set_pivot</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On change pivot callback(self, pivot)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_set_pivot</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_set_text"></a>
|
||||||
|
<strong>on_set_text</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On set text callback(self, text)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_set_text</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_update_text_scale"></a>
|
||||||
|
<strong>on_update_text_scale</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On adjust text size callback(self, new_scale)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_update_text_scale</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "pos"></a>
|
<a name = "pos"></a>
|
||||||
@ -688,15 +739,15 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "start_scale"></a>
|
<a name = "scale"></a>
|
||||||
<strong>start_scale</strong>
|
<strong>scale</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Initial text node scale
|
Current text node scale
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">start_scale</span>
|
<li><span class="parameter">scale</span>
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -708,15 +759,15 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "scale"></a>
|
<a name = "start_scale"></a>
|
||||||
<strong>scale</strong>
|
<strong>start_scale</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Current text node scale
|
Initial text node scale
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">scale</span>
|
<li><span class="parameter">start_scale</span>
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
<span class="types"><span class="type">vector3</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -766,46 +817,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "adjust_type"></a>
|
|
||||||
<strong>adjust_type</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Current text size adjust settings
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">adjust_type</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "color"></a>
|
|
||||||
<strong>color</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Current text color
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">color</span>
|
|
||||||
<span class="types"><span class="type">vector3</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -814,7 +825,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -40,29 +40,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><a href="../modules/druid.html">druid</a></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><strong>Timer</strong></li>
|
<li><strong>Timer</strong></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -83,39 +85,39 @@
|
|||||||
<td class="summary">Component init function</td>
|
<td class="summary">Component init function</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
|
<td class="name" nowrap><a href="#set_interval">set_interval(self, from, to)</a></td>
|
||||||
<td class="summary">Set text to text field</td>
|
<td class="summary">Set time interval</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_state">set_state(self, is_on)</a></td>
|
<td class="name" nowrap><a href="#set_state">set_state(self, is_on)</a></td>
|
||||||
<td class="summary">Called when update</td>
|
<td class="summary">Called when update</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_interval">set_interval(self, from, to)</a></td>
|
<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
|
||||||
<td class="summary">Set time interval</td>
|
<td class="summary">Set text to text field</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<h2><a href="#Fields">Fields</a></h2>
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_tick">on_tick</a></td>
|
<td class="name" nowrap><a href="#from">from</a></td>
|
||||||
<td class="summary">On timer tick.</td>
|
<td class="summary">Initial timer value</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_set_enabled">on_set_enabled</a></td>
|
|
||||||
<td class="summary">On timer change enabled state callback(self, is_enabled)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#on_timer_end">on_timer_end</a></td>
|
|
||||||
<td class="summary">On timer end callback</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#node">node</a></td>
|
<td class="name" nowrap><a href="#node">node</a></td>
|
||||||
<td class="summary">Trigger node</td>
|
<td class="summary">Trigger node</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#from">from</a></td>
|
<td class="name" nowrap><a href="#on_set_enabled">on_set_enabled</a></td>
|
||||||
<td class="summary">Initial timer value</td>
|
<td class="summary">On timer change enabled state callback(self, is_enabled)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_tick">on_tick</a></td>
|
||||||
|
<td class="summary">On timer tick.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_timer_end">on_timer_end</a></td>
|
||||||
|
<td class="summary">On timer end callback</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#target">target</a></td>
|
<td class="name" nowrap><a href="#target">target</a></td>
|
||||||
@ -146,7 +148,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Timer</span></span>
|
<span class="types"><span class="type">Timer</span></span>
|
||||||
|
<a href="../modules/Timer.html#">Timer</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">node</span>
|
<li><span class="parameter">node</span>
|
||||||
<span class="types"><a class="type" href="../modules/Timer.html#node">node</a></span>
|
<span class="types"><a class="type" href="../modules/Timer.html#node">node</a></span>
|
||||||
@ -174,22 +176,26 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_to"></a>
|
<a name = "set_interval"></a>
|
||||||
<strong>set_to(self, set_to)</strong>
|
<strong>set_interval(self, from, to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set text to text field
|
Set time interval
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Timer</span></span>
|
<span class="types"><span class="type">Timer</span></span>
|
||||||
|
<a href="../modules/Timer.html#">Timer</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">set_to</span>
|
<li><span class="parameter">from</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Value in seconds
|
Start time in seconds
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Target time in seconds
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -210,7 +216,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Timer</span></span>
|
<span class="types"><span class="type">Timer</span></span>
|
||||||
|
<a href="../modules/Timer.html#">Timer</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">is_on</span>
|
<li><span class="parameter">is_on</span>
|
||||||
<span class="types"><span class="type">bool</span></span>
|
<span class="types"><span class="type">bool</span></span>
|
||||||
@ -224,26 +230,22 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_interval"></a>
|
<a name = "set_to"></a>
|
||||||
<strong>set_interval(self, from, to)</strong>
|
<strong>set_to(self, set_to)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Set time interval
|
Set text to text field
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">self</span>
|
<li><span class="parameter">self</span>
|
||||||
<span class="types"><span class="type">Timer</span></span>
|
<span class="types"><span class="type">Timer</span></span>
|
||||||
|
<a href="../modules/Timer.html#">Timer</a>
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">from</span>
|
<li><span class="parameter">set_to</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
Start time in seconds
|
Value in seconds
|
||||||
</li>
|
|
||||||
<li><span class="parameter">to</span>
|
|
||||||
<span class="types"><span class="type">number</span></span>
|
|
||||||
Target time in seconds
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -257,16 +259,16 @@
|
|||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_tick"></a>
|
<a name = "from"></a>
|
||||||
<strong>on_tick</strong>
|
<strong>from</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
On timer tick. Fire every second callback(self, value)
|
Initial timer value
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">on_tick</span>
|
<li><span class="parameter">from</span>
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -275,46 +277,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_set_enabled"></a>
|
|
||||||
<strong>on_set_enabled</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On timer change enabled state callback(self, is_enabled)
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_set_enabled</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_timer_end"></a>
|
|
||||||
<strong>on_timer_end</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
On timer end callback
|
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">on_timer_end</span>
|
|
||||||
<span class="types"><span class="type">druid_event</span></span>
|
|
||||||
(self, Timer)
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "node"></a>
|
<a name = "node"></a>
|
||||||
@ -337,17 +299,57 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "from"></a>
|
<a name = "on_set_enabled"></a>
|
||||||
<strong>from</strong>
|
<strong>on_set_enabled</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Initial timer value
|
On timer change enabled state callback(self, is_enabled)
|
||||||
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">from</span>
|
<li><span class="parameter">on_set_enabled</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_tick"></a>
|
||||||
|
<strong>on_tick</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On timer tick. Fire every second callback(self, value)
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_tick</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_timer_end"></a>
|
||||||
|
<strong>on_timer_end</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
On timer end callback
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">on_timer_end</span>
|
||||||
|
<span class="types"><span class="type">DruidEvent</span></span>
|
||||||
|
(self, Timer) <a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -403,7 +405,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -39,29 +39,31 @@
|
|||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||||
|
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||||
<li><a href="../modules/Button.html">Button</a></li>
|
<li><a href="../modules/Button.html">Button</a></li>
|
||||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
|
||||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
|
||||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
|
||||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
|
||||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
|
||||||
<li><a href="../modules/Text.html">Text</a></li>
|
|
||||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
|
||||||
<li><strong>druid</strong></li>
|
|
||||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
|
||||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||||
|
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||||
|
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||||
|
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||||
|
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||||
|
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||||
<li><a href="../modules/Input.html">Input</a></li>
|
<li><a href="../modules/Input.html">Input</a></li>
|
||||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||||
|
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||||
|
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||||
|
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||||
|
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||||
|
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||||
|
<li><a href="../modules/Text.html">Text</a></li>
|
||||||
<li><a href="../modules/Timer.html">Timer</a></li>
|
<li><a href="../modules/Timer.html">Timer</a></li>
|
||||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
<li><strong>druid</strong></li>
|
||||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -86,39 +88,35 @@
|
|||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#register">register(name, module)</a></td>
|
|
||||||
<td class="summary">Register external druid component.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#new">new(context[, style])</a></td>
|
<td class="name" nowrap><a href="#new">new(context[, style])</a></td>
|
||||||
<td class="summary">Create Druid instance.</td>
|
<td class="summary">Create Druid instance.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#set_default_style">set_default_style(style)</a></td>
|
<td class="name" nowrap><a href="#on_language_change">on_language_change()</a></td>
|
||||||
<td class="summary">Set new default style.</td>
|
<td class="summary">Callback on global language change event.</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_text_function">set_text_function(callback)</a></td>
|
|
||||||
<td class="summary">Set text function
|
|
||||||
Druid locale component will call this function
|
|
||||||
to get translated text.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="#set_sound_function">set_sound_function(callback)</a></td>
|
|
||||||
<td class="summary">Set sound function.</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_window_callback">on_window_callback(event)</a></td>
|
<td class="name" nowrap><a href="#on_window_callback">on_window_callback(event)</a></td>
|
||||||
<td class="summary">Callback on global window event.</td>
|
<td class="summary">Callback on global window event.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_layout_change">on_layout_change()</a></td>
|
<td class="name" nowrap><a href="#register">register(name, module)</a></td>
|
||||||
<td class="summary">Callback on global layout change event.</td>
|
<td class="summary">Register external druid component.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#on_language_change">on_language_change()</a></td>
|
<td class="name" nowrap><a href="#set_default_style">set_default_style(style)</a></td>
|
||||||
<td class="summary">Callback on global language change event.</td>
|
<td class="summary">Set new default style.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_sound_function">set_sound_function(callback)</a></td>
|
||||||
|
<td class="summary">Set sound function.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_text_function">set_text_function(callback)</a></td>
|
||||||
|
<td class="summary">Set text function
|
||||||
|
Druid locale component will call this function
|
||||||
|
to get translated text.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@ -129,33 +127,6 @@
|
|||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
|
||||||
<a name = "register"></a>
|
|
||||||
<strong>register(name, module)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Register external druid component.
|
|
||||||
After register you can create the component with
|
|
||||||
druid_instance:new_{name}. For example `druid:new_button(...)`
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">name</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
||||||
module name
|
|
||||||
</li>
|
|
||||||
<li><span class="parameter">module</span>
|
|
||||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
||||||
lua table with component
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "new"></a>
|
<a name = "new"></a>
|
||||||
<strong>new(context[, style])</strong>
|
<strong>new(context[, style])</strong>
|
||||||
@ -187,6 +158,70 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_language_change"></a>
|
||||||
|
<strong>on_language_change()</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Callback on global language change event.
|
||||||
|
Use to update all lang texts
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_window_callback"></a>
|
||||||
|
<strong>on_window_callback(event)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Callback on global window event.
|
||||||
|
Used to trigger on_focus_lost and on_focus_gain
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">event</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
Event param from window listener
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "register"></a>
|
||||||
|
<strong>register(name, module)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Register external druid component.
|
||||||
|
After register you can create the component with
|
||||||
|
druid_instance:new_{name}. For example `druid:new_button(...)`
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">name</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||||
|
module name
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">module</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
lua table with component
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_default_style"></a>
|
<a name = "set_default_style"></a>
|
||||||
@ -208,30 +243,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "set_text_function"></a>
|
|
||||||
<strong>set_text_function(callback)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Set text function
|
|
||||||
Druid locale component will call this function
|
|
||||||
to get translated text. After set_text_funtion
|
|
||||||
all existing locale component will be updated
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
|
||||||
<ul>
|
|
||||||
<li><span class="parameter">callback</span>
|
|
||||||
<span class="types"><span class="type">function</span></span>
|
|
||||||
Get localized text function
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "set_sound_function"></a>
|
<a name = "set_sound_function"></a>
|
||||||
@ -257,19 +268,21 @@
|
|||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "on_window_callback"></a>
|
<a name = "set_text_function"></a>
|
||||||
<strong>on_window_callback(event)</strong>
|
<strong>set_text_function(callback)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Callback on global window event.
|
Set text function
|
||||||
Used to trigger on_focus_lost and on_focus_gain
|
Druid locale component will call this function
|
||||||
|
to get translated text. After set_text_funtion
|
||||||
|
all existing locale component will be updated
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters:</h3>
|
<h3>Parameters:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">event</span>
|
<li><span class="parameter">callback</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"><span class="type">function</span></span>
|
||||||
Event param from window listener
|
Get localized text function
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
@ -277,35 +290,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_layout_change"></a>
|
|
||||||
<strong>on_layout_change()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Callback on global layout change event.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
|
||||||
<a name = "on_language_change"></a>
|
|
||||||
<strong>on_language_change()</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Callback on global language change event.
|
|
||||||
Use to update all lang texts
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
@ -314,7 +298,7 @@
|
|||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@ -11,13 +11,16 @@ local druid = {}
|
|||||||
function druid.new(context, style) end
|
function druid.new(context, style) end
|
||||||
|
|
||||||
--- Callback on global language change event.
|
--- Callback on global language change event.
|
||||||
|
--- Use to update all lang texts
|
||||||
function druid.on_language_change() end
|
function druid.on_language_change() end
|
||||||
|
|
||||||
--- Callback on global window event.
|
--- Callback on global window event.
|
||||||
|
--- Used to trigger on_focus_lost and on_focus_gain
|
||||||
---@param event string Event param from window listener
|
---@param event string Event param from window listener
|
||||||
function druid.on_window_callback(event) end
|
function druid.on_window_callback(event) end
|
||||||
|
|
||||||
--- Register external druid component.
|
--- Register external druid component.
|
||||||
|
--- After register you can create the component with druid_instance:new_{name}. For example `druid:new_button(...)`
|
||||||
---@param name string module name
|
---@param name string module name
|
||||||
---@param module table lua table with component
|
---@param module table lua table with component
|
||||||
function druid.register(name, module) end
|
function druid.register(name, module) end
|
||||||
@ -27,10 +30,12 @@ function druid.register(name, module) end
|
|||||||
function druid.set_default_style(style) end
|
function druid.set_default_style(style) end
|
||||||
|
|
||||||
--- Set sound function.
|
--- Set sound function.
|
||||||
|
--- Component will call this function to play sound by sound_id
|
||||||
---@param callback function Sound play callback
|
---@param callback function Sound play callback
|
||||||
function druid.set_sound_function(callback) end
|
function druid.set_sound_function(callback) end
|
||||||
|
|
||||||
--- Set text function Druid locale component will call this function to get translated text.
|
--- Set text function Druid locale component will call this function to get translated text.
|
||||||
|
--- After set_text_funtion all existing locale component will be updated
|
||||||
---@param callback function Get localized text function
|
---@param callback function Get localized text function
|
||||||
function druid.set_text_function(callback) end
|
function druid.set_text_function(callback) end
|
||||||
|
|
||||||
@ -57,87 +62,117 @@ function druid__back_handler.on_input(self, action_id, action) end
|
|||||||
---@field ON_INPUT field Component Interests
|
---@field ON_INPUT field Component Interests
|
||||||
local druid__base_component = {}
|
local druid__base_component = {}
|
||||||
|
|
||||||
--- Return all children components, recursive
|
--- Return all children components, recursive (protected)
|
||||||
---@param self druid.base_component
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@return table Array of childrens if the Druid component instance
|
---@return table Array of childrens if the Druid component instance
|
||||||
function druid__base_component.get_childrens(self) end
|
function druid__base_component.get_childrens(self) end
|
||||||
|
|
||||||
--- Get current component context
|
--- Get current component context (protected)
|
||||||
---@param self druid.base_component
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@return table BaseComponent context
|
---@return table BaseComponent context
|
||||||
function druid__base_component.get_context(self) end
|
function druid__base_component.get_context(self) end
|
||||||
|
|
||||||
--- Return druid with context of calling component.
|
--- Return druid with context of calling component (protected).
|
||||||
---@param self druid.base_component
|
--- Use it to create component inside of other components.
|
||||||
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@return Druid Druid instance with component context
|
---@return Druid Druid instance with component context
|
||||||
function druid__base_component.get_druid(self) end
|
function druid__base_component.get_druid(self) end
|
||||||
|
|
||||||
--- Return component input priority
|
--- Return component input priority
|
||||||
---@param self druid.base_component
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@return number The component input priority
|
---@return number The component input priority
|
||||||
function druid__base_component.get_input_priority(self) end
|
function druid__base_component.get_input_priority(self) end
|
||||||
|
|
||||||
--- Return component name
|
--- Return component name
|
||||||
---@param self druid.base_component
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@return string The component name
|
---@return string The component name
|
||||||
function druid__base_component.get_name(self) end
|
function druid__base_component.get_name(self) end
|
||||||
|
|
||||||
--- Get node for component by name.
|
--- Get node for component by name.
|
||||||
---@param self druid.base_component
|
--- If component has nodes, node_or_name should be string It auto pick node by template name or from nodes by clone_tree if they was setup via component:set_nodes, component:set_template. If node is not found, the exception will fired
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@param node_or_name string|node Node name or node itself
|
---@param node_or_name string|node Node name or node itself
|
||||||
---@return node Gui node
|
---@return node Gui node
|
||||||
function druid__base_component.get_node(self, node_or_name) end
|
function druid__base_component.get_node(self, node_or_name) end
|
||||||
|
|
||||||
--- Return the parent for current component
|
--- Return the parent for current component (protected)
|
||||||
---@param self druid.base_component
|
---@protected
|
||||||
---@return druid.base_component|nil The druid component instance or nil
|
---@param self druid.base_component @{BaseComponent}
|
||||||
|
---@return BaseComponent|nil The druid component instance or nil
|
||||||
function druid__base_component.get_parent_component(self) end
|
function druid__base_component.get_parent_component(self) end
|
||||||
|
|
||||||
--- Return component uid.
|
--- Return parent component name
|
||||||
---@param self druid.base_component
|
---@param self druid.base_component @{BaseComponent}
|
||||||
|
---@return string|nil The parent component name if exist or bil
|
||||||
|
function druid__base_component.get_parent_name(self) end
|
||||||
|
|
||||||
|
--- Get current component template name (protected)
|
||||||
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
|
---@return string Component full template name
|
||||||
|
function druid__base_component.get_template(self) end
|
||||||
|
|
||||||
|
--- Return component uid (protected).
|
||||||
|
--- UID generated in component creation order
|
||||||
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@return number The component uid
|
---@return number The component uid
|
||||||
function druid__base_component.get_uid(self) end
|
function druid__base_component.get_uid(self) end
|
||||||
|
|
||||||
|
--- Print log information if debug mode is enabled (protected)
|
||||||
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
|
---@param message string
|
||||||
|
---@param context table
|
||||||
|
function druid__base_component.log_message(self, message, context) end
|
||||||
|
|
||||||
--- Reset component input priority to default value
|
--- Reset component input priority to default value
|
||||||
---@param self druid.base_component
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@return number The component input priority
|
---@return number The component input priority
|
||||||
function druid__base_component.reset_input_priority(self) end
|
function druid__base_component.reset_input_priority(self) end
|
||||||
|
|
||||||
|
--- Set debug logs for component enabled or disabled
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
|
---@param is_debug bool
|
||||||
|
function druid__base_component.set_debug(self, is_debug) end
|
||||||
|
|
||||||
--- Set component input state.
|
--- Set component input state.
|
||||||
---@param self druid.base_component
|
--- By default it enabled You can disable any input of component by this function
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@param state bool The component input state
|
---@param state bool The component input state
|
||||||
---@return druid.base_component BaseComponent itself
|
---@return druid.base_component BaseComponent itself
|
||||||
function druid__base_component.set_input_enabled(self, state) end
|
function druid__base_component.set_input_enabled(self, state) end
|
||||||
|
|
||||||
--- Set component input priority
|
--- Set component input priority
|
||||||
---@param self druid.base_component
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@param value number The new input priority value
|
---@param value number The new input priority value
|
||||||
---@return number The component input priority
|
---@return number The component input priority
|
||||||
function druid__base_component.set_input_priority(self, value) end
|
function druid__base_component.set_input_priority(self, value) end
|
||||||
|
|
||||||
--- Set current component nodes
|
--- Set current component nodes (protected)
|
||||||
---@param self druid.base_component
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@param nodes table BaseComponent nodes table
|
---@param nodes table BaseComponent nodes table
|
||||||
|
---@return druid.base_component @{BaseComponent}
|
||||||
function druid__base_component.set_nodes(self, nodes) end
|
function druid__base_component.set_nodes(self, nodes) end
|
||||||
|
|
||||||
--- Set current component style table.
|
--- Set current component style table (protected).
|
||||||
---@param self druid.base_component
|
--- Invoke `on_style_change` on component, if exist. BaseComponent should handle their style changing and store all style params
|
||||||
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@param druid_style table Druid style module
|
---@param druid_style table Druid style module
|
||||||
function druid__base_component.set_style(self, druid_style) end
|
function druid__base_component.set_style(self, druid_style) end
|
||||||
|
|
||||||
--- Set current component template name
|
--- Set current component template name (protected) It will check parent template name to build full template name
|
||||||
---@param self druid.base_component
|
---@protected
|
||||||
|
---@param self druid.base_component @{BaseComponent}
|
||||||
---@param template string BaseComponent template name
|
---@param template string BaseComponent template name
|
||||||
|
---@return druid.base_component @{BaseComponent}
|
||||||
function druid__base_component.set_template(self, template) end
|
function druid__base_component.set_template(self, template) end
|
||||||
|
|
||||||
--- Setup component context and his style table
|
|
||||||
---@param self druid.base_component
|
|
||||||
---@param druid_instance table The parent druid instance
|
|
||||||
---@param context table Druid context. Usually it is self of script
|
|
||||||
---@param style table Druid style module
|
|
||||||
---@return component BaseComponent itself
|
|
||||||
function druid__base_component.setup_component(self, druid_instance, context, style) end
|
|
||||||
|
|
||||||
|
|
||||||
---@class druid.blocker : druid.base_component
|
---@class druid.blocker : druid.base_component
|
||||||
---@field node node Trigger node
|
---@field node node Trigger node
|
||||||
@ -204,6 +239,7 @@ function druid__button.is_enabled(self) end
|
|||||||
function druid__button.set_check_function(self, check_function, failure_callback) end
|
function druid__button.set_check_function(self, check_function, failure_callback) end
|
||||||
|
|
||||||
--- Strict button click area.
|
--- Strict button click area.
|
||||||
|
--- Useful for no click events outside stencil node
|
||||||
---@param self druid.button @{Button}
|
---@param self druid.button @{Button}
|
||||||
---@param zone node Gui node
|
---@param zone node Gui node
|
||||||
---@return druid.button Current button instance
|
---@return druid.button Current button instance
|
||||||
@ -306,6 +342,7 @@ local druid__data_list = {}
|
|||||||
function druid__data_list.clear(self) end
|
function druid__data_list.clear(self) end
|
||||||
|
|
||||||
--- Return first index from data.
|
--- Return first index from data.
|
||||||
|
--- It not always equals to 1
|
||||||
---@param self druid.data_list @{DataList}
|
---@param self druid.data_list @{DataList}
|
||||||
function druid__data_list.get_first_index(self) end
|
function druid__data_list.get_first_index(self) end
|
||||||
|
|
||||||
@ -368,6 +405,7 @@ local druid__drag = {}
|
|||||||
function druid__drag.init(self, node, on_drag_callback) end
|
function druid__drag.init(self, node, on_drag_callback) end
|
||||||
|
|
||||||
--- Strict drag click area.
|
--- Strict drag click area.
|
||||||
|
--- Useful for restrict events outside stencil node
|
||||||
---@param self druid.drag @{Drag}
|
---@param self druid.drag @{Drag}
|
||||||
---@param node node Gui node
|
---@param node node Gui node
|
||||||
function druid__drag.set_click_zone(self, node) end
|
function druid__drag.set_click_zone(self, node) end
|
||||||
@ -407,6 +445,7 @@ function druid__dynamic_grid._get_side_vector(self, side, is_forward) end
|
|||||||
function druid__dynamic_grid.add(self, node, index, shift_policy, is_instant) end
|
function druid__dynamic_grid.add(self, node, index, shift_policy, is_instant) end
|
||||||
|
|
||||||
--- Clear grid nodes array.
|
--- Clear grid nodes array.
|
||||||
|
--- GUI nodes will be not deleted! If you want to delete GUI nodes, use dynamic_grid.nodes array before grid:clear
|
||||||
---@param self druid.dynamic_grid @{DynamicGrid}
|
---@param self druid.dynamic_grid @{DynamicGrid}
|
||||||
---@return druid.dynamic_grid Current grid instance
|
---@return druid.dynamic_grid Current grid instance
|
||||||
function druid__dynamic_grid.clear(self) end
|
function druid__dynamic_grid.clear(self) end
|
||||||
@ -452,6 +491,7 @@ function druid__dynamic_grid.get_size(self, border) end
|
|||||||
function druid__dynamic_grid.init(self, parent) end
|
function druid__dynamic_grid.init(self, parent) end
|
||||||
|
|
||||||
--- Remove the item from the grid.
|
--- Remove the item from the grid.
|
||||||
|
--- Note that gui node will be not deleted
|
||||||
---@param self druid.dynamic_grid @{DynamicGrid}
|
---@param self druid.dynamic_grid @{DynamicGrid}
|
||||||
---@param index number The grid node index to remove
|
---@param index number The grid node index to remove
|
||||||
---@param shift_policy number How shift nodes, if required. See const.SHIFT
|
---@param shift_policy number How shift nodes, if required. See const.SHIFT
|
||||||
@ -460,6 +500,7 @@ function druid__dynamic_grid.init(self, parent) end
|
|||||||
function druid__dynamic_grid.remove(self, index, shift_policy, is_instant) end
|
function druid__dynamic_grid.remove(self, index, shift_policy, is_instant) end
|
||||||
|
|
||||||
--- Change set position function for grid nodes.
|
--- Change set position function for grid nodes.
|
||||||
|
--- It will call on update poses on grid elements. Default: gui.set_position
|
||||||
---@param self druid.dynamic_grid @{DynamicGrid}
|
---@param self druid.dynamic_grid @{DynamicGrid}
|
||||||
---@param callback function Function on node set position
|
---@param callback function Function on node set position
|
||||||
---@return druid.dynamic_grid Current grid instance
|
---@return druid.dynamic_grid Current grid instance
|
||||||
@ -501,6 +542,15 @@ function druid__event.trigger(self, ...) end
|
|||||||
function druid__event.unsubscribe(self, callback, context) end
|
function druid__event.unsubscribe(self, callback, context) end
|
||||||
|
|
||||||
|
|
||||||
|
---@class druid.helper
|
||||||
|
local druid__helper = {}
|
||||||
|
|
||||||
|
--- Transform table to oneline string
|
||||||
|
---@param t table
|
||||||
|
---@return string
|
||||||
|
function druid__helper.table_to_string(t) end
|
||||||
|
|
||||||
|
|
||||||
---@class druid.hover : druid.base_component
|
---@class druid.hover : druid.base_component
|
||||||
---@field on_hover druid.event On hover callback(self, state)
|
---@field on_hover druid.event On hover callback(self, state)
|
||||||
---@field on_mouse_hover druid.event On mouse hover callback(self, state)
|
---@field on_mouse_hover druid.event On mouse hover callback(self, state)
|
||||||
@ -518,11 +568,13 @@ function druid__hover.init(self, node, on_hover_callback) end
|
|||||||
function druid__hover.is_enabled(self) end
|
function druid__hover.is_enabled(self) end
|
||||||
|
|
||||||
--- Strict hover click area.
|
--- Strict hover click area.
|
||||||
|
--- Useful for no click events outside stencil node
|
||||||
---@param self druid.hover @{Hover}
|
---@param self druid.hover @{Hover}
|
||||||
---@param zone node Gui node
|
---@param zone node Gui node
|
||||||
function druid__hover.set_click_zone(self, zone) end
|
function druid__hover.set_click_zone(self, zone) end
|
||||||
|
|
||||||
--- Set enable state of hover component.
|
--- Set enable state of hover component.
|
||||||
|
--- If hover is not enabled, it will not generate any hover events
|
||||||
---@param self druid.hover @{Hover}
|
---@param self druid.hover @{Hover}
|
||||||
---@param state bool The hover enabled state
|
---@param state bool The hover enabled state
|
||||||
function druid__hover.set_enabled(self, state) end
|
function druid__hover.set_enabled(self, state) end
|
||||||
@ -572,16 +624,19 @@ function druid__input.init(self, click_node, text_node, keyboard_type) end
|
|||||||
function druid__input.reset_changes(self) end
|
function druid__input.reset_changes(self) end
|
||||||
|
|
||||||
--- Select input field.
|
--- Select input field.
|
||||||
|
--- It will show the keyboard and trigger on_select events
|
||||||
---@param self druid.input @{Input}
|
---@param self druid.input @{Input}
|
||||||
function druid__input.select(self) end
|
function druid__input.select(self) end
|
||||||
|
|
||||||
--- Set allowed charaters for input field.
|
--- Set allowed charaters for input field.
|
||||||
|
--- See: https://defold.com/ref/stable/string/ ex: [%a%d] for alpha and numeric
|
||||||
---@param self druid.input @{Input}
|
---@param self druid.input @{Input}
|
||||||
---@param characters string Regulax exp. for validate user input
|
---@param characters string Regulax exp. for validate user input
|
||||||
---@return druid.input Current input instance
|
---@return druid.input Current input instance
|
||||||
function druid__input.set_allowed_characters(self, characters) end
|
function druid__input.set_allowed_characters(self, characters) end
|
||||||
|
|
||||||
--- Set maximum length for input field.
|
--- Set maximum length for input field.
|
||||||
|
--- Pass nil to make input field unliminted (by default)
|
||||||
---@param self druid.input @{Input}
|
---@param self druid.input @{Input}
|
||||||
---@param max_length number Maximum length for input text field
|
---@param max_length number Maximum length for input text field
|
||||||
---@return druid.input Current input instance
|
---@return druid.input Current input instance
|
||||||
@ -593,6 +648,7 @@ function druid__input.set_max_length(self, max_length) end
|
|||||||
function druid__input.set_text(self, input_text) end
|
function druid__input.set_text(self, input_text) end
|
||||||
|
|
||||||
--- Remove selection from input.
|
--- Remove selection from input.
|
||||||
|
--- It will hide the keyboard and trigger on_unselect events
|
||||||
---@param self druid.input @{Input}
|
---@param self druid.input @{Input}
|
||||||
function druid__input.unselect(self) end
|
function druid__input.unselect(self) end
|
||||||
|
|
||||||
@ -652,6 +708,34 @@ function druid__lang_text.set_to(self, text) end
|
|||||||
function druid__lang_text.translate(self, locale_id, a, b, c, d, e, f, g) end
|
function druid__lang_text.translate(self, locale_id, a, b, c, d, e, f, g) end
|
||||||
|
|
||||||
|
|
||||||
|
---@class druid.pin_knob : druid.base_component
|
||||||
|
---@field druid druid_instance The component druid instance
|
||||||
|
---@field is_drag bool Is currently under user control
|
||||||
|
---@field node node The pin node
|
||||||
|
local druid__pin_knob = {}
|
||||||
|
|
||||||
|
--- Component init function
|
||||||
|
---@param self druid.pin_knob @{PinKnob}
|
||||||
|
---@param callback function Callback(self, value) on value changed
|
||||||
|
---@param template string The template string name
|
||||||
|
---@param nodes table Nodes table from gui.clone_tree
|
||||||
|
function druid__pin_knob.init(self, callback, template, nodes) end
|
||||||
|
|
||||||
|
--- Set current and min/max angles for component
|
||||||
|
---@param self druid.pin_knob @{PinKnob}
|
||||||
|
---@param cur_value number The new value for pin knob
|
||||||
|
---@param min number The minimum value for pin knob
|
||||||
|
---@param max number The maximum value for pin knob
|
||||||
|
---@return druid.pin_knob @{PinKnob}
|
||||||
|
function druid__pin_knob.set_angle(self, cur_value, min, max) end
|
||||||
|
|
||||||
|
--- Set current and min/max angles for component
|
||||||
|
---@param self druid.pin_knob @{PinKnob}
|
||||||
|
---@param value number The spin speed multiplier
|
||||||
|
---@return druid.pin_knob @{PinKnob}
|
||||||
|
function druid__pin_knob.set_friction(self, value) end
|
||||||
|
|
||||||
|
|
||||||
---@class druid.progress : druid.base_component
|
---@class druid.progress : druid.base_component
|
||||||
---@field key string The progress bar direction
|
---@field key string The progress bar direction
|
||||||
---@field max_size number Maximum size of progress bar
|
---@field max_size number Maximum size of progress bar
|
||||||
@ -732,7 +816,7 @@ function druid__radio_group.set_state(self, index, is_instant) end
|
|||||||
|
|
||||||
---@class druid.rich_input : druid.input
|
---@class druid.rich_input : druid.input
|
||||||
---@field cursor node On input field text change to empty string callback(self, input_text)
|
---@field cursor node On input field text change to empty string callback(self, input_text)
|
||||||
---@field druid druid_instance On input field select callback(self, button_node)
|
---@field druid druid_instance The component druid instance
|
||||||
---@field input druid.input On input field text change callback(self, input_text)
|
---@field input druid.input On input field text change callback(self, input_text)
|
||||||
---@field placeholder druid.text On input field text change to max length string callback(self, input_text)
|
---@field placeholder druid.text On input field text change to max length string callback(self, input_text)
|
||||||
local druid__rich_input = {}
|
local druid__rich_input = {}
|
||||||
@ -774,6 +858,7 @@ local druid__scroll = {}
|
|||||||
function druid__scroll.bind_grid(self, grid) end
|
function druid__scroll.bind_grid(self, grid) end
|
||||||
|
|
||||||
--- Return current scroll progress status.
|
--- Return current scroll progress status.
|
||||||
|
--- Values will be in [0..1] interval
|
||||||
---@param self druid.scroll @{Scroll}
|
---@param self druid.scroll @{Scroll}
|
||||||
---@return vector3 New vector with scroll progress values
|
---@return vector3 New vector with scroll progress values
|
||||||
function druid__scroll.get_percent(self) end
|
function druid__scroll.get_percent(self) end
|
||||||
@ -795,6 +880,7 @@ function druid__scroll.init(self, view_node, content_node) end
|
|||||||
function druid__scroll.is_inert(self) end
|
function druid__scroll.is_inert(self) end
|
||||||
|
|
||||||
--- Check node if it visible now on scroll.
|
--- Check node if it visible now on scroll.
|
||||||
|
--- Extra border is not affected. Return true for elements in extra scroll zone
|
||||||
---@param self druid.scroll @{Scroll}
|
---@param self druid.scroll @{Scroll}
|
||||||
---@param node node The node to check
|
---@param node node The node to check
|
||||||
---@return boolean True if node in visible scroll area
|
---@return boolean True if node in visible scroll area
|
||||||
@ -819,11 +905,13 @@ function druid__scroll.scroll_to_index(self, index, skip_cb) end
|
|||||||
function druid__scroll.scroll_to_percent(self, percent, is_instant) end
|
function druid__scroll.scroll_to_percent(self, percent, is_instant) end
|
||||||
|
|
||||||
--- Strict drag scroll area.
|
--- Strict drag scroll area.
|
||||||
|
--- Useful for restrict events outside stencil node
|
||||||
---@param self druid.drag
|
---@param self druid.drag
|
||||||
---@param node node Gui node
|
---@param node node Gui node
|
||||||
function druid__scroll.set_click_zone(self, node) end
|
function druid__scroll.set_click_zone(self, node) end
|
||||||
|
|
||||||
--- Set extra size for scroll stretching.
|
--- Set extra size for scroll stretching.
|
||||||
|
--- Set 0 to disable stretching effect
|
||||||
---@param self druid.scroll @{Scroll}
|
---@param self druid.scroll @{Scroll}
|
||||||
---@param stretch_size number Size in pixels of additional scroll area
|
---@param stretch_size number Size in pixels of additional scroll area
|
||||||
---@return druid.scroll Current scroll instance
|
---@return druid.scroll Current scroll instance
|
||||||
@ -836,18 +924,21 @@ function druid__scroll.set_extra_stretch_size(self, stretch_size) end
|
|||||||
function druid__scroll.set_horizontal_scroll(self, state) end
|
function druid__scroll.set_horizontal_scroll(self, state) end
|
||||||
|
|
||||||
--- Enable or disable scroll inert.
|
--- Enable or disable scroll inert.
|
||||||
|
--- If disabled, scroll through points (if exist) If no points, just simple drag without inertion
|
||||||
---@param self druid.scroll @{Scroll}
|
---@param self druid.scroll @{Scroll}
|
||||||
---@param state bool Inert scroll state
|
---@param state bool Inert scroll state
|
||||||
---@return druid.scroll Current scroll instance
|
---@return druid.scroll Current scroll instance
|
||||||
function druid__scroll.set_inert(self, state) end
|
function druid__scroll.set_inert(self, state) end
|
||||||
|
|
||||||
--- Set points of interest.
|
--- Set points of interest.
|
||||||
|
--- Scroll will always centered on closer points
|
||||||
---@param self druid.scroll @{Scroll}
|
---@param self druid.scroll @{Scroll}
|
||||||
---@param points table Array of vector3 points
|
---@param points table Array of vector3 points
|
||||||
---@return druid.scroll Current scroll instance
|
---@return druid.scroll Current scroll instance
|
||||||
function druid__scroll.set_points(self, points) end
|
function druid__scroll.set_points(self, points) end
|
||||||
|
|
||||||
--- Set scroll content size.
|
--- Set scroll content size.
|
||||||
|
--- It will change content gui node size
|
||||||
---@param self druid.scroll @{Scroll}
|
---@param self druid.scroll @{Scroll}
|
||||||
---@param size vector3 The new size for content node
|
---@param size vector3 The new size for content node
|
||||||
---@param offset vector3 Offset value to set, where content is starts
|
---@param offset vector3 Offset value to set, where content is starts
|
||||||
@ -902,9 +993,18 @@ function druid__slider.init(self, node, end_pos, callback) end
|
|||||||
---@param is_silent bool Don't trigger event if true
|
---@param is_silent bool Don't trigger event if true
|
||||||
function druid__slider.set(self, value, is_silent) end
|
function druid__slider.set(self, value, is_silent) end
|
||||||
|
|
||||||
|
--- Set input zone for slider.
|
||||||
|
--- User can touch any place of node, pin instantly will move at this position and node drag will start. This function require the Defold version 1.3.0+
|
||||||
|
---@param self druid.slider @{Slider}
|
||||||
|
---@param input_node Node
|
||||||
|
---@return druid.slider @{Slider}
|
||||||
|
function druid__slider.set_input_node(self, input_node) end
|
||||||
|
|
||||||
--- Set slider steps.
|
--- Set slider steps.
|
||||||
|
--- Pin node will apply closest step position
|
||||||
---@param self druid.slider @{Slider}
|
---@param self druid.slider @{Slider}
|
||||||
---@param steps number[] Array of steps
|
---@param steps number[] Array of steps
|
||||||
|
---@return druid.slider @{Slider}
|
||||||
function druid__slider.set_steps(self, steps) end
|
function druid__slider.set_steps(self, steps) end
|
||||||
|
|
||||||
|
|
||||||
@ -933,6 +1033,7 @@ local druid__static_grid = {}
|
|||||||
function druid__static_grid.add(self, item, index, shift_policy, is_instant) end
|
function druid__static_grid.add(self, item, index, shift_policy, is_instant) end
|
||||||
|
|
||||||
--- Clear grid nodes array.
|
--- Clear grid nodes array.
|
||||||
|
--- GUI nodes will be not deleted! If you want to delete GUI nodes, use static_grid.nodes array before grid:clear
|
||||||
---@param self druid.static_grid @{StaticGrid}
|
---@param self druid.static_grid @{StaticGrid}
|
||||||
---@return druid.static_grid Current grid instance
|
---@return druid.static_grid Current grid instance
|
||||||
function druid__static_grid.clear(self) end
|
function druid__static_grid.clear(self) end
|
||||||
@ -983,6 +1084,7 @@ function druid__static_grid.get_size(self) end
|
|||||||
function druid__static_grid.init(self, parent, element, in_row) end
|
function druid__static_grid.init(self, parent, element, in_row) end
|
||||||
|
|
||||||
--- Remove the item from the grid.
|
--- Remove the item from the grid.
|
||||||
|
--- Note that gui node will be not deleted
|
||||||
---@param self druid.static_grid @{StaticGrid}
|
---@param self druid.static_grid @{StaticGrid}
|
||||||
---@param index number The grid node index to remove
|
---@param index number The grid node index to remove
|
||||||
---@param shift_policy number How shift nodes, if required. See const.SHIFT
|
---@param shift_policy number How shift nodes, if required. See const.SHIFT
|
||||||
@ -991,6 +1093,7 @@ function druid__static_grid.init(self, parent, element, in_row) end
|
|||||||
function druid__static_grid.remove(self, index, shift_policy, is_instant) end
|
function druid__static_grid.remove(self, index, shift_policy, is_instant) end
|
||||||
|
|
||||||
--- Set grid anchor.
|
--- Set grid anchor.
|
||||||
|
--- Default anchor is equal to anchor of grid parent node
|
||||||
---@param self druid.static_grid @{StaticGrid}
|
---@param self druid.static_grid @{StaticGrid}
|
||||||
---@param anchor vector3 Anchor
|
---@param anchor vector3 Anchor
|
||||||
function druid__static_grid.set_anchor(self, anchor) end
|
function druid__static_grid.set_anchor(self, anchor) end
|
||||||
@ -1002,6 +1105,7 @@ function druid__static_grid.set_anchor(self, anchor) end
|
|||||||
function druid__static_grid.set_in_row(self, in_row) end
|
function druid__static_grid.set_in_row(self, in_row) end
|
||||||
|
|
||||||
--- Change set position function for grid nodes.
|
--- Change set position function for grid nodes.
|
||||||
|
--- It will call on update poses on grid elements. Default: gui.set_position
|
||||||
---@param self druid.static_grid @{StaticGrid}
|
---@param self druid.static_grid @{StaticGrid}
|
||||||
---@param callback function Function on node set position
|
---@param callback function Function on node set position
|
||||||
---@return druid.static_grid Current grid instance
|
---@return druid.static_grid Current grid instance
|
||||||
@ -1017,7 +1121,7 @@ local druid__static_grid__style = {}
|
|||||||
---@class druid.swipe : druid.base_component
|
---@class druid.swipe : druid.base_component
|
||||||
---@field click_zone node Restriction zone
|
---@field click_zone node Restriction zone
|
||||||
---@field node node Swipe node
|
---@field node node Swipe node
|
||||||
---@field on_swipe druid.event Trigger on swipe event(self, swipe_side, dist, delta_time
|
---@field on_swipe druid.event Trigger on swipe event(self, swipe_side, dist, delta_time)
|
||||||
---@field style druid.swipe.style Component style params.
|
---@field style druid.swipe.style Component style params.
|
||||||
local druid__swipe = {}
|
local druid__swipe = {}
|
||||||
|
|
||||||
@ -1028,6 +1132,7 @@ local druid__swipe = {}
|
|||||||
function druid__swipe.init(self, node, on_swipe_callback) end
|
function druid__swipe.init(self, node, on_swipe_callback) end
|
||||||
|
|
||||||
--- Strict swipe click area.
|
--- Strict swipe click area.
|
||||||
|
--- Useful for restrict events outside stencil node
|
||||||
---@param self druid.swipe @{Swipe}
|
---@param self druid.swipe @{Swipe}
|
||||||
---@param zone node Gui node
|
---@param zone node Gui node
|
||||||
function druid__swipe.set_click_zone(self, zone) end
|
function druid__swipe.set_click_zone(self, zone) end
|
||||||
@ -1065,7 +1170,9 @@ function druid__text.get_text_adjust(self, adjust_type) end
|
|||||||
--- Calculate text width with font with respect to trailing space
|
--- Calculate text width with font with respect to trailing space
|
||||||
---@param self druid.text @{Text}
|
---@param self druid.text @{Text}
|
||||||
---@param text string
|
---@param text string
|
||||||
function druid__text.get_text_width(self, text) end
|
---@return number Width
|
||||||
|
---@return number Height
|
||||||
|
function druid__text.get_text_size(self, text) end
|
||||||
|
|
||||||
--- Component init function
|
--- Component init function
|
||||||
---@param self druid.text @{Text}
|
---@param self druid.text @{Text}
|
||||||
@ -1098,6 +1205,7 @@ function druid__text.set_color(self, color) end
|
|||||||
function druid__text.set_minimal_scale(self, minimal_scale) end
|
function druid__text.set_minimal_scale(self, minimal_scale) end
|
||||||
|
|
||||||
--- Set text pivot.
|
--- Set text pivot.
|
||||||
|
--- Text will re-anchor inside text area
|
||||||
---@param self druid.text @{Text}
|
---@param self druid.text @{Text}
|
||||||
---@param pivot gui.pivot Gui pivot constant
|
---@param pivot gui.pivot Gui pivot constant
|
||||||
---@return druid.text Current text instance
|
---@return druid.text Current text instance
|
||||||
@ -1172,22 +1280,16 @@ local druid_const = {}
|
|||||||
---@class druid_instance
|
---@class druid_instance
|
||||||
local druid_instance = {}
|
local druid_instance = {}
|
||||||
|
|
||||||
--- Create data list basic component
|
|
||||||
---@param druid_scroll druid.scroll The Scroll instance for Data List component
|
|
||||||
---@param druid_grid Grid The Grid instance for Data List component
|
|
||||||
---@param create_function function The create function callback(self, data, index, data_list). Function should return (node, [component])
|
|
||||||
---@return druid.data_list data_list component
|
|
||||||
function druid_instance.druid:new_data_list(druid_scroll, druid_grid, create_function) end
|
|
||||||
|
|
||||||
--- Call on final function on gui_script.
|
--- Call on final function on gui_script.
|
||||||
|
--- It will call on_remove on all druid components
|
||||||
---@param self druid_instance
|
---@param self druid_instance
|
||||||
function druid_instance.final(self) end
|
function druid_instance.final(self) end
|
||||||
|
|
||||||
--- Druid class constructor
|
--- Log message, if is_debug mode is enabled
|
||||||
---@param self druid_instance
|
---@param self druid_instance @{DruidInstance}
|
||||||
---@param context table Druid context. Usually it is self of script
|
---@param message string
|
||||||
---@param style table Druid style module
|
---@param context table
|
||||||
function druid_instance.initialize(self, context, style) end
|
function druid_instance.log_message(self, message, context) end
|
||||||
|
|
||||||
--- Create new druid component
|
--- Create new druid component
|
||||||
---@param self druid_instance
|
---@param self druid_instance
|
||||||
@ -1234,6 +1336,14 @@ function druid_instance.new_checkbox(self, node, callback, click_node, initial_s
|
|||||||
---@return druid.checkbox_group checkbox_group component
|
---@return druid.checkbox_group checkbox_group component
|
||||||
function druid_instance.new_checkbox_group(self, nodes, callback, click_nodes) end
|
function druid_instance.new_checkbox_group(self, nodes, callback, click_nodes) end
|
||||||
|
|
||||||
|
--- Create data list basic component
|
||||||
|
---@param self druid_instance
|
||||||
|
---@param druid_scroll druid.scroll The Scroll instance for Data List component
|
||||||
|
---@param druid_grid Grid The Grid instance for Data List component
|
||||||
|
---@param create_function function The create function callback(self, data, index, data_list). Function should return (node, [component])
|
||||||
|
---@return druid.data_list data_list component
|
||||||
|
function druid_instance.new_data_list(self, druid_scroll, druid_grid, create_function) end
|
||||||
|
|
||||||
--- Create drag basic component
|
--- Create drag basic component
|
||||||
---@param self druid_instance
|
---@param self druid_instance
|
||||||
---@param node node GUI node to detect dragging
|
---@param node node GUI node to detect dragging
|
||||||
@ -1341,14 +1451,6 @@ function druid_instance.new_text(self, node, value, no_adjust) end
|
|||||||
---@return druid.timer timer component
|
---@return druid.timer timer component
|
||||||
function druid_instance.new_timer(self, node, seconds_from, seconds_to, callback) end
|
function druid_instance.new_timer(self, node, seconds_from, seconds_to, callback) end
|
||||||
|
|
||||||
--- Druid on focus gained interest function.
|
|
||||||
---@param self druid_instance
|
|
||||||
function druid_instance.on_focus_gained(self) end
|
|
||||||
|
|
||||||
--- Druid on focus lost interest function.
|
|
||||||
---@param self druid_instance
|
|
||||||
function druid_instance.on_focus_lost(self) end
|
|
||||||
|
|
||||||
--- Druid on_input function
|
--- Druid on_input function
|
||||||
---@param self druid_instance
|
---@param self druid_instance
|
||||||
---@param action_id hash Action_id from on_input
|
---@param action_id hash Action_id from on_input
|
||||||
@ -1356,10 +1458,6 @@ function druid_instance.on_focus_lost(self) end
|
|||||||
---@return bool The boolean value is input was consumed
|
---@return bool The boolean value is input was consumed
|
||||||
function druid_instance.on_input(self, action_id, action) end
|
function druid_instance.on_input(self, action_id, action) end
|
||||||
|
|
||||||
--- Druid on language change.
|
|
||||||
---@param self druid_instance
|
|
||||||
function druid_instance.on_language_change(self) end
|
|
||||||
|
|
||||||
--- Druid on_message function
|
--- Druid on_message function
|
||||||
---@param self druid_instance
|
---@param self druid_instance
|
||||||
---@param message_id hash Message_id from on_message
|
---@param message_id hash Message_id from on_message
|
||||||
@ -1368,16 +1466,26 @@ function druid_instance.on_language_change(self) end
|
|||||||
function druid_instance.on_message(self, message_id, message, sender) end
|
function druid_instance.on_message(self, message_id, message, sender) end
|
||||||
|
|
||||||
--- Remove component from druid instance.
|
--- Remove component from druid instance.
|
||||||
|
--- Component `on_remove` function will be invoked, if exist.
|
||||||
---@param self druid_instance
|
---@param self druid_instance
|
||||||
---@param component Component Component instance
|
---@param component Component Component instance
|
||||||
function druid_instance.remove(self, component) end
|
function druid_instance.remove(self, component) end
|
||||||
|
|
||||||
--- Set blacklist components for input processing.
|
--- Set blacklist components for input processing.
|
||||||
---@param self druid_instance
|
--- If blacklist is not empty and component contains in this list, component will be not processed on input step
|
||||||
|
---@param self druid_instance @{DruidInstance}
|
||||||
---@param blacklist_components table|Component The array of component to blacklist
|
---@param blacklist_components table|Component The array of component to blacklist
|
||||||
function druid_instance.set_blacklist(self, blacklist_components) end
|
function druid_instance.set_blacklist(self, blacklist_components) end
|
||||||
|
|
||||||
|
--- Set debug mode for current Druid instance.
|
||||||
|
--- It's enable debug log messages
|
||||||
|
---@param self druid_instance @{DruidInstance}
|
||||||
|
---@param is_debug bool
|
||||||
|
---@return self @{DruidInstance}
|
||||||
|
function druid_instance.set_debug(self, is_debug) end
|
||||||
|
|
||||||
--- Set whitelist components for input processing.
|
--- Set whitelist components for input processing.
|
||||||
|
--- If whitelist is not empty and component not contains in this list, component will be not processed on input step
|
||||||
---@param self druid_instance
|
---@param self druid_instance
|
||||||
---@param whitelist_components table|Component The array of component to whitelist
|
---@param whitelist_components table|Component The array of component to whitelist
|
||||||
function druid_instance.set_whitelist(self, whitelist_components) end
|
function druid_instance.set_whitelist(self, whitelist_components) end
|
||||||
@ -1413,23 +1521,27 @@ function formats.second_string_min(s, tab) end
|
|||||||
local helper = {}
|
local helper = {}
|
||||||
|
|
||||||
--- Center two nodes.
|
--- Center two nodes.
|
||||||
|
--- Nodes will be center around 0 x position icon_node will be first (at left side)
|
||||||
---@param icon_node box Gui box node
|
---@param icon_node box Gui box node
|
||||||
---@param text_node text Gui text node
|
---@param text_node text Gui text node
|
||||||
---@param margin number Offset between nodes
|
---@param margin number Offset between nodes
|
||||||
function helper.centrate_icon_with_text(icon_node, text_node, margin) end
|
function helper.centrate_icon_with_text(icon_node, text_node, margin) end
|
||||||
|
|
||||||
--- Center several nodes nodes.
|
--- Center several nodes nodes.
|
||||||
|
--- Nodes will be center around 0 x position
|
||||||
---@param margin number Offset between nodes
|
---@param margin number Offset between nodes
|
||||||
---@param ... Node Any count of gui Node
|
---@param ... Node Any count of gui Node
|
||||||
function helper.centrate_nodes(margin, ...) end
|
function helper.centrate_nodes(margin, ...) end
|
||||||
|
|
||||||
--- Center two nodes.
|
--- Center two nodes.
|
||||||
|
--- Nodes will be center around 0 x position text_node will be first (at left side)
|
||||||
---@param text_node text Gui text node
|
---@param text_node text Gui text node
|
||||||
---@param icon_node box Gui box node
|
---@param icon_node box Gui box node
|
||||||
---@param margin number Offset between nodes
|
---@param margin number Offset between nodes
|
||||||
function helper.centrate_text_with_icon(text_node, icon_node, margin) end
|
function helper.centrate_text_with_icon(text_node, icon_node, margin) end
|
||||||
|
|
||||||
--- Show deprecated message.
|
--- Show deprecated message.
|
||||||
|
--- Once time per message
|
||||||
---@param message string The deprecated message
|
---@param message string The deprecated message
|
||||||
function helper.deprecated(message) end
|
function helper.deprecated(message) end
|
||||||
|
|
||||||
@ -1450,6 +1562,7 @@ function helper.get_closest_stencil_node(node) end
|
|||||||
function helper.get_pivot_offset(pivot) end
|
function helper.get_pivot_offset(pivot) end
|
||||||
|
|
||||||
--- Check if node is enabled in gui hierarchy.
|
--- Check if node is enabled in gui hierarchy.
|
||||||
|
--- Return false, if node or any his parent is disabled
|
||||||
---@param node node Gui node
|
---@param node node Gui node
|
||||||
---@return bool Is enabled in hierarchy
|
---@return bool Is enabled in hierarchy
|
||||||
function helper.is_enabled(node) end
|
function helper.is_enabled(node) end
|
||||||
|
|||||||
@ -260,8 +260,8 @@ function Input.set_text(self, input_text)
|
|||||||
self.text:set_to(final_text)
|
self.text:set_to(final_text)
|
||||||
|
|
||||||
-- measure it
|
-- measure it
|
||||||
self.text_width = self.text:get_text_width(value)
|
self.text_width = self.text:get_text_size(value)
|
||||||
self.marked_text_width = self.text:get_text_width(marked_value)
|
self.marked_text_width = self.text:get_text_size(marked_value)
|
||||||
self.total_width = self.text_width + self.marked_text_width
|
self.total_width = self.text_width + self.marked_text_width
|
||||||
|
|
||||||
self.on_input_text:trigger(self:get_context(), final_text)
|
self.on_input_text:trigger(self:get_context(), final_text)
|
||||||
|
|||||||
@ -189,7 +189,7 @@ end
|
|||||||
-- move at this position and node drag will start.
|
-- move at this position and node drag will start.
|
||||||
-- This function require the Defold version 1.3.0+
|
-- This function require the Defold version 1.3.0+
|
||||||
-- @tparam Slider self @{Slider}
|
-- @tparam Slider self @{Slider}
|
||||||
-- @tparam input_node Node
|
-- @tparam Node input_node
|
||||||
-- @treturn Slider @{Slider}
|
-- @treturn Slider @{Slider}
|
||||||
function Slider.set_input_node(self, input_node)
|
function Slider.set_input_node(self, input_node)
|
||||||
self._input_node = self:get_node(input_node)
|
self._input_node = self:get_node(input_node)
|
||||||
|
|||||||
210
example/engine_template.html
Normal file
210
example/engine_template.html
Normal file
@ -0,0 +1,210 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0, minimal-ui, shrink-to-fit=no">
|
||||||
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
||||||
|
<!-- The above 4 meta tags *must* come first in the head; any other head content must come *after* these tags -->
|
||||||
|
|
||||||
|
<title>{{project.title}} {{project.version}}</title>
|
||||||
|
<style type='text/css'>
|
||||||
|
/* Disable user selection to avoid strange bug in Chrome on Windows:
|
||||||
|
* Selecting a text outside the canvas, then clicking+draging would
|
||||||
|
* drag the selected text but block mouse down/up events to the engine.
|
||||||
|
*/
|
||||||
|
body {
|
||||||
|
{{^DEFOLD_SCALE_MODE_IS_NO_SCALE}}
|
||||||
|
position: fixed; /* Prevent overscroll */
|
||||||
|
{{/DEFOLD_SCALE_MODE_IS_NO_SCALE}}
|
||||||
|
margin:0;
|
||||||
|
padding:0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.canvas-app-container {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
position: absolute;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.canvas-app-container:-webkit-full-screen {
|
||||||
|
/* Auto width and height in Safari/Chrome fullscreen. */
|
||||||
|
width: auto;
|
||||||
|
height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
#canvas {
|
||||||
|
outline: none;
|
||||||
|
border: 0;
|
||||||
|
width: 100%;
|
||||||
|
vertical-align: bottom;
|
||||||
|
}
|
||||||
|
|
||||||
|
#canvas-container {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
canvas:focus, canvas:active {
|
||||||
|
outline: none;
|
||||||
|
border: 0;
|
||||||
|
ie-dummy: expression(this.hideFocus=true);
|
||||||
|
-moz-outline-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div {
|
||||||
|
-webkit-tap-highlight-color: rgba(0,0,0,0);
|
||||||
|
-webkit-touch-callout: none;
|
||||||
|
-webkit-user-select: none;
|
||||||
|
-khtml-user-select: none;
|
||||||
|
-moz-user-select: none;
|
||||||
|
-ms-user-select: none;
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
{{{DEFOLD_CUSTOM_CSS_INLINE}}}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app-container" class="canvas-app-container">
|
||||||
|
<div id="canvas-container" class="canvas-app-canvas-container">
|
||||||
|
<canvas id="canvas" class="canvas-app-canvas" tabindex="1" width="{{display.width}}" height="{{display.height}}"></canvas>
|
||||||
|
</div>
|
||||||
|
<div class="buttons-background">
|
||||||
|
{{#html5.show_fullscreen_button}}
|
||||||
|
<div class="button" onclick="Module.toggleFullscreen();">Fullscreen</div>
|
||||||
|
{{/html5.show_fullscreen_button}}
|
||||||
|
{{#html5.show_made_with_defold}}
|
||||||
|
<div class="link">Made with <a href="https://defold.com/" target="_blank">Defold</a></div>
|
||||||
|
{{/html5.show_made_with_defold}}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!-- -->
|
||||||
|
<script id='engine-loader' type='text/javascript' src="dmloader.js"></script>
|
||||||
|
<!-- -->
|
||||||
|
<script id='engine-setup' type='text/javascript'>
|
||||||
|
var extra_params = {
|
||||||
|
archive_location_filter: function( path ) {
|
||||||
|
return ("{{DEFOLD_ARCHIVE_LOCATION_PREFIX}}" + path + "{{DEFOLD_ARCHIVE_LOCATION_SUFFIX}}");
|
||||||
|
},
|
||||||
|
engine_arguments: [{{#DEFOLD_ENGINE_ARGUMENTS}}"{{.}}",{{/DEFOLD_ENGINE_ARGUMENTS}}],
|
||||||
|
custom_heap_size: {{DEFOLD_HEAP_SIZE}},
|
||||||
|
full_screen_container: "#canvas-container",
|
||||||
|
disable_context_menu: true
|
||||||
|
}
|
||||||
|
|
||||||
|
Module['INITIAL_MEMORY'] = extra_params.custom_heap_size;
|
||||||
|
|
||||||
|
Module['onRuntimeInitialized'] = function() {
|
||||||
|
Module.runApp("canvas", extra_params);
|
||||||
|
};
|
||||||
|
|
||||||
|
Module["locateFile"] = function(path, scriptDirectory)
|
||||||
|
{
|
||||||
|
// dmengine*.wasm is hardcoded in the built JS loader for WASM,
|
||||||
|
// we need to replace it here with the correct project name.
|
||||||
|
if (path == "dmengine.wasm" || path == "dmengine_release.wasm" || path == "dmengine_headless.wasm") {
|
||||||
|
path = "{{exe-name}}.wasm";
|
||||||
|
}
|
||||||
|
return scriptDirectory + path;
|
||||||
|
};
|
||||||
|
|
||||||
|
var is_iOS = /iPad|iPhone|iPod/.test(navigator.userAgent) && !window.MSStream;
|
||||||
|
var buttonHeight = 0;
|
||||||
|
var prevInnerWidth = -1;
|
||||||
|
var prevInnerHeight = -1;
|
||||||
|
{{#html5.show_made_with_defold}}
|
||||||
|
buttonHeight = 42;
|
||||||
|
{{/html5.show_made_with_defold}}
|
||||||
|
{{#html5.show_fullscreen_button}}
|
||||||
|
buttonHeight = 42;
|
||||||
|
{{/html5.show_fullscreen_button}}
|
||||||
|
function resize_game_canvas() {
|
||||||
|
// Hack for iOS when exit from Fullscreen mode
|
||||||
|
if (is_iOS) {
|
||||||
|
window.scrollTo(0, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
var app_container = document.getElementById('app-container');
|
||||||
|
var game_canvas = document.getElementById('canvas');
|
||||||
|
var innerWidth = window.innerWidth;
|
||||||
|
var innerHeight = window.innerHeight - buttonHeight;
|
||||||
|
if (prevInnerWidth == innerWidth && prevInnerHeight == innerHeight)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
prevInnerWidth = innerWidth;
|
||||||
|
prevInnerHeight = innerHeight;
|
||||||
|
var width = {{display.width}};
|
||||||
|
var height = {{display.height}};
|
||||||
|
var targetRatio = width / height;
|
||||||
|
var actualRatio = innerWidth / innerHeight;
|
||||||
|
{{#DEFOLD_SCALE_MODE_IS_DOWNSCALE_FIT}}
|
||||||
|
//Downscale fit
|
||||||
|
if (innerWidth < width || innerHeight < height) {
|
||||||
|
if (actualRatio > targetRatio) {
|
||||||
|
width = innerHeight * targetRatio;
|
||||||
|
height = innerHeight;
|
||||||
|
app_container.style.marginLeft = ((innerWidth - width) / 2) + "px";
|
||||||
|
app_container.style.marginTop = "0px";
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
width = innerWidth;
|
||||||
|
height = innerWidth / targetRatio;
|
||||||
|
app_container.style.marginLeft = "0px";
|
||||||
|
app_container.style.marginTop = ((innerHeight - height) / 2) + "px";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
app_container.style.marginLeft = ((innerWidth - width) / 2) + "px";
|
||||||
|
app_container.style.marginTop = ((innerHeight - height) / 2) + "px";
|
||||||
|
}
|
||||||
|
{{/DEFOLD_SCALE_MODE_IS_DOWNSCALE_FIT}}
|
||||||
|
{{#DEFOLD_SCALE_MODE_IS_STRETCH}}
|
||||||
|
//Stretch
|
||||||
|
width = innerWidth;
|
||||||
|
height = innerHeight;
|
||||||
|
{{/DEFOLD_SCALE_MODE_IS_STRETCH}}
|
||||||
|
{{#DEFOLD_SCALE_MODE_IS_FIT}}
|
||||||
|
//Fit
|
||||||
|
if (actualRatio > targetRatio) {
|
||||||
|
width = innerHeight * targetRatio;
|
||||||
|
height = innerHeight;
|
||||||
|
app_container.style.marginLeft = ((innerWidth - width) / 2) + "px";
|
||||||
|
app_container.style.marginTop = "0px";
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
width = innerWidth;
|
||||||
|
height = innerWidth / targetRatio;
|
||||||
|
app_container.style.marginLeft = "0px";
|
||||||
|
app_container.style.marginTop = ((innerHeight - height) / 2) + "px";
|
||||||
|
}
|
||||||
|
{{/DEFOLD_SCALE_MODE_IS_FIT}}
|
||||||
|
{{#DEFOLD_SCALE_MODE_IS_NO_SCALE}}
|
||||||
|
//No scale
|
||||||
|
var margin_left = ((innerWidth - width) / 2);
|
||||||
|
margin_left = margin_left > 0 ? margin_left : 0;
|
||||||
|
var margin_top = ((innerHeight - height) / 2);
|
||||||
|
margin_top = margin_top > 0 ? margin_top : 0;
|
||||||
|
app_container.style.marginLeft = margin_left + "px";
|
||||||
|
app_container.style.marginTop = margin_top + "px";
|
||||||
|
{{/DEFOLD_SCALE_MODE_IS_NO_SCALE}}
|
||||||
|
app_container.style.width = width + "px";
|
||||||
|
app_container.style.height = height + buttonHeight + "px";
|
||||||
|
game_canvas.width = width;
|
||||||
|
game_canvas.height = height;
|
||||||
|
}
|
||||||
|
resize_game_canvas();
|
||||||
|
window.addEventListener('resize', resize_game_canvas, false);
|
||||||
|
window.addEventListener('orientationchange', resize_game_canvas, false);
|
||||||
|
window.addEventListener('focus', resize_game_canvas, false);
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script id='engine-start' type='text/javascript'>
|
||||||
|
EngineLoader.load("canvas", "{{exe-name}}");
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -180,7 +180,7 @@ nodes {
|
|||||||
z: 0.0
|
z: 0.0
|
||||||
w: 0.0
|
w: 0.0
|
||||||
}
|
}
|
||||||
clipping_mode: CLIPPING_MODE_NONE
|
clipping_mode: CLIPPING_MODE_STENCIL
|
||||||
clipping_visible: true
|
clipping_visible: true
|
||||||
clipping_inverted: false
|
clipping_inverted: false
|
||||||
alpha: 1.0
|
alpha: 1.0
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user