nbt
Version:
A parser and serializer for NBT archives
1,637 lines (339 loc) • 14.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Reader</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Reader</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>
<span class="ancestors"><a href="module-nbt.html">nbt</a>.</span>Reader<span class="signature">()</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Reader"><span class="type-signature"></span>new Reader<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
In addition to the named writing methods documented below,
the same methods are indexed by the NBT type number as well,
as shown in the example below.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line387">line 387</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="module-nbt.Writer.html">module:nbt.Writer</a></li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var reader = new nbt.Reader(buf);
int x = reader.int();
int y = reader[3]();
int z = reader[nbt.tagTypes.int]();</code></pre>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="offset"><span class="type-signature"></span>offset<span class="type-signature"> :number</span></h4>
<div class="description">
The current location in the buffer. Can be freely changed
within the bounds of the buffer.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line397">line 397</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="byte"><span class="type-signature"></span>byte<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line408">line 408</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read byte
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="byte"><span class="type-signature"></span>byte<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line413">line 413</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read unsigned byte
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="byteArray"><span class="type-signature"></span>byteArray<span class="signature">()</span><span class="type-signature"> → {Array.<number>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line449">line 449</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read array
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<number></span>
</dd>
</dl>
<h4 class="name" id="compound"><span class="type-signature"></span>compound<span class="signature">()</span><span class="type-signature"> → {Object.<string, {type: string, value}>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line522">line 522</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object.<string, {type: string, value}></span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>reader.compound();
// -> { foo: { type: int, value: 42 },
// bar: { type: string, value: 'Hello! }}</code></pre>
<h4 class="name" id="double"><span class="type-signature"></span>double<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line433">line 433</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read signed 64-bit float
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="float"><span class="type-signature"></span>float<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line428">line 428</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read signed 32-bit float
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="int"><span class="type-signature"></span>int<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line423">line 423</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read signed 32-bit integer
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="intArray"><span class="type-signature"></span>intArray<span class="signature">()</span><span class="type-signature"> → {Array.<number>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line462">line 462</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read array of 32-bit ints
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<number></span>
</dd>
</dl>
<h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line504">line 504</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>reader.list();
// -> { type: 'string', values: ['foo', 'bar'] }</code></pre>
<h4 class="name" id="long"><span class="type-signature"></span>long<span class="signature">()</span><span class="type-signature"> → {Array.<number>}</span></h4>
<div class="description">
As JavaScript does not not natively support 64-bit
integers, the value is returned as an array of two
32-bit integers, the upper and the lower.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line438">line 438</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
[upper, lower]
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<number></span>
</dd>
</dl>
<h4 class="name" id="longArray"><span class="type-signature"></span>longArray<span class="signature">()</span><span class="type-signature"> → {Array.<number>}</span></h4>
<div class="description">
As JavaScript does not not natively support 64-bit
integers, the value is returned as an array of arrays of two
32-bit integers, the upper and the lower.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line475">line 475</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read array of 64-bit ints
split into [upper, lower]
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<number></span>
</dd>
</dl>
<h4 class="name" id="short"><span class="type-signature"></span>short<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line418">line 418</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read signed 16-bit short
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="string"><span class="type-signature"></span>string<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nbt.js.html">nbt.js</a>, <a href="nbt.js.html#line493">line 493</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the read string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-nbt.html">nbt</a></li></ul><h3>Classes</h3><ul><li><a href="module-nbt.Reader.html">Reader</a></li><li><a href="module-nbt.Writer.html">Writer</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Dec 16 2018 05:05:14 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>