Started work on upgrading to 1.16.1. Not in a compilable state yet

2025-10-26 11:27:38 +00:00 · 2020-07-07 13:27:13 -04:00
parent cb66ef7e30
commit 605e1f6b9b
513 changed files with 48117 additions and 534 deletions
--- a/remappedSrc/dan200/computercraft/api/media/IMedia.java
+++ b/remappedSrc/dan200/computercraft/api/media/IMedia.java
@@ -0,0 +1,90 @@
+/*
+ * This file is part of the public ComputerCraft API - http://www.computercraft.info
+ * Copyright Daniel Ratcliffe, 2011-2019. 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.media;
+
+import dan200.computercraft.api.filesystem.IMount;
+import net.minecraft.item.Item;
+import net.minecraft.item.ItemStack;
+import net.minecraft.sound.SoundEvent;
+import net.minecraft.world.World;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/**
+ * Represents an item that can be placed in a disk drive and used by a Computer.
+ *
+ * Implement this interface on your {@link Item} class to allow it to be used in the drive. Alternatively, register
+ * a {@link IMediaProvider}.
+ */
+public interface IMedia
+{
+    /**
+     * Get a string representing the label of this item. Will be called via {@code disk.getLabel()} in lua.
+     *
+     * @param stack The {@link ItemStack} to inspect.
+     * @return The label. ie: "Dan's Programs".
+     */
+    @Nullable
+    String getLabel( @Nonnull ItemStack stack );
+
+    /**
+     * Set a string representing the label of this item. Will be called vi {@code disk.setLabel()} in lua.
+     *
+     * @param stack The {@link ItemStack} to modify.
+     * @param label The string to set the label to.
+     * @return true if the label was updated, false if the label may not be modified.
+     */
+    default boolean setLabel( @Nonnull ItemStack stack, @Nullable String label )
+    {
+        return false;
+    }
+
+    /**
+     * If this disk represents an item with audio (like a record), get the readable name of the audio track. ie:
+     * "Jonathan Coulton - Still Alive"
+     *
+     * @param stack The {@link ItemStack} to modify.
+     * @return The name, or null if this item does not represent an item with audio.
+     */
+    @Nullable
+    default String getAudioTitle( @Nonnull ItemStack stack )
+    {
+        return null;
+    }
+
+    /**
+     * If this disk represents an item with audio (like a record), get the resource name of the audio track to play.
+     *
+     * @param stack The {@link ItemStack} to modify.
+     * @return The name, or null if this item does not represent an item with audio.
+     */
+    @Nullable
+    default SoundEvent getAudio( @Nonnull ItemStack stack )
+    {
+        return null;
+    }
+
+    /**
+     * If this disk represents an item with data (like a floppy disk), get a mount representing it's contents. This will
+     * be mounted onto the filesystem of the computer while the media is in the disk drive.
+     *
+     * @param stack The {@link ItemStack} to modify.
+     * @param world The world in which the item and disk drive reside.
+     * @return The mount, or null if this item does not represent an item with data. If the mount returned also
+     * implements {@link dan200.computercraft.api.filesystem.IWritableMount}, it will mounted using mountWritable()
+     * @see IMount
+     * @see dan200.computercraft.api.filesystem.IWritableMount
+     * @see dan200.computercraft.api.ComputerCraftAPI#createSaveDirMount(World, String, long)
+     * @see dan200.computercraft.api.ComputerCraftAPI#createResourceMount(Class, String, String)
+     */
+    @Nullable
+    default IMount createDataMount( @Nonnull ItemStack stack, @Nonnull World world )
+    {
+        return null;
+    }
+}