From b4f3eb5fa13ea38dc7aac1012cb86ec2ebe5f64b Mon Sep 17 00:00:00 2001 From: Jake Potrebic Date: Fri, 28 May 2021 21:47:39 -0700 Subject: [PATCH] More CommandBlock API --- .../paper/command/CommandBlockHolder.java | 57 +++++++++++++++++++ .../java/org/bukkit/block/CommandBlock.java | 2 +- .../entity/minecart/CommandMinecart.java | 2 +- 3 files changed, 59 insertions(+), 2 deletions(-) create mode 100644 paper-api/src/main/java/io/papermc/paper/command/CommandBlockHolder.java diff --git a/paper-api/src/main/java/io/papermc/paper/command/CommandBlockHolder.java b/paper-api/src/main/java/io/papermc/paper/command/CommandBlockHolder.java new file mode 100644 index 0000000000..8dc061e38a --- /dev/null +++ b/paper-api/src/main/java/io/papermc/paper/command/CommandBlockHolder.java @@ -0,0 +1,57 @@ +package io.papermc.paper.command; + +import net.kyori.adventure.text.Component; +import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.Nullable; + +@NullMarked +public interface CommandBlockHolder { + + /** + * Gets the command that this CommandBlock will run when powered. + * This will never return null. If the CommandBlock does not have a + * command, an empty String will be returned instead. + * + * @return Command that this CommandBlock will run when activated. + */ + String getCommand(); + + /** + * Sets the command that this CommandBlock will run when powered. + * Setting the command to null is the same as setting it to an empty + * String. + * + * @param command Command that this CommandBlock will run when activated. + */ + void setCommand(@Nullable String command); + + /** + * Gets the last output from this command block. + * + * @return the last output + */ + Component lastOutput(); + + /** + * Sets the last output from this command block. + * + * @param lastOutput the last output + */ + void lastOutput(@Nullable Component lastOutput); + + /** + * Gets the success count from this command block. + * @see Command_Block#Success_count + * + * @return the success count + */ + int getSuccessCount(); + + /** + * Sets the success count from this command block. + * @see Command_Block#Success_count + * + * @param successCount the success count + */ + void setSuccessCount(int successCount); +} diff --git a/paper-api/src/main/java/org/bukkit/block/CommandBlock.java b/paper-api/src/main/java/org/bukkit/block/CommandBlock.java index 9c88be68b4..02bf0f8c12 100644 --- a/paper-api/src/main/java/org/bukkit/block/CommandBlock.java +++ b/paper-api/src/main/java/org/bukkit/block/CommandBlock.java @@ -6,7 +6,7 @@ import org.jetbrains.annotations.Nullable; /** * Represents a captured state of a command block. */ -public interface CommandBlock extends TileState { +public interface CommandBlock extends TileState, io.papermc.paper.command.CommandBlockHolder { // Paper /** * Gets the command that this CommandBlock will run when powered. diff --git a/paper-api/src/main/java/org/bukkit/entity/minecart/CommandMinecart.java b/paper-api/src/main/java/org/bukkit/entity/minecart/CommandMinecart.java index 91cab8b13d..6a6021ad3a 100644 --- a/paper-api/src/main/java/org/bukkit/entity/minecart/CommandMinecart.java +++ b/paper-api/src/main/java/org/bukkit/entity/minecart/CommandMinecart.java @@ -4,7 +4,7 @@ import org.bukkit.entity.Minecart; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; -public interface CommandMinecart extends Minecart { +public interface CommandMinecart extends Minecart, io.papermc.paper.command.CommandBlockHolder { // Paper /** * Gets the command that this CommandMinecart will run when activated.