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/FluidRegistry.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/net/minecraftforge/fluids/FluidRegistry.html')
| -rw-r--r-- | javadoc/net/minecraftforge/fluids/FluidRegistry.html | 488 |
1 files changed, 488 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/fluids/FluidRegistry.html b/javadoc/net/minecraftforge/fluids/FluidRegistry.html new file mode 100644 index 0000000..ae3c6bf --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidRegistry.html @@ -0,0 +1,488 @@ +<!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>FluidRegistry (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="FluidRegistry (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/FluidEvent.FluidSpilledEvent.html" title="class in net.minecraftforge.fluids"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html" title="class in net.minecraftforge.fluids"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/fluids/FluidRegistry.html" target="_top">Frames</a></li> +<li><a href="FluidRegistry.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><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </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>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.fluids</div> +<h2 title="Class FluidRegistry" class="title">Class FluidRegistry</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.fluids.FluidRegistry</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">FluidRegistry</span> +extends java.lang.Object</pre> +<div class="block">Handles Fluid registrations. Fluids MUST be registered in order to function.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html" title="class in net.minecraftforge.fluids">FluidRegistry.FluidRegisterEvent</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- =========== 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>static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#LAVA">LAVA</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#renderIdFluid">renderIdFluid</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#WATER">WATER</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>static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getFluid(int)">getFluid</a></strong>(int fluidID)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getFluid(java.lang.String)">getFluid</a></strong>(java.lang.String fluidName)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getFluidID(java.lang.String)">getFluidID</a></strong>(java.lang.String fluidName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getFluidName(net.minecraftforge.fluids.FluidStack)">getFluidName</a></strong>(<a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> stack)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getFluidName(int)">getFluidName</a></strong>(int fluidID)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/FluidRegistry.html#getFluidStack(java.lang.String,%20int)">getFluidStack</a></strong>(java.lang.String fluidName, + int amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getMaxID()">getMaxID</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Map<java.lang.String,java.lang.Integer></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getRegisteredFluidIDs()">getRegisteredFluidIDs</a></strong>()</code> +<div class="block">Returns a read-only map containing Fluid Names and their associated IDs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Map<java.lang.String,<a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#getRegisteredFluids()">getRegisteredFluids</a></strong>()</code> +<div class="block">Returns a read-only map containing Fluid Names and their associated Fluids.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#initFluidIDs(com.google.common.collect.BiMap)">initFluidIDs</a></strong>(com.google.common.collect.BiMap<java.lang.String,java.lang.Integer> newfluidIDs)</code> +<div class="block">Called by Forge to prepare the ID map for server -> client sync.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#isFluidRegistered(net.minecraftforge.fluids.Fluid)">isFluidRegistered</a></strong>(<a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#isFluidRegistered(java.lang.String)">isFluidRegistered</a></strong>(java.lang.String fluidName)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#lookupFluidForBlock(net.minecraft.block.Block)">lookupFluidForBlock</a></strong>(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/FluidRegistry.html#registerFluid(net.minecraftforge.fluids.Fluid)">registerFluid</a></strong>(<a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</code> +<div class="block">Register a new Fluid.</div> +</td> +</tr> +</table> +<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="WATER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WATER</h4> +<pre>public static final <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> WATER</pre> +</li> +</ul> +<a name="LAVA"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LAVA</h4> +<pre>public static final <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> LAVA</pre> +</li> +</ul> +<a name="renderIdFluid"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>renderIdFluid</h4> +<pre>public static int renderIdFluid</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initFluidIDs(com.google.common.collect.BiMap)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initFluidIDs</h4> +<pre>public static void initFluidIDs(com.google.common.collect.BiMap<java.lang.String,java.lang.Integer> newfluidIDs)</pre> +<div class="block">Called by Forge to prepare the ID map for server -> client sync. + Modders, DO NOT call this.</div> +</li> +</ul> +<a name="registerFluid(net.minecraftforge.fluids.Fluid)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerFluid</h4> +<pre>public static boolean registerFluid(<a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</pre> +<div class="block">Register a new Fluid. If a fluid with the same name already exists, registration is denied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fluid</code> - The fluid to register.</dd> +<dt><span class="strong">Returns:</span></dt><dd>True if the fluid was successfully registered; false if there is a name clash.</dd></dl> +</li> +</ul> +<a name="isFluidRegistered(net.minecraftforge.fluids.Fluid)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFluidRegistered</h4> +<pre>public static boolean isFluidRegistered(<a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> fluid)</pre> +</li> +</ul> +<a name="isFluidRegistered(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFluidRegistered</h4> +<pre>public static boolean isFluidRegistered(java.lang.String fluidName)</pre> +</li> +</ul> +<a name="getFluid(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFluid</h4> +<pre>public static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> getFluid(java.lang.String fluidName)</pre> +</li> +</ul> +<a name="getFluid(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFluid</h4> +<pre>public static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> getFluid(int fluidID)</pre> +</li> +</ul> +<a name="getFluidName(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFluidName</h4> +<pre>public static java.lang.String getFluidName(int fluidID)</pre> +</li> +</ul> +<a name="getFluidName(net.minecraftforge.fluids.FluidStack)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFluidName</h4> +<pre>public static java.lang.String getFluidName(<a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> stack)</pre> +</li> +</ul> +<a name="getFluidID(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFluidID</h4> +<pre>public static int getFluidID(java.lang.String fluidName)</pre> +</li> +</ul> +<a name="getFluidStack(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFluidStack</h4> +<pre>public static <a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> getFluidStack(java.lang.String fluidName, + int amount)</pre> +</li> +</ul> +<a name="getRegisteredFluids()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegisteredFluids</h4> +<pre>public static java.util.Map<java.lang.String,<a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a>> getRegisteredFluids()</pre> +<div class="block">Returns a read-only map containing Fluid Names and their associated Fluids.</div> +</li> +</ul> +<a name="getRegisteredFluidIDs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegisteredFluidIDs</h4> +<pre>public static java.util.Map<java.lang.String,java.lang.Integer> getRegisteredFluidIDs()</pre> +<div class="block">Returns a read-only map containing Fluid Names and their associated IDs.</div> +</li> +</ul> +<a name="lookupFluidForBlock(net.minecraft.block.Block)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lookupFluidForBlock</h4> +<pre>public static <a href="../../../net/minecraftforge/fluids/Fluid.html" title="class in net.minecraftforge.fluids">Fluid</a> lookupFluidForBlock(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block)</pre> +</li> +</ul> +<a name="getMaxID()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMaxID</h4> +<pre>public static int getMaxID()</pre> +</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/FluidEvent.FluidSpilledEvent.html" title="class in net.minecraftforge.fluids"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html" title="class in net.minecraftforge.fluids"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/fluids/FluidRegistry.html" target="_top">Frames</a></li> +<li><a href="FluidRegistry.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><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </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>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> |