mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-10-31 05:33:00 +00:00
a4e68d637a
- Move some common upgrade code to IUpgradeBase. 99% sure this this preserves binary compatibility (on the JVM at least). - Instead of requiring the share tag to match, allow upgrades to specify their own predicate. IMO this is a little ugly, but required to fix #614 as other mods chuck their own NBT on items.
62 lines
2.3 KiB
Java
62 lines
2.3 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2020. 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.pocket;
|
|
|
|
import javax.annotation.Nonnull;
|
|
import javax.annotation.Nullable;
|
|
|
|
import dan200.computercraft.api.ComputerCraftAPI;
|
|
import dan200.computercraft.api.IUpgradeBase;
|
|
import dan200.computercraft.api.peripheral.IPeripheral;
|
|
|
|
import net.minecraft.world.World;
|
|
|
|
/**
|
|
* Additional peripherals for pocket computers.
|
|
*
|
|
* @see ComputerCraftAPI#registerPocketUpgrade(IPocketUpgrade)
|
|
*/
|
|
public interface IPocketUpgrade extends IUpgradeBase
|
|
{
|
|
/**
|
|
* Creates a peripheral for the pocket computer.
|
|
*
|
|
* The peripheral created will be stored for the lifetime of the upgrade, will be passed an argument to {@link #update(IPocketAccess, IPeripheral)} and
|
|
* will be attached, detached and have methods called in the same manner as an ordinary peripheral.
|
|
*
|
|
* @param access The access object for the pocket item stack.
|
|
* @return The newly created peripheral.
|
|
* @see #update(IPocketAccess, IPeripheral)
|
|
*/
|
|
@Nullable
|
|
IPeripheral createPeripheral(@Nonnull IPocketAccess access);
|
|
|
|
/**
|
|
* Called when the pocket computer item stack updates.
|
|
*
|
|
* @param access The access object for the pocket item stack.
|
|
* @param peripheral The peripheral for this upgrade.
|
|
* @see #createPeripheral(IPocketAccess)
|
|
*/
|
|
default void update(@Nonnull IPocketAccess access, @Nullable IPeripheral peripheral) {
|
|
}
|
|
|
|
/**
|
|
* Called when the pocket computer is right clicked.
|
|
*
|
|
* @param world The world the computer is in.
|
|
* @param access The access object for the pocket item stack.
|
|
* @param peripheral The peripheral for this upgrade.
|
|
* @return {@code true} to stop the GUI from opening, otherwise false. You should always provide some code path which returns {@code false}, such as
|
|
* requiring the player to be sneaking - otherwise they will be unable to access the GUI.
|
|
* @see #createPeripheral(IPocketAccess)
|
|
*/
|
|
default boolean onRightClick(@Nonnull World world, @Nonnull IPocketAccess access, @Nullable IPeripheral peripheral) {
|
|
return false;
|
|
}
|
|
}
|