aperx/factorio-scenario-ExpCluster
1
0
Fork 0
mirror of https://github.com/PHIDIAS0303/ExpCluster.git synced 2025-12-28 03:55:23 +09:00
Code Issues Packages Projects Releases Wiki Activity
Files
0c52f0c793c09a952710fafb4bf78685cccacb9f
factorio-scenario-ExpCluster/docs/modules/expcore.gui.popups.html
Cooldude2606 1c23daa1ed Rename doc to docs
2019-08-23 15:14:36 +01:00

353 lines
12 KiB
HTML
Raw Blame History

<!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>Reference</title>
<link rel="stylesheet" href="../ldoc.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>ldoc</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="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
<li><a href="../modules/config.roles.html">config.roles</a></li>
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
<li><a href="../modules/control.html">control</a></li>
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
<li><a href="../modules/expcore.common.html">expcore.common</a></li>
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
<li><strong>expcore.gui.popups</strong></li>
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
<li><a href="../modules/expcore.permission_groups.html">expcore.permission_groups</a></li>
<li><a href="../modules/expcore.roles.html">expcore.roles</a></li>
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
<li><a href="../modules/utils.core.html">utils.core</a></li>
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
<li><a href="../modules/utils.event.html">utils.event</a></li>
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
<li><a href="../modules/utils.math.html">utils.math</a></li>
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
<li><a href="../modules/utils.table.html">utils.table</a></li>
<li><a href="../modules/utils.task.html">utils.task</a></li>
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>expcore.gui.popups</code></h1>
<p>Gui structure define for popup gui
[[</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#PopupFrames.get_flow">PopupFrames.get_flow (player)</a></td>
<td class="summary">Gets the left flow that contains the popup frames</td>
</tr>
<tr>
<td class="name" nowrap><a href="#PopupFrames.open">PopupFrames.open (define_name, player[, open_time], ...)</a></td>
<td class="summary">Opens a popup for the player, can give the amount of time it is open as well as params for the draw function</td>
</tr>
<tr>
<td class="name" nowrap><a href="#PopupFrames.new_popup">PopupFrames.new_popup ([name])</a></td>
<td class="summary">Creates a new popup frame define</td>
</tr>
<tr>
<td class="name" nowrap><a href="#PopupFrames._prototype:set_default_open_time">PopupFrames._prototype:set_default_open_time (amount)</a></td>
<td class="summary">Sets the default open time for the popup, will be used if non is provided with open</td>
</tr>
<tr>
<td class="name" nowrap><a href="#PopupFrames._prototype:open">PopupFrames._prototype:open (player[, open_time], ...)</a></td>
<td class="summary">Opens this define for a player, can be given open time and any other params for the draw function</td>
</tr>
</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#PopupFrames.close_progress">PopupFrames.close_progress</a></td>
<td class="summary">Progress bar which when depleaded will close the popup frame</td>
</tr>
<tr>
<td class="name" nowrap><a href="#PopupFrames.close_button">PopupFrames.close_button</a></td>
<td class="summary">A button which can be used to close the gui before the timer runs out</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "PopupFrames.get_flow"></a>
<strong>PopupFrames.get_flow (player)</strong>
</dt>
<dd>
Gets the left flow that contains the popup frames
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
<span class="types"><span class="type">LuaPlayer</span></span>
the player to get the flow for
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">LuaGuiElement</span></span>
the left flow that contains the popup frames
</ol>
</dd>
<dt>
<a name = "PopupFrames.open"></a>
<strong>PopupFrames.open (define_name, player[, open_time], ...)</strong>
</dt>
<dd>
Opens a popup for the player, can give the amount of time it is open as well as params for the draw function
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">define_name</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
the name of the define that you want to open for the player
</li>
<li><span class="parameter">player</span>
<span class="types"><span class="type">LuaPlayer</span></span>
the player to open the popup for
</li>
<li><span class="parameter">open_time</span>
<span class="types"><span class="type">number</span></span>
the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default
(<em>optional</em>)
</li>
<li><span class="parameter">...</span>
<span class="types"><span class="type">any</span></span>
the other params that you want to pass to your on_draw event
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">LuaGuiElement</span></span>
the frame that was drawn, the inner gui flow which contains the content
</ol>
</dd>
<dt>
<a name = "PopupFrames.new_popup"></a>
<strong>PopupFrames.new_popup ([name])</strong>
</dt>
<dd>
Creates a new popup frame define
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
the optional debug name that can be added
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the new popup frame define
</ol>
</dd>
<dt>
<a name = "PopupFrames._prototype:set_default_open_time"></a>
<strong>PopupFrames._prototype:set_default_open_time (amount)</strong>
</dt>
<dd>
Sets the default open time for the popup, will be used if non is provided with open
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">amount</span>
<span class="types"><span class="type">number</span></span>
the number of ticks, by default, the popup will be open for
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the define to allow for chaining
</ol>
</dd>
<dt>
<a name = "PopupFrames._prototype:open"></a>
<strong>PopupFrames._prototype:open (player[, open_time], ...)</strong>
</dt>
<dd>
Opens this define for a player, can be given open time and any other params for the draw function
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
<span class="types"><span class="type">LuaPlayer</span></span>
the player to open the popup for
</li>
<li><span class="parameter">open_time</span>
<span class="types"><span class="type">number</span></span>
the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default
(<em>optional</em>)
</li>
<li><span class="parameter">...</span>
<span class="types"><span class="type">any</span></span>
the other params that you want to pass to your on_draw event
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">LuaGuiElement</span></span>
the frame that was drawn, the inner gui flow which contains the content
</ol>
</dd>
</dl>
<h2><a name="Fields"></a>Fields</h2>
<dl class="function">
<dt>
<a name = "PopupFrames.close_progress"></a>
<strong>PopupFrames.close_progress</strong>
</dt>
<dd>
Progress bar which when depleaded will close the popup frame
</dd>
<dt>
<a name = "PopupFrames.close_button"></a>
<strong>PopupFrames.close_button</strong>
</dt>
<dd>
A button which can be used to close the gui before the timer runs out
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2019-05-29 22:30:49 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink