2023-03-15 21:52:13 +00:00
|
|
|
// SPDX-FileCopyrightText: 2017 The CC: Tweaked Developers
|
|
|
|
//
|
|
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
|
2017-05-02 00:46:17 +00:00
|
|
|
package dan200.computercraft.api.pocket;
|
|
|
|
|
2023-07-02 09:55:55 +00:00
|
|
|
import dan200.computercraft.api.upgrades.UpgradeBase;
|
2024-04-25 19:17:43 +00:00
|
|
|
import net.minecraft.core.component.DataComponentPatch;
|
2021-08-03 20:46:53 +00:00
|
|
|
import net.minecraft.world.entity.Entity;
|
2023-07-02 09:55:55 +00:00
|
|
|
import net.minecraft.world.item.ItemStack;
|
2017-05-02 00:46:17 +00:00
|
|
|
|
|
|
|
import javax.annotation.Nullable;
|
|
|
|
|
|
|
|
/**
|
2019-10-27 15:16:47 +00:00
|
|
|
* Wrapper class for pocket computers.
|
2017-05-02 00:46:17 +00:00
|
|
|
*/
|
|
|
|
public interface IPocketAccess {
|
|
|
|
/**
|
2017-05-05 01:07:11 +00:00
|
|
|
* Gets the entity holding this item.
|
2022-10-25 18:17:55 +00:00
|
|
|
* <p>
|
2019-03-16 11:18:03 +00:00
|
|
|
* This must be called on the server thread.
|
|
|
|
*
|
|
|
|
* @return The holding entity, or {@code null} if none exists.
|
|
|
|
*/
|
|
|
|
@Nullable
|
Update CC: Tweaked to 1.13
Look, I originally had this split into several commits, but lots of
other cleanups got mixed in. I then backported some of the cleanups to
1.12, did other tidy ups there, and eventually the web of merges was
unreadable.
Yes, this is a horrible mess, but it's still nicer than it was. Anyway,
changes:
- Flatten everything. For instance, there are now three instances of
BlockComputer, two BlockTurtle, ItemPocketComputer. There's also no
more BlockPeripheral (thank heavens) - there's separate block classes
for each peripheral type.
- Remove pretty much all legacy code. As we're breaking world
compatibility anyway, we can remove all the code to load worlds from
1.4 days.
- The command system is largely rewriten to take advantage of 1.13's
new system. It's very fancy!
- WidgetTerminal now uses Minecraft's "GUI listener" system.
- BREAKING CHANGE: All the codes in keys.lua are different, due to the
move to LWJGL 3. Hopefully this won't have too much of an impact.
I don't want to map to the old key codes on the Java side, as there
always ends up being small but slight inconsistencies. IMO it's
better to make a clean break - people should be using keys rather
than hard coding the constants anyway.
- commands.list now allows fetching sub-commands. The ROM has already
been updated to allow fancy usage such as commands.time.set("noon").
- Turtles, modems and cables can be waterlogged.
2019-04-02 12:27:27 +00:00
|
|
|
Entity getEntity();
|
2019-03-16 11:18:03 +00:00
|
|
|
|
|
|
|
/**
|
2017-05-14 14:02:56 +00:00
|
|
|
* Get the colour of this pocket computer as a RGB number.
|
|
|
|
*
|
|
|
|
* @return The colour this pocket computer is. This will be a RGB colour between {@code 0x000000} and
|
|
|
|
* {@code 0xFFFFFF} or -1 if it has no colour.
|
|
|
|
* @see #setColour(int)
|
|
|
|
*/
|
|
|
|
int getColour();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the colour of the pocket computer to a RGB number.
|
|
|
|
*
|
|
|
|
* @param colour The colour this pocket computer should be changed to. This should be a RGB colour between
|
|
|
|
* {@code 0x000000} and {@code 0xFFFFFF} or -1 to reset to the default colour.
|
|
|
|
* @see #getColour()
|
|
|
|
*/
|
|
|
|
void setColour(int colour);
|
|
|
|
|
2017-05-02 00:46:17 +00:00
|
|
|
/**
|
2017-05-14 13:22:20 +00:00
|
|
|
* Get the colour of this pocket computer's light as a RGB number.
|
2017-05-02 00:46:17 +00:00
|
|
|
*
|
2017-05-14 13:22:20 +00:00
|
|
|
* @return The colour this light is. This will be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or
|
|
|
|
* -1 if it has no colour.
|
2017-05-04 23:54:41 +00:00
|
|
|
* @see #setLight(int)
|
2017-05-02 00:46:17 +00:00
|
|
|
*/
|
2017-05-04 23:54:41 +00:00
|
|
|
int getLight();
|
2017-05-02 00:46:17 +00:00
|
|
|
|
|
|
|
/**
|
2017-05-14 13:22:20 +00:00
|
|
|
* Set the colour of the pocket computer's light to a RGB number.
|
2017-05-02 00:46:17 +00:00
|
|
|
*
|
2017-05-14 13:22:20 +00:00
|
|
|
* @param colour The colour this modem's light will be changed to. This should be a RGB colour between
|
|
|
|
* {@code 0x000000} and {@code 0xFFFFFF} or -1 to reset to the default colour.
|
2017-05-04 23:54:41 +00:00
|
|
|
* @see #getLight()
|
2017-05-02 00:46:17 +00:00
|
|
|
*/
|
2017-05-14 13:22:20 +00:00
|
|
|
void setLight(int colour);
|
2017-05-02 00:46:17 +00:00
|
|
|
|
|
|
|
/**
|
2017-05-05 01:07:11 +00:00
|
|
|
* Get the upgrade-specific NBT.
|
2022-10-25 18:17:55 +00:00
|
|
|
* <p>
|
2017-05-05 01:07:11 +00:00
|
|
|
* This is persisted between computer reboots and chunk loads.
|
|
|
|
*
|
|
|
|
* @return The upgrade's NBT.
|
2024-04-25 19:17:43 +00:00
|
|
|
* @see #setUpgradeData(DataComponentPatch)
|
|
|
|
* @see UpgradeBase#getUpgradeItem(DataComponentPatch)
|
2023-07-02 09:55:55 +00:00
|
|
|
* @see UpgradeBase#getUpgradeData(ItemStack)
|
2017-05-02 00:46:17 +00:00
|
|
|
*/
|
2024-04-25 19:17:43 +00:00
|
|
|
DataComponentPatch getUpgradeData();
|
2017-05-02 00:46:17 +00:00
|
|
|
|
|
|
|
/**
|
2024-04-25 19:17:43 +00:00
|
|
|
* Update the upgrade-specific data.
|
2017-05-04 23:54:41 +00:00
|
|
|
*
|
2024-04-25 19:17:43 +00:00
|
|
|
* @param data The new upgrade data.
|
|
|
|
* @see #getUpgradeData()
|
2017-05-02 00:46:17 +00:00
|
|
|
*/
|
2024-04-25 19:17:43 +00:00
|
|
|
void setUpgradeData(DataComponentPatch data);
|
2017-05-02 00:46:17 +00:00
|
|
|
|
|
|
|
/**
|
2023-07-01 17:32:19 +00:00
|
|
|
* Remove the current peripheral and create a new one.
|
|
|
|
* <p>
|
|
|
|
* You may wish to do this if the methods available change, for instance when the {@linkplain #getEntity() owning
|
|
|
|
* entity} changes.
|
2017-05-02 00:46:17 +00:00
|
|
|
*/
|
|
|
|
void invalidatePeripheral();
|
|
|
|
}
|