Minestom/docs/net/minestom/server/utils/NBTUtils.html
2020-11-15 23:39:49 +01:00

403 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>NBTUtils (Minestom 1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: net.minestom.server.utils, class: NBTUtils">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">net.minestom.server.utils</a></div>
<h1 title="Class NBTUtils" class="title">Class NBTUtils</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">net.minestom.server.utils.NBTUtils</div>
</div>
<section class="description">
<hr>
<pre>public final class <span class="typeNameLabel">NBTUtils</span>
extends java.lang.Object</pre>
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li class="blockList">
<section class="nestedClassSummary"><a id="nested.class.summary">
<!-- -->
</a>
<h2>Nested Class Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="NBTUtils.EnchantmentSetter.html" title="interface in net.minestom.server.utils">NBTUtils.EnchantmentSetter</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>static java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromNBT(org.jglrxavpok.hephaistos.nbt.NBT)">fromNBT</a></span>&#8203;(org.jglrxavpok.hephaistos.nbt.NBT&nbsp;nbt)</code></th>
<td class="colLast">
<div class="block">Converts a nbt object to its raw value.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadAllItems(org.jglrxavpok.hephaistos.nbt.NBTList,net.minestom.server.inventory.Inventory)">loadAllItems</a></span>&#8203;(org.jglrxavpok.hephaistos.nbt.NBTList&lt;org.jglrxavpok.hephaistos.nbt.NBTCompound&gt;&nbsp;items,
<a href="../inventory/Inventory.html" title="class in net.minestom.server.inventory">Inventory</a>&nbsp;destination)</code></th>
<td class="colLast">
<div class="block">Loads all the items from the 'items' list into the given inventory</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadDataIntoItem(net.minestom.server.item.ItemStack,org.jglrxavpok.hephaistos.nbt.NBTCompound)">loadDataIntoItem</a></span>&#8203;(<a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a>&nbsp;item,
org.jglrxavpok.hephaistos.nbt.NBTCompound&nbsp;nbt)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadEnchantments(org.jglrxavpok.hephaistos.nbt.NBTList,net.minestom.server.utils.NBTUtils.EnchantmentSetter)">loadEnchantments</a></span>&#8203;(org.jglrxavpok.hephaistos.nbt.NBTList&lt;org.jglrxavpok.hephaistos.nbt.NBTCompound&gt;&nbsp;enchantments,
<a href="NBTUtils.EnchantmentSetter.html" title="interface in net.minestom.server.utils">NBTUtils.EnchantmentSetter</a>&nbsp;setter)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>static <a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readItemStack(net.minestom.server.utils.binary.BinaryReader)">readItemStack</a></span>&#8203;(<a href="binary/BinaryReader.html" title="class in net.minestom.server.utils.binary">BinaryReader</a>&nbsp;reader)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveAllItems(org.jglrxavpok.hephaistos.nbt.NBTList,net.minestom.server.inventory.Inventory)">saveAllItems</a></span>&#8203;(org.jglrxavpok.hephaistos.nbt.NBTList&lt;org.jglrxavpok.hephaistos.nbt.NBTCompound&gt;&nbsp;list,
<a href="../inventory/Inventory.html" title="class in net.minestom.server.inventory">Inventory</a>&nbsp;inventory)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveDataIntoNBT(net.minestom.server.item.ItemStack,org.jglrxavpok.hephaistos.nbt.NBTCompound)">saveDataIntoNBT</a></span>&#8203;(<a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a>&nbsp;itemStack,
org.jglrxavpok.hephaistos.nbt.NBTCompound&nbsp;itemNBT)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>static org.jglrxavpok.hephaistos.nbt.NBT</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toNBT(java.lang.Object,java.lang.Class,boolean)">toNBT</a></span>&#8203;(java.lang.Object&nbsp;value,
java.lang.Class&nbsp;type,
boolean&nbsp;supportDataType)</code></th>
<td class="colLast">
<div class="block">Converts an object into its <code>NBT</code> equivalent.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeEnchant(org.jglrxavpok.hephaistos.nbt.NBTCompound,java.lang.String,java.util.Map)">writeEnchant</a></span>&#8203;(org.jglrxavpok.hephaistos.nbt.NBTCompound&nbsp;nbt,
java.lang.String&nbsp;listName,
java.util.Map&lt;<a href="../item/Enchantment.html" title="enum in net.minestom.server.item">Enchantment</a>,&#8203;java.lang.Short&gt;&nbsp;enchantmentMap)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeItemStack(net.minestom.server.utils.binary.BinaryWriter,net.minestom.server.item.ItemStack)">writeItemStack</a></span>&#8203;(<a href="binary/BinaryWriter.html" title="class in net.minestom.server.utils.binary">BinaryWriter</a>&nbsp;packet,
<a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a>&nbsp;itemStack)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="loadAllItems(org.jglrxavpok.hephaistos.nbt.NBTList,net.minestom.server.inventory.Inventory)">loadAllItems</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">loadAllItems</span>&#8203;(<span class="arguments">@NotNull
org.jglrxavpok.hephaistos.nbt.NBTList&lt;org.jglrxavpok.hephaistos.nbt.NBTCompound&gt;&nbsp;items,
@NotNull
<a href="../inventory/Inventory.html" title="class in net.minestom.server.inventory">Inventory</a>&nbsp;destination)</span></div>
<div class="block">Loads all the items from the 'items' list into the given inventory</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - the items to save</dd>
<dd><code>destination</code> - the inventory destination</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="saveAllItems(org.jglrxavpok.hephaistos.nbt.NBTList,net.minestom.server.inventory.Inventory)">saveAllItems</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">saveAllItems</span>&#8203;(<span class="arguments">@NotNull
org.jglrxavpok.hephaistos.nbt.NBTList&lt;org.jglrxavpok.hephaistos.nbt.NBTCompound&gt;&nbsp;list,
@NotNull
<a href="../inventory/Inventory.html" title="class in net.minestom.server.inventory">Inventory</a>&nbsp;inventory)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="writeEnchant(org.jglrxavpok.hephaistos.nbt.NBTCompound,java.lang.String,java.util.Map)">writeEnchant</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">writeEnchant</span>&#8203;(<span class="arguments">@NotNull
org.jglrxavpok.hephaistos.nbt.NBTCompound&nbsp;nbt,
@NotNull
java.lang.String&nbsp;listName,
@NotNull
java.util.Map&lt;<a href="../item/Enchantment.html" title="enum in net.minestom.server.item">Enchantment</a>,&#8203;java.lang.Short&gt;&nbsp;enchantmentMap)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="readItemStack(net.minestom.server.utils.binary.BinaryReader)">readItemStack</a></h3>
<div class="memberSignature"><span class="annotations">@Nullable
</span><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a></span>&nbsp;<span class="memberName">readItemStack</span>&#8203;(<span class="arguments">@NotNull
<a href="binary/BinaryReader.html" title="class in net.minestom.server.utils.binary">BinaryReader</a>&nbsp;reader)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="loadDataIntoItem(net.minestom.server.item.ItemStack,org.jglrxavpok.hephaistos.nbt.NBTCompound)">loadDataIntoItem</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">loadDataIntoItem</span>&#8203;(<span class="arguments">@NotNull
<a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a>&nbsp;item,
@NotNull
org.jglrxavpok.hephaistos.nbt.NBTCompound&nbsp;nbt)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="loadEnchantments(org.jglrxavpok.hephaistos.nbt.NBTList,net.minestom.server.utils.NBTUtils.EnchantmentSetter)">loadEnchantments</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">loadEnchantments</span>&#8203;(<span class="arguments">org.jglrxavpok.hephaistos.nbt.NBTList&lt;org.jglrxavpok.hephaistos.nbt.NBTCompound&gt;&nbsp;enchantments,
<a href="NBTUtils.EnchantmentSetter.html" title="interface in net.minestom.server.utils">NBTUtils.EnchantmentSetter</a>&nbsp;setter)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="writeItemStack(net.minestom.server.utils.binary.BinaryWriter,net.minestom.server.item.ItemStack)">writeItemStack</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">writeItemStack</span>&#8203;(<span class="arguments"><a href="binary/BinaryWriter.html" title="class in net.minestom.server.utils.binary">BinaryWriter</a>&nbsp;packet,
<a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a>&nbsp;itemStack)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="saveDataIntoNBT(net.minestom.server.item.ItemStack,org.jglrxavpok.hephaistos.nbt.NBTCompound)">saveDataIntoNBT</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">saveDataIntoNBT</span>&#8203;(<span class="arguments">@NotNull
<a href="../item/ItemStack.html" title="class in net.minestom.server.item">ItemStack</a>&nbsp;itemStack,
@NotNull
org.jglrxavpok.hephaistos.nbt.NBTCompound&nbsp;itemNBT)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="toNBT(java.lang.Object,java.lang.Class,boolean)">toNBT</a></h3>
<div class="memberSignature"><span class="annotations">@Nullable
</span><span class="modifiers">public static</span>&nbsp;<span class="returnType">org.jglrxavpok.hephaistos.nbt.NBT</span>&nbsp;<span class="memberName">toNBT</span>&#8203;(<span class="arguments">@NotNull
java.lang.Object&nbsp;value,
@NotNull
java.lang.Class&nbsp;type,
boolean&nbsp;supportDataType)</span></div>
<div class="block">Converts an object into its <code>NBT</code> equivalent.
<p>
If <code>type</code> is not a primitive type or primitive array and <code>supportDataType</code> is true,
the data will be encoded with the appropriate <a href="../data/DataType.html" title="class in net.minestom.server.data"><code>DataType</code></a> into a byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the value to convert</dd>
<dd><code>type</code> - the type of the value, used to know which <a href="../data/DataType.html" title="class in net.minestom.server.data"><code>DataType</code></a> to use if <code>value</code> is not a primitive type</dd>
<dd><code>supportDataType</code> - true to allow using a <a href="../data/DataType.html" title="class in net.minestom.server.data"><code>DataType</code></a> to encode <code>value</code> into a byte array if not a primitive type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the converted value, null if <code>type</code> is not a primitive type and <code>supportDataType</code> is false</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="fromNBT(org.jglrxavpok.hephaistos.nbt.NBT)">fromNBT</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">java.lang.Object</span>&nbsp;<span class="memberName">fromNBT</span>&#8203;(<span class="arguments">@NotNull
org.jglrxavpok.hephaistos.nbt.NBT&nbsp;nbt)</span></div>
<div class="block">Converts a nbt object to its raw value.
<p>
Currently support number, string, byte/int/long array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nbt</code> - the nbt tag to convert</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value representation of a tag</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the tag type is not supported</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</div>
</div>
</body>
</html>