Expose certain scoreboard related argument types #12541
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,4 +65,5 @@ aerulion <[email protected]> | |
| Lukas Planz <[email protected]> | ||
| granny <[email protected]> | ||
| mja00 <[email protected]> | ||
| Strokkur24 <[email protected]> | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| package io.papermc.paper.command.brigadier.argument.operation; | ||
|
|
||
| import com.mojang.brigadier.exceptions.CommandSyntaxException; | ||
| import org.bukkit.scoreboard.Objective; | ||
| import org.bukkit.scoreboard.ScoreHolder; | ||
| import org.bukkit.scoreboard.Scoreboard; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
| import org.jspecify.annotations.NullMarked; | ||
|
|
||
| /** | ||
| * Represents a simple arithmetic operation between two integers. | ||
| * An {@link Operation} backs an operator. | ||
| * Most arithmetic operators (like {@code +=, -=, /=, etc.}) are | ||
| * supported, alongside certain conditional operators ({@code >=, <=, ==, etc.}). | ||
| * <p> | ||
| * Note that conditional operators, instead of yielding a boolean value, return the value | ||
| * that matches the operation. | ||
| * For example, the {@code <=} operator always returns the <strong>smaller</strong> value | ||
| * of two given values. | ||
| */ | ||
| @ApiStatus.Experimental | ||
| @NullMarked | ||
| public interface Operation { | ||
|
|
||
| /** | ||
| * Applies this operation to a pair of integers. | ||
| * <p> | ||
| * Arithmetic between two integers always follows this pattern: | ||
| * <pre> | ||
| * return left <operator> right | ||
| * </pre> | ||
| * On certain operators, such as division, the order matters. | ||
| * {@code 20 %= 10} yields a different result than{@code 10 %= 20}. | ||
| * | ||
| * @param left left side of the expression | ||
| * @param right right side of the expression | ||
| * @return result of the operation | ||
| */ | ||
| int apply(int left, int right) throws CommandSyntaxException; | ||
|
|
||
| /** | ||
| * Applies this operation to a pair of {@link ScoreHolder}s, retrieving their | ||
| * values from a {@link Scoreboard} and their respective {@link Objective}s. | ||
| * <p> | ||
| * Arithmetic between two integers always follows this pattern: | ||
| * <pre>return left <operator> right;</pre> | ||
| * On certain operators, such as division, the order matters. | ||
| * {@code 20 %= 10} yields a different result than{@code 10 %= 20}. | ||
| * | ||
| * @param scoreboard scoreboard to edit the score of | ||
| * @param sourceObjective objective to retrieve the score from | ||
| * @param targetObjective objective to edit the score of | ||
| * @param targetHolder target of the operation | ||
| * @param sourceHolder source of the operation | ||
| */ | ||
| void apply(Scoreboard scoreboard, Objective targetObjective, Objective sourceObjective, ScoreHolder targetHolder, ScoreHolder sourceHolder) throws CommandSyntaxException; | ||
|
There was a problem hiding this comment. In general I am not much of a fan of this split between SimpleOperation and Operation internally. Having to pass all this BS just to construct a ScoreAccess also seems overkill. This scoreboard/objective based method seems just very very useless/cumbersome to work with. |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| package io.papermc.paper.command.brigadier.argument.resolvers; | ||
|
|
||
| import io.papermc.paper.command.brigadier.CommandSourceStack; | ||
| import io.papermc.paper.command.brigadier.argument.ArgumentTypes; | ||
| import org.bukkit.scoreboard.ScoreHolder; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
| import java.util.Collection; | ||
|
|
||
| /** | ||
| * An {@link ArgumentResolver} that's capable of resolving | ||
| * argument value using a {@link CommandSourceStack} into a | ||
| * collection of {@link ScoreHolder}s. | ||
| * | ||
| * @see ArgumentTypes#scoreHolders() | ||
| */ | ||
| @ApiStatus.Experimental | ||
| @ApiStatus.NonExtendable | ||
| public interface ScoreHolderResolver extends ArgumentResolver<Collection<ScoreHolder>> { | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| package org.bukkit.scoreboard; | ||
|
|
||
| import io.papermc.paper.InternalAPIBridge; | ||
| import net.kyori.adventure.text.Component; | ||
| import org.bukkit.OfflinePlayer; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
| import org.jspecify.annotations.NullMarked; | ||
|
|
||
| /** | ||
| * Represents anything that can be used as an entry in a {@link Scoreboard}. Includes all entities, | ||
| * players, and text. | ||
| */ | ||
| @ApiStatus.Experimental | ||
| @NullMarked | ||
| public interface ScoreHolder { | ||
|
There was a problem hiding this comment. Javadocs are missing on everything but also, this entire type is pretty annoying. The fact that this always wraps means consumers cannot do anything with this beyond the exposed methods. A scoreholder is never e.g. instanceOf a Player or Entity. I think this would be better off as a parent type to Entity and a separate implementation for those string-only implementations. |
||
|
|
||
| /** | ||
| * The name used to access this {@link ScoreHolder} on a scoreboard. | ||
| * @return the name | ||
| */ | ||
| String getScoreboardName(); | ||
|
|
||
| /** | ||
| * The display name of this {@link ScoreHolder}. | ||
| * @return the display name | ||
| */ | ||
| default Component getDisplayName() { | ||
| return Component.text(getScoreboardName()); | ||
| } | ||
|
|
||
| /** | ||
| * Wraps an {@link OfflinePlayer} into a {@link ScoreHolder}. | ||
| * @param offlinePlayer the player to wrap | ||
| * @return a {@link ScoreHolder} representing the given player | ||
| */ | ||
| static ScoreHolder of(OfflinePlayer offlinePlayer) { | ||
| return InternalAPIBridge.get().scoreHolderOf(offlinePlayer); | ||
| } | ||
|
|
||
| /** | ||
| * Wraps a {@link String} into a {@link ScoreHolder}. | ||
| * @param entry the text to warp | ||
| * @return a {@link ScoreHolder} representing the given String | ||
| */ | ||
| static ScoreHolder of(String entry) { | ||
| return InternalAPIBridge.get().scoreHolderOf(entry); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Javadocs, what is an operation.
What are common usage patterns etc.
Operation also is a very broad name, idk if there a is a point in finding something more specific to what this is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is more okay in internals, because this type lives purely as an inner type to OperationArgument.
But yea, on a top level, this doesn't mean much.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also experimental annotation