Files
factorio-scenario-ExpCluster/doc/modules/expcore.guiparts.popup.html
Cooldude2606 f5153f3686 Doc Added
2018-05-29 20:15:20 +01:00

139 lines
4.1 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>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>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
<li><strong>expcore.guiparts.popup</strong></li>
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/modules.expgaminglib.control.html">modules.expgaminglib.control</a></li>
<li><a href="../modules/defines.color.html">defines.color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li>
<li><a href="../modules/table.html">table</a></li>
<li><a href="../modules/defines.time.html">defines.time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="../scripts/control.lua.html">control.lua</a></li>
<li><a href="../scripts/index.lua.html">index.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>expcore.guiparts.popup</code></h1>
<p>Used to add a popup gui style</p>
<p></p>
<h3>Usage:</h3>
<ul>
<pre class="example">Gui.left.add{name=&apos;foo&apos;,caption=&apos;Foo&apos;,draw=function}
</pre>
</ul>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#open">open (style, data[, players=game.connected_players])</a></td>
<td class="summary">Use to open a popup for these players</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "open"></a>
<strong>open (style, data[, players=game.connected_players])</strong>
</dt>
<dd>
Use to open a popup for these players
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">style</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
this is the name you gave to the popup when added
</li>
<li><span class="parameter">data</span>
this is the data that is sent to the draw function
</li>
<li><span class="parameter">players</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the players to open the popup for
(<em>default</em> game.connected_players)
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">Gui.popup.open(<span class="string">'ban'</span>,<span class="keyword">nil</span>,{player=<span class="number">1</span>,reason=<span class="string">'foo'</span>})</pre>
</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 2018-05-29 20:15:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>