Files
factorio-scenario-ExpCluster/doc/modules/modules.expgamingcore.gui.control.html
2018-06-05 19:32:29 +01:00

168 lines
5.0 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/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingCore.Commands.html">ExpGamingCore.Commands</a></li>
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
<li><strong>modules.expgamingcore.gui.control</strong></li>
<li><a href="../modules/ExpGamingCore.Ranking.html">ExpGamingCore.Ranking</a></li>
<li><a href="../modules/ExpGamingCore.Server.html">ExpGamingCore.Server</a></li>
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>modules.expgamingcore.gui.control</code></h1>
<p>Add a white bar to any gui frame</p>
<p></p>
<h3>Usage:</h3>
<ul>
<pre class="example">Gui.bar(frame,100)
</pre>
</ul>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Gui.set_dropdown_index">Gui.set_dropdown_index (dropdown, _item)</a></td>
<td class="summary">Used to set the index of a drop down to a certian item</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Gui.cam_link">Gui.cam_link (data)</a></td>
<td class="summary">Adds a camera that updates every tick (or less depeading on how many are opening) it will move to follow an entity</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Gui.set_dropdown_index"></a>
<strong>Gui.set_dropdown_index (dropdown, _item)</strong>
</dt>
<dd>
Used to set the index of a drop down to a certian item
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">dropdown</span>
the dropdown that is to be effected
</li>
<li><span class="parameter">_item</span>
this is the item to look for
</li>
</ul>
<h3>Returns:</h3>
<ol>
returns the dropdown if it was successful
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example">Gui.set_dropdown_index(dropdown,player.name)</pre>
</ul>
</dd>
<dt>
<a name = "Gui.cam_link"></a>
<strong>Gui.cam_link (data)</strong>
</dt>
<dd>
Adds a camera that updates every tick (or less depeading on how many are opening) it will move to follow an entity
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">data</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
contains all other params given below
</li>
</ul>
<h3>Returns:</h3>
<ol>
the camera that the function used be it made or given as a param
</ol>
<h3>Usage:</h3>
<ul>
<li><pre class="example">Gui.cam_link{entity=game.player.character,frame=frame,width=<span class="number">50</span>,hight=<span class="number">50</span>,zoom=<span class="number">1</span>}</pre></li>
<li><pre class="example">Gui.cam_link{entity=game.player.character,cam=frame.camera,surface=game.surfaces[<span class="string">'testing'</span>]}</pre></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 2018-06-05 19:31:42 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>