162 lines
3.9 KiB
HTML
162 lines
3.9 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>Personal Bookmarks</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>pbmarks <span style="font-size:12pt;">(v1.2)</span></h1>
|
|
|
|
|
|
<ul>
|
|
<li><a href="../api.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/settings.lua.html">settings.lua</a></li>
|
|
<li><a href="../modules/api.lua.html">api.lua</a></li>
|
|
<li><strong>formspec.lua</strong></li>
|
|
<li><a href="../modules/chat.lua.html">chat.lua</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>formspec.lua</code></h1>
|
|
<p>Personal Bookmarks Formspec</p>
|
|
<p>
|
|
|
|
</p>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#pbmarks.get_formspec">pbmarks.get_formspec (pname, flags)</a></td>
|
|
<td class="summary">Retrieves formspec formatted string for this mod.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#pbmarks.show_formspec">pbmarks.show_formspec (pname, flags)</a></td>
|
|
<td class="summary">Displays formspec for managing bookmarks.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "pbmarks.get_formspec"></a>
|
|
<strong>pbmarks.get_formspec (pname, flags)</strong>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Retrieves formspec formatted string for this mod. </p>
|
|
|
|
<p> Usable flags:</p>
|
|
|
|
<pre><code>- version (number) formspec version (default: 4)
|
|
- noversion (boolean) no formspec version (overrides "version")
|
|
- width (number) formspec width
|
|
- height (number) formspec height
|
|
- noback (boolean) show "close" button instead of "back"
|
|
</code></pre>
|
|
|
|
|
|
|
|
</ul>
|
|
</ul>
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">pname</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
Player name referenced for bookmarks.
|
|
</li>
|
|
<li><span class="parameter">flags</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
Custom flags to set for formspec layout.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
Formatted string.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "pbmarks.show_formspec"></a>
|
|
<strong>pbmarks.show_formspec (pname, flags)</strong>
|
|
</dt>
|
|
<dd>
|
|
Displays formspec for managing bookmarks.
|
|
|
|
</ul>
|
|
</ul>
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">pname</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
Player name referenced for bookmarks & who will be shown formspec.
|
|
</li>
|
|
<li><span class="parameter">flags</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
see: <a href="../modules/formspec.lua.html#pbmarks.get_formspec">pbmarks.get_formspec</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
|
<i style="float:right;">Last updated 2021-08-18 08:18:35 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|