You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sort of closes#2125. I've really struggled to find a way to make it
clear that the information returned here is a snapshot of the current
item, and not a live view and/or proxy. Most wordings I've tried end up
feeling really clunky — given that this is a relatively rare
misunderstanding, let's not stress about this too much.
Copy file name to clipboardExpand all lines: projects/common/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/AbstractFluidMethods.java
+2-2
Original file line number
Diff line number
Diff line change
@@ -41,9 +41,9 @@ public final String id() {
41
41
* The returned table is sparse, and so empty tanks will be `nil` - it is recommended to loop over using [`pairs`]
42
42
* rather than [`ipairs`].
43
43
*
44
-
* @param fluids The current fluid handler.
44
+
* @param fluids The current fluid storage.
45
45
* @return All tanks.
46
-
* @cc.treturn { (table|nil)... } All tanks in this fluid storage.
46
+
* @cc.treturn { (table|nil)... } Basic information about all fluids in this fluid storage.
Copy file name to clipboardExpand all lines: projects/common/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/AbstractInventoryMethods.java
+4-5
Original file line number
Diff line number
Diff line change
@@ -56,8 +56,8 @@ public final String id() {
56
56
* rather than [`ipairs`].
57
57
*
58
58
* @param inventory The current inventory.
59
-
* @return All items in this inventory.
60
-
* @cc.treturn { (table|nil)... } All items in this inventory.
59
+
* @return Basic information about all items in this inventory.
60
+
* @cc.treturn { (table|nil)... } Basic information about all items in this inventory.
61
61
* @cc.usage Find an adjacent chest and print all items in it.
62
62
*
63
63
* <pre>{@code
@@ -89,9 +89,8 @@ public final String id() {
89
89
*
90
90
* @param inventory The current inventory.
91
91
* @param slot The slot to get information about.
92
-
* @return Information about the item in this slot, or {@code nil} if not present.
92
+
* @return Information about the item in this slot, or {@code nil} if it is empty.
93
93
* @throws LuaException If the slot is out of range.
94
-
* @cc.treturn table Information about the item in this slot, or {@code nil} if not present.
95
94
* @cc.usage Print some information about the first in a chest.
0 commit comments