diff options
| author | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
|---|---|---|
| committer | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
| commit | dc3df3edd5843bde0c1335d6a8e460b2c832aa48 (patch) | |
| tree | af13bfeee567f2351e35e1ef176d168fe37c8aac /javadoc/net/minecraftforge/common/IShearable.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/net/minecraftforge/common/IShearable.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/IShearable.html | 264 |
1 files changed, 264 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/IShearable.html b/javadoc/net/minecraftforge/common/IShearable.html new file mode 100644 index 0000000..4c316d5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IShearable.html @@ -0,0 +1,264 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Feb 05 20:10:17 EST 2015 --> +<title>IShearable (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="IShearable (Forge API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.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"> +<ul class="navList"> +<li><a href="../../../net/minecraftforge/common/IPlantable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.html" title="interface in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/IShearable.html" target="_top">Frames</a></li> +<li><a href="IShearable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></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> +</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 name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">net.minecraftforge.common</div> +<h2 title="Interface IShearable" class="title">Interface IShearable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../net/minecraft/block/BlockDeadBush.html" title="class in net.minecraft.block">BlockDeadBush</a>, <a href="../../../net/minecraft/block/BlockDoublePlant.html" title="class in net.minecraft.block">BlockDoublePlant</a>, <a href="../../../net/minecraft/block/BlockLeaves.html" title="class in net.minecraft.block">BlockLeaves</a>, <a href="../../../net/minecraft/block/BlockNewLeaf.html" title="class in net.minecraft.block">BlockNewLeaf</a>, <a href="../../../net/minecraft/block/BlockOldLeaf.html" title="class in net.minecraft.block">BlockOldLeaf</a>, <a href="../../../net/minecraft/block/BlockTallGrass.html" title="class in net.minecraft.block">BlockTallGrass</a>, <a href="../../../net/minecraft/block/BlockVine.html" title="class in net.minecraft.block">BlockVine</a>, <a href="../../../net/minecraft/entity/passive/EntityMooshroom.html" title="class in net.minecraft.entity.passive">EntityMooshroom</a>, <a href="../../../net/minecraft/entity/passive/EntitySheep.html" title="class in net.minecraft.entity.passive">EntitySheep</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IShearable</span></pre> +<div class="block">This allows for mods to create there own Shear-like items + and have them interact with Blocks/Entities without extra work. + Also, if your block/entity supports the Shears, this allows you + to support mod-shears as well.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IShearable.html#isShearable(net.minecraft.item.ItemStack,%20net.minecraft.world.IBlockAccess,%20int,%20int,%20int)">isShearable</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</code> +<div class="block">Checks if the object is currently shearable + Example: Sheep return false when they have no wool</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.ArrayList<<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IShearable.html#onSheared(net.minecraft.item.ItemStack,%20net.minecraft.world.IBlockAccess,%20int,%20int,%20int,%20int)">onSheared</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z, + int fortune)</code> +<div class="block">Performs the shear function on this object.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isShearable(net.minecraft.item.ItemStack, net.minecraft.world.IBlockAccess, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isShearable</h4> +<pre>boolean isShearable(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</pre> +<div class="block">Checks if the object is currently shearable + Example: Sheep return false when they have no wool</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - The itemstack that is being used, Possible to be null</dd><dd><code>world</code> - The current world</dd><dd><code>x</code> - The X Position</dd><dd><code>y</code> - The Y Position</dd><dd><code>z</code> - The Z Position</dd> +<dt><span class="strong">Returns:</span></dt><dd>If this is shearable, and onSheared should be called.</dd></dl> +</li> +</ul> +<a name="onSheared(net.minecraft.item.ItemStack, net.minecraft.world.IBlockAccess, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onSheared</h4> +<pre>java.util.ArrayList<<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>> onSheared(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z, + int fortune)</pre> +<div class="block">Performs the shear function on this object. + This is called for both client, and server. + The object should perform all actions related to being sheared, + except for dropping of the items, and removal of the block. + As those are handled by ItemShears itself. + + Returns a list of items that resulted from the shearing process. + + For entities, they should trust there internal location information + over the values passed into this function.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - The itemstack that is being used, Possible to be null</dd><dd><code>world</code> - The current world</dd><dd><code>x</code> - The X Position</dd><dd><code>y</code> - The Y Position</dd><dd><code>z</code> - The Z Position</dd><dd><code>fortune</code> - The fortune level of the shears being used</dd> +<dt><span class="strong">Returns:</span></dt><dd>A ArrayList containing all items from this shearing. Possible to be null.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.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"> +<ul class="navList"> +<li><a href="../../../net/minecraftforge/common/IPlantable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.html" title="interface in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/IShearable.html" target="_top">Frames</a></li> +<li><a href="IShearable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.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> +</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 name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |