1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
<!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>IFluidContainerItem (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="IFluidContainerItem (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/IFluidBlock.html" title="interface in net.minecraftforge.fluids"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/minecraftforge/fluids/IFluidContainerItem.html" target="_top">Frames</a></li>
<li><a href="IFluidContainerItem.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.fluids</div>
<h2 title="Interface IFluidContainerItem" class="title">Interface IFluidContainerItem</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/minecraftforge/fluids/ItemFluidContainer.html" title="class in net.minecraftforge.fluids">ItemFluidContainer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">IFluidContainerItem</span></pre>
<div class="block">Implement this interface on Item classes that support external manipulation of their internal
fluid storage.
A reference implementation is provided <a href="../../../net/minecraftforge/fluids/ItemFluidContainer.html" title="class in net.minecraftforge.fluids"><code>ItemFluidContainer</code></a>.
NOTE: Use of NBT data on the containing ItemStack is encouraged.</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><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/IFluidContainerItem.html#drain(net.minecraft.item.ItemStack,%20int,%20boolean)">drain</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container,
int maxDrain,
boolean doDrain)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/IFluidContainerItem.html#fill(net.minecraft.item.ItemStack,%20net.minecraftforge.fluids.FluidStack,%20boolean)">fill</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container,
<a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> resource,
boolean doFill)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../net/minecraftforge/fluids/IFluidContainerItem.html#getCapacity(net.minecraft.item.ItemStack)">getCapacity</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container)</code> </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/IFluidContainerItem.html#getFluid(net.minecraft.item.ItemStack)">getFluid</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container)</code> </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="getFluid(net.minecraft.item.ItemStack)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFluid</h4>
<pre><a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> getFluid(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - ItemStack which is the fluid container.</dd>
<dt><span class="strong">Returns:</span></dt><dd>FluidStack representing the fluid in the container, null if the container is empty.</dd></dl>
</li>
</ul>
<a name="getCapacity(net.minecraft.item.ItemStack)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapacity</h4>
<pre>int getCapacity(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - ItemStack which is the fluid container.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Capacity of this fluid container.</dd></dl>
</li>
</ul>
<a name="fill(net.minecraft.item.ItemStack, net.minecraftforge.fluids.FluidStack, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fill</h4>
<pre>int fill(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container,
<a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> resource,
boolean doFill)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - ItemStack which is the fluid container.</dd><dd><code>resource</code> - FluidStack attempting to fill the container.</dd><dd><code>doFill</code> - If false, the fill will only be simulated.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Amount of fluid that was (or would have been, if simulated) filled into the
container.</dd></dl>
</li>
</ul>
<a name="drain(net.minecraft.item.ItemStack, int, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>drain</h4>
<pre><a href="../../../net/minecraftforge/fluids/FluidStack.html" title="class in net.minecraftforge.fluids">FluidStack</a> drain(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> container,
int maxDrain,
boolean doDrain)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - ItemStack which is the fluid container.</dd><dd><code>maxDrain</code> - Maximum amount of fluid to be removed from the container.</dd><dd><code>doFill</code> - If false, the drain will only be simulated.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Amount of fluid that was (or would have been, if simulated) drained from the
container.</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/IFluidBlock.html" title="interface in net.minecraftforge.fluids"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../net/minecraftforge/fluids/IFluidHandler.html" title="interface in net.minecraftforge.fluids"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/minecraftforge/fluids/IFluidContainerItem.html" target="_top">Frames</a></li>
<li><a href="IFluidContainerItem.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>
|
