-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(paper): add a simple sender mapper
designed for use with the modern paper command manager and provides various sender mappings such as PlayerSource and ConsoleSource --------- Co-authored-by: Jason Penilla <[email protected]>
- Loading branch information
Showing
9 changed files
with
365 additions
and
9 deletions.
There are no files selected for viewing
46 changes: 46 additions & 0 deletions
46
cloud-paper/src/main/java/org/incendo/cloud/paper/util/sender/ConsoleSource.java
This file contains 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,46 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
| // | ||
| package org.incendo.cloud.paper.util.sender; | ||
|
|
||
| import io.papermc.paper.command.brigadier.CommandSourceStack; | ||
| import org.bukkit.command.ConsoleCommandSender; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| /** | ||
| * Specialized variant of {@link Source}, for when the {@link CommandSourceStack#getSender() sender} is a | ||
| * {@link ConsoleCommandSender}. | ||
| */ | ||
| @SuppressWarnings("UnstableApiUsage") | ||
| public final class ConsoleSource extends GenericSource { | ||
|
|
||
| ConsoleSource(final CommandSourceStack commandSourceStack) { | ||
| super(commandSourceStack); | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull ConsoleCommandSender source() { | ||
| return (ConsoleCommandSender) super.source(); | ||
| } | ||
|
|
||
| } |
50 changes: 50 additions & 0 deletions
50
cloud-paper/src/main/java/org/incendo/cloud/paper/util/sender/EntitySource.java
This file contains 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,50 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
| // | ||
| package org.incendo.cloud.paper.util.sender; | ||
|
|
||
| import io.papermc.paper.command.brigadier.CommandSourceStack; | ||
| import org.bukkit.entity.Entity; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| /** | ||
| * Specialized variant of {@link Source}, for when the {@link CommandSourceStack#getSender() sender} is | ||
| * an {@link Entity}. | ||
| */ | ||
| @SuppressWarnings("UnstableApiUsage") | ||
| public class EntitySource extends GenericSource { | ||
|
|
||
| EntitySource(final CommandSourceStack commandSourceStack) { | ||
| super(commandSourceStack); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| * | ||
| * @return the source | ||
| */ | ||
| @Override | ||
| public @NonNull Entity source() { | ||
| return (Entity) super.source(); | ||
| } | ||
| } |
53 changes: 53 additions & 0 deletions
53
cloud-paper/src/main/java/org/incendo/cloud/paper/util/sender/GenericSource.java
This file contains 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,53 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
| // | ||
| package org.incendo.cloud.paper.util.sender; | ||
|
|
||
| import io.papermc.paper.command.brigadier.CommandSourceStack; | ||
| import org.bukkit.command.CommandSender; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| @SuppressWarnings("UnstableApiUsage") | ||
| class GenericSource implements Source { | ||
|
|
||
| private final CommandSourceStack commandSourceStack; | ||
|
|
||
| GenericSource(final @NonNull CommandSourceStack commandSourceStack) { | ||
| this.commandSourceStack = commandSourceStack; | ||
| } | ||
|
|
||
| @Override | ||
| public final @NonNull CommandSourceStack stack() { | ||
| return this.commandSourceStack; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| * | ||
| * @return the source | ||
| */ | ||
| @Override | ||
| public @NonNull CommandSender source() { | ||
| return this.commandSourceStack.getSender(); | ||
| } | ||
| } |
84 changes: 84 additions & 0 deletions
84
cloud-paper/src/main/java/org/incendo/cloud/paper/util/sender/PaperSimpleSenderMapper.java
This file contains 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,84 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
| // | ||
| package org.incendo.cloud.paper.util.sender; | ||
|
|
||
| import io.papermc.paper.command.brigadier.CommandSourceStack; | ||
| import org.bukkit.command.CommandSender; | ||
| import org.bukkit.command.ConsoleCommandSender; | ||
| import org.bukkit.entity.Entity; | ||
| import org.bukkit.entity.Player; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
| import org.incendo.cloud.Command; | ||
| import org.incendo.cloud.SenderMapper; | ||
| import org.incendo.cloud.paper.PaperCommandManager; | ||
|
|
||
| /** | ||
| * A simple {@link SenderMapper} implementation designed for use with {@link PaperCommandManager}. | ||
| * Allows for easily utilizing cloud's {@link Command.Builder#senderType(Class)} utilities despite the | ||
| * single {@link CommandSourceStack} implementation provided by Paper/Minecraft. | ||
| * | ||
| * <p>The {@link #map(CommandSourceStack)} implementation performs type dispatch based on the {@link CommandSourceStack#getSender() sender}, | ||
| * for example it will create a {@link PlayerSource} when {@link CommandSourceStack#getSender()} is a {@link Player}, and similar for | ||
| * {@link ConsoleSource} and {@link EntitySource}. Any other specific sender types do not currently have special handling | ||
| * and will fall back to a generic {@link Source} implementation.</p> | ||
| */ | ||
| @SuppressWarnings("UnstableApiUsage") | ||
| public final class PaperSimpleSenderMapper implements SenderMapper<CommandSourceStack, Source> { | ||
|
|
||
| /** | ||
| * Create a new instance of {@link PaperSimpleSenderMapper}. | ||
| * | ||
| * @return a new instance of {@link PaperSimpleSenderMapper} | ||
| */ | ||
| public static @NonNull PaperSimpleSenderMapper simpleSenderMapper() { | ||
| return new PaperSimpleSenderMapper(); | ||
| } | ||
|
|
||
| PaperSimpleSenderMapper() { | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull Source map(final @NonNull CommandSourceStack base) { | ||
| CommandSender commandSender = base.getSender(); | ||
|
|
||
| if (commandSender instanceof ConsoleCommandSender) { | ||
| return new ConsoleSource(base); | ||
| } | ||
|
|
||
| if (commandSender instanceof Player) { | ||
| return new PlayerSource(base); | ||
| } | ||
|
|
||
| if (commandSender instanceof Entity) { | ||
| return new EntitySource(base); | ||
| } | ||
|
|
||
| return new GenericSource(base); | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull CommandSourceStack reverse(final @NonNull Source mapped) { | ||
| return mapped.stack(); | ||
| } | ||
| } |
45 changes: 45 additions & 0 deletions
45
cloud-paper/src/main/java/org/incendo/cloud/paper/util/sender/PlayerSource.java
This file contains 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,45 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
| // | ||
| package org.incendo.cloud.paper.util.sender; | ||
|
|
||
| import io.papermc.paper.command.brigadier.CommandSourceStack; | ||
| import org.bukkit.entity.Player; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| /** | ||
| * Specialized variant of {@link Source}, for when the {@link CommandSourceStack#getSender() sender} is a | ||
| * {@link Player}. | ||
| */ | ||
| @SuppressWarnings("UnstableApiUsage") | ||
| public final class PlayerSource extends EntitySource { | ||
|
|
||
| PlayerSource(final CommandSourceStack commandSourceStack) { | ||
| super(commandSourceStack); | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull Player source() { | ||
| return (Player) super.source(); | ||
| } | ||
| } |
53 changes: 53 additions & 0 deletions
53
cloud-paper/src/main/java/org/incendo/cloud/paper/util/sender/Source.java
This file contains 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,53 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
| // | ||
| package org.incendo.cloud.paper.util.sender; | ||
|
|
||
| import io.papermc.paper.command.brigadier.CommandSourceStack; | ||
| import org.bukkit.command.CommandSender; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| /** | ||
| * A simple wrapper around {@link CommandSourceStack}. | ||
| * | ||
| * @see PaperSimpleSenderMapper | ||
| */ | ||
| @SuppressWarnings("UnstableApiUsage") | ||
| public interface Source { | ||
|
|
||
| /** | ||
| * Gets the {@link CommandSourceStack}. | ||
| * | ||
| * @return the command source stack | ||
| */ | ||
| @NonNull CommandSourceStack stack(); | ||
|
|
||
| /** | ||
| * Gets the underlying {@link CommandSourceStack#getSender() sender} from the {@link #stack() source stack}. | ||
| * | ||
| * <p>Specific implementations may override this method with a more specific return type.</p> | ||
| * | ||
| * @return the source | ||
| */ | ||
| @NonNull CommandSender source(); | ||
| } |
5 changes: 5 additions & 0 deletions
5
cloud-paper/src/main/java/org/incendo/cloud/paper/util/sender/package-info.java
This file contains 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,5 @@ | ||
| /** | ||
| * Built in command sender {@link org.incendo.cloud.paper.util.sender.Source types} and | ||
| * {@link org.incendo.cloud.paper.util.sender.PaperSimpleSenderMapper mappings} for modern Paper. | ||
| */ | ||
| package org.incendo.cloud.paper.util.sender; |
This file contains 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.