mirror of
https://github.com/KAMKEEL/CustomNPC-Plus.git
synced 2026-11-11 17:17:37 +00:00
1375 lines
49 KiB
HTML
1375 lines
49 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.27) on Tue Oct 28 02:00:43 EDT 2025 -->
|
|
<title>IItemStack</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="dc.created" content="2025-10-28">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="IItemStack";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= 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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">noppes.npcs.api.item</a></div>
|
|
<h2 title="Interface IItemStack" class="title">Interface IItemStack</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Subinterfaces:</dt>
|
|
<dd><code><a href="IItemCustom.html" title="interface in noppes.npcs.api.item">IItemCustom</a></code>, <code><a href="IItemCustomizable.html" title="interface in noppes.npcs.api.item">IItemCustomizable</a></code>, <code><a href="IItemLinked.html" title="interface in noppes.npcs.api.item">IItemLinked</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public interface <span class="typeNameLabel">IItemStack</span></pre>
|
|
<div class="block">Represents an item stack with extended functionality:
|
|
enchantments, lore, and additional item data.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<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>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addEnchant(int,int)">addEnchant</a></span>​(int id,
|
|
int strength)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Adds an enchantment to the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compare(noppes.npcs.api.item.IItemStack,boolean)">compare</a></span>​(<a href="IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a> item,
|
|
boolean ignoreNBT)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Compares this item with another item, with an option to ignore NBT data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compare(noppes.npcs.api.item.IItemStack,boolean,boolean)">compare</a></span>​(<a href="IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a> item,
|
|
boolean ignoreDamage,
|
|
boolean ignoreNBT)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Compares this item with another item, with options to ignore damage and/or NBT data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy()">copy</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a deep copy of this item stack.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttribute(java.lang.String)">getAttribute</a></span>​(java.lang.String name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves the attribute value using the default MC attribute system.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBookAuthor()">getBookAuthor</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBookText()">getBookText</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBookTitle()">getBookTitle</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomAttribute(java.lang.String)">getCustomAttribute</a></span>​(java.lang.String key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the custom attribute object associated with the given key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomAttributeKeys()">getCustomAttributeKeys</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns an array of all custom attribute keys stored on the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDisplayName()">getDisplayName</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItemDamage()">getItemDamage</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItemName()">getItemName</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="../INbt.html" title="interface in noppes.npcs.api">INbt</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItemNbt()">getItemNbt</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns an INbt instance representing the full NBT data of the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLore()">getLore</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMagicAttribute(java.lang.String,int)">getMagicAttribute</a></span>​(java.lang.String key,
|
|
int magicId)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the magic attribute object (typically a Float value) associated with the given key and magic identifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMagicAttributeKeys(java.lang.String)">getMagicAttributeKeys</a></span>​(java.lang.String key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns an array of all magic attribute keys (as strings) for the specified magic attribute key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxItemDamage()">getMaxItemDamage</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxStackSize()">getMaxStackSize</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code>net.minecraft.item.ItemStack</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMCItemStack()">getMCItemStack</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the underlying Minecraft ItemStack.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code>net.minecraft.nbt.NBTTagCompound</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMCNbt()">getMCNbt</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the underlying Minecraft NBTTagCompound for the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="../INbt.html" title="interface in noppes.npcs.api">INbt</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNbt()">getNbt</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns an INbt instance representing the item's custom NBT data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequirement(java.lang.String)">getRequirement</a></span>​(java.lang.String reqKey)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves the requirement value for the specified key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequirementKeys()">getRequirementKeys</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns an array of all requirement keys stored on the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStackSize()">getStackSize</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTag(java.lang.String)">getTag</a></span>​(java.lang.String key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the value of the NBT tag with the specified key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAttribute(java.lang.String)">hasAttribute</a></span>​(java.lang.String name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks if the item has an attribute (using the default MC attribute system).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCustomAttribute(java.lang.String)">hasCustomAttribute</a></span>​(java.lang.String key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks whether the item has a custom attribute with the specified key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCustomName()">hasCustomName</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasEnchant(int)">hasEnchant</a></span>​(int id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks if the item has the specified enchantment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasLore()">hasLore</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasMagicAttribute(java.lang.String,int)">hasMagicAttribute</a></span>​(java.lang.String key,
|
|
int magicId)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks whether the item has a magic attribute with the given key and magic identifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasRequirement(java.lang.String)">hasRequirement</a></span>​(java.lang.String reqKey)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks whether the item has a requirement with the specified key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasTag(java.lang.String)">hasTag</a></span>​(java.lang.String key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks if the item has an NBT tag with the specified key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i35" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlock()">isBlock</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnchanted()">isEnchanted</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isWrittenBook()">isWrittenBook</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#itemHash()">itemHash</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns a hash value for the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i39" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeCustomAttribute(java.lang.String)">removeCustomAttribute</a></span>​(java.lang.String key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Removes the custom attribute with the specified key from the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i40" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMagicAttribute(java.lang.String,int)">removeMagicAttribute</a></span>​(java.lang.String key,
|
|
int magicId)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Removes the magic attribute with the specified key and magic identifier from the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i41" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeRequirement(java.lang.String)">removeRequirement</a></span>​(java.lang.String reqKey)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Removes the requirement with the specified key from the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i42" class="altColor">
|
|
<td class="colFirst"><code><a href="../INbt.html" title="interface in noppes.npcs.api">INbt</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeTags()">removeTags</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Removes all custom tags from the item and returns the removed NBT data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i43" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAttribute(java.lang.String,double)">setAttribute</a></span>​(java.lang.String name,
|
|
double value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets an attribute on the item using the default MC attribute system.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i44" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCustomAttribute(java.lang.String,double)">setCustomAttribute</a></span>​(java.lang.String key,
|
|
double value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the custom attribute value for the given key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i45" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCustomName(java.lang.String)">setCustomName</a></span>​(java.lang.String name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the custom name for the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i46" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setItemDamage(int)">setItemDamage</a></span>​(int value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the item damage value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i47" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLore(java.lang.String%5B%5D)">setLore</a></span>​(java.lang.String[] lore)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the lore for the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i48" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMagicAttribute(java.lang.String,int,double)">setMagicAttribute</a></span>​(java.lang.String key,
|
|
int magicId,
|
|
double value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the magic attribute value for the given key and magic identifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i49" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMCNbt(net.minecraft.nbt.NBTTagCompound)">setMCNbt</a></span>​(net.minecraft.nbt.NBTTagCompound compound)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the underlying Minecraft NBTTagCompound for the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i50" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRequirement(java.lang.String,java.lang.Object)">setRequirement</a></span>​(java.lang.String reqKey,
|
|
java.lang.Object value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets (or applies) a requirement for the item using the given requirement key and value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i51" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStackSize(int)">setStackSize</a></span>​(int size)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the stack size of the item.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i52" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTag(java.lang.String,java.lang.Object)">setTag</a></span>​(java.lang.String key,
|
|
java.lang.Object value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets an NBT tag for this item.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="getName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre class="methodSignature">java.lang.String getName()</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="getStackSize()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getStackSize</h4>
|
|
<pre class="methodSignature">int getStackSize()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the stack size.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasCustomName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasCustomName</h4>
|
|
<pre class="methodSignature">boolean hasCustomName()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns whether the item has a custom name.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setCustomName(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCustomName</h4>
|
|
<pre class="methodSignature">void setCustomName​(java.lang.String name)</pre>
|
|
<div class="block">Sets the custom name for the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - The custom name.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getDisplayName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDisplayName</h4>
|
|
<pre class="methodSignature">java.lang.String getDisplayName()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the in-game displayed name. This is either the item name or the custom name if set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getItemName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getItemName</h4>
|
|
<pre class="methodSignature">java.lang.String getItemName()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the base item name, regardless of any custom name.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setStackSize(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setStackSize</h4>
|
|
<pre class="methodSignature">void setStackSize​(int size)</pre>
|
|
<div class="block">Sets the stack size of the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>size</code> - The new stack size (between 1 and 64).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMaxStackSize()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxStackSize</h4>
|
|
<pre class="methodSignature">int getMaxStackSize()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the maximum stack size for this item.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getItemDamage()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getItemDamage</h4>
|
|
<pre class="methodSignature">int getItemDamage()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the item damage. For tools, this represents durability.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setItemDamage(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setItemDamage</h4>
|
|
<pre class="methodSignature">void setItemDamage​(int value)</pre>
|
|
<div class="block">Sets the item damage value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The new damage value.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setTag(java.lang.String,java.lang.Object)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTag</h4>
|
|
<pre class="methodSignature">void setTag​(java.lang.String key,
|
|
java.lang.Object value)</pre>
|
|
<div class="block">Sets an NBT tag for this item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The tag key.</dd>
|
|
<dd><code>value</code> - The value to store (Number or String).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasTag(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasTag</h4>
|
|
<pre class="methodSignature">boolean hasTag​(java.lang.String key)</pre>
|
|
<div class="block">Checks if the item has an NBT tag with the specified key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The tag key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if present, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getTag(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTag</h4>
|
|
<pre class="methodSignature">java.lang.Object getTag​(java.lang.String key)</pre>
|
|
<div class="block">Returns the value of the NBT tag with the specified key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The tag key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The tag value, or null if not present.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="removeTags()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeTags</h4>
|
|
<pre class="methodSignature"><a href="../INbt.html" title="interface in noppes.npcs.api">INbt</a> removeTags()</pre>
|
|
<div class="block">Removes all custom tags from the item and returns the removed NBT data.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The removed NBT data.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isEnchanted()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isEnchanted</h4>
|
|
<pre class="methodSignature">boolean isEnchanted()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns whether the item is enchanted.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasEnchant(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasEnchant</h4>
|
|
<pre class="methodSignature">boolean hasEnchant​(int id)</pre>
|
|
<div class="block">Checks if the item has the specified enchantment.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The enchantment id.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if present, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="addEnchant(int,int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addEnchant</h4>
|
|
<pre class="methodSignature">void addEnchant​(int id,
|
|
int strength)</pre>
|
|
<div class="block">Adds an enchantment to the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The enchantment id.</dd>
|
|
<dd><code>strength</code> - The enchantment strength.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setAttribute(java.lang.String,double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setAttribute</h4>
|
|
<pre class="methodSignature">void setAttribute​(java.lang.String name,
|
|
double value)</pre>
|
|
<div class="block">Sets an attribute on the item using the default MC attribute system.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - The attribute key.</dd>
|
|
<dd><code>value</code> - The attribute value.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getAttribute(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAttribute</h4>
|
|
<pre class="methodSignature">double getAttribute​(java.lang.String name)</pre>
|
|
<div class="block">Retrieves the attribute value using the default MC attribute system.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - The attribute key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasAttribute(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasAttribute</h4>
|
|
<pre class="methodSignature">boolean hasAttribute​(java.lang.String name)</pre>
|
|
<div class="block">Checks if the item has an attribute (using the default MC attribute system).</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - The attribute key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if present, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setCustomAttribute(java.lang.String,double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCustomAttribute</h4>
|
|
<pre class="methodSignature">void setCustomAttribute​(java.lang.String key,
|
|
double value)</pre>
|
|
<div class="block">Sets the custom attribute value for the given key.
|
|
The value is stored in the item's custom NBT structure.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The custom attribute key.</dd>
|
|
<dd><code>value</code> - The attribute value.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasCustomAttribute(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasCustomAttribute</h4>
|
|
<pre class="methodSignature">boolean hasCustomAttribute​(java.lang.String key)</pre>
|
|
<div class="block">Checks whether the item has a custom attribute with the specified key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The custom attribute key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the attribute exists, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCustomAttribute(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCustomAttribute</h4>
|
|
<pre class="methodSignature">float getCustomAttribute​(java.lang.String key)</pre>
|
|
<div class="block">Returns the custom attribute object associated with the given key.
|
|
This may be a raw value or a more complex structure.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The custom attribute key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute object value</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="removeCustomAttribute(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeCustomAttribute</h4>
|
|
<pre class="methodSignature">void removeCustomAttribute​(java.lang.String key)</pre>
|
|
<div class="block">Removes the custom attribute with the specified key from the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The custom attribute key.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setMagicAttribute(java.lang.String,int,double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMagicAttribute</h4>
|
|
<pre class="methodSignature">void setMagicAttribute​(java.lang.String key,
|
|
int magicId,
|
|
double value)</pre>
|
|
<div class="block">Sets the magic attribute value for the given key and magic identifier.
|
|
The value is stored in the item's custom NBT under "RPGCore" -> "Magic".</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The magic attribute key.</dd>
|
|
<dd><code>magicId</code> - The magic identifier.</dd>
|
|
<dd><code>value</code> - The attribute value.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasMagicAttribute(java.lang.String,int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasMagicAttribute</h4>
|
|
<pre class="methodSignature">boolean hasMagicAttribute​(java.lang.String key,
|
|
int magicId)</pre>
|
|
<div class="block">Checks whether the item has a magic attribute with the given key and magic identifier.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The magic attribute key.</dd>
|
|
<dd><code>magicId</code> - The magic identifier.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the attribute exists, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMagicAttribute(java.lang.String,int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMagicAttribute</h4>
|
|
<pre class="methodSignature">float getMagicAttribute​(java.lang.String key,
|
|
int magicId)</pre>
|
|
<div class="block">Returns the magic attribute object (typically a Float value) associated with the given key and magic identifier.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The magic attribute key.</dd>
|
|
<dd><code>magicId</code> - The magic identifier.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute object, or null if not present.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="removeMagicAttribute(java.lang.String,int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeMagicAttribute</h4>
|
|
<pre class="methodSignature">void removeMagicAttribute​(java.lang.String key,
|
|
int magicId)</pre>
|
|
<div class="block">Removes the magic attribute with the specified key and magic identifier from the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The magic attribute key.</dd>
|
|
<dd><code>magicId</code> - The magic identifier.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setRequirement(java.lang.String,java.lang.Object)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRequirement</h4>
|
|
<pre class="methodSignature">void setRequirement​(java.lang.String reqKey,
|
|
java.lang.Object value)</pre>
|
|
<div class="block">Sets (or applies) a requirement for the item using the given requirement key and value.
|
|
The requirement data is stored under "RPGCore" → "Requirements" in the item's NBT.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>reqKey</code> - The requirement key.</dd>
|
|
<dd><code>value</code> - The requirement value (Number or String).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasRequirement(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasRequirement</h4>
|
|
<pre class="methodSignature">boolean hasRequirement​(java.lang.String reqKey)</pre>
|
|
<div class="block">Checks whether the item has a requirement with the specified key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>reqKey</code> - The requirement key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the requirement exists, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getRequirement(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRequirement</h4>
|
|
<pre class="methodSignature">java.lang.Object getRequirement​(java.lang.String reqKey)</pre>
|
|
<div class="block">Retrieves the requirement value for the specified key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>reqKey</code> - The requirement key.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The requirement value as an Object (or null if not present).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="removeRequirement(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeRequirement</h4>
|
|
<pre class="methodSignature">void removeRequirement​(java.lang.String reqKey)</pre>
|
|
<div class="block">Removes the requirement with the specified key from the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>reqKey</code> - The requirement key.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCustomAttributeKeys()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCustomAttributeKeys</h4>
|
|
<pre class="methodSignature">java.lang.String[] getCustomAttributeKeys()</pre>
|
|
<div class="block">Returns an array of all custom attribute keys stored on the item.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array of custom attribute keys.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMagicAttributeKeys(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMagicAttributeKeys</h4>
|
|
<pre class="methodSignature">java.lang.String[] getMagicAttributeKeys​(java.lang.String key)</pre>
|
|
<div class="block">Returns an array of all magic attribute keys (as strings) for the specified magic attribute key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the magic attribute key (e.g. "magic_damage").</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array of magic identifier keys as strings.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getRequirementKeys()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRequirementKeys</h4>
|
|
<pre class="methodSignature">java.lang.String[] getRequirementKeys()</pre>
|
|
<div class="block">Returns an array of all requirement keys stored on the item.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array of requirement keys.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getLore()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLore</h4>
|
|
<pre class="methodSignature">java.lang.String[] getLore()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the lore (descriptive text) for the item.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasLore()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasLore</h4>
|
|
<pre class="methodSignature">boolean hasLore()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns whether the item has lore.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setLore(java.lang.String[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLore</h4>
|
|
<pre class="methodSignature">void setLore​(java.lang.String[] lore)</pre>
|
|
<div class="block">Sets the lore for the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>lore</code> - An array of lore strings.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="copy()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>copy</h4>
|
|
<pre class="methodSignature"><a href="IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a> copy()</pre>
|
|
<div class="block">Creates a deep copy of this item stack.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A copy of the item stack.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMaxItemDamage()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxItemDamage</h4>
|
|
<pre class="methodSignature">int getMaxItemDamage()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the maximum damage the item can sustain.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isWrittenBook()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isWrittenBook</h4>
|
|
<pre class="methodSignature">boolean isWrittenBook()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns whether the item is a written book.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getBookTitle()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBookTitle</h4>
|
|
<pre class="methodSignature">java.lang.String getBookTitle()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the book's title.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getBookAuthor()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBookAuthor</h4>
|
|
<pre class="methodSignature">java.lang.String getBookAuthor()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns the book's author.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getBookText()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBookText</h4>
|
|
<pre class="methodSignature">java.lang.String[] getBookText()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the item is a book, returns the book pages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isBlock()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isBlock</h4>
|
|
<pre class="methodSignature">boolean isBlock()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Returns whether the item represents a block.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getNbt()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNbt</h4>
|
|
<pre class="methodSignature"><a href="../INbt.html" title="interface in noppes.npcs.api">INbt</a> getNbt()</pre>
|
|
<div class="block">Returns an INbt instance representing the item's custom NBT data.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The custom NBT data.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getItemNbt()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getItemNbt</h4>
|
|
<pre class="methodSignature"><a href="../INbt.html" title="interface in noppes.npcs.api">INbt</a> getItemNbt()</pre>
|
|
<div class="block">Returns an INbt instance representing the full NBT data of the item.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The complete NBT data.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMCItemStack()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMCItemStack</h4>
|
|
<pre class="methodSignature">net.minecraft.item.ItemStack getMCItemStack()</pre>
|
|
<div class="block">Returns the underlying Minecraft ItemStack.
|
|
<p>No support is given for this method. Use with caution.</p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The Minecraft ItemStack.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="itemHash()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>itemHash</h4>
|
|
<pre class="methodSignature">int itemHash()</pre>
|
|
<div class="block">Returns a hash value for the item.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The item's hash code.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMCNbt()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMCNbt</h4>
|
|
<pre class="methodSignature">net.minecraft.nbt.NBTTagCompound getMCNbt()</pre>
|
|
<div class="block">Returns the underlying Minecraft NBTTagCompound for the item.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The NBTTagCompound.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setMCNbt(net.minecraft.nbt.NBTTagCompound)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMCNbt</h4>
|
|
<pre class="methodSignature">void setMCNbt​(net.minecraft.nbt.NBTTagCompound compound)</pre>
|
|
<div class="block">Sets the underlying Minecraft NBTTagCompound for the item.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>compound</code> - The NBTTagCompound to set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="compare(noppes.npcs.api.item.IItemStack,boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>compare</h4>
|
|
<pre class="methodSignature">boolean compare​(<a href="IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a> item,
|
|
boolean ignoreNBT)</pre>
|
|
<div class="block">Compares this item with another item, with an option to ignore NBT data.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>item</code> - The item to compare.</dd>
|
|
<dd><code>ignoreNBT</code> - true to ignore NBT data.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the items are considered equal, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="compare(noppes.npcs.api.item.IItemStack,boolean,boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>compare</h4>
|
|
<pre class="methodSignature">boolean compare​(<a href="IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a> item,
|
|
boolean ignoreDamage,
|
|
boolean ignoreNBT)</pre>
|
|
<div class="block">Compares this item with another item, with options to ignore damage and/or NBT data.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>item</code> - The item to compare.</dd>
|
|
<dd><code>ignoreDamage</code> - true to ignore damage values.</dd>
|
|
<dd><code>ignoreNBT</code> - true to ignore NBT data.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the items are considered equal, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|