gradle=7.1.1, gradle migrateMappings

remappedSrc/dan200/computercraft/api/lua/GenericSource.java

@@ -0,0 +1,58 @@
+/*
+ * This file is part of the public ComputerCraft API - http://www.computercraft.info
+ * Copyright Daniel Ratcliffe, 2011-2021. This API may be redistributed unmodified and in full only.
+ * For help using the API, and posting your mods, visit the forums at computercraft.info.
+ */
+package dan200.computercraft.api.lua;
+
+import dan200.computercraft.api.ComputerCraftAPI;
+import dan200.computercraft.api.peripheral.IPeripheral;
+import dan200.computercraft.api.peripheral.IPeripheralProvider;
+import dan200.computercraft.core.asm.LuaMethod;
+import net.minecraft.util.Identifier;
+
+import javax.annotation.Nonnull;
+
+/**
+ * A generic source of {@link LuaMethod} functions.
+ *
+ * Unlike normal objects ({@link IDynamicLuaObject} or {@link IPeripheral}), methods do not target this object but
+ * instead are defined as {@code static} and accept their target as the first parameter. This allows you to inject
+ * methods onto objects you do not own, as well as declaring methods for a specific "trait" (for instance, a
+ * {@link Capability}).
+ *
+ * Currently the "generic peripheral" system is incompatible with normal peripherals. Normal {@link IPeripheralProvider}
+ * or {@link IPeripheral} implementations take priority. Tile entities which use this system are given a peripheral name
+ * determined by their id, rather than any peripheral provider. This will hopefully change in the future, once a suitable
+ * design has been established.
+ *
+ * For example, the main CC: Tweaked mod defines a generic source for inventories, which works on {@link IItemHandler}s:
+ *
+ * <pre>{@code
+ * public class InventoryMethods implements GenericSource {
+ *     \@LuaFunction( mainThread = true )
+ *     public static int size(IItemHandler inventory) {
+ *         return inventory.getSlots();
+ *     }
+ *
+ *     // ...
+ * }
+ * }</pre>
+ *
+ * @see ComputerCraftAPI#registerGenericSource(GenericSource)
+ * @see ComputerCraftAPI#registerGenericCapability(Capability) New capabilities (those not built into Forge) must be
+ * explicitly given to the generic peripheral system, as there is no way to enumerate all capabilities.
+ */
+public interface GenericSource
+{
+    /**
+     * A unique identifier for this generic source.
+     *
+     * This is currently unused, but may be used in the future to allow disabling specific sources. It is recommended
+     * to return an identifier using your mod's ID.
+     *
+     * @return This source's identifier.
+     */
+    @Nonnull
+    Identifier id();
+}