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/fluids/TileFluidHandler.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/net/minecraftforge/fluids/TileFluidHandler.html')
| -rw-r--r-- | javadoc/net/minecraftforge/fluids/TileFluidHandler.html | 491 |
1 files changed, 491 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/fluids/TileFluidHandler.html b/javadoc/net/minecraftforge/fluids/TileFluidHandler.html new file mode 100644 index 0000000..50a53aa --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/TileFluidHandler.html @@ -0,0 +1,491 @@ +<!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>TileFluidHandler (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="TileFluidHandler (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/fluids/RenderBlockFluid.html" title="class in net.minecraftforge.fluids"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/fluids/TileFluidHandler.html" target="_top">Frames</a></li> +<li><a href="TileFluidHandler.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </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.fluids</div> +<h2 title="Class TileFluidHandler" class="title">Class TileFluidHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">net.minecraft.tileentity.TileEntity</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.fluids.TileFluidHandler</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">TileFluidHandler</span> +extends <a href="../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">TileEntity</a> +implements <a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></pre> +<div class="block">Reference Tile Entity implementation of <a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids"><code>IFluidHandler</code></a>. Use/extend this or write your own.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../net/minecraftforge/fluids/FluidTank.html" title="class in net.minecraftforge.fluids">FluidTank</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#tank">tank</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraft.tileentity.TileEntity"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraft.tileentity.<a href="../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">TileEntity</a></h3> +<code><a href="../../../net/minecraft/tileentity/TileEntity.html#blockMetadata">blockMetadata</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#blockType">blockType</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#INFINITE_EXTENT_AABB">INFINITE_EXTENT_AABB</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#tileEntityInvalid">tileEntityInvalid</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#worldObj">worldObj</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#xCoord">xCoord</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#yCoord">yCoord</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#zCoord">zCoord</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#TileFluidHandler()">TileFluidHandler</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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/fluids/TileFluidHandler.html#canDrain(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.Fluid)">canDrain</a></strong>(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</code> +<div class="block">Returns true if the given fluid can be extracted from the given direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#canFill(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.Fluid)">canFill</a></strong>(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</code> +<div class="block">Returns true if the given fluid can be inserted into the given direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#drain(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.FluidStack,%20boolean)">drain</a></strong>(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> resource, + boolean doDrain)</code> +<div class="block">Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#drain(net.minecraftforge.common.util.ForgeDirection,%20int,%20boolean)">drain</a></strong>(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + int maxDrain, + boolean doDrain)</code> +<div class="block">Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#fill(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.FluidStack,%20boolean)">fill</a></strong>(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> resource, + boolean doFill)</code> +<div class="block">Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/fluids/FluidTankInfo.html" title="class in net.minecraftforge.fluids">FluidTankInfo</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#getTankInfo(net.minecraftforge.common.util.ForgeDirection)">getTankInfo</a></strong>(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from)</code> +<div class="block">Returns an array of objects which represent the internal tanks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#readFromNBT(net.minecraft.nbt.NBTTagCompound)">readFromNBT</a></strong>(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/TileFluidHandler.html#writeToNBT(net.minecraft.nbt.NBTTagCompound)">writeToNBT</a></strong>(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_net.minecraft.tileentity.TileEntity"> +<!-- --> +</a> +<h3>Methods inherited from class net.minecraft.tileentity.<a href="../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">TileEntity</a></h3> +<code><a href="../../../net/minecraft/tileentity/TileEntity.html#addMapping(java.lang.Class,%20java.lang.String)">addMapping</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#canUpdate()">canUpdate</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#createAndLoadEntity(net.minecraft.nbt.NBTTagCompound)">createAndLoadEntity</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#func_145828_a(net.minecraft.crash.CrashReportCategory)">func_145828_a</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#getBlockMetadata()">getBlockMetadata</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#getBlockType()">getBlockType</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#getDescriptionPacket()">getDescriptionPacket</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#getDistanceFrom(double,%20double,%20double)">getDistanceFrom</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#getMaxRenderDistanceSquared()">getMaxRenderDistanceSquared</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#getRenderBoundingBox()">getRenderBoundingBox</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#getWorldObj()">getWorldObj</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#hasWorldObj()">hasWorldObj</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#invalidate()">invalidate</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#isInvalid()">isInvalid</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#markDirty()">markDirty</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#onChunkUnload()">onChunkUnload</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#onDataPacket(net.minecraft.network.NetworkManager,%20net.minecraft.network.play.server.S35PacketUpdateTileEntity)">onDataPacket</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#receiveClientEvent(int,%20int)">receiveClientEvent</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#setWorldObj(net.minecraft.world.World)">setWorldObj</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#shouldRefresh(net.minecraft.block.Block,%20net.minecraft.block.Block,%20int,%20int,%20net.minecraft.world.World,%20int,%20int,%20int)">shouldRefresh</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#shouldRenderInPass(int)">shouldRenderInPass</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#updateContainingBlockInfo()">updateContainingBlockInfo</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#updateEntity()">updateEntity</a>, <a href="../../../net/minecraft/tileentity/TileEntity.html#validate()">validate</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="tank"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>tank</h4> +<pre>protected <a href="../../../net/minecraftforge/fluids/FluidTank.html" title="class in net.minecraftforge.fluids">FluidTank</a> tank</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="TileFluidHandler()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TileFluidHandler</h4> +<pre>public TileFluidHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="readFromNBT(net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFromNBT</h4> +<pre>public void readFromNBT(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../net/minecraft/tileentity/TileEntity.html#readFromNBT(net.minecraft.nbt.NBTTagCompound)">readFromNBT</a></code> in class <code><a href="../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">TileEntity</a></code></dd> +</dl> +</li> +</ul> +<a name="writeToNBT(net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeToNBT</h4> +<pre>public void writeToNBT(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../net/minecraft/tileentity/TileEntity.html#writeToNBT(net.minecraft.nbt.NBTTagCompound)">writeToNBT</a></code> in class <code><a href="../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">TileEntity</a></code></dd> +</dl> +</li> +</ul> +<a name="fill(net.minecraftforge.common.util.ForgeDirection, net.minecraftforge.fluids.FluidStack, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fill</h4> +<pre>public int fill(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> resource, + boolean doFill)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#fill(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.FluidStack,%20boolean)">IFluidHandler</a></code></strong></div> +<div class="block">Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#fill(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.FluidStack,%20boolean)">fill</a></code> in interface <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - Orientation the Fluid is pumped in from.</dd><dd><code>resource</code> - FluidStack representing the Fluid and maximum amount of fluid to be filled.</dd><dd><code>doFill</code> - If false, fill will only be simulated.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Amount of resource that was (or would have been, if simulated) filled.</dd></dl> +</li> +</ul> +<a name="drain(net.minecraftforge.common.util.ForgeDirection, net.minecraftforge.fluids.FluidStack, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>drain</h4> +<pre>public <a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> drain(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> resource, + boolean doDrain)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#drain(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.FluidStack,%20boolean)">IFluidHandler</a></code></strong></div> +<div class="block">Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#drain(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.FluidStack,%20boolean)">drain</a></code> in interface <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - Orientation the Fluid is drained to.</dd><dd><code>resource</code> - FluidStack representing the Fluid and maximum amount of fluid to be drained.</dd><dd><code>doDrain</code> - If false, drain will only be simulated.</dd> +<dt><span class="strong">Returns:</span></dt><dd>FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.</dd></dl> +</li> +</ul> +<a name="drain(net.minecraftforge.common.util.ForgeDirection, int, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>drain</h4> +<pre>public <a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> drain(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + int maxDrain, + boolean doDrain)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#drain(net.minecraftforge.common.util.ForgeDirection,%20int,%20boolean)">IFluidHandler</a></code></strong></div> +<div class="block">Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler. + + This method is not Fluid-sensitive.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#drain(net.minecraftforge.common.util.ForgeDirection,%20int,%20boolean)">drain</a></code> in interface <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - Orientation the fluid is drained to.</dd><dd><code>maxDrain</code> - Maximum amount of fluid to drain.</dd><dd><code>doDrain</code> - If false, drain will only be simulated.</dd> +<dt><span class="strong">Returns:</span></dt><dd>FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.</dd></dl> +</li> +</ul> +<a name="canFill(net.minecraftforge.common.util.ForgeDirection, net.minecraftforge.fluids.Fluid)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canFill</h4> +<pre>public boolean canFill(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#canFill(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.Fluid)">IFluidHandler</a></code></strong></div> +<div class="block">Returns true if the given fluid can be inserted into the given direction. + + More formally, this should return true if fluid is able to enter from the given direction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#canFill(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.Fluid)">canFill</a></code> in interface <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="canDrain(net.minecraftforge.common.util.ForgeDirection, net.minecraftforge.fluids.Fluid)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canDrain</h4> +<pre>public boolean canDrain(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from, + <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#canDrain(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.Fluid)">IFluidHandler</a></code></strong></div> +<div class="block">Returns true if the given fluid can be extracted from the given direction. + + More formally, this should return true if fluid is able to leave from the given direction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#canDrain(net.minecraftforge.common.util.ForgeDirection,%20net.minecraftforge.fluids.Fluid)">canDrain</a></code> in interface <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="getTankInfo(net.minecraftforge.common.util.ForgeDirection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTankInfo</h4> +<pre>public <a href="../../../net/minecraftforge/fluids/FluidTankInfo.html" title="class in net.minecraftforge.fluids">FluidTankInfo</a>[] getTankInfo(<a href="../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> from)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#getTankInfo(net.minecraftforge.common.util.ForgeDirection)">IFluidHandler</a></code></strong></div> +<div class="block">Returns an array of objects which represent the internal tanks. These objects cannot be used + to manipulate the internal tanks. See <a href="../../../net/minecraftforge/fluids/FluidTankInfo.html" title="class in net.minecraftforge.fluids"><code>FluidTankInfo</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html#getTankInfo(net.minecraftforge.common.util.ForgeDirection)">getTankInfo</a></code> in interface <code><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids">IFluidHandler</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - Orientation determining which tanks should be queried.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Info for the relevant internal tanks.</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/fluids/RenderBlockFluid.html" title="class in net.minecraftforge.fluids"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/fluids/TileFluidHandler.html" target="_top">Frames</a></li> +<li><a href="TileFluidHandler.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |