Compare commits

..

137 Commits

Author SHA1 Message Date
Auxilor
264c591020 Fixed readme again 2023-02-15 13:49:01 +00:00
Auxilor
6bd3ca0f5c Updated README 2023-02-15 13:48:07 +00:00
Auxilor
98df14a23a Fixed javadoc 2023-02-15 13:43:46 +00:00
Auxilor
ccb6e38064 Cleaned up entity / target goal code 2023-02-15 13:07:16 +00:00
Auxilor
50f1ba6a19 Fix 2023-02-15 12:55:16 +00:00
Auxilor
501e7b05a6 Fucksake, reverted my bugfixes 2023-02-14 20:21:12 +00:00
Auxilor
ebf8abf764 Oops 2023-02-14 20:09:56 +00:00
Auxilor
aff8fa8e88 Javadoc 2023-02-14 20:07:12 +00:00
Auxilor
1accad88fe Added GUI Detection system with DeluxeMenus support 2023-02-14 20:00:39 +00:00
Auxilor
a3a5e4df38 Fixed packet injector 2023-02-14 17:42:52 +00:00
Auxilor
6e8dc1d729 Packet refactor 2023-02-14 17:26:01 +00:00
Auxilor
a8556008f9 Fixed EcoPlugin compiler warnings 2023-02-14 16:53:45 +00:00
Auxilor
ab18a8bd29 Updated to 6.51.0 2023-02-14 16:49:16 +00:00
Auxilor
a053f512f8 Moved away from ProtocolLib 2023-02-14 16:49:04 +00:00
Auxilor
add5390787 Removed ProtocolLib dependency 2023-02-14 12:29:55 +00:00
Auxilor
49687f9a91 Updated to 6.50.3 2023-02-05 16:32:56 +00:00
Auxilor
5480c70f8c Fixed dynamic commands 2023-02-05 16:32:48 +00:00
Auxilor
ef922f6d3f Fixed dynamic commands 2023-01-31 18:58:05 +00:00
Auxilor
026bc55ffb Updated to 6.50.2 2023-01-31 18:35:17 +00:00
Will FP
270fdbb18c Merge pull request #238
Update oraxen dependency
2023-01-31 18:35:02 +00:00
casper
fbf5967d17 Update oraxen dependency 2023-01-31 12:21:41 -06:00
Auxilor
4102be1201 Updated to 6.50.1 2023-01-27 17:47:21 +00:00
Will FP
f6bdb9cc65 Merge pull request #236 from 0ft3n/develop
Fixed fix
2023-01-27 17:46:19 +00:00
Will FP
c8282d1acf Merge branch 'develop' into develop 2023-01-27 17:46:13 +00:00
_OfTeN_
b056b537ef Fixed fix x2 2023-01-27 20:31:00 +03:00
_OfTeN_
f69b458731 Fixed fix 2023-01-27 19:48:28 +03:00
Auxilor
b035fa8940 Changed deprecations 2023-01-27 12:52:55 +00:00
Auxilor
25c087592d Cached placeholder lookups 2023-01-27 12:45:57 +00:00
Auxilor
083cb39771 Cleanups, fixes 2023-01-27 12:20:51 +00:00
Auxilor
eb3e0f5c09 Updated to 6.50.0 2023-01-27 12:18:01 +00:00
Auxilor
08f43ddafd Added dynamic placeholders 2023-01-27 12:17:51 +00:00
Auxilor
9d3efb5e83 Imports, often. Imports 2023-01-27 11:50:50 +00:00
Auxilor
8a5d1a604a Updated to 6.49.2 2023-01-27 11:46:15 +00:00
Auxilor
ef67c6d6ae Merge branch 'develop' 2023-01-27 11:45:42 +00:00
Auxilor
5b2654db15 Merge remote-tracking branch 'origin/master' 2023-01-27 11:45:18 +00:00
Will FP
eccd793317 Merge pull request #235 from Baterka/master
Fix Prices evaluation if they include player placeholders
2023-01-27 11:43:56 +00:00
Will FP
1bc44755a0 Merge pull request #234 from 0ft3n/develop
EconomyShopGUI integration fixes
2023-01-27 11:35:39 +00:00
Baterka
ec606d9ebe Fix Prices evaluation if they include player placeholders 2023-01-27 03:04:48 +01:00
_OfTeN_
c5556f15ab Attempted to fix Lands integration 2023-01-27 04:54:09 +03:00
_OfTeN_
399cce21f5 EconomyShopGUI integration fixes 2023-01-27 04:48:18 +03:00
Auxilor
b25feffdfa Codestyle 2023-01-24 13:54:59 +00:00
Auxilor
1a96fdf465 Updated to 6.49.1 2023-01-24 11:47:18 +00:00
Auxilor
cee1ac4cc2 Fixed eco setting off it's own warnings 2023-01-23 12:10:12 +00:00
Auxilor
ac10fa46dc Fixed javadoc 2023-01-23 11:27:44 +00:00
Auxilor
7c616e64ae Fixed XP / XPL 2023-01-18 20:03:28 +00:00
Auxilor
708f9130c6 Removed old docs URL 2023-01-18 12:53:13 +00:00
Auxilor
9118d49c67 Updated README.md 2023-01-18 12:52:29 +00:00
Auxilor
a1ce72476f Fixed README.md 2023-01-18 12:38:39 +00:00
Auxilor
2cfab99644 Fixed a plethora of codestyle issues 2023-01-17 17:57:40 +00:00
Auxilor
cc9b3f7710 Small blips 2023-01-17 17:50:07 +00:00
Auxilor
5bfe48c8d9 Updated CONTRIBUTING.md 2023-01-17 17:48:45 +00:00
Auxilor
22ff157ffc Merge branch 'MisterFrans_master' into develop 2023-01-17 17:44:35 +00:00
Auxilor
720dbe789c Merge branch 'patch-1' into develop 2023-01-17 17:42:49 +00:00
Auxilor
b51dd51941 Deprecated Prerequisite#HAS_BUNGEECORD and Prerequisite#HAS_VELOCITY 2023-01-17 16:05:06 +00:00
Auxilor
f3ffaa4cf6 Javadoc improvements 2023-01-17 16:02:07 +00:00
Auxilor
085032e315 Further command cleanup, added lang.yml validation and removed magic strings 2023-01-17 15:59:15 +00:00
Auxilor
3d920ee2b4 Updated to 6.49.0 2023-01-17 12:20:51 +00:00
Auxilor
06a04e4375 Fixed spelling inconsistency 2023-01-17 12:19:59 +00:00
Auxilor
7349f15784 Cleaned up command rework 2023-01-17 12:18:10 +00:00
Auxilor
a4c77857d5 Merge branch 'master' into Samkist_master 2023-01-17 12:00:10 +00:00
Auxilor
999fafc8df Javadoc cleanjp 2023-01-17 12:00:04 +00:00
Auxilor
0d533850f6 Updated to 6.48.3 2023-01-13 17:53:44 +00:00
Auxilor
569f9cfcb4 Merge remote-tracking branch 'origin/master' 2023-01-13 17:52:53 +00:00
Auxilor
f0619f2374 Updated to 6.48.2 2023-01-13 17:52:48 +00:00
Auxilor
7e8d97e11d Updated MythicMobs and ExecutableItems 2023-01-13 17:52:20 +00:00
Auxilor
d3414f25ad Cleanup 2023-01-13 17:39:29 +00:00
MCCasper
f0cf118448 Update McmmoManager.java
Change to not quit after first iteration of loop
2022-12-29 10:07:05 -05:00
François
297bb10b85 Removal of an unnecessary semicolon 2022-12-27 13:06:22 +01:00
François
751624bc8d Update of Lands api to the latest version (6.26.7). 2022-12-26 15:34:11 +01:00
Auxilor
8b1b15a3e4 Updated to 6.48.2 2022-12-20 15:05:30 +00:00
Auxilor
7fe330bafb Fixed 1.19.3 support 2022-12-20 15:05:21 +00:00
Auxilor
20584b2a9b Updated to 6.48.1 2022-12-12 12:13:32 +00:00
Auxilor
bd7594a117 Fixed 1.19.3 build 2022-12-12 12:13:22 +00:00
Samuel Pizette
f1bfa21270 restructured some methods 2022-12-11 20:32:23 -05:00
Samuel Pizette
01aa1e708a more missing documentations 2022-12-11 14:17:16 -05:00
Samuel Pizette
8424baa285 wrote missing documentations 2022-12-11 14:14:37 -05:00
Auxilor
d9a8d26990 Fixed 1.19.3 build 2022-12-11 17:07:33 +00:00
Auxilor
4d3eeaaefc Added 1.19.3 support 2022-12-11 16:58:58 +00:00
Samuel Pizette
d54a2b9516 fixed method signature of extensions 2022-12-10 17:18:06 -05:00
Samuel Pizette
f7f12b6255 finished working refactor 2022-12-10 16:50:52 -05:00
Samuel Pizette
42eb1344a6 removed unneeded debug statement 2022-12-10 16:08:33 -05:00
Samuel Pizette
4c2a8585cc got command functionality working 2022-12-10 16:08:01 -05:00
Samuel Pizette
8cccc67b0d wrote documentation for Eco Plugin and Eco Sub Command 2022-12-09 14:42:12 -05:00
Samuel Pizette
396d74497c wrote EcoHandledCommand.kt documentation 2022-12-09 14:38:13 -05:00
Samuel Pizette
49602dce04 rewrote notify documentation 2022-12-09 14:24:13 -05:00
Samuel Pizette
5da811ba74 added notifyPermissionRequired and updated some comments 2022-12-09 13:52:03 -05:00
Samuel Pizette
a4d57e21fe cleaned up eco handled command 2022-12-09 13:29:33 -05:00
Samuel Pizette
4b8efdc79f whoops 2022-12-09 12:10:39 -05:00
Auxilor
610110efde Improved CombinedDisplayPrice 2022-12-07 16:38:32 +00:00
Samuel Pizette
a87f675269 updated method signature annotations to accurately reflect behavior 2022-12-06 03:42:34 -05:00
Samuel Pizette
a371d314b8 shortened logic of notifyNull extension 2022-12-06 03:38:28 -05:00
Samuel Pizette
9a9097adc5 updated some annotations 2022-12-05 20:27:31 -05:00
Samuel Pizette
0669a57e4b updated some annotations 2022-12-05 20:08:35 -05:00
Samuel Pizette
692eaf6836 changed onTabComplete return signature in EcoDelegatedBukkitCommand.kt from nullable to not null 2022-12-05 19:22:09 -05:00
Auxilor
7f9052c64d Updated to 6.48.0 2022-12-05 12:34:53 +00:00
Auxilor
55a841b3f5 Added CombinedDisplayPrice 2022-12-05 12:34:45 +00:00
Samuel Pizette
85f02c5ca2 wrote notification kotlin extensions 2022-12-04 19:35:54 -05:00
Samuel Pizette
74c428b90d rearranged notify methods 2022-12-04 19:17:36 -05:00
Samuel Pizette
fd8c67fa66 wrote handle tab complete for ecohandled command 2022-12-04 19:13:23 -05:00
Samuel Pizette
a396754e2e commands rework progress
- Wrote EcoDelegatedBukkitCommand.kt
- Wrote EcoHandledCommand.kt
- Wrote Eco#createSubCommand
- Renamed RegistrableCommandBase.java to PluginCommandBase
- Moved most of EcoPluginCommand.kt to EcoHandledCommand.kt
- Changed Delegate type in PluginCommand from CommandBase to PluginCommandBase
2022-12-04 18:52:19 -05:00
Samuel Pizette
6f97f47712 removed getAliases and getDescription from commandbase 2022-12-04 18:50:03 -05:00
Samuel Pizette
d1109e485a more fixing auto reformat 2022-12-04 17:56:07 -05:00
Samuel Pizette
476e5c7cae fuck auto reformat 2022-12-04 17:54:50 -05:00
Samuel Pizette
dc2b7a6fda returned instance get to original location 2022-12-04 17:53:49 -05:00
Samuel Pizette
00f18519b0 progress commit 2022-12-04 17:52:05 -05:00
Samuel Pizette
f7ea5fd182 fix eco format 2022-11-30 16:50:02 -05:00
Samuel Pizette
70d29c872a removed HandledCommand 2022-11-29 16:29:23 -05:00
Samuel Pizette
f79f4a84c3 deprecated DelegatedBukkitCommand 2022-11-29 16:29:16 -05:00
Samuel Pizette
9af63907ef Merge branch 'master' into master 2022-11-29 16:28:37 -05:00
Samuel Pizette
c9aa92895b work in progress commit 2022-11-29 16:13:01 -05:00
Auxilor
c57c824027 Cleaned up UltraEconomy integration 2022-11-29 15:56:30 +00:00
Auxilor
7cb905e65a Merge remote-tracking branch 'origin/develop' into develop
# Conflicts:
#	eco-api/src/main/java/com/willfp/eco/core/gui/slot/ConfigSlot.java
2022-11-29 15:47:52 +00:00
Auxilor
31a2c7e338 Added lore to ConfigSlot 2022-11-29 15:47:41 +00:00
Auxilor
1759b52f82 Added lore to ConfigSlot 2022-11-29 15:37:36 +00:00
Auxilor
ccf93e3a4d Fixed 2x2 crafting bug 2022-11-28 23:55:45 +00:00
Auxilor
abd07389ab Fixed dynamic command registration 2022-11-28 17:28:29 +00:00
Auxilor
80ad738bb2 Removed AbstractItemStackBuilder correctifying things 2022-11-28 15:10:28 +00:00
Auxilor
b01105819a Updated EconomyShopGUI and ShopGUI+ integrations 2022-11-28 14:46:38 +00:00
Auxilor
a7c08b0731 Updated shop API (again) 2022-11-28 14:40:42 +00:00
Auxilor
7e4c071698 Fixed javadoc 2022-11-28 14:28:38 +00:00
Auxilor
f94f7ead08 Reworked price/shop API to have call-site multipliers 2022-11-28 14:26:46 +00:00
Auxilor
b21c5bf3a9 Fixed captive filter and GUI drag bug 2022-11-28 13:57:41 +00:00
Auxilor
7a9e8c5c10 Fixed bug with multiple stacked paginated menus 2022-11-25 16:51:17 +00:00
Auxilor
a6ddbc46ab Fixes 2022-11-25 16:28:24 +00:00
Auxilor
ffaee137d8 Overhauled ShopSellEvent API 2022-11-24 23:19:03 +00:00
Auxilor
18d882dac6 Reworked Shop API 2022-11-24 23:12:25 +00:00
Auxilor
52841f7f04 Fixed bug with price copying 2022-11-23 22:31:37 +00:00
Auxilor
47b72e9243 Javadoc fix 2022-11-23 22:03:44 +00:00
Auxilor
854a10e8fd Added Price#withMultiplier 2022-11-23 22:00:07 +00:00
Auxilor
823ef6477b Refactoring for naming, updated to 6.47.0 2022-11-23 21:56:07 +00:00
Auxilor
eccb146852 Reworked slot changes into canCaptivateItem 2022-11-18 18:08:21 +00:00
Auxilor
d877b707d6 Improved lang.yml/config.yml warning messages 2022-11-17 15:12:28 +00:00
Auxilor
bcb7401c74 Fixed captive slot changes PR 2022-11-17 15:10:05 +00:00
Auxilor
f05c5f3cd6 Fixed UltraEconomy integration 2022-11-17 15:02:40 +00:00
_OfTeN_
3bd8bccb81 Added UltraEconomy support to Price Lookup 2022-11-17 02:58:53 +03:00
_OfTeN_
6f55787c84 Added ability to filter items for captive slots 2022-11-13 02:50:23 +03:00
_OfTeN_
eb4dc168fc Added proper error displaying when missing config or lang ymls 2022-11-11 02:08:19 +03:00
211 changed files with 4184 additions and 2077 deletions

View File

@@ -1,38 +1,7 @@
# How to contribute to eco # How to contribute to eco
## Codestyle Please open any Pull Requests into the `develop` branch or ideally into a new branch for your changes. PRs that go into `master` won't be ignored, but I have to checkout and merge manually, which makes your PR show as being closed.
1. The eco checkstyle is in /config/checkstyle.xml Do not write any Kotlin-only APIs; all API components should be written in Java, Kotlin extensions should not have functionality that isn't available in java. The same applies the other way round, do not write any backend code in Java, it should be Kotlin-exclusive.
- The pull request must not have any checkstyle issues. If you have any questions about contributing, feel free to ask in the [Discord](https://discord.gg/ZcwpSsE)!
- Every method and field must have a javadoc attached.
2. Use JetBrains annotations
- Every parameter should be annotated with @NotNull or @Nullable
3. Imports
- No group (*) imports.
- No static imports.
4. Kotlin
- Kotlin should be the only language used in the backend, java should be the only language used in the frontend.
- Kotlin API extensions should only be for creating extension functions and extra niceties that aren't possible in java.
Do not write API components in kotlin.
- Kotlin code should never be called directly from the frontend Java API. Kotlin API extensions should always rely on
java, not the other way round.
## Dependency Injection
- eco uses Dependency Injection
- Any calls to Eco#getHandler#getEcoPlugin are code smells and should never be used unless **absolutely necessary**.
- NamespacedKeys, FixedMetadataValues, Runnables, and Schedules should be managed using AbstractEcoPlugin through DI.
- Any DI class should extend PluginDependent where possible. If the class extends another, then you **must** store the
plugin instance in a private final variable called **plugin** with a private or protected getter.
## Other
- All drops **must** be sent through a DropQueue - calls to World#dropItem will get your PR rejected.
- eco is built with java 17.

View File

@@ -1,5 +1,5 @@
# eco # eco
eco is a powerful Spigot development library that simplifies the process of plugin creation and supercharges eco is a powerful Spigot plugin framework that simplifies the process of plugin creation and supercharges
your plugins. your plugins.
It's the engine behind [EcoEnchants](https://polymart.org/resource/490), [Reforges](https://polymart.org/resource/1330), It's the engine behind [EcoEnchants](https://polymart.org/resource/490), [Reforges](https://polymart.org/resource/1330),
[EcoItems](https://polymart.org/resource/1247), [EcoSkills](https://polymart.org/resource/1351), [EcoItems](https://polymart.org/resource/1247), [EcoSkills](https://polymart.org/resource/1351),
@@ -16,30 +16,54 @@ and many more.
<a href="https://bstats.org/plugin/bukkit/EcoEnchants" alt="bstats players"> <a href="https://bstats.org/plugin/bukkit/EcoEnchants" alt="bstats players">
<img src="https://img.shields.io/bstats/players/7666?color=informational"/> <img src="https://img.shields.io/bstats/players/7666?color=informational"/>
</a> </a>
<a href="https://plugins.auxilor.io/" alt="Docs (gitbook)">
<img src="https://img.shields.io/badge/docs-gitbook-informational"/>
</a>
<a href="https://discord.gg/ZcwpSsE/" alt="Discord"> <a href="https://discord.gg/ZcwpSsE/" alt="Discord">
<img src="https://img.shields.io/discord/452518336627081236?label=discord&color=informational"/> <img src="https://img.shields.io/discord/452518336627081236?label=discord&color=informational"/>
</a> </a>
<a href="https://github.com/Auxilor/eco/actions/workflows/java-ci.yml" alt="Latest Dev Build"> <a href="https://github.com/Auxilor/eco/actions/workflows/java-ci.yml" alt="Latest Dev Build">
<img src="https://img.shields.io/github/workflow/status/Auxilor/eco/Java%20CI/develop?color=informational"/> <img src="https://img.shields.io/github/actions/workflow/status/Auxilor/eco/java-ci.yml?branch=develop&color=informational"/>
</a> </a>
</p> </p>
eco comes packed with all the tools you need in your plugins:
- Modern command API
- Native color parsing with full hex/RGB/MiniMessage support
- Yaml/JSON/TOML config system
- Persistent data storage API with Yaml/MySQL/MongoDB support
- Packet item display system
- Lightweight event loop based packet API
- Entity AI API with near-1:1 NMS mappings
- More events
- Extension API, essentially plugins for plugins
- Fluent dependency injection for NamespacedKey, Metadata values, etc.
- Ultra-fast ItemStack reimplementation bypassing ItemMeta
- Complete GUI API with pre-made components available from [ecomponent](https://github.com/Auxilor/ecomponent)
- Over 30 native integrations for other plugins
- First-class custom item support with lookup strings
- Math expression parsing via [Crunch](https://github.com/Redempt/Crunch)
- Particle lookups
- Complete Placeholder API
- Price system, supporting economy plugins, XP, Items, etc.
- NMS/Version-specific tooling
- Custom crafting recipe API with support for stacks and custom items
- Native plugin update checking
- Native bStats support
- Full Kotlin support and native extensions
- Tooling to make meta-frameworks, like [libreforge](https://github.com/Auxilor/libreforge)
- And much more
# For server owners # For server owners
- Requires ProtocolLib to be installed: get the latest version [here](https://www.spigotmc.org/resources/protocollib.1997/)
- Supports 1.17+ - Supports 1.17+
## Downloads ## Downloads
- Stable (Recommended): [GitHub](https://github.com/Auxilor/eco/releases), [Polymart](https://polymart.org/resource/eco.773) - Stable: [GitHub](https://github.com/Auxilor/eco/releases), [Polymart](https://polymart.org/resource/eco.773)
- Dev (Not Recommended): [GitHub](https://github.com/Auxilor/eco/actions/workflows/java-ci.yml) (Open latest run and download) - Dev: [GitHub](https://github.com/Auxilor/eco/actions/workflows/java-ci.yml) (Open latest run and download)
# For developers # For developers
## Javadoc ## Javadoc
The 6.45.0 Javadoc can be found [here](https://javadoc.jitpack.io/com/willfp/eco/6.45.0/javadoc/) The 6.49.0 Javadoc can be found [here](https://javadoc.jitpack.io/com/willfp/eco/6.49.0/javadoc/)
## Plugin Information ## Plugin Information
@@ -68,7 +92,7 @@ dependencies {
} }
``` ```
Replace `Tag` with a release tag for eco, eg `6.45.0`. Replace `Tag` with a release tag for eco, eg `6.49.0`.
Maven: Maven:
@@ -88,7 +112,7 @@ Maven:
</dependency> </dependency>
``` ```
Replace `Tag` with a release tag for eco, eg `6.45.0`. Replace `Tag` with a release tag for eco, eg `6.49.0`.
## Build locally: ## Build locally:
@@ -103,7 +127,7 @@ cd eco
## License ## License
*Click here to read [the entire license](https://github.com/Auxilor/eco/blob/master/LICENSE.md).* eco is licensed under GNU GPL3. *Click here to read [the entire license](https://github.com/Auxilor/eco/blob/master/LICENSE.md).*
<h1 align="center"> <h1 align="center">
Check out our partners! Check out our partners!

View File

@@ -25,6 +25,7 @@ dependencies {
implementation(project(path = ":eco-core:core-nms:v1_18_R1", configuration = "reobf")) implementation(project(path = ":eco-core:core-nms:v1_18_R1", configuration = "reobf"))
implementation(project(path = ":eco-core:core-nms:v1_18_R2", configuration = "reobf")) implementation(project(path = ":eco-core:core-nms:v1_18_R2", configuration = "reobf"))
implementation(project(path = ":eco-core:core-nms:v1_19_R1", configuration = "reobf")) implementation(project(path = ":eco-core:core-nms:v1_19_R1", configuration = "reobf"))
implementation(project(path = ":eco-core:core-nms:v1_19_R2", configuration = "reobf"))
} }
allprojects { allprojects {
@@ -77,6 +78,8 @@ allprojects {
// LibsDisguises // LibsDisguises
maven("https://repo.md-5.net/content/groups/public/") maven("https://repo.md-5.net/content/groups/public/")
maven("https://repo.techscode.com/repository/maven-releases/")
} }
dependencies { dependencies {

View File

@@ -13,27 +13,30 @@ import java.util.Collections;
/** /**
* Wrapper class for ProtocolLib packets. * Wrapper class for ProtocolLib packets.
*
* @deprecated ProtocolLib is no longer used by eco. Use {@link com.willfp.eco.core.packet.PacketListener} instead.
*/ */
@Deprecated(since = "6.51.0")
public abstract class AbstractPacketAdapter extends PacketAdapter { public abstract class AbstractPacketAdapter extends PacketAdapter {
/** /**
* The packet type to listen for. * The handle type to listen for.
*/ */
private final PacketType type; private final PacketType type;
/** /**
* Whether the packet adapter should be registered after the server has loaded. * Whether the handle adapter should be registered after the server has loaded.
* <p> * <p>
* Useful for monitor priority adapters that <b>must</b> be ran last. * Useful for monitor priority adapters that <b>must</b> be ran last.
*/ */
private final boolean postLoad; private final boolean postLoad;
/** /**
* Create a new packet adapter for a specified plugin and type. * Create a new handle adapter for a specified plugin and type.
* *
* @param plugin The plugin that ProtocolLib should mark as the owner. * @param plugin The plugin that ProtocolLib should mark as the owner.
* @param type The {@link PacketType} to listen for. * @param type The {@link PacketType} to listen for.
* @param priority The priority at which the adapter should be ran on packet send/receive. * @param priority The priority at which the adapter should be ran on handle send/receive.
* @param postLoad If the packet adapter should be registered after the server has loaded. * @param postLoad If the handle adapter should be registered after the server has loaded.
*/ */
protected AbstractPacketAdapter(@NotNull final EcoPlugin plugin, protected AbstractPacketAdapter(@NotNull final EcoPlugin plugin,
@NotNull final PacketType type, @NotNull final PacketType type,
@@ -45,11 +48,11 @@ public abstract class AbstractPacketAdapter extends PacketAdapter {
} }
/** /**
* Create a new packet adapter for a specified plugin and type. * Create a new handle adapter for a specified plugin and type.
* *
* @param plugin The plugin that ProtocolLib should mark as the owner. * @param plugin The plugin that ProtocolLib should mark as the owner.
* @param type The {@link PacketType} to listen for. * @param type The {@link PacketType} to listen for.
* @param postLoad If the packet adapter should be registered after the server has loaded. * @param postLoad If the handle adapter should be registered after the server has loaded.
*/ */
protected AbstractPacketAdapter(@NotNull final EcoPlugin plugin, protected AbstractPacketAdapter(@NotNull final EcoPlugin plugin,
@NotNull final PacketType type, @NotNull final PacketType type,
@@ -58,9 +61,9 @@ public abstract class AbstractPacketAdapter extends PacketAdapter {
} }
/** /**
* The code that should be executed once the packet has been received. * The code that should be executed once the handle has been received.
* *
* @param packet The packet. * @param packet The handle.
* @param player The player. * @param player The player.
* @param event The event. * @param event The event.
*/ */
@@ -71,9 +74,9 @@ public abstract class AbstractPacketAdapter extends PacketAdapter {
} }
/** /**
* THe code that should be executed once the packet has been sent. * THe code that should be executed once the handle has been sent.
* *
* @param packet The packet. * @param packet The handle.
* @param player The player. * @param player The player.
* @param event The event. * @param event The event.
*/ */
@@ -84,7 +87,7 @@ public abstract class AbstractPacketAdapter extends PacketAdapter {
} }
/** /**
* Boilerplate to assert that the packet is of the specified type. * Boilerplate to assert that the handle is of the specified type.
* *
* @param event The ProtocolLib event. * @param event The ProtocolLib event.
*/ */
@@ -102,7 +105,7 @@ public abstract class AbstractPacketAdapter extends PacketAdapter {
} }
/** /**
* Boilerplate to assert that the packet is of the specified type. * Boilerplate to assert that the handle is of the specified type.
* *
* @param event The ProtocolLib event. * @param event The ProtocolLib event.
*/ */
@@ -125,7 +128,7 @@ public abstract class AbstractPacketAdapter extends PacketAdapter {
} }
/** /**
* Register the packet adapter with ProtocolLib. * Register the handle adapter with ProtocolLib.
*/ */
public final void register() { public final void register() {
if (!ProtocolLibrary.getProtocolManager().getPacketListeners().contains(this)) { if (!ProtocolLibrary.getProtocolManager().getPacketListeners().contains(this)) {
@@ -134,7 +137,7 @@ public abstract class AbstractPacketAdapter extends PacketAdapter {
} }
/** /**
* Get if the packet adapter should be loaded last. * Get if the handle adapter should be loaded last.
* *
* @return If post load. * @return If post load.
*/ */

View File

@@ -1,5 +1,8 @@
package com.willfp.eco.core; package com.willfp.eco.core;
import com.willfp.eco.core.command.CommandBase;
import com.willfp.eco.core.command.PluginCommandBase;
import com.willfp.eco.core.command.impl.PluginCommand;
import com.willfp.eco.core.config.ConfigType; import com.willfp.eco.core.config.ConfigType;
import com.willfp.eco.core.config.interfaces.Config; import com.willfp.eco.core.config.interfaces.Config;
import com.willfp.eco.core.config.interfaces.LoadableConfig; import com.willfp.eco.core.config.interfaces.LoadableConfig;
@@ -23,6 +26,7 @@ import com.willfp.eco.core.gui.slot.SlotBuilder;
import com.willfp.eco.core.gui.slot.functional.SlotProvider; import com.willfp.eco.core.gui.slot.functional.SlotProvider;
import com.willfp.eco.core.items.TestableItem; import com.willfp.eco.core.items.TestableItem;
import com.willfp.eco.core.math.MathContext; import com.willfp.eco.core.math.MathContext;
import com.willfp.eco.core.packet.Packet;
import com.willfp.eco.core.proxy.ProxyFactory; import com.willfp.eco.core.proxy.ProxyFactory;
import com.willfp.eco.core.scheduling.Scheduler; import com.willfp.eco.core.scheduling.Scheduler;
import net.kyori.adventure.platform.bukkit.BukkitAudiences; import net.kyori.adventure.platform.bukkit.BukkitAudiences;
@@ -47,18 +51,18 @@ import java.util.UUID;
import java.util.logging.Logger; import java.util.logging.Logger;
/** /**
* Holds the instance of eco for bridging between the frontend * Holds the instance of eco for bridging between the frontend and backend.
* and backend.
* <p> * <p>
* <strong>Do not use this in your plugins!</strong> It can and will contain * <strong>Do not use this in your plugins!</strong> It can and will contain
* breaking changes between minor versions and even patches, and you will create * breaking changes between minor versions and even patches, and you will create compatibility
* compatibility issues by. All parts of this have been abstracted * issues by. All parts of this have been abstracted into logically named API components that you
* into logically named API components that you can use. * can use.
* *
* @see Eco#get() * @see Eco#get()
*/ */
@ApiStatus.Internal @ApiStatus.Internal
public interface Eco { public interface Eco {
/** /**
* Create a scheduler. * Create a scheduler.
* *
@@ -71,7 +75,7 @@ public interface Eco {
/** /**
* Create an event manager. * Create an event manager.
* *
* @param plugin The plugin. * @param plugin The plugin.F
* @return The event manager. * @return The event manager.
*/ */
@NotNull @NotNull
@@ -155,6 +159,40 @@ public interface Eco {
@NotNull @NotNull
EcoPlugin getEcoPlugin(); EcoPlugin getEcoPlugin();
/**
* Create PluginCommandBase implementation of {@link PluginCommand}.
*
* @param parentDelegate the enclosing class of this implementation.
* @param plugin the plugin.
* @param name the name of the command.
* @param permission the permission of the command.
* @param playersOnly if the command is players only.
* @return The PluginCommandBase implementation
*/
@NotNull
PluginCommandBase createPluginCommand(@NotNull CommandBase parentDelegate,
@NotNull EcoPlugin plugin,
@NotNull String name,
@NotNull String permission,
boolean playersOnly);
/**
* Create CommandBase implementation of {@link com.willfp.eco.core.command.impl.Subcommand Subcommand}.
*
* @param parentDelegate the enclosing class of this implementation.
* @param plugin the plugin.
* @param name the name of the command.
* @param permission the permission of the command.
* @param playersOnly if the command is players only.
* @return The CommandBase implementation
*/
@NotNull
CommandBase createSubcommand(@NotNull CommandBase parentDelegate,
@NotNull EcoPlugin plugin,
@NotNull String name,
@NotNull String permission,
boolean playersOnly);
/** /**
* Updatable config. * Updatable config.
* *
@@ -376,9 +414,8 @@ public interface Eco {
/** /**
* Create a {@link NamespacedKey} quickly * Create a {@link NamespacedKey} quickly
* <p> * <p>
* Bypasses the constructor, allowing for the creation of invalid keys, * Bypasses the constructor, allowing for the creation of invalid keys, therefore this is
* therefore this is considered unsafe and should only be called after * considered unsafe and should only be called after the key has been confirmed to be valid.
* the key has been confirmed to be valid.
* *
* @param namespace The namespace. * @param namespace The namespace.
* @param key The key. * @param key The key.
@@ -511,8 +548,23 @@ public interface Eco {
void syncCommands(); void syncCommands();
/** /**
* Get the instance of eco; the bridge between the api frontend * Unregister a command.
* and the implementation backend. *
* @param command The command.
*/
void unregisterCommand(@NotNull PluginCommandBase command);
/**
* Send a packet.
*
* @param player The player.
* @param packet The packet.
*/
void sendPacket(@NotNull Player player,
@NotNull Packet packet);
/**
* Get the instance of eco; the bridge between the api frontend and the implementation backend.
* *
* @return The instance of eco. * @return The instance of eco.
*/ */
@@ -526,6 +578,7 @@ public interface Eco {
*/ */
@ApiStatus.Internal @ApiStatus.Internal
final class Instance { final class Instance {
/** /**
* Instance of eco. * Instance of eco.
*/ */

View File

@@ -13,6 +13,7 @@ import com.willfp.eco.core.factory.MetadataValueFactory;
import com.willfp.eco.core.factory.NamespacedKeyFactory; import com.willfp.eco.core.factory.NamespacedKeyFactory;
import com.willfp.eco.core.factory.RunnableFactory; import com.willfp.eco.core.factory.RunnableFactory;
import com.willfp.eco.core.integrations.IntegrationLoader; import com.willfp.eco.core.integrations.IntegrationLoader;
import com.willfp.eco.core.packet.PacketListener;
import com.willfp.eco.core.proxy.ProxyFactory; import com.willfp.eco.core.proxy.ProxyFactory;
import com.willfp.eco.core.scheduling.Scheduler; import com.willfp.eco.core.scheduling.Scheduler;
import com.willfp.eco.core.web.UpdateChecker; import com.willfp.eco.core.web.UpdateChecker;
@@ -52,7 +53,7 @@ import java.util.stream.Collectors;
* <b>IMPORTANT: When reloading a plugin, all runnables / tasks will * <b>IMPORTANT: When reloading a plugin, all runnables / tasks will
* be cancelled.</b> * be cancelled.</b>
*/ */
@SuppressWarnings("unused") @SuppressWarnings({"unused", "DeprecatedIsStillUsed", "deprecation", "RedundantSuppression"})
public abstract class EcoPlugin extends JavaPlugin implements PluginLike { public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
/** /**
* The polymart resource ID of the plugin. * The polymart resource ID of the plugin.
@@ -344,6 +345,13 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
this.configHandler = Eco.get().createConfigHandler(this); this.configHandler = Eco.get().createConfigHandler(this);
this.langYml = this.createLangYml(); this.langYml = this.createLangYml();
if (!this.langYml.isValid() && !(this instanceof Eco)) {
this.getLogger().warning("Notify plugin authors " + String.join(", ", this.getDescription().getAuthors()) + " that");
this.getLogger().warning("they are missing crucial lang.yml keys! They can be found");
this.getLogger().warning("in the LangYml class.");
}
this.configYml = this.createConfigYml(); this.configYml = this.createConfigYml();
Eco.get().addNewPlugin(this); Eco.get().addNewPlugin(this);
@@ -415,13 +423,16 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
Prerequisite.update(); Prerequisite.update();
if (Prerequisite.HAS_PROTOCOLLIB.isMet()) {
this.loadPacketAdapters().forEach(abstractPacketAdapter -> { this.loadPacketAdapters().forEach(abstractPacketAdapter -> {
if (!abstractPacketAdapter.isPostLoad()) { if (!abstractPacketAdapter.isPostLoad()) {
abstractPacketAdapter.register(); abstractPacketAdapter.register();
} }
}); });
}
this.loadListeners().forEach(listener -> this.getEventManager().registerListener(listener)); this.loadListeners().forEach(listener -> this.getEventManager().registerListener(listener));
this.loadPacketListeners().forEach(listener -> this.getEventManager().registerPacketListener(listener));
this.loadPluginCommands().forEach(PluginCommand::register); this.loadPluginCommands().forEach(PluginCommand::register);
@@ -513,11 +524,13 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
Display.registerDisplayModule(this.getDisplayModule()); Display.registerDisplayModule(this.getDisplayModule());
} }
if (Prerequisite.HAS_PROTOCOLLIB.isMet()) {
this.loadPacketAdapters().forEach(abstractPacketAdapter -> { this.loadPacketAdapters().forEach(abstractPacketAdapter -> {
if (abstractPacketAdapter.isPostLoad()) { if (abstractPacketAdapter.isPostLoad()) {
abstractPacketAdapter.register(); abstractPacketAdapter.register();
} }
}); });
}
if (!Prerequisite.HAS_PAPER.isMet()) { if (!Prerequisite.HAS_PAPER.isMet()) {
this.getLogger().severe(""); this.getLogger().severe("");
@@ -674,16 +687,27 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
} }
/** /**
* ProtocolLib packet adapters to be registered. * ProtocolLib handle adapters to be registered.
* <p> * <p>
* If the plugin does not require ProtocolLib this can be left empty. * If the plugin does not require ProtocolLib this can be left empty.
* *
* @return A list of packet adapters. * @return A list of handle adapters.
* @deprecated Use {@link #loadPacketListeners()} instead.
*/ */
@Deprecated(since = "6.51.0")
protected List<AbstractPacketAdapter> loadPacketAdapters() { protected List<AbstractPacketAdapter> loadPacketAdapters() {
return new ArrayList<>(); return new ArrayList<>();
} }
/**
* Packet Listeners to be registered.
*
* @return A list of handle listeners.
*/
protected List<PacketListener> loadPacketListeners() {
return new ArrayList<>();
}
/** /**
* All listeners to be registered. * All listeners to be registered.
* *
@@ -699,7 +723,15 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
* @return lang.yml. * @return lang.yml.
*/ */
protected LangYml createLangYml() { protected LangYml createLangYml() {
try {
return new LangYml(this); return new LangYml(this);
} catch (NullPointerException e) {
this.getLogger().severe("Failed to load lang.yml!");
this.getLogger().severe("For the developer of this plugin: make sure you have a lang.yml");
e.printStackTrace();
Bukkit.getPluginManager().disablePlugin(this);
return null;
}
} }
/** /**
@@ -710,7 +742,15 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
* @return config.yml. * @return config.yml.
*/ */
protected ConfigYml createConfigYml() { protected ConfigYml createConfigYml() {
try {
return new ConfigYml(this); return new ConfigYml(this);
} catch (NullPointerException e) {
this.getLogger().severe("Failed to load config.yml!");
this.getLogger().severe("For the developer of this plugin: make sure you have a config.yml");
e.printStackTrace();
Bukkit.getPluginManager().disablePlugin(this);
return null;
}
} }
/** /**

View File

@@ -221,7 +221,7 @@ public final class PluginProps {
/** /**
* Create new props from known values. * Create new props from known values.
* * <p>
* Marked as internal as this method will break whenever the properties themselves * Marked as internal as this method will break whenever the properties themselves
* are updated (e.g. if a new property is added) - so to prevent any potential * are updated (e.g. if a new property is added) - so to prevent any potential
* backwards-compatibility bugs, this method cannot be invoked outside eco itself. * backwards-compatibility bugs, this method cannot be invoked outside eco itself.

View File

@@ -30,6 +30,14 @@ public class Prerequisite {
"Requires server to be running paper (or a fork)" "Requires server to be running paper (or a fork)"
); );
/**
* Requires the server to be running an implementation of paper.
*/
public static final Prerequisite HAS_PROTOCOLLIB = new Prerequisite(
() -> ClassUtils.exists("com.comphenix.protocol.events.PacketAdapter"),
"Requires server to have ProtocolLib"
);
/** /**
* Requires the server to have vault installed. * Requires the server to have vault installed.
* *
@@ -70,7 +78,10 @@ public class Prerequisite {
/** /**
* Requires the server to be running an implementation of BungeeCord. * Requires the server to be running an implementation of BungeeCord.
*
* @deprecated This will never return true.
*/ */
@Deprecated(since = "6.49.0", forRemoval = true)
public static final Prerequisite HAS_BUNGEECORD = new Prerequisite( public static final Prerequisite HAS_BUNGEECORD = new Prerequisite(
() -> ClassUtils.exists("net.md_5.bungee.api.event.ServerConnectedEvent"), () -> ClassUtils.exists("net.md_5.bungee.api.event.ServerConnectedEvent"),
"Requires server to be running BungeeCord (or a fork)" "Requires server to be running BungeeCord (or a fork)"
@@ -78,7 +89,10 @@ public class Prerequisite {
/** /**
* Requires the server to be running an implementation of Velocity. * Requires the server to be running an implementation of Velocity.
*
* @deprecated This will never return true.
*/ */
@Deprecated(since = "6.49.0", forRemoval = true)
public static final Prerequisite HAS_VELOCITY = new Prerequisite( public static final Prerequisite HAS_VELOCITY = new Prerequisite(
() -> ClassUtils.exists("com.velocitypowered.api.event.player.ServerConnectedEvent"), () -> ClassUtils.exists("com.velocitypowered.api.event.player.ServerConnectedEvent"),
"Requires server to be running Velocity (or a fork)" "Requires server to be running Velocity (or a fork)"

View File

@@ -1,32 +1,37 @@
package com.willfp.eco.core.command; package com.willfp.eco.core.command;
import com.google.common.collect.ImmutableList;
import com.willfp.eco.core.EcoPlugin; import com.willfp.eco.core.EcoPlugin;
import org.bukkit.Bukkit;
import org.bukkit.OfflinePlayer;
import org.bukkit.command.CommandSender; import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Objects;
import java.util.function.Predicate;
/** /**
* Interface for all command implementations. * Generic interface for commands.
*/ */
@SuppressWarnings("removal") @SuppressWarnings("null")
public interface CommandBase { public interface CommandBase {
/** /**
* Get command name. * Get command name.
* *
* @return The name. * @return The name.
*/ */
String getName(); @NotNull String getName();
/** /**
* Get command permission. * Get command permission.
* *
* @return The permission. * @return The permission.
*/ */
String getPermission(); @NotNull String getPermission();
/** /**
* If only players can execute the command. * If only players can execute the command.
@@ -41,110 +46,237 @@ public interface CommandBase {
* @param command The subcommand. * @param command The subcommand.
* @return The parent command. * @return The parent command.
*/ */
CommandBase addSubcommand(@NotNull CommandBase command); @NotNull CommandBase addSubcommand(@NotNull CommandBase command);
/**
* Get the subcommands of the command.
*
* @return The subcommands.
*/
@NotNull List<CommandBase> getSubcommands();
/**
* Intended for returning the enclosing CommandBase,
* when this instance is serving as the delegate command base.
*
* @return the wrapping object of this delegate.
*/
default @NotNull CommandBase getWrapped() {
return this;
}
/** /**
* Handle command execution. * Handle command execution.
* <p>
* This will always be called on command execution.
* *
* @param sender The sender. * @param sender The sender.
* @param args The args. * @param args The args.
* @throws NotificationException naturally, this is handled as a part of the command system.
*/ */
default void onExecute(@NotNull CommandSender sender, default void onExecute(@NotNull final CommandSender sender, @NotNull final List<String> args) throws NotificationException {
@NotNull List<String> args) {
// Do nothing. // Do nothing.
} }
/** /**
* Handle command execution from players. * Handle command execution from players.
* <p>
* This will only be called if the sender is a player.
* *
* @param sender The sender. * @param sender The sender.
* @param args The args. * @param args The args.
* @throws NotificationException naturally, this is handled as a part of the command system.
*/ */
default void onExecute(@NotNull Player sender, default void onExecute(@NotNull final Player sender, @NotNull final List<String> args) throws NotificationException {
@NotNull List<String> args) {
// Do nothing. // Do nothing.
} }
/** /**
* Handle tab completion. * Handle tab completion.
* <p>
* This will always be called on tab completion.
* *
* @param sender The sender. * @param sender The sender.
* @param args The args. * @param args The args.
* @return The results. * @return The results.
*/ */
@NotNull @NotNull
default List<String> tabComplete(@NotNull CommandSender sender, default List<String> tabComplete(@NotNull final CommandSender sender, @NotNull final List<String> args) {
@NotNull List<String> args) {
return new ArrayList<>(); return new ArrayList<>();
} }
/** /**
* Handle tab completion. * Handle tab completion.
* <p>
* This will only be called if the sender is a player.
* *
* @param sender The sender. * @param sender The sender.
* @param args The args. * @param args The args.
* @return The results. * @return The results.
*/ */
@NotNull @NotNull
default List<String> tabComplete(@NotNull Player sender, default List<String> tabComplete(@NotNull final Player sender, @NotNull final List<String> args) {
@NotNull List<String> args) {
return new ArrayList<>(); return new ArrayList<>();
} }
/**
* Throws an {@link NotificationException} relating to a specific lang.yml key.
* <p>
* This is automatically handled with eco, and should not be surrounded by a
* try/catch block.
*
* @param key The lang.yml key for the message to be sent.
* @throws NotificationException always.
*/
default void notify(@NotNull final String key) throws NotificationException {
throw new NotificationException(key);
}
/**
* Throws an {@link NotificationException} relating to a specific lang.yml key
* if the passed object is null.
* <p>
* This is automatically handled with eco, and should not be surrounded by a
* try/catch block.
*
* @param obj The object to test.
* @param key The lang.yml key for the message to be sent.
* @param <T> The object type.
* @return Returns the object, definitely not-null.
* @throws NotificationException If the object is null.
*/
@NotNull
default <T> T notifyNull(@Nullable final T obj,
@NotNull final String key) throws NotificationException {
if (Objects.isNull(obj)) {
notify(key);
}
return Objects.requireNonNull(obj);
}
/**
* Throws an {@link NotificationException} relating to a specific lang.yml key
* if the passed object doesn't match the predicate.
* <p>
* This is automatically handled with eco, and should not be surrounded by a
* try/catch block.
*
* @param obj The object to test.
* @param key The lang.yml key for the message to be sent.
* @param predicate The predicate to test the object against.
* @param <T> The type of the object.
* @return Returns the object, definitely not-null.
* @throws NotificationException If the object doesn't satisfy the predicate.
*/
@NotNull
default <T> T notifyFalse(@NotNull final T obj,
@NotNull final String key,
@NotNull final Predicate<T> predicate) throws NotificationException {
notifyFalse(predicate.test(obj), key);
return obj;
}
/**
* Throws an {@link NotificationException} relating to a specific lang.yml key
* if a condition is false.
* <p>
* This is automatically handled with eco, and should not be surrounded by a
* try/catch block.
*
* @param condition The condition to test.
* @param key The lang.yml key for the message to be sent.
* @return True.
* @throws NotificationException If the condition is false.
*/
default boolean notifyFalse(final boolean condition,
@NotNull final String key) throws NotificationException {
if (!condition) {
notify(key);
}
return true;
}
/**
* Throws an {@link NotificationException} relating to a specific lang.yml key
* if the passed string doesn't relate to a currently online player.
* <p>
* This is automatically handled with eco, and should not be surrounded by a
* try/catch block.
*
* @param playerName The player name.
* @param key The lang.yml key for the message to be sent.
* @return Returns the player, definitely not-null.
* @throws NotificationException If the player name is invalid.
*/
@NotNull
default Player notifyPlayerRequired(@Nullable final String playerName, @NotNull final String key) throws NotificationException {
if (playerName == null) {
notify(key);
}
assert playerName != null;
final Player player = Bukkit.getPlayer(playerName);
notifyNull(player, key);
return Objects.requireNonNull(player);
}
/**
* Throws an {@link NotificationException} relating to a specific lang.yml key
* if the passed string doesn't relate to a player on the server.
* <p>
* This is automatically handled with eco, and should not be surrounded by a
* try/catch block.
*
* @param playerName The player name.
* @param key The lang.yml key for the message to be sent.
* @return Returns the offline player, definitely not-null.
* @throws NotificationException If the player name is invalid.
*/
@NotNull
default OfflinePlayer notifyOfflinePlayerRequired(@Nullable final String playerName,
@NotNull final String key) throws NotificationException {
if (playerName == null) {
notify(key);
}
assert playerName != null;
@SuppressWarnings("deprecation") final OfflinePlayer player = Bukkit.getOfflinePlayer(playerName);
boolean hasPlayedBefore = player.hasPlayedBefore() || player.isOnline();
notifyFalse(!hasPlayedBefore, key);
return player;
}
/**
* Throws an exception containing a langYml key if player doesn't have permission.
*
* @param player The player.
* @param permission The permission.
* @param key The lang.yml key for the message to be sent.
* @return The player.
* @throws NotificationException If the player doesn't have the required permission.
*/
@NotNull
default Player notifyPermissionRequired(@NotNull final Player player,
@NotNull final String permission,
@NotNull final String key) throws NotificationException {
return notifyFalse(player, key, p -> p.hasPermission(permission));
}
/** /**
* Get the plugin. * Get the plugin.
* *
* @return The plugin. * @return The plugin.
*/ */
EcoPlugin getPlugin(); EcoPlugin getPlugin();
/**
* Get the handler.
*
* @return The handler.
* @see CommandHandler
* @deprecated Use {@link CommandBase#onExecute(CommandSender, List)} instead.
*/
@Deprecated(forRemoval = true)
default CommandHandler getHandler() {
return (a, b) -> {
};
}
/**
* Set the handler.
*
* @param handler The handler.
* @see CommandHandler
* @deprecated Handlers have been deprecated.
*/
@Deprecated(forRemoval = true)
default void setHandler(@NotNull final CommandHandler handler) {
// Do nothing.
}
/**
* Get the tab completer.
*
* @return The tab completer.
* @see TabCompleteHandler
* @deprecated Use {@link CommandBase#tabComplete(CommandSender, List)} instead.
*/
@Deprecated(forRemoval = true)
default TabCompleteHandler getTabCompleter() {
return (a, b) -> ImmutableList.of();
}
/**
* Set the tab completer.
*
* @param handler The handler.
* @see TabCompleteHandler
* @deprecated Handlers have been deprecated.
*/
@Deprecated(forRemoval = true)
default void setTabCompleter(@NotNull final TabCompleteHandler handler) {
// Do nothing.
}
} }

View File

@@ -1,29 +0,0 @@
package com.willfp.eco.core.command;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.jetbrains.annotations.NotNull;
import java.util.List;
/**
* A command handler handles the actual code for a command.
* <p>
* The replacement for {@link org.bukkit.command.CommandExecutor#onCommand(CommandSender, Command, String, String[])}
*
* @see CommandBase
* @deprecated Handlers have been deprecated. This legacy system will eventually be removed,
* update to use the new system: {@link CommandBase#onExecute(CommandSender, List)}.
*/
@FunctionalInterface
@Deprecated(since = "6.17.0", forRemoval = true)
public interface CommandHandler {
/**
* The code to be called on execution.
*
* @param sender The sender.
* @param args The arguments.
*/
void onExecute(@NotNull CommandSender sender,
@NotNull List<String> args);
}

View File

@@ -0,0 +1,36 @@
package com.willfp.eco.core.command;
import org.jetbrains.annotations.NotNull;
/**
* A notification exception is thrown when {@link org.bukkit.command.CommandSender}s don't
* specify valid arguments in commands.
* <p>
* Methods in eco that throw this will contain automatic handling and thus
* should not be surrounded by try / catch blocks.
*/
public class NotificationException extends Exception {
/**
* The key for the lang.yml message to be sent.
*/
private final String key;
/**
* Creates a notification exception.
*
* @param key The lang key of the notification.
*/
public NotificationException(@NotNull final String key) {
super(key);
this.key = key;
}
/**
* Get the lang key.
*
* @return The lang key.
*/
public String getKey() {
return key;
}
}

View File

@@ -0,0 +1,44 @@
package com.willfp.eco.core.command;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.List;
/**
* Plugin command bases can be registered directly with the server,
* this essentially functions as the interface that is implemented generically
* via {@link com.willfp.eco.core.command.impl.PluginCommand}.
*/
public interface PluginCommandBase extends CommandBase {
/**
* Register the PluginCommandBase to the bukkit commandMap.
*/
void register();
/**
* Unregister the PluginCommandBase from the bukkit commandMap.
*/
void unregister();
/**
* Get aliases. Leave null if this command is from plugin.yml.
*
* @return The aliases.
*/
@NotNull
default List<String> getAliases() {
return new ArrayList<>();
}
/**
* Get description.
*
* @return The description.
*/
@Nullable
default String getDescription() {
return null;
}
}

View File

@@ -1,30 +0,0 @@
package com.willfp.eco.core.command;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.jetbrains.annotations.NotNull;
import java.util.List;
/**
* A Tab Complete handler handles the actual tab-completion code.
* <p>
* The replacement for {@link org.bukkit.command.TabCompleter#onTabComplete(CommandSender, Command, String, String[])}
*
* @see CommandBase
* @deprecated Handlers have been deprecated. This legacy system will eventually be removed,
* update to use the new system: {@link CommandBase#tabComplete(CommandSender, List)}
*/
@FunctionalInterface
@Deprecated(since = "6.17.0", forRemoval = true)
public interface TabCompleteHandler {
/**
* Handle Tab Completion.
*
* @param sender The sender.
* @param args The arguments.
* @return The tab completion results.
*/
List<String> tabComplete(@NotNull CommandSender sender,
@NotNull List<String> args);
}

View File

@@ -6,13 +6,15 @@ import org.bukkit.command.PluginIdentifiableCommand;
import org.bukkit.command.TabCompleter; import org.bukkit.command.TabCompleter;
import org.bukkit.plugin.Plugin; import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List; import java.util.List;
/** /**
* Delegates a bukkit command to an eco command (for registrations). * Delegates a bukkit command to an eco command (for registrations).
*
* @deprecated Internal command implementations have been removed from the API.
*/ */
@Deprecated(forRemoval = true, since = "6.49.0")
public final class DelegatedBukkitCommand extends Command implements TabCompleter, PluginIdentifiableCommand { public final class DelegatedBukkitCommand extends Command implements TabCompleter, PluginIdentifiableCommand {
/** /**
* The delegate command. * The delegate command.
@@ -34,7 +36,7 @@ public final class DelegatedBukkitCommand extends Command implements TabComplete
public boolean execute(@NotNull final CommandSender commandSender, public boolean execute(@NotNull final CommandSender commandSender,
@NotNull final String label, @NotNull final String label,
@NotNull final String[] args) { @NotNull final String[] args) {
return delegate.onCommand(commandSender, this, label, args); return false;
} }
@Override @Override
@@ -42,7 +44,7 @@ public final class DelegatedBukkitCommand extends Command implements TabComplete
@NotNull final Command command, @NotNull final Command command,
@NotNull final String label, @NotNull final String label,
@NotNull final String[] args) { @NotNull final String[] args) {
return delegate.onTabComplete(commandSender, command, label, args); return List.of();
} }
@NotNull @NotNull
@@ -51,9 +53,8 @@ public final class DelegatedBukkitCommand extends Command implements TabComplete
return this.delegate.getPlugin(); return this.delegate.getPlugin();
} }
@Nullable
@Override @Override
public String getPermission() { public @NotNull String getPermission() {
return this.delegate.getPermission(); return this.delegate.getPermission();
} }

View File

@@ -1,294 +0,0 @@
package com.willfp.eco.core.command.impl;
import com.willfp.eco.core.EcoPlugin;
import com.willfp.eco.core.command.CommandBase;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.util.StringUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
/**
* Abstract class for commands that can be handled.
* <p>
* Handled commands have a method to pass in raw input from bukkit commands
* in order to execute the command-specific code. It's essentially an internal
* layer, hence why it's a package-private class.
*/
@SuppressWarnings({"DeprecatedIsStillUsed", "removal"})
abstract class HandledCommand implements CommandBase {
/**
* The plugin.
*/
private final EcoPlugin plugin;
/**
* The name of the command.
*/
private final String name;
/**
* The permission required to execute the command.
* <p>
* Written out as a string for flexibility with subclasses.
*/
private final String permission;
/**
* Should the command only be allowed to be executed by players?
* <p>
* In other worlds, only allowed to be executed by console.
*/
private final boolean playersOnly;
/**
* The actual code to be executed in the command.
*/
@Deprecated
@Nullable
private com.willfp.eco.core.command.CommandHandler handler = null;
/**
* The tab completion code to be executed in the command.
*/
@Deprecated
@Nullable
private com.willfp.eco.core.command.TabCompleteHandler tabCompleter = null;
/**
* All subcommands for the command.
*/
private final List<CommandBase> subcommands;
/**
* Create a new command.
* <p>
* The name cannot be the same as an existing command as this will conflict.
*
* @param plugin Instance of a plugin.
* @param name The name used in execution.
* @param permission The permission required to execute the command.
* @param playersOnly If only players should be able to execute this command.
*/
HandledCommand(@NotNull final EcoPlugin plugin,
@NotNull final String name,
@NotNull final String permission,
final boolean playersOnly) {
this.plugin = plugin;
this.name = name;
this.permission = permission;
this.playersOnly = playersOnly;
this.subcommands = new ArrayList<>();
}
/**
* Add a subcommand to the command.
*
* @param subcommand The subcommand.
* @return The parent command.
*/
@Override
public final CommandBase addSubcommand(@NotNull final CommandBase subcommand) {
subcommands.add(subcommand);
return this;
}
/**
* Get the plugin.
*
* @return The plugin.
*/
@Override
public EcoPlugin getPlugin() {
return this.plugin;
}
/**
* Handle the command.
*
* @param sender The sender.
* @param args The arguments.
*/
protected final void handle(@NotNull final CommandSender sender,
@NotNull final String[] args) {
if (!canExecute(sender, this, this.getPlugin())) {
return;
}
if (args.length > 0) {
for (CommandBase subcommand : this.getSubcommands()) {
if (subcommand.getName().equalsIgnoreCase(args[0])) {
if (!canExecute(sender, subcommand, this.getPlugin())) {
return;
}
((HandledCommand) subcommand).handle(sender, Arrays.copyOfRange(args, 1, args.length));
return;
}
}
}
if (this.isPlayersOnly() && !(sender instanceof Player)) {
sender.sendMessage(this.getPlugin().getLangYml().getMessage("not-player"));
return;
}
if (this.getHandler() != null) {
this.getHandler().onExecute(sender, Arrays.asList(args));
} else {
this.onExecute(sender, Arrays.asList(args));
if (sender instanceof Player player) {
this.onExecute(player, Arrays.asList(args));
}
}
}
/**
* Handle the tab completion.
*
* @param sender The sender.
* @param args The arguments.
* @return The tab completion results.
*/
protected final List<String> handleTabCompletion(@NotNull final CommandSender sender,
@NotNull final String[] args) {
if (!sender.hasPermission(this.getPermission())) {
return null;
}
if (args.length == 1) {
List<String> completions = new ArrayList<>();
StringUtil.copyPartialMatches(
args[0],
this.getSubcommands().stream()
.filter(subCommand -> sender.hasPermission(subCommand.getPermission()))
.map(CommandBase::getName)
.collect(Collectors.toList()),
completions
);
Collections.sort(completions);
if (!completions.isEmpty()) {
return completions;
}
}
if (args.length >= 2) {
HandledCommand command = null;
for (CommandBase subcommand : this.getSubcommands()) {
if (!sender.hasPermission(subcommand.getPermission())) {
continue;
}
if (args[0].equalsIgnoreCase(subcommand.getName())) {
command = (HandledCommand) subcommand;
}
}
if (command != null) {
return command.handleTabCompletion(sender, Arrays.copyOfRange(args, 1, args.length));
}
}
if (this.getTabCompleter() != null) {
return this.getTabCompleter().tabComplete(sender, Arrays.asList(args));
} else {
List<String> completions = new ArrayList<>(this.tabComplete(sender, Arrays.asList(args)));
if (sender instanceof Player player) {
completions.addAll(this.tabComplete(player, Arrays.asList(args)));
}
return completions;
}
}
/**
* If a sender can execute the command.
*
* @param sender The sender.
* @param command The command.
* @param plugin The plugin.
* @return If the sender can execute.
*/
public static boolean canExecute(@NotNull final CommandSender sender,
@NotNull final CommandBase command,
@NotNull final EcoPlugin plugin) {
if (!sender.hasPermission(command.getPermission()) && sender instanceof Player) {
sender.sendMessage(plugin.getLangYml().getNoPermission());
return false;
}
return true;
}
/**
* Get the command name.
*
* @return The name.
*/
public String getName() {
return this.name;
}
/**
* Get the permission required to execute the command.
*
* @return The permission.
*/
public String getPermission() {
return this.permission;
}
/**
* Get if the command can only be executed by players.
*
* @return If players only.
*/
public boolean isPlayersOnly() {
return this.playersOnly;
}
/**
* Get the subcommands of the command.
*
* @return The subcommands.
*/
public List<CommandBase> getSubcommands() {
return this.subcommands;
}
@Deprecated(forRemoval = true)
@Override
public @Nullable com.willfp.eco.core.command.CommandHandler getHandler() {
return this.handler;
}
@Deprecated(forRemoval = true)
@Override
public @Nullable com.willfp.eco.core.command.TabCompleteHandler getTabCompleter() {
return this.tabCompleter;
}
@Deprecated(forRemoval = true)
@Override
public void setHandler(@Nullable final com.willfp.eco.core.command.CommandHandler handler) {
this.handler = handler;
}
@Deprecated(forRemoval = true)
@Override
public void setTabCompleter(@Nullable final com.willfp.eco.core.command.TabCompleteHandler tabCompleter) {
this.tabCompleter = tabCompleter;
}
}

View File

@@ -2,29 +2,27 @@ package com.willfp.eco.core.command.impl;
import com.willfp.eco.core.Eco; import com.willfp.eco.core.Eco;
import com.willfp.eco.core.EcoPlugin; import com.willfp.eco.core.EcoPlugin;
import org.bukkit.Bukkit; import com.willfp.eco.core.command.CommandBase;
import org.bukkit.command.Command; import com.willfp.eco.core.command.PluginCommandBase;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandMap;
import org.bukkit.command.CommandSender;
import org.bukkit.command.TabCompleter;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List; import java.util.List;
/** /**
* PluginCommands are the class to be used instead of CommandExecutor, * PluginCommands are the class to be used instead of CommandExecutor, they function as the base
* they function as the base command, e.g. {@code /ecoenchants} would be a base command, with each * command, e.g. {@code /ecoenchants} would be a base command, with each subsequent argument
* subsequent argument functioning as subcommands. * functioning as subcommands.
* <p> * <p>
* The command will not be registered until register() is called. * The command will not be registered until register() is called.
* <p> * <p>
* The name cannot be the same as an existing command as this will conflict. * The name cannot be the same as an existing command as this will conflict.
*/ */
public abstract class PluginCommand extends HandledCommand implements CommandExecutor, TabCompleter { public abstract class PluginCommand implements PluginCommandBase {
/**
* The delegate command.
*/
private final PluginCommandBase delegate;
/** /**
* Create a new command. * Create a new command.
* *
@@ -37,128 +35,51 @@ public abstract class PluginCommand extends HandledCommand implements CommandExe
@NotNull final String name, @NotNull final String name,
@NotNull final String permission, @NotNull final String permission,
final boolean playersOnly) { final boolean playersOnly) {
super(plugin, name, permission, playersOnly); this.delegate = Eco.get().createPluginCommand(this, plugin, name, permission, playersOnly);
} }
/**
* Registers the command with the server,
*/
public final void register() {
org.bukkit.command.PluginCommand command = Bukkit.getPluginCommand(this.getName());
if (command != null) {
command.setExecutor(this);
command.setTabCompleter(this);
if (this.getDescription() != null) {
command.setDescription(this.getDescription());
}
List<String> aliases = new ArrayList<>(command.getAliases());
aliases.addAll(this.getAliases());
command.setAliases(aliases);
} else {
this.unregister();
CommandMap commandMap = getCommandMap();
commandMap.register(this.getPlugin().getName().toLowerCase(), new DelegatedBukkitCommand(this));
}
Eco.get().syncCommands();
}
/**
* Unregisters the command from the server.
*/
public final void unregister() {
CommandMap commandMap = getCommandMap();
Command found = commandMap.getCommand(this.getName());
if (found != null) {
found.unregister(commandMap);
}
Eco.get().syncCommands();
}
/**
* Get aliases. Leave null if this command is from plugin.yml.
*
* @return The aliases.
*/
@NotNull
public List<String> getAliases() {
return new ArrayList<>();
}
/**
* Get description.
*
* @return The description.
*/
@Nullable
public String getDescription() {
return null;
}
/**
* Internal implementation used to clean up boilerplate.
* Used for parity with {@link CommandExecutor#onCommand(CommandSender, Command, String, String[])}.
*
* @param sender The executor of the command.
* @param command The bukkit command.
* @param label The name of the executed command.
* @param args The arguments of the command (anything after the physical command name)
* @return If the command was processed by the linked {@link EcoPlugin}
*/
@Override @Override
public final boolean onCommand(@NotNull final CommandSender sender, public @NotNull String getName() {
@NotNull final Command command, return delegate.getName();
@NotNull final String label,
@NotNull final String[] args) {
if (!command.getName().equalsIgnoreCase(this.getName())) {
return false;
} }
this.handle(sender, args);
return true;
}
/**
* Internal implementation used to clean up boilerplate.
* Used for parity with {@link TabCompleter#onTabComplete(CommandSender, Command, String, String[])}.
*
* @param sender The executor of the command.
* @param command The bukkit command.
* @param label The name of the executed command.
* @param args The arguments of the command (anything after the physical command name).
* @return The list of tab-completions.
*/
@Override @Override
public @Nullable List<String> onTabComplete(@NotNull final CommandSender sender, public @NotNull String getPermission() {
@NotNull final Command command, return delegate.getPermission();
@NotNull final String label,
@NotNull final String[] args) {
if (!command.getName().equalsIgnoreCase(this.getName())) {
return null;
} }
return this.handleTabCompletion(sender, args); @Override
public boolean isPlayersOnly() {
return delegate.isPlayersOnly();
} }
/** @Override
* Get the internal server CommandMap. public @NotNull CommandBase addSubcommand(@NotNull CommandBase command) {
* return delegate.addSubcommand(command);
* @return The CommandMap.
*/
public static CommandMap getCommandMap() {
try {
Field field = Bukkit.getServer().getClass().getDeclaredField("commandMap");
field.setAccessible(true);
return (CommandMap) field.get(Bukkit.getServer());
} catch (NoSuchFieldException | IllegalAccessException e) {
throw new NullPointerException("Command map wasn't found!");
} }
@Override
public @NotNull List<CommandBase> getSubcommands() {
return delegate.getSubcommands();
}
@Override
public @NotNull CommandBase getWrapped() {
return this;
}
@Override
public void register() {
delegate.register();
}
@Override
public void unregister() {
delegate.unregister();
}
@Override
public EcoPlugin getPlugin() {
return delegate.getPlugin();
} }
} }

View File

@@ -1,13 +1,21 @@
package com.willfp.eco.core.command.impl; package com.willfp.eco.core.command.impl;
import com.willfp.eco.core.Eco;
import com.willfp.eco.core.EcoPlugin; import com.willfp.eco.core.EcoPlugin;
import com.willfp.eco.core.command.CommandBase; import com.willfp.eco.core.command.CommandBase;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import java.util.List;
/** /**
* Subcommands can be added to PluginCommands or to other Subcommands. * A command implementation that must exist as a subcommand (i.e. cannot be registered directly).
*/ */
public abstract class Subcommand extends HandledCommand { public abstract class Subcommand implements CommandBase {
/**
* The delegate command.
*/
private final CommandBase delegate;
/** /**
* Create subcommand. * Create subcommand.
* *
@@ -20,7 +28,7 @@ public abstract class Subcommand extends HandledCommand {
@NotNull final String name, @NotNull final String name,
@NotNull final String permission, @NotNull final String permission,
final boolean playersOnly) { final boolean playersOnly) {
super(plugin, name, permission, playersOnly); this.delegate = Eco.get().createSubcommand(this, plugin, name, permission, playersOnly);
} }
/** /**
@@ -33,6 +41,41 @@ public abstract class Subcommand extends HandledCommand {
protected Subcommand(@NotNull final EcoPlugin plugin, protected Subcommand(@NotNull final EcoPlugin plugin,
@NotNull final String name, @NotNull final String name,
@NotNull final CommandBase parent) { @NotNull final CommandBase parent) {
super(plugin, name, parent.getPermission(), parent.isPlayersOnly()); this(plugin, name, parent.getPermission(), parent.isPlayersOnly());
}
@Override
public @NotNull String getName() {
return delegate.getName();
}
@Override
public @NotNull String getPermission() {
return delegate.getPermission();
}
@Override
public boolean isPlayersOnly() {
return delegate.isPlayersOnly();
}
@Override
public @NotNull CommandBase addSubcommand(@NotNull CommandBase command) {
return delegate.addSubcommand(command);
}
@Override
public @NotNull List<CommandBase> getSubcommands() {
return delegate.getSubcommands();
}
@Override
public @NotNull CommandBase getWrapped() {
return this;
}
@Override
public EcoPlugin getPlugin() {
return delegate.getPlugin();
} }
} }

View File

@@ -6,10 +6,32 @@ import com.willfp.eco.core.config.ConfigType;
import com.willfp.eco.util.StringUtils; import com.willfp.eco.util.StringUtils;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import java.util.List;
/** /**
* Default plugin lang.yml. * Default plugin lang.yml.
*/ */
public class LangYml extends BaseConfig { public class LangYml extends BaseConfig {
/**
* The messages key.
*/
public static final String KEY_MESSAGES = "messages";
/**
* The prefix key.
*/
public static final String KEY_PREFIX = "messages.prefix";
/**
* The no permission key.
*/
public static final String KEY_NO_PERMISSION = "messages.no-permission";
/**
* The not player key.
*/
public static final String KEY_NOT_PLAYER = "messages.not-player";
/** /**
* Lang.yml. * Lang.yml.
* *
@@ -19,13 +41,31 @@ public class LangYml extends BaseConfig {
super("lang", plugin, false, ConfigType.YAML); super("lang", plugin, false, ConfigType.YAML);
} }
/**
* lang.yml requires certain keys to be present.
* <p>
* If the lang.yml does not contain these keys, it is considered to be
* invalid and thus will show a warning in console.
*
* @return If valid.
*/
public boolean isValid() {
for (String key : List.of(KEY_MESSAGES, KEY_PREFIX, KEY_NO_PERMISSION, KEY_NOT_PLAYER)) {
if (!this.has(key)) {
return false;
}
}
return true;
}
/** /**
* Get the prefix for messages in chat. * Get the prefix for messages in chat.
* *
* @return The prefix. * @return The prefix.
*/ */
public String getPrefix() { public String getPrefix() {
return this.getFormattedString("messages.prefix"); return this.getFormattedString(KEY_PREFIX);
} }
/** /**
@@ -34,7 +74,7 @@ public class LangYml extends BaseConfig {
* @return The message. * @return The message.
*/ */
public String getNoPermission() { public String getNoPermission() {
return getPrefix() + this.getFormattedString("messages.no-permission"); return getPrefix() + this.getFormattedString(KEY_NO_PERMISSION);
} }
/** /**
@@ -56,6 +96,6 @@ public class LangYml extends BaseConfig {
*/ */
public String getMessage(@NotNull final String message, public String getMessage(@NotNull final String message,
@NotNull final StringUtils.FormatOption option) { @NotNull final StringUtils.FormatOption option) {
return getPrefix() + this.getFormattedString("messages." + message, option); return getPrefix() + this.getFormattedString(KEY_MESSAGES + "." + message, option);
} }
} }

View File

@@ -134,7 +134,7 @@ public final class PersistentDataKey<T> {
if (this == o) { if (this == o) {
return true; return true;
} }
if (!(o instanceof PersistentDataKey that)) { if (!(o instanceof PersistentDataKey<?> that)) {
return false; return false;
} }
return Objects.equals(this.getKey(), that.getKey()); return Objects.equals(this.getKey(), that.getKey());

View File

@@ -99,7 +99,7 @@ public final class PersistentDataKeyType<T> {
if (this == that) { if (this == that) {
return true; return true;
} }
if (!(that instanceof PersistentDataKeyType type)) { if (!(that instanceof PersistentDataKeyType<?> type)) {
return false; return false;
} }
return Objects.equals(this.name, type.name); return Objects.equals(this.name, type.name);

View File

@@ -1,6 +1,7 @@
package com.willfp.eco.core.display; package com.willfp.eco.core.display;
import com.willfp.eco.core.fast.FastItemStack; import com.willfp.eco.core.fast.FastItemStack;
import com.willfp.eco.core.integrations.guidetection.GUIDetectionManager;
import com.willfp.eco.util.NamespacedKeyUtils; import com.willfp.eco.util.NamespacedKeyUtils;
import org.bukkit.NamespacedKey; import org.bukkit.NamespacedKey;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
@@ -18,6 +19,9 @@ import java.util.TreeMap;
/** /**
* Utility class to manage client-side item display. * Utility class to manage client-side item display.
* <p>
* Packet display is not done on the main thread, so make sure
* all your modules are thread-safe.
*/ */
public final class Display { public final class Display {
/** /**
@@ -71,7 +75,7 @@ public final class Display {
ItemStack original = itemStack.clone(); ItemStack original = itemStack.clone();
Inventory inventory = player == null ? null : player.getOpenInventory().getTopInventory(); Inventory inventory = player == null ? null : player.getOpenInventory().getTopInventory();
boolean inInventory = inventory != null && inventory.contains(original); boolean inInventory = inventory != null && inventory.contains(original);
boolean inGui = inventory != null && inventory.getHolder() == null; boolean inGui = player != null && GUIDetectionManager.hasGUIOpen(player);
DisplayProperties properties = new DisplayProperties( DisplayProperties properties = new DisplayProperties(
inInventory, inInventory,

View File

@@ -8,6 +8,8 @@ import org.jetbrains.annotations.Nullable;
/** /**
* Class for all plugin-specific client-side item display modules. * Class for all plugin-specific client-side item display modules.
* <p>
* Display modules are called in the netty thread, so make sure they are thread-safe.
*/ */
public abstract class DisplayModule { public abstract class DisplayModule {
/** /**

View File

@@ -45,7 +45,6 @@ public record EntityGoalAvoidEntity(
return null; return null;
} }
try {
TestableEntity entity = Entities.lookup(config.getString("entity")); TestableEntity entity = Entities.lookup(config.getString("entity"));
return new EntityGoalAvoidEntity( return new EntityGoalAvoidEntity(
@@ -54,14 +53,6 @@ public record EntityGoalAvoidEntity(
config.getDouble("slowSpeed"), config.getDouble("slowSpeed"),
config.getDouble("fastSpeed") config.getDouble("fastSpeed")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalBreakDoors(
return null; return null;
} }
try {
return new EntityGoalBreakDoors( return new EntityGoalBreakDoors(
config.getInt("ticks") config.getInt("ticks")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalBreed(
return null; return null;
} }
try {
return new EntityGoalBreed( return new EntityGoalBreed(
config.getDouble("speed") config.getDouble("speed")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,19 +37,10 @@ public record EntityGoalCatLieOnBed(
return null; return null;
} }
try {
return new EntityGoalCatLieOnBed( return new EntityGoalCatLieOnBed(
config.getDouble("speed"), config.getDouble("speed"),
config.getInt("range") config.getInt("range")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalCatSitOnBed(
return null; return null;
} }
try {
return new EntityGoalCatSitOnBed( return new EntityGoalCatSitOnBed(
config.getDouble("speed") config.getDouble("speed")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalFleeSun(
return null; return null;
} }
try {
return new EntityGoalFleeSun( return new EntityGoalFleeSun(
config.getDouble("speed") config.getDouble("speed")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -40,20 +40,11 @@ public record EntityGoalFollowMobs(
return null; return null;
} }
try {
return new EntityGoalFollowMobs( return new EntityGoalFollowMobs(
config.getDouble("speed"), config.getDouble("speed"),
config.getDouble("minDistance"), config.getDouble("minDistance"),
config.getDouble("maxDistance") config.getDouble("maxDistance")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -42,20 +42,11 @@ public record EntityGoalInteract(
return null; return null;
} }
try {
return new EntityGoalInteract( return new EntityGoalInteract(
Entities.lookup(config.getString("target")), Entities.lookup(config.getString("target")),
config.getDouble("range"), config.getDouble("range"),
config.getDouble("chance") config.getDouble("chance")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalLeapAtTarget(
return null; return null;
} }
try {
return new EntityGoalLeapAtTarget( return new EntityGoalLeapAtTarget(
config.getDouble("velocity") config.getDouble("velocity")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,19 +37,10 @@ public record EntityGoalLookAtPlayer(
return null; return null;
} }
try {
return new EntityGoalLookAtPlayer( return new EntityGoalLookAtPlayer(
config.getDouble("range"), config.getDouble("range"),
config.getDouble("chance") config.getDouble("chance")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,19 +37,10 @@ public record EntityGoalMeleeAttack(
return null; return null;
} }
try {
return new EntityGoalMeleeAttack( return new EntityGoalMeleeAttack(
config.getDouble("speed"), config.getDouble("speed"),
config.getBool("pauseWhenMobIdle") config.getBool("pauseWhenMobIdle")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,19 +37,10 @@ public record EntityGoalMoveBackToVillage(
return null; return null;
} }
try {
return new EntityGoalMoveBackToVillage( return new EntityGoalMoveBackToVillage(
config.getDouble("speed"), config.getDouble("speed"),
config.getBool("canDespawn") config.getBool("canDespawn")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -43,21 +43,12 @@ public record EntityGoalMoveThroughVillage(
return null; return null;
} }
try {
return new EntityGoalMoveThroughVillage( return new EntityGoalMoveThroughVillage(
config.getDouble("speed"), config.getDouble("speed"),
config.getBool("onlyAtNight"), config.getBool("onlyAtNight"),
config.getInt("distance"), config.getInt("distance"),
config.getBool("canPassThroughDoors") config.getBool("canPassThroughDoors")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalMoveTowardsRestriction(
return null; return null;
} }
try {
return new EntityGoalMoveTowardsRestriction( return new EntityGoalMoveTowardsRestriction(
config.getDouble("speed") config.getDouble("speed")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,19 +37,10 @@ public record EntityGoalMoveTowardsTarget(
return null; return null;
} }
try {
return new EntityGoalMoveTowardsTarget( return new EntityGoalMoveTowardsTarget(
config.getDouble("speed"), config.getDouble("speed"),
config.getDouble("maxDistance") config.getDouble("maxDistance")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalOpenDoors(
return null; return null;
} }
try {
return new EntityGoalOpenDoors( return new EntityGoalOpenDoors(
config.getBool("delayClosing") config.getBool("delayClosing")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalPanic(
return null; return null;
} }
try {
return new EntityGoalPanic( return new EntityGoalPanic(
config.getDouble("speed") config.getDouble("speed")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -40,20 +40,11 @@ public record EntityGoalRandomStroll(
return null; return null;
} }
try {
return new EntityGoalRandomStroll( return new EntityGoalRandomStroll(
config.getDouble("speed"), config.getDouble("speed"),
config.getInt("interval"), config.getInt("interval"),
config.getBool("canDespawn") config.getBool("canDespawn")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,19 +37,10 @@ public record EntityGoalRandomSwimming(
return null; return null;
} }
try {
return new EntityGoalRandomSwimming( return new EntityGoalRandomSwimming(
config.getDouble("speed"), config.getDouble("speed"),
config.getInt("interval") config.getInt("interval")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -45,21 +45,12 @@ public record EntityGoalRangedAttack(
return null; return null;
} }
try {
return new EntityGoalRangedAttack( return new EntityGoalRangedAttack(
config.getDouble("speed"), config.getDouble("speed"),
config.getInt("minInterval"), config.getInt("minInterval"),
config.getInt("maxInterval"), config.getInt("maxInterval"),
config.getDouble("range") config.getDouble("range")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -42,20 +42,11 @@ public record EntityGoalRangedBowAttack(
return null; return null;
} }
try {
return new EntityGoalRangedBowAttack( return new EntityGoalRangedBowAttack(
config.getDouble("speed"), config.getDouble("speed"),
config.getInt("interval"), config.getInt("interval"),
config.getDouble("range") config.getDouble("range")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -39,19 +39,10 @@ public record EntityGoalRangedCrossbowAttack(
return null; return null;
} }
try {
return new EntityGoalRangedCrossbowAttack( return new EntityGoalRangedCrossbowAttack(
config.getDouble("speed"), config.getDouble("speed"),
config.getDouble("range") config.getDouble("range")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalStrollThroughVillage(
return null; return null;
} }
try {
return new EntityGoalStrollThroughVillage( return new EntityGoalStrollThroughVillage(
config.getInt("searchRange") config.getInt("searchRange")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -58,7 +58,6 @@ public record EntityGoalTempt(
return null; return null;
} }
try {
Collection<TestableItem> items = config.getStrings("items").stream() Collection<TestableItem> items = config.getStrings("items").stream()
.map(Items::lookup) .map(Items::lookup)
.filter(it -> !(it instanceof EmptyTestableItem)) .filter(it -> !(it instanceof EmptyTestableItem))
@@ -69,14 +68,6 @@ public record EntityGoalTempt(
items, items,
config.getBool("canBeScared") config.getBool("canBeScared")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -48,7 +48,6 @@ public record EntityGoalUseItem(
return null; return null;
} }
try {
TestableEntity filter = Entities.lookup(config.getString("condition")); TestableEntity filter = Entities.lookup(config.getString("condition"));
return new EntityGoalUseItem( return new EntityGoalUseItem(
@@ -56,14 +55,6 @@ public record EntityGoalUseItem(
Sound.valueOf(config.getString("sound").toUpperCase()), Sound.valueOf(config.getString("sound").toUpperCase()),
filter::matches filter::matches
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalWaterAvoidingRandomFlying(
return null; return null;
} }
try {
return new EntityGoalWaterAvoidingRandomFlying( return new EntityGoalWaterAvoidingRandomFlying(
config.getDouble("speed") config.getDouble("speed")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,19 +37,10 @@ public record EntityGoalWaterAvoidingRandomStroll(
return null; return null;
} }
try {
return new EntityGoalWaterAvoidingRandomStroll( return new EntityGoalWaterAvoidingRandomStroll(
config.getDouble("speed"), config.getDouble("speed"),
config.getDouble("chance") config.getDouble("chance")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -34,18 +34,9 @@ public record EntityGoalWolfBeg(
return null; return null;
} }
try {
return new EntityGoalWolfBeg( return new EntityGoalWolfBeg(
config.getDouble("distance") config.getDouble("distance")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -37,18 +37,9 @@ public record TargetGoalHurtBy(
return null; return null;
} }
try {
return new TargetGoalHurtBy( return new TargetGoalHurtBy(
Entities.lookup(config.getString("blacklist")) Entities.lookup(config.getString("blacklist"))
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -63,7 +63,6 @@ public record TargetGoalNearestAttackable(
return null; return null;
} }
try {
if (config.has("targetFilter")) { if (config.has("targetFilter")) {
TestableEntity filter = Entities.lookup(config.getString("targetFilter")); TestableEntity filter = Entities.lookup(config.getString("targetFilter"));
@@ -82,14 +81,6 @@ public record TargetGoalNearestAttackable(
config.getInt("reciprocalChance") config.getInt("reciprocalChance")
); );
} }
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -63,7 +63,6 @@ public record TargetGoalNearestAttackableWitch(
return null; return null;
} }
try {
if (config.has("targetFilter")) { if (config.has("targetFilter")) {
TestableEntity filter = Entities.lookup(config.getString("targetFilter")); TestableEntity filter = Entities.lookup(config.getString("targetFilter"));
@@ -82,14 +81,6 @@ public record TargetGoalNearestAttackableWitch(
config.getInt("reciprocalChance") config.getInt("reciprocalChance")
); );
} }
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -53,7 +53,6 @@ public record TargetGoalNearestHealableRaider(
return null; return null;
} }
try {
if (config.has("targetFilter")) { if (config.has("targetFilter")) {
TestableEntity filter = Entities.lookup(config.getString("targetFilter")); TestableEntity filter = Entities.lookup(config.getString("targetFilter"));
@@ -68,14 +67,6 @@ public record TargetGoalNearestHealableRaider(
config.getBool("checkVisibility") config.getBool("checkVisibility")
); );
} }
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -53,7 +53,6 @@ public record TargetGoalNonTameRandom(
return null; return null;
} }
try {
if (config.has("targetFilter")) { if (config.has("targetFilter")) {
TestableEntity filter = Entities.lookup(config.getString("targetFilter")); TestableEntity filter = Entities.lookup(config.getString("targetFilter"));
@@ -68,14 +67,6 @@ public record TargetGoalNonTameRandom(
config.getBool("checkVisibility") config.getBool("checkVisibility")
); );
} }
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -36,18 +36,9 @@ public record TargetGoalResetUniversalAnger(
return null; return null;
} }
try {
return new TargetGoalResetUniversalAnger( return new TargetGoalResetUniversalAnger(
config.getBool("triggerOthers") config.getBool("triggerOthers")
); );
} catch (Exception e) {
/*
Exceptions could be caused by configs having values of a wrong type,
invalid enum parameters, etc. Serializers shouldn't throw exceptions,
so we encapsulate them as null.
*/
return null;
}
} }
@NotNull @NotNull

View File

@@ -1,5 +1,6 @@
package com.willfp.eco.core.events; package com.willfp.eco.core.events;
import com.willfp.eco.core.packet.PacketListener;
import org.bukkit.event.Listener; import org.bukkit.event.Listener;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@@ -25,4 +26,11 @@ public interface EventManager {
* Unregister all listeners associated with the plugin. * Unregister all listeners associated with the plugin.
*/ */
void unregisterAllListeners(); void unregisterAllListeners();
/**
* Register a packet listener.
*
* @param listener The listener.
*/
void registerPacketListener(@NotNull PacketListener listener);
} }

View File

@@ -139,7 +139,7 @@ public interface MenuBuilder extends PageBuilder {
* @return The builder. * @return The builder.
*/ */
default MenuBuilder maxPages(@NotNull final Function<Player, Integer> pages) { default MenuBuilder maxPages(@NotNull final Function<Player, Integer> pages) {
return onRender((player, menu) -> menu.setState(player, Page.MAX_PAGE_KEY, pages.apply(player))); return this.onRender((player, menu) -> menu.setState(player, Page.MAX_PAGE_KEY, pages.apply(player)));
} }
/** /**

View File

@@ -1,12 +1,14 @@
package com.willfp.eco.core.gui.slot; package com.willfp.eco.core.gui.slot;
import com.willfp.eco.core.config.interfaces.Config; import com.willfp.eco.core.config.interfaces.Config;
import com.willfp.eco.core.fast.FastItemStack;
import com.willfp.eco.core.gui.slot.functional.SlotHandler; import com.willfp.eco.core.gui.slot.functional.SlotHandler;
import com.willfp.eco.core.items.Items; import com.willfp.eco.core.items.Items;
import com.willfp.eco.util.StringUtils; import com.willfp.eco.util.StringUtils;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.event.inventory.ClickType; import org.bukkit.event.inventory.ClickType;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import java.util.ArrayList; import java.util.ArrayList;
@@ -37,7 +39,25 @@ public class ConfigSlot extends CustomSlot {
public ConfigSlot(@NotNull final Config config) { public ConfigSlot(@NotNull final Config config) {
this.config = config; this.config = config;
SlotBuilder builder = Slot.builder(Items.lookup(config.getString("item"))); ItemStack item = Items.lookup(config.getString("item")).getItem();
SlotBuilder builder = Slot.builder((player, menu) -> {
if (!config.has("lore")) {
return item;
} else {
FastItemStack fast = FastItemStack.wrap(item.clone());
List<String> newLore = new ArrayList<>(fast.getLore());
newLore.addAll(
StringUtils.formatList(
config.getStrings("lore"),
player,
StringUtils.FormatOption.WITH_PLACEHOLDERS
)
);
fast.setLore(newLore);
return fast.unwrap();
}
});
for (ClickType clickType : ClickType.values()) { for (ClickType clickType : ClickType.values()) {
builder.onClick( builder.onClick(

View File

@@ -4,6 +4,7 @@ import com.willfp.eco.core.gui.menu.Menu;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** /**
* Base class for custom slot implementations. * Base class for custom slot implementations.
@@ -31,7 +32,7 @@ public abstract class CustomSlot implements Slot {
} }
@Override @Override
public @NotNull ItemStack getItemStack(@NotNull final Player player) { public final @NotNull ItemStack getItemStack(@NotNull final Player player) {
if (delegate == null) { if (delegate == null) {
throw new IllegalStateException("Custom Slot was not initialized!"); throw new IllegalStateException("Custom Slot was not initialized!");
} }
@@ -40,7 +41,7 @@ public abstract class CustomSlot implements Slot {
} }
@Override @Override
public boolean isCaptive(@NotNull final Player player, public final boolean isCaptive(@NotNull final Player player,
@NotNull final Menu menu) { @NotNull final Menu menu) {
if (delegate == null) { if (delegate == null) {
throw new IllegalStateException("Custom Slot was not initialized!"); throw new IllegalStateException("Custom Slot was not initialized!");
@@ -50,7 +51,18 @@ public abstract class CustomSlot implements Slot {
} }
@Override @Override
public boolean isCaptiveFromEmpty() { public final boolean isAllowedCaptive(@NotNull final Player player,
@NotNull final Menu menu,
@Nullable final ItemStack itemStack) {
if (delegate == null) {
throw new IllegalStateException("Custom Slot was not initialized!");
}
return delegate.isAllowedCaptive(player, menu, itemStack);
}
@Override
public final boolean isCaptiveFromEmpty() {
if (delegate == null) { if (delegate == null) {
throw new IllegalStateException("Custom Slot was not initialized!"); throw new IllegalStateException("Custom Slot was not initialized!");
} }
@@ -59,7 +71,7 @@ public abstract class CustomSlot implements Slot {
} }
@Override @Override
public final Slot getActionableSlot(@NotNull final Player player, public final @NotNull Slot getActionableSlot(@NotNull final Player player,
@NotNull final Menu menu) { @NotNull final Menu menu) {
return delegate; return delegate;
} }

View File

@@ -5,6 +5,7 @@ import org.bukkit.Material;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** /**
* Base class for custom slot implementations. * Base class for custom slot implementations.
@@ -34,11 +35,18 @@ public abstract class ReactiveSlot implements Slot {
} }
@Override @Override
public boolean isCaptive(@NotNull final Player player, public final boolean isCaptive(@NotNull final Player player,
@NotNull final Menu menu) { @NotNull final Menu menu) {
return getSlot(player, menu).isCaptive(player, menu); return getSlot(player, menu).isCaptive(player, menu);
} }
@Override
public final boolean isAllowedCaptive(@NotNull final Player player,
@NotNull final Menu menu,
@Nullable final ItemStack itemStack) {
return getSlot(player, menu).isAllowedCaptive(player, menu, itemStack);
}
@Override @Override
public final @NotNull Slot getActionableSlot(@NotNull final Player player, public final @NotNull Slot getActionableSlot(@NotNull final Player player,
@NotNull final Menu menu) { @NotNull final Menu menu) {

View File

@@ -9,6 +9,7 @@ import org.bukkit.Material;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.function.Function; import java.util.function.Function;
@@ -45,6 +46,20 @@ public interface Slot extends GUIComponent {
return false; return false;
} }
/**
* If the slot allows a certain item to be placed in it.
*
* @param player The player.
* @param menu The menu.
* @param itemStack The item; use null if the item is unknown.
* @return If captive.
*/
default boolean isAllowedCaptive(@NotNull final Player player,
@NotNull final Menu menu,
@Nullable final ItemStack itemStack) {
return this.isCaptive(player, menu);
}
/** /**
* Get the actionable slot to be shown. * Get the actionable slot to be shown.
* <p> * <p>

View File

@@ -1,5 +1,6 @@
package com.willfp.eco.core.gui.slot; package com.willfp.eco.core.gui.slot;
import com.willfp.eco.core.gui.slot.functional.CaptiveFilter;
import com.willfp.eco.core.gui.slot.functional.SlotHandler; import com.willfp.eco.core.gui.slot.functional.SlotHandler;
import com.willfp.eco.core.gui.slot.functional.SlotModifier; import com.willfp.eco.core.gui.slot.functional.SlotModifier;
import com.willfp.eco.core.gui.slot.functional.SlotUpdater; import com.willfp.eco.core.gui.slot.functional.SlotUpdater;
@@ -143,7 +144,17 @@ public interface SlotBuilder {
* @param predicate The predicate. Returns true when the slot should not be captive. * @param predicate The predicate. Returns true when the slot should not be captive.
* @return The builder. * @return The builder.
*/ */
SlotBuilder notCaptiveFor(@NotNull Predicate<Player> predicate); SlotBuilder notCaptiveFor(@NotNull final Predicate<Player> predicate);
/**
* Set a whitelist for allowed captive items.
*
* @param filter The filter.
* @return The builder.
*/
default SlotBuilder setCaptiveFilter(@NotNull final CaptiveFilter filter) {
return this;
}
/** /**
* Set the ItemStack updater. * Set the ItemStack updater.

View File

@@ -0,0 +1,25 @@
package com.willfp.eco.core.gui.slot.functional;
import com.willfp.eco.core.gui.menu.Menu;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Interface to test if a captive slot is allowed to contain an item given a player and a menu.
*/
@FunctionalInterface
public interface CaptiveFilter {
/**
* Get if allowed.
*
* @param player The player.
* @param menu The menu.
* @param itemStack The item.
* @return If captive.
*/
boolean isAllowed(@NotNull Player player,
@NotNull Menu menu,
@Nullable ItemStack itemStack);
}

View File

@@ -0,0 +1,18 @@
package com.willfp.eco.core.integrations.guidetection;
import com.willfp.eco.core.integrations.Integration;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
/**
* Wrapper class for GUI integrations.
*/
public interface GUIDetectionIntegration extends Integration {
/**
* Determine if a player is in a GUI.
*
* @param player The player.
* @return If the player is in a GUI.
*/
boolean hasGUIOpen(@NotNull final Player player);
}

View File

@@ -0,0 +1,52 @@
package com.willfp.eco.core.integrations.guidetection;
import com.willfp.eco.util.MenuUtils;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import java.util.HashSet;
import java.util.Set;
/**
* Class to handle GUI detection.
*/
public final class GUIDetectionManager {
/**
* A set of all registered integrations.
*/
private static final Set<GUIDetectionIntegration> REGISTERED = new HashSet<>();
/**
* Register a new integration.
*
* @param integration The integration to register.
*/
public static void register(@NotNull final GUIDetectionIntegration integration) {
REGISTERED.removeIf(it -> it.getPluginName().equalsIgnoreCase(integration.getPluginName()));
REGISTERED.add(integration);
}
/**
* Get if a player is in a GUI.
*
* @param player The player.
* @return If the player has a GUI open.
*/
public static boolean hasGUIOpen(@NotNull final Player player) {
if (MenuUtils.getOpenMenu(player) != null) {
return true;
}
for (GUIDetectionIntegration integration : REGISTERED) {
if (integration.hasGUIOpen(player)) {
return true;
}
}
return false;
}
private GUIDetectionManager() {
throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
}
}

View File

@@ -33,10 +33,15 @@ public final class McmmoManager {
* @return The bonus drop count. * @return The bonus drop count.
*/ */
public static int getBonusDropCount(@NotNull final Block block) { public static int getBonusDropCount(@NotNull final Block block) {
int finalValue = 0;
for (McmmoIntegration mcmmoIntegration : REGISTERED) { for (McmmoIntegration mcmmoIntegration : REGISTERED) {
return mcmmoIntegration.getBonusDropCount(block); finalValue += mcmmoIntegration.getBonusDropCount(block);
} }
return 0; return finalValue;
} }
/** /**
@@ -47,7 +52,10 @@ public final class McmmoManager {
*/ */
public static boolean isFake(@NotNull final Event event) { public static boolean isFake(@NotNull final Event event) {
for (McmmoIntegration mcmmoIntegration : REGISTERED) { for (McmmoIntegration mcmmoIntegration : REGISTERED) {
return mcmmoIntegration.isFake(event); if (mcmmoIntegration.isFake(event)) {
return true;
}
} }
return false; return false;
} }

View File

@@ -1,13 +1,16 @@
package com.willfp.eco.core.integrations.placeholder; package com.willfp.eco.core.integrations.placeholder;
import com.github.benmanes.caffeine.cache.Cache;
import com.github.benmanes.caffeine.cache.Caffeine; import com.github.benmanes.caffeine.cache.Caffeine;
import com.github.benmanes.caffeine.cache.LoadingCache; import com.github.benmanes.caffeine.cache.LoadingCache;
import com.willfp.eco.core.Eco; import com.willfp.eco.core.Eco;
import com.willfp.eco.core.EcoPlugin; import com.willfp.eco.core.EcoPlugin;
import com.willfp.eco.core.placeholder.AdditionalPlayer; import com.willfp.eco.core.placeholder.AdditionalPlayer;
import com.willfp.eco.core.placeholder.DynamicPlaceholder;
import com.willfp.eco.core.placeholder.InjectablePlaceholder; import com.willfp.eco.core.placeholder.InjectablePlaceholder;
import com.willfp.eco.core.placeholder.Placeholder; import com.willfp.eco.core.placeholder.Placeholder;
import com.willfp.eco.core.placeholder.PlaceholderInjectable; import com.willfp.eco.core.placeholder.PlaceholderInjectable;
import com.willfp.eco.core.placeholder.PlayerDynamicPlaceholder;
import com.willfp.eco.core.placeholder.PlayerPlaceholder; import com.willfp.eco.core.placeholder.PlayerPlaceholder;
import com.willfp.eco.core.placeholder.PlayerStaticPlaceholder; import com.willfp.eco.core.placeholder.PlayerStaticPlaceholder;
import com.willfp.eco.core.placeholder.PlayerlessPlaceholder; import com.willfp.eco.core.placeholder.PlayerlessPlaceholder;
@@ -24,6 +27,7 @@ import java.util.HashMap;
import java.util.HashSet; import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Optional;
import java.util.Set; import java.util.Set;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher; import java.util.regex.Matcher;
@@ -37,13 +41,20 @@ public final class PlaceholderManager {
/** /**
* All registered placeholders. * All registered placeholders.
*/ */
private static final Map<EcoPlugin, Map<String, Placeholder>> REGISTERED_PLACEHOLDERS = new HashMap<>(); private static final Map<EcoPlugin, Map<Pattern, Placeholder>> REGISTERED_PLACEHOLDERS = new HashMap<>();
/** /**
* All registered placeholder integrations. * All registered placeholder integrations.
*/ */
private static final Set<PlaceholderIntegration> REGISTERED_INTEGRATIONS = new HashSet<>(); private static final Set<PlaceholderIntegration> REGISTERED_INTEGRATIONS = new HashSet<>();
/**
* Placeholder Lookup Cache.
*/
private static final Cache<PlaceholderLookup, Optional<Placeholder>> PLACEHOLDER_LOOKUP_CACHE = Caffeine.newBuilder()
.expireAfterWrite(1, TimeUnit.SECONDS)
.build();
/** /**
* Placeholder Cache. * Placeholder Cache.
*/ */
@@ -51,10 +62,17 @@ public final class PlaceholderManager {
.expireAfterWrite(50, TimeUnit.MILLISECONDS) .expireAfterWrite(50, TimeUnit.MILLISECONDS)
.build(key -> key.entry.getValue(key.player)); .build(key -> key.entry.getValue(key.player));
/**
* Dynamic Placeholder Cache.
*/
private static final LoadingCache<DynamicEntryWithPlayer, String> DYNAMIC_PLACEHOLDER_CACHE = Caffeine.newBuilder()
.expireAfterWrite(50, TimeUnit.MILLISECONDS)
.build(key -> key.entry.getValue(key.args, key.player));
/** /**
* The default PlaceholderAPI pattern; brought in for compatibility. * The default PlaceholderAPI pattern; brought in for compatibility.
*/ */
private static final Pattern PATTERN = Pattern.compile("[%]([^% ]+)[%]"); private static final Pattern PATTERN = Pattern.compile("%([^% ]+)%");
/** /**
* Empty injectable object. * Empty injectable object.
@@ -88,14 +106,17 @@ public final class PlaceholderManager {
* @param placeholder The placeholder to register. * @param placeholder The placeholder to register.
*/ */
public static void registerPlaceholder(@NotNull final Placeholder placeholder) { public static void registerPlaceholder(@NotNull final Placeholder placeholder) {
if (placeholder instanceof StaticPlaceholder) { if (placeholder instanceof StaticPlaceholder || placeholder instanceof PlayerStaticPlaceholder) {
throw new IllegalArgumentException("Static placeholders cannot be registered!"); throw new IllegalArgumentException("Static placeholders cannot be registered!");
} }
EcoPlugin plugin = placeholder.getPlugin() == null ? Eco.get().getEcoPlugin() : placeholder.getPlugin(); EcoPlugin plugin = placeholder.getPlugin() == null ? Eco.get().getEcoPlugin() : placeholder.getPlugin();
Map<String, Placeholder> pluginPlaceholders = REGISTERED_PLACEHOLDERS
Map<Pattern, Placeholder> pluginPlaceholders = REGISTERED_PLACEHOLDERS
.getOrDefault(plugin, new HashMap<>()); .getOrDefault(plugin, new HashMap<>());
pluginPlaceholders.put(placeholder.getIdentifier(), placeholder);
pluginPlaceholders.put(placeholder.getPattern(), placeholder);
REGISTERED_PLACEHOLDERS.put(plugin, pluginPlaceholders); REGISTERED_PLACEHOLDERS.put(plugin, pluginPlaceholders);
} }
@@ -136,21 +157,47 @@ public final class PlaceholderManager {
public static String getResult(@Nullable final Player player, public static String getResult(@Nullable final Player player,
@NotNull final String identifier, @NotNull final String identifier,
@Nullable final EcoPlugin plugin) { @Nullable final EcoPlugin plugin) {
// This is really janky, and it sucks, but it works so?
// Compensating for regex being slow so that's why we get it.
Placeholder placeholder = PLACEHOLDER_LOOKUP_CACHE.get(
new PlaceholderLookup(identifier, plugin),
(it) -> {
EcoPlugin owner = plugin == null ? Eco.get().getEcoPlugin() : plugin; EcoPlugin owner = plugin == null ? Eco.get().getEcoPlugin() : plugin;
Placeholder placeholder = REGISTERED_PLACEHOLDERS.getOrDefault(owner, new HashMap<>()).get(identifier.toLowerCase());
if (placeholder == null && plugin != null) { // I hate the streams API.
Placeholder alternate = REGISTERED_PLACEHOLDERS.getOrDefault(Eco.get().getEcoPlugin(), new HashMap<>()) Optional<Placeholder> found = REGISTERED_PLACEHOLDERS
.get(identifier.toLowerCase()); .getOrDefault(owner, new HashMap<>())
if (alternate != null) { .entrySet()
placeholder = alternate; .stream().filter(entry -> entry.getKey().matcher(identifier).matches())
.map(Map.Entry::getValue)
.findFirst();
if (found.isEmpty() && plugin != null) {
// Here we go again! Something about legacy support? I don't remember.
// I won't touch it though, I'm scared of the placeholder system.
found = REGISTERED_PLACEHOLDERS
.getOrDefault(Eco.get().getEcoPlugin(), new HashMap<>())
.entrySet()
.stream().filter(entry -> entry.getKey().matcher(identifier).matches())
.map(Map.Entry::getValue)
.findFirst();
} }
return found;
} }
).orElse(null);
if (placeholder == null) { if (placeholder == null) {
return ""; return "";
} }
/*
This code here is *really* not very good. It's mega externalized logic hacked
together and made worse by the addition of dynamic placeholders. But it works,
and it means I don't have to rewrite the whole placeholder system. So it's
good enough for me.
*/
if (placeholder instanceof PlayerPlaceholder playerPlaceholder) { if (placeholder instanceof PlayerPlaceholder playerPlaceholder) {
if (player == null) { if (player == null) {
return ""; return "";
@@ -159,6 +206,14 @@ public final class PlaceholderManager {
} }
} else if (placeholder instanceof PlayerlessPlaceholder playerlessPlaceholder) { } else if (placeholder instanceof PlayerlessPlaceholder playerlessPlaceholder) {
return playerlessPlaceholder.getValue(); return playerlessPlaceholder.getValue();
} else if (placeholder instanceof PlayerDynamicPlaceholder playerDynamicPlaceholder) {
if (player == null) {
return "";
} else {
return DYNAMIC_PLACEHOLDER_CACHE.get(new DynamicEntryWithPlayer(playerDynamicPlaceholder, identifier, player));
}
} else if (placeholder instanceof DynamicPlaceholder dynamicPlaceholder) {
return dynamicPlaceholder.getValue(identifier);
} else { } else {
return ""; return "";
} }
@@ -245,8 +300,10 @@ public final class PlaceholderManager {
for (PlaceholderIntegration integration : REGISTERED_INTEGRATIONS) { for (PlaceholderIntegration integration : REGISTERED_INTEGRATIONS) {
processed = integration.translate(processed, player); processed = integration.translate(processed, player);
} }
for (InjectablePlaceholder injection : context.getPlaceholderInjections()) { for (InjectablePlaceholder injection : context.getPlaceholderInjections()) {
// Do I know this is a bad way of doing this? Yes. // Do I know this is a bad way of doing this? Yes.
// I know it's deprecated, but it's fast.
if (injection instanceof StaticPlaceholder placeholder) { if (injection instanceof StaticPlaceholder placeholder) {
processed = processed.replace("%" + placeholder.getIdentifier() + "%", placeholder.getValue()); processed = processed.replace("%" + placeholder.getIdentifier() + "%", placeholder.getValue());
} else if (injection instanceof PlayerStaticPlaceholder placeholder && player != null) { } else if (injection instanceof PlayerStaticPlaceholder placeholder && player != null) {
@@ -280,11 +337,22 @@ public final class PlaceholderManager {
return new ArrayList<>(found); return new ArrayList<>(found);
} }
private record PlaceholderLookup(@NotNull String identifier,
@Nullable EcoPlugin plugin) {
}
private record EntryWithPlayer(@NotNull PlayerPlaceholder entry, private record EntryWithPlayer(@NotNull PlayerPlaceholder entry,
@NotNull Player player) { @NotNull Player player) {
} }
private record DynamicEntryWithPlayer(@NotNull PlayerDynamicPlaceholder entry,
@NotNull String args,
@NotNull Player player) {
}
private PlaceholderManager() { private PlaceholderManager() {
throw new UnsupportedOperationException("This is a utility class and cannot be instantiated"); throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
} }

View File

@@ -1,6 +1,8 @@
package com.willfp.eco.core.integrations.shop; package com.willfp.eco.core.integrations.shop;
import com.willfp.eco.core.integrations.Integration; import com.willfp.eco.core.integrations.Integration;
import com.willfp.eco.core.price.Price;
import com.willfp.eco.core.price.impl.PriceFree;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.event.Listener; import org.bukkit.event.Listener;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
@@ -29,12 +31,41 @@ public interface ShopIntegration extends Integration {
return null; return null;
} }
/**
* Get if an item is sellable for a player.
*
* @param itemStack The item.
* @param player The player.
* @return If sellable.
*/
default boolean isSellable(@NotNull final ItemStack itemStack,
@NotNull final Player player) {
return false;
}
/**
* Get the value of one of an item for a player.
* <p>
* For example, if you pass in a stack, it will only return the value of <b>one</b> item, not the full stack.
*
* @param itemStack The item.
* @param player The player.
* @return The price.
*/
@NotNull
default Price getUnitValue(@NotNull final ItemStack itemStack,
@NotNull final Player player) {
return new PriceFree();
}
/** /**
* Get the price of an item. * Get the price of an item.
* *
* @param itemStack The item. * @param itemStack The item.
* @return The price. * @return The price.
* @deprecated Use getValue instead.
*/ */
@Deprecated(since = "6.47.0", forRemoval = true)
default double getPrice(@NotNull final ItemStack itemStack) { default double getPrice(@NotNull final ItemStack itemStack) {
// Do nothing unless overridden. // Do nothing unless overridden.
return 0.0; return 0.0;
@@ -46,9 +77,11 @@ public interface ShopIntegration extends Integration {
* @param itemStack The item. * @param itemStack The item.
* @param player The player. * @param player The player.
* @return The price. * @return The price.
* @deprecated Use getValue instead.
*/ */
@Deprecated(since = "6.47.0", forRemoval = true)
default double getPrice(@NotNull final ItemStack itemStack, default double getPrice(@NotNull final ItemStack itemStack,
@NotNull final Player player) { @NotNull final Player player) {
return getPrice(itemStack); return getUnitValue(itemStack, player).getValue(player);
} }
} }

View File

@@ -1,5 +1,7 @@
package com.willfp.eco.core.integrations.shop; package com.willfp.eco.core.integrations.shop;
import com.willfp.eco.core.price.Price;
import com.willfp.eco.core.price.impl.PriceFree;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@@ -36,12 +38,57 @@ public final class ShopManager {
} }
} }
/**
* Get if an item is sellable for a player.
*
* @param itemStack The item.
* @param player The player.
* @return If sellable.
*/
public static boolean isSellable(@Nullable final ItemStack itemStack,
@NotNull final Player player) {
if (itemStack == null) {
return false;
}
for (ShopIntegration integration : REGISTERED) {
return integration.isSellable(itemStack, player);
}
return false;
}
/**
* Get the value of one of an item for a player.
* <p>
* For example, if you pass in a stack, it will only return the value of <b>one</b> item, not the full stack.
*
* @param itemStack The item.
* @param player The player.
* @return The price.
*/
@NotNull
public static Price getUnitValue(@Nullable final ItemStack itemStack,
@NotNull final Player player) {
if (itemStack == null) {
return new PriceFree();
}
for (ShopIntegration integration : REGISTERED) {
return integration.getUnitValue(itemStack, player);
}
return new PriceFree();
}
/** /**
* Get the price of an item. * Get the price of an item.
* *
* @param itemStack The item. * @param itemStack The item.
* @return The price. * @return The price.
* @deprecated Use getValue instead. This will always return 0 as prices depend on players.
*/ */
@Deprecated(since = "6.47.0", forRemoval = true)
public static double getItemPrice(@Nullable final ItemStack itemStack) { public static double getItemPrice(@Nullable final ItemStack itemStack) {
return getItemPrice(itemStack, null); return getItemPrice(itemStack, null);
} }
@@ -52,19 +99,17 @@ public final class ShopManager {
* @param itemStack The item. * @param itemStack The item.
* @param player The player. * @param player The player.
* @return The price. * @return The price.
* @deprecated Use getValue instead. Null players / null items will always return 0.
*/ */
@Deprecated(since = "6.47.0", forRemoval = true)
public static double getItemPrice(@Nullable final ItemStack itemStack, public static double getItemPrice(@Nullable final ItemStack itemStack,
@Nullable final Player player) { @Nullable final Player player) {
if (itemStack == null) { if (itemStack == null || player == null) {
return 0.0; return 0.0;
} }
for (ShopIntegration shopIntegration : REGISTERED) { for (ShopIntegration shopIntegration : REGISTERED) {
if (player == null) { return shopIntegration.getUnitValue(itemStack, player).getValue(player, itemStack.getAmount());
return shopIntegration.getPrice(itemStack);
} else {
return shopIntegration.getPrice(itemStack, player);
}
} }
return 0.0; return 0.0;

View File

@@ -1,5 +1,7 @@
package com.willfp.eco.core.integrations.shop; package com.willfp.eco.core.integrations.shop;
import com.willfp.eco.core.price.Price;
import com.willfp.eco.core.price.impl.PriceEconomy;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList; import org.bukkit.event.HandlerList;
import org.bukkit.event.player.PlayerEvent; import org.bukkit.event.player.PlayerEvent;
@@ -19,7 +21,12 @@ public class ShopSellEvent extends PlayerEvent {
/** /**
* The sell price. * The sell price.
*/ */
private double price; private Price price;
/**
* The price multiplier.
*/
private double multiplier;
/** /**
* The item to be sold. * The item to be sold.
@@ -33,31 +40,64 @@ public class ShopSellEvent extends PlayerEvent {
* @param who The player. * @param who The player.
* @param price The price. * @param price The price.
* @param item The item. * @param item The item.
* @deprecated Use the price system instead.
*/ */
@Deprecated(since = "6.47.0", forRemoval = true)
public ShopSellEvent(@NotNull final Player who, public ShopSellEvent(@NotNull final Player who,
final double price, final double price,
@Nullable final ItemStack item) { @Nullable final ItemStack item) {
this(who, new PriceEconomy(price), item);
}
/**
* Create new shop sell event.
*
* @param who The player.
* @param price The price.
* @param item The item.
*/
public ShopSellEvent(@NotNull final Player who,
@NotNull final Price price,
@Nullable final ItemStack item) {
this(who, price, item, 1.0);
}
/**
* Create new shop sell event.
*
* @param who The player.
* @param price The price.
* @param item The item.
* @param multiplier The multiplier.
*/
public ShopSellEvent(@NotNull final Player who,
@NotNull final Price price,
@Nullable final ItemStack item,
final double multiplier) {
super(who); super(who);
this.price = price; this.price = price;
this.item = item; this.item = item;
this.multiplier = multiplier;
} }
/** /**
* Get the price. * Get the value.
* *
* @return The price. * @return The value.
*/ */
public double getPrice() { @NotNull
public Price getValue() {
return this.price; return this.price;
} }
/** /**
* Set the price. * Set the value.
* *
* @param price The price. * @param price The value.
*/ */
public void setPrice(final double price) { public void setValue(@NotNull final Price price) {
this.price = price; this.price = price;
} }
@@ -81,6 +121,46 @@ public class ShopSellEvent extends PlayerEvent {
return item != null; return item != null;
} }
/**
* Get the price multiplier.
*
* @return The multiplier.
*/
public double getMultiplier() {
return multiplier;
}
/**
* Set the price multiplier.
*
* @param multiplier The multiplier.
*/
public void setMultiplier(final double multiplier) {
this.multiplier = multiplier;
}
/**
* Get the price.
*
* @return The price.
* @deprecated Use the price system instead.
*/
@Deprecated(since = "6.47.0", forRemoval = true)
public double getPrice() {
return this.getValue().getValue(player);
}
/**
* Set the price.
*
* @param price The price.
* @deprecated Use the price system instead.
*/
@Deprecated(since = "6.47.0", forRemoval = true)
public void setPrice(final double price) {
this.setValue(new PriceEconomy(price));
}
/** /**
* Bukkit parity. * Bukkit parity.
* *

View File

@@ -70,7 +70,7 @@ public abstract class AbstractItemStackBuilder<T extends ItemMeta, U extends Abs
@Override @Override
public U setAmount(final int amount) { public U setAmount(final int amount) {
Validate.isTrue(amount >= 1 && amount <= base.getMaxStackSize()); Validate.isTrue(amount >= 1);
base.setAmount(amount); base.setAmount(amount);
return (U) this; return (U) this;
} }

View File

@@ -0,0 +1,21 @@
package com.willfp.eco.core.packet;
import com.willfp.eco.core.Eco;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
/**
* Represents a packet.
*
* @param handle The NMS handle.
*/
public record Packet(@NotNull Object handle) {
/**
* Send to a player.
*
* @param player The player.
*/
void send(@NotNull final Player player) {
Eco.get().sendPacket(player, this);
}
}

View File

@@ -0,0 +1,67 @@
package com.willfp.eco.core.packet;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.jetbrains.annotations.NotNull;
/**
* Represents a packet being sent or received.
*/
public class PacketEvent implements Cancellable {
/**
* The packet.
*/
private final Packet packet;
/**
* The player.
*/
private final Player player;
/**
* If the event should be cancelled.
*/
private boolean cancelled = false;
/**
* Create a new packet event.
*
* @param packet The packet.
* @param player The player.
*/
public PacketEvent(@NotNull final Packet packet,
@NotNull final Player player) {
this.packet = packet;
this.player = player;
}
/**
* Get the packet.
*
* @return The packet.
*/
@NotNull
public Packet getPacket() {
return packet;
}
/**
* Get the player.
*
* @return The player.
*/
@NotNull
public Player getPlayer() {
return player;
}
@Override
public boolean isCancelled() {
return cancelled;
}
@Override
public void setCancelled(final boolean cancelled) {
this.cancelled = cancelled;
}
}

View File

@@ -0,0 +1,35 @@
package com.willfp.eco.core.packet;
import org.jetbrains.annotations.NotNull;
/**
* Listens to packets.
*/
public interface PacketListener {
/**
* Called when a handle is sent.
*
* @param event The event.
*/
default void onSend(@NotNull final PacketEvent event) {
// Override when needed.
}
/**
* Called when a handle is received.
*
* @param event The event.
*/
default void onReceive(@NotNull final PacketEvent event) {
// Override when needed.
}
/**
* Get the priority of the listener.
*
* @return The priority.
*/
default PacketPriority getPriority() {
return PacketPriority.NORMAL;
}
}

View File

@@ -0,0 +1,31 @@
package com.willfp.eco.core.packet;
/**
* The priority (order) of packet listeners.
*/
public enum PacketPriority {
/**
* Ran first.
*/
LOWEST,
/**
* Ran second.
*/
LOW,
/**
* Ran third.
*/
NORMAL,
/**
* Ran fourth.
*/
HIGH,
/**
* Ran last.
*/
HIGHEST
}

View File

@@ -0,0 +1,102 @@
package com.willfp.eco.core.placeholder;
import com.willfp.eco.core.EcoPlugin;
import com.willfp.eco.core.integrations.placeholder.PlaceholderManager;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Objects;
import java.util.function.Function;
import java.util.regex.Pattern;
/**
* A placeholder that does not require a player and supports dynamic styles.
*/
public final class DynamicPlaceholder implements Placeholder {
/**
* The placeholder pattern.
*/
private final Pattern pattern;
/**
* The function to retrieve the output of the placeholder.
*/
private final Function<String, String> function;
/**
* The plugin for the placeholder.
*/
private final EcoPlugin plugin;
/**
* Create a new dynamic placeholder.
*
* @param plugin The plugin.
* @param pattern The pattern.
* @param function The function to retrieve the value.
*/
public DynamicPlaceholder(@NotNull final EcoPlugin plugin,
@NotNull final Pattern pattern,
@NotNull final Function<String, String> function) {
this.plugin = plugin;
this.pattern = pattern;
this.function = function;
}
/**
* Get the value of the placeholder.
*
* @param args The args.
* @return The value.
*/
@NotNull
public String getValue(@NotNull final String args) {
return function.apply(args);
}
/**
* Register the placeholder.
*
* @return The placeholder.
*/
public DynamicPlaceholder register() {
PlaceholderManager.registerPlaceholder(this);
return this;
}
@Override
public @NotNull EcoPlugin getPlugin() {
return this.plugin;
}
@Override
@Deprecated
public @NotNull String getIdentifier() {
return "dynamic";
}
@NotNull
@Override
public Pattern getPattern() {
return this.pattern;
}
@Override
public boolean equals(@Nullable final Object o) {
if (this == o) {
return true;
}
if (!(o instanceof DynamicPlaceholder that)) {
return false;
}
return Objects.equals(this.getPattern(), that.getPattern())
&& Objects.equals(this.getPlugin(), that.getPlugin());
}
@Override
public int hashCode() {
return Objects.hash(this.getIdentifier(), this.getPlugin());
}
}

View File

@@ -2,13 +2,14 @@ package com.willfp.eco.core.placeholder;
import com.willfp.eco.core.Eco; import com.willfp.eco.core.Eco;
import com.willfp.eco.core.EcoPlugin; import com.willfp.eco.core.EcoPlugin;
import org.jetbrains.annotations.NotNull;
/** /**
* Placeholders that can be injected into {@link PlaceholderInjectable} objects. * Placeholders that can be injected into {@link PlaceholderInjectable} objects.
*/ */
public sealed interface InjectablePlaceholder extends Placeholder permits PlayerStaticPlaceholder, StaticPlaceholder { public sealed interface InjectablePlaceholder extends Placeholder permits PlayerStaticPlaceholder, StaticPlaceholder {
@Override @Override
default EcoPlugin getPlugin() { default @NotNull EcoPlugin getPlugin() {
return Eco.get().getEcoPlugin(); return Eco.get().getEcoPlugin();
} }
} }

View File

@@ -1,16 +1,22 @@
package com.willfp.eco.core.placeholder; package com.willfp.eco.core.placeholder;
import com.willfp.eco.core.EcoPlugin; import com.willfp.eco.core.EcoPlugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.regex.Pattern;
/** /**
* A placeholder represents a string that can hold a value. * A placeholder represents a string that can hold a value.
*/ */
public sealed interface Placeholder permits PlayerPlaceholder, PlayerlessPlaceholder, InjectablePlaceholder { public sealed interface Placeholder permits PlayerPlaceholder, PlayerlessPlaceholder,
DynamicPlaceholder, PlayerDynamicPlaceholder, InjectablePlaceholder {
/** /**
* Get the plugin that holds the placeholder. * Get the plugin that holds the placeholder.
* *
* @return The plugin. * @return The plugin.
*/ */
@Nullable
EcoPlugin getPlugin(); EcoPlugin getPlugin();
/** /**
@@ -18,5 +24,16 @@ public sealed interface Placeholder permits PlayerPlaceholder, PlayerlessPlaceho
* *
* @return The identifier. * @return The identifier.
*/ */
@NotNull
String getIdentifier(); String getIdentifier();
/**
* Get the pattern for the placeholder.
*
* @return The pattern.
*/
@NotNull
default Pattern getPattern() {
return Pattern.compile(this.getIdentifier());
}
} }

View File

@@ -0,0 +1,105 @@
package com.willfp.eco.core.placeholder;
import com.willfp.eco.core.EcoPlugin;
import com.willfp.eco.core.integrations.placeholder.PlaceholderManager;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Objects;
import java.util.function.BiFunction;
import java.util.regex.Pattern;
/**
* A placeholder that does not require a player and supports dynamic styles.
*/
public final class PlayerDynamicPlaceholder implements Placeholder {
/**
* The placeholder pattern.
*/
private final Pattern pattern;
/**
* The function to retrieve the output of the placeholder.
*/
private final BiFunction<String, Player, String> function;
/**
* The plugin for the placeholder.
*/
private final EcoPlugin plugin;
/**
* Create a new dynamic placeholder.
*
* @param plugin The plugin.
* @param pattern The pattern.
* @param function The function to retrieve the value.
*/
public PlayerDynamicPlaceholder(@NotNull final EcoPlugin plugin,
@NotNull final Pattern pattern,
@NotNull final BiFunction<String, Player, String> function) {
this.plugin = plugin;
this.pattern = pattern;
this.function = function;
}
/**
* Get the value of the placeholder.
*
* @param args The args.
* @param player The player.
* @return The value.
*/
@NotNull
public String getValue(@NotNull final String args,
@NotNull final Player player) {
return function.apply(args, player);
}
/**
* Register the placeholder.
*
* @return The placeholder.
*/
public PlayerDynamicPlaceholder register() {
PlaceholderManager.registerPlaceholder(this);
return this;
}
@Override
public @NotNull EcoPlugin getPlugin() {
return this.plugin;
}
@Override
@Deprecated
public @NotNull String getIdentifier() {
return "dynamic";
}
@NotNull
@Override
public Pattern getPattern() {
return this.pattern;
}
@Override
public boolean equals(@Nullable final Object o) {
if (this == o) {
return true;
}
if (!(o instanceof PlayerDynamicPlaceholder that)) {
return false;
}
return Objects.equals(this.getPattern(), that.getPattern())
&& Objects.equals(this.getPlugin(), that.getPlugin());
}
@Override
public int hashCode() {
return Objects.hash(this.getIdentifier(), this.getPlugin());
}
}

View File

@@ -8,6 +8,7 @@ import org.jetbrains.annotations.Nullable;
import java.util.Objects; import java.util.Objects;
import java.util.function.Function; import java.util.function.Function;
import java.util.regex.Pattern;
/** /**
* A placeholder that requires a player. * A placeholder that requires a player.
@@ -18,6 +19,11 @@ public final class PlayerPlaceholder implements Placeholder {
*/ */
private final String identifier; private final String identifier;
/**
* The placeholder pattern.
*/
private final Pattern pattern;
/** /**
* The function to retrieve the output of the placeholder given a player. * The function to retrieve the output of the placeholder given a player.
*/ */
@@ -40,6 +46,7 @@ public final class PlayerPlaceholder implements Placeholder {
@NotNull final Function<Player, String> function) { @NotNull final Function<Player, String> function) {
this.plugin = plugin; this.plugin = plugin;
this.identifier = identifier; this.identifier = identifier;
this.pattern = Pattern.compile(identifier);
this.function = function; this.function = function;
} }
@@ -49,6 +56,7 @@ public final class PlayerPlaceholder implements Placeholder {
* @param player The player. * @param player The player.
* @return The value. * @return The value.
*/ */
@NotNull
public String getValue(@NotNull final Player player) { public String getValue(@NotNull final Player player) {
return function.apply(player); return function.apply(player);
} }
@@ -64,15 +72,21 @@ public final class PlayerPlaceholder implements Placeholder {
} }
@Override @Override
public EcoPlugin getPlugin() { public @NotNull EcoPlugin getPlugin() {
return this.plugin; return this.plugin;
} }
@Override @Override
public String getIdentifier() { public @NotNull String getIdentifier() {
return this.identifier; return this.identifier;
} }
@NotNull
@Override
public Pattern getPattern() {
return this.pattern;
}
@Override @Override
public boolean equals(@Nullable final Object o) { public boolean equals(@Nullable final Object o) {
if (this == o) { if (this == o) {

View File

@@ -6,6 +6,7 @@ import org.jetbrains.annotations.Nullable;
import java.util.Objects; import java.util.Objects;
import java.util.function.Function; import java.util.function.Function;
import java.util.regex.Pattern;
/** /**
* A placeholder that cannot be registered, and exists purely in injection. * A placeholder that cannot be registered, and exists purely in injection.
@@ -16,6 +17,11 @@ public final class PlayerStaticPlaceholder implements InjectablePlaceholder {
*/ */
private final String identifier; private final String identifier;
/**
* The placeholder pattern.
*/
private final Pattern pattern;
/** /**
* The function to retrieve the output of the placeholder. * The function to retrieve the output of the placeholder.
*/ */
@@ -30,6 +36,7 @@ public final class PlayerStaticPlaceholder implements InjectablePlaceholder {
public PlayerStaticPlaceholder(@NotNull final String identifier, public PlayerStaticPlaceholder(@NotNull final String identifier,
@NotNull final Function<Player, String> function) { @NotNull final Function<Player, String> function) {
this.identifier = identifier; this.identifier = identifier;
this.pattern = Pattern.compile(identifier);
this.function = function; this.function = function;
} }
@@ -39,15 +46,22 @@ public final class PlayerStaticPlaceholder implements InjectablePlaceholder {
* @param player The player. * @param player The player.
* @return The value. * @return The value.
*/ */
@NotNull
public String getValue(@NotNull final Player player) { public String getValue(@NotNull final Player player) {
return function.apply(player); return function.apply(player);
} }
@Override @Override
public String getIdentifier() { public @NotNull String getIdentifier() {
return this.identifier; return this.identifier;
} }
@NotNull
@Override
public Pattern getPattern() {
return this.pattern;
}
@Override @Override
public boolean equals(@Nullable final Object o) { public boolean equals(@Nullable final Object o) {
if (this == o) { if (this == o) {

View File

@@ -7,16 +7,22 @@ import org.jetbrains.annotations.Nullable;
import java.util.Objects; import java.util.Objects;
import java.util.function.Supplier; import java.util.function.Supplier;
import java.util.regex.Pattern;
/** /**
* A placeholder that does not require a player. * A placeholder that does not require a player.
*/ */
public final class PlayerlessPlaceholder implements Placeholder { public final class PlayerlessPlaceholder implements Placeholder {
/** /**
* The name of the placeholder. * The placeholder identifier.
*/ */
private final String identifier; private final String identifier;
/**
* The placeholder pattern.
*/
private final Pattern pattern;
/** /**
* The function to retrieve the output of the placeholder. * The function to retrieve the output of the placeholder.
*/ */
@@ -39,6 +45,7 @@ public final class PlayerlessPlaceholder implements Placeholder {
@NotNull final Supplier<String> function) { @NotNull final Supplier<String> function) {
this.plugin = plugin; this.plugin = plugin;
this.identifier = identifier; this.identifier = identifier;
this.pattern = Pattern.compile(identifier);
this.function = function; this.function = function;
} }
@@ -62,15 +69,21 @@ public final class PlayerlessPlaceholder implements Placeholder {
} }
@Override @Override
public EcoPlugin getPlugin() { public @NotNull EcoPlugin getPlugin() {
return this.plugin; return this.plugin;
} }
@Override @Override
public String getIdentifier() { public @NotNull String getIdentifier() {
return this.identifier; return this.identifier;
} }
@NotNull
@Override
public Pattern getPattern() {
return this.pattern;
}
@Override @Override
public boolean equals(@Nullable final Object o) { public boolean equals(@Nullable final Object o) {
if (this == o) { if (this == o) {

View File

@@ -5,6 +5,7 @@ import org.jetbrains.annotations.Nullable;
import java.util.Objects; import java.util.Objects;
import java.util.function.Supplier; import java.util.function.Supplier;
import java.util.regex.Pattern;
/** /**
* A placeholder that cannot be registered, and exists purely in injection. * A placeholder that cannot be registered, and exists purely in injection.
@@ -15,6 +16,11 @@ public final class StaticPlaceholder implements InjectablePlaceholder {
*/ */
private final String identifier; private final String identifier;
/**
* The placeholder pattern.
*/
private final Pattern pattern;
/** /**
* The function to retrieve the output of the placeholder. * The function to retrieve the output of the placeholder.
*/ */
@@ -29,6 +35,7 @@ public final class StaticPlaceholder implements InjectablePlaceholder {
public StaticPlaceholder(@NotNull final String identifier, public StaticPlaceholder(@NotNull final String identifier,
@NotNull final Supplier<String> function) { @NotNull final Supplier<String> function) {
this.identifier = identifier; this.identifier = identifier;
this.pattern = Pattern.compile(identifier);
this.function = function; this.function = function;
} }
@@ -37,15 +44,22 @@ public final class StaticPlaceholder implements InjectablePlaceholder {
* *
* @return The value. * @return The value.
*/ */
@NotNull
public String getValue() { public String getValue() {
return function.get(); return function.get();
} }
@Override @Override
public String getIdentifier() { public @NotNull String getIdentifier() {
return this.identifier; return this.identifier;
} }
@NotNull
@Override
public Pattern getPattern() {
return this.pattern;
}
@Override @Override
public boolean equals(@Nullable final Object o) { public boolean equals(@Nullable final Object o) {
if (this == o) { if (this == o) {

View File

@@ -0,0 +1,156 @@
package com.willfp.eco.core.price;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* A group of {@link ConfiguredPrice}s in order to show them
* to players in one go.
*/
public final class CombinedDisplayPrice {
/**
* Maps configured prices to multipliers.
*/
private final Map<ConfiguredPrice, Double> prices;
/**
* The player to format for.
*/
private final Player player;
/**
* Initialize a new combined price mapping formatters to multipliers.
*
* @param player The player.
* @param prices The prices.
*/
private CombinedDisplayPrice(@NotNull final Player player,
@NotNull final Map<ConfiguredPrice, Double> prices) {
this.player = player;
this.prices = prices;
}
/**
* Get the display strings.
*
* @return The display strings.
*/
@NotNull
public String[] getDisplayStrings() {
List<String> displayStrings = new ArrayList<>();
for (Map.Entry<ConfiguredPrice, Double> entry : prices.entrySet()) {
displayStrings.add(entry.getKey().getDisplay(player, entry.getValue()));
}
return displayStrings.toArray(new String[0]);
}
/**
* The builder.
*/
public static class Builder {
/**
* All multiplied prices.
*/
private final List<MultipliedPrice> prices = new ArrayList<>();
/**
* The player.
*/
private final Player player;
/**
* Create a new builder.
*
* @param player The player.
*/
Builder(@NotNull final Player player) {
this.player = player;
}
/**
* Add a new price with a certain multiplier.
*
* @param price The price.
* @param multiplier The multiplier.
* @return The builder.
*/
@NotNull
public Builder add(@NotNull final ConfiguredPrice price,
final double multiplier) {
prices.add(new MultipliedPrice(price, multiplier));
return this;
}
/**
* Add a new price.
*
* @param price The price.
* @return The builder.
*/
@NotNull
public Builder add(@NotNull final ConfiguredPrice price) {
return this.add(price, 1D);
}
/**
* Build into a {@link CombinedDisplayPrice}.
*
* @return The combined price.
*/
@NotNull
public CombinedDisplayPrice build() {
Map<ConfiguredPrice, Double> unitPrices = new HashMap<>();
// Take first configured price at each ID as the format for all prices with that ID.
for (MultipliedPrice price : prices) {
// Find the base price.
ConfiguredPrice base = unitPrices.keySet()
.stream()
.filter(it -> it.getIdentifier().equals(price.price().getIdentifier()))
.findFirst()
.orElse(price.price());
// Find the multiplier for a value of 1, e.g. a price that's worth 20 will be 0.05.
double unitMultiplier = 1 / base.getValue(player);
double currentMultiplier = unitPrices.getOrDefault(base, 0D);
currentMultiplier += unitMultiplier * price.price().getValue(player, price.multiplier());
unitPrices.put(base, currentMultiplier);
}
return new CombinedDisplayPrice(player, unitPrices);
}
/**
* A price with a multiplier.
*
* @param price The price.
* @param multiplier The multiplier.
*/
private record MultipliedPrice(
@NotNull ConfiguredPrice price,
double multiplier
) {
}
}
/**
* Create a new builder for a player.
*
* @param player The player.
* @return The builder.
*/
@NotNull
public static Builder builder(@NotNull final Player player) {
return new Builder(player);
}
}

View File

@@ -24,7 +24,7 @@ public final class ConfiguredPrice implements Price {
/** /**
* Free. * Free.
*/ */
private static final ConfiguredPrice FREE = new ConfiguredPrice( public static final ConfiguredPrice FREE = new ConfiguredPrice(
new PriceFree(), new PriceFree(),
"Free" "Free"
); );
@@ -52,23 +52,27 @@ public final class ConfiguredPrice implements Price {
} }
@Override @Override
public boolean canAfford(@NotNull final Player player) { public boolean canAfford(@NotNull final Player player,
return this.price.canAfford(player); final double multiplier) {
return this.price.canAfford(player, multiplier);
} }
@Override @Override
public void pay(@NotNull final Player player) { public void pay(@NotNull final Player player,
this.price.pay(player); final double multiplier) {
this.price.pay(player, multiplier);
} }
@Override @Override
public void giveTo(@NotNull final Player player) { public void giveTo(@NotNull final Player player,
this.price.giveTo(player); final double multiplier) {
this.price.giveTo(player, multiplier);
} }
@Override @Override
public double getValue(@NotNull final Player player) { public double getValue(@NotNull final Player player,
return this.price.getValue(player); final double multiplier) {
return this.price.getValue(player, multiplier);
} }
@Override @Override
@@ -82,6 +86,11 @@ public final class ConfiguredPrice implements Price {
this.price.setMultiplier(player, multiplier); this.price.setMultiplier(player, multiplier);
} }
@Override
public String getIdentifier() {
return this.price.getIdentifier();
}
/** /**
* Get the price that this delegates to. * Get the price that this delegates to.
* *
@@ -98,8 +107,20 @@ public final class ConfiguredPrice implements Price {
* @return The display string. * @return The display string.
*/ */
public String getDisplay(@NotNull final Player player) { public String getDisplay(@NotNull final Player player) {
return this.getDisplay(player, 1.0);
}
/**
* Get the display string for a player.
*
* @param player The player.
* @param multiplier The multiplier.
* @return The display string.
*/
public String getDisplay(@NotNull final Player player,
final double multiplier) {
return StringUtils.format( return StringUtils.format(
formatString.replace("%value%", NumberUtils.format(this.getPrice().getValue(player))), formatString.replace("%value%", NumberUtils.format(this.getPrice().getValue(player, multiplier))),
player, player,
StringUtils.FormatOption.WITH_PLACEHOLDERS StringUtils.FormatOption.WITH_PLACEHOLDERS
); );

View File

@@ -1,49 +1,150 @@
package com.willfp.eco.core.price; package com.willfp.eco.core.price;
import org.apache.commons.lang.NotImplementedException;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/** /**
* A price that a player should pay. * A price that a player should pay.
* <p>
* There are important implementation details:
* <p>
* For backwards compatibility, all methods are default, however you must override the following:
* <ul>
* <li><code>canAfford(Player, double)</code></li>
* <li><code>pay(Player, double)</code></li>
* <li><code>giveTo(Player, double)</code></li>
* <li><code>getValue(Player, double)</code></li>
* <li><code>getMultiplier(Player)</code></li>
* <li><code>setMultiplier(Player, double)</code></li>
* </ul>
* Otherwise, your implementation will throw {@link NotImplementedException}.
* <p>
* Also, getValue() should always return the value with player multipliers applied.
*/ */
public interface Price { public interface Price {
/** /**
* Get if the player can afford the price. * Get if a player can afford to pay the price.
* *
* @param player The player. * @param player The player.
* @return If the player can afford. * @return If the player can afford.
*/ */
boolean canAfford(@NotNull Player player); default boolean canAfford(@NotNull final Player player) {
return this.canAfford(player, 1);
}
/**
* Get if a player can afford to pay x times the price.
*
* @param player The player.
* @param multiplier The multiplier.
* @return If the player can afford.
*/
default boolean canAfford(@NotNull final Player player,
final double multiplier) {
throw new NotImplementedException("Override canAfford(Player, double) in your Price implementation!");
}
/** /**
* Make the player pay the price. * Make the player pay the price.
* <p> * <p>
* Only run this if the player can afford the price. * Check canAfford first.
* *
* @param player The player. * @param player The player.
*/ */
void pay(@NotNull Player player); default void pay(@NotNull final Player player) {
this.pay(player, 1);
/**
* Give the value of the price to the player.
* <p>
* You should override this method, it's only marked as default for
* backwards compatibility purposes.
*
* @param player The player.
*/
default void giveTo(@NotNull Player player) {
// Override when needed.
} }
/** /**
* If the price is backed by a value, get it here. * Make the player pay the price x times.
* <p>
* Check canAfford first.
*
* @param player The player.
* @param multiplier The multiplier.
*/
default void pay(@NotNull final Player player,
final double multiplier) {
throw new NotImplementedException("Override pay(Player, double) in your Price implementation!");
}
/**
* Give the price to the player.
*
* @param player The player.
*/
default void giveTo(@NotNull final Player player) {
this.giveTo(player, 1);
}
/**
* Give the price to the player x times.
*
* @param player The player.
* @param multiplier The multiplier.
*/
default void giveTo(@NotNull final Player player,
final double multiplier) {
throw new NotImplementedException("Override giveTo(Player, double) in your Price implementation!");
}
/**
* Get the numerical value that backs this price.
* *
* @param player The player. * @param player The player.
* @return The value. * @return The value.
*/ */
default double getValue(@NotNull final Player player) { default double getValue(@NotNull final Player player) {
return 0; return getValue(player, 1);
}
/**
* Get the numeral value that backs this price multiplied x times.
*
* @param player The player.
* @param multiplier The multiplier.
* @return The value.
*/
default double getValue(@NotNull final Player player,
final double multiplier) {
throw new NotImplementedException("Override getValue(Player, double) in your Price implementation!");
}
/**
* Get the value multiplier for the player.
*
* @param player The player.
* @return The multiplier.
*/
default double getMultiplier(@NotNull final Player player) {
return 1;
}
/**
* Set the value multiplier for the player.
*
* @param player The player.
* @param multiplier The multiplier.
*/
default void setMultiplier(@NotNull final Player player,
final double multiplier) {
throw new NotImplementedException("Override setMultiplier(Player, double) in your Price implementation!");
}
/**
* Get the identifier of this price (as type/instance checks break with delegation,
* this is used for combining prices, etc.)
* <p>
* By default, this uses the class name, but it's good practice to override this.
* <p>
* It's also good practice to prefix your identifiers with some kind of namespace or
* internal ID, in order to prevent conflicts.
*
* @return The identifier.
*/
default String getIdentifier() {
return this.getClass().getName();
} }
/** /**
@@ -61,31 +162,10 @@ public interface Price {
* If the price is backed by a value, set it here. * If the price is backed by a value, set it here.
* *
* @param value The value. * @param value The value.
* @deprecated Values shouldn't be fixed. * @deprecated Values shouldn't be fixed. This method should never work.
*/ */
@Deprecated(since = "6.45.0", forRemoval = true) @Deprecated(since = "6.45.0", forRemoval = true)
default void setValue(final double value) { default void setValue(final double value) {
// Override when needed. // Override when needed.
} }
/**
* Get the price multiplier for a player.
*
* @param player The player.
* @return The value.
*/
default double getMultiplier(@NotNull final Player player) {
return 1;
}
/**
* Set the price multiplier for a player.
*
* @param player The player.
* @param multiplier The multiplier.
*/
default void setMultiplier(@NotNull final Player player,
final double multiplier) {
// Override when needed.
}
} }

View File

@@ -71,10 +71,6 @@ public final class Prices {
ctx ctx
); );
if (function.apply(context) <= 0) {
return new PriceFree();
}
// Default to economy // Default to economy
if (priceName == null) { if (priceName == null) {
return new PriceEconomy(context, function); return new PriceEconomy(context, function);

View File

@@ -52,23 +52,27 @@ public final class PriceEconomy implements Price {
} }
@Override @Override
public boolean canAfford(@NotNull final Player player) { public boolean canAfford(@NotNull final Player player,
return EconomyManager.getBalance(player) >= getValue(player); final double multiplier) {
return EconomyManager.getBalance(player) >= getValue(player, multiplier);
} }
@Override @Override
public void pay(@NotNull final Player player) { public void pay(@NotNull final Player player,
EconomyManager.removeMoney(player, getValue(player)); final double multiplier) {
EconomyManager.removeMoney(player, getValue(player, multiplier));
} }
@Override @Override
public void giveTo(@NotNull final Player player) { public void giveTo(@NotNull final Player player,
EconomyManager.giveMoney(player, getValue(player)); final double multiplier) {
EconomyManager.giveMoney(player, getValue(player, multiplier));
} }
@Override @Override
public double getValue(@NotNull final Player player) { public double getValue(@NotNull final Player player,
return this.function.apply(MathContext.copyWithPlayer(baseContext, player)) * getMultiplier(player); final double multiplier) {
return this.function.apply(MathContext.copyWithPlayer(baseContext, player)) * getMultiplier(player) * multiplier;
} }
@Override @Override
@@ -81,4 +85,9 @@ public final class PriceEconomy implements Price {
final double multiplier) { final double multiplier) {
this.multipliers.put(player.getUniqueId(), multiplier); this.multipliers.put(player.getUniqueId(), multiplier);
} }
@Override
public String getIdentifier() {
return "eco:economy";
}
} }

View File

@@ -16,12 +16,42 @@ public final class PriceFree implements Price {
} }
@Override @Override
public boolean canAfford(@NotNull final Player player) { public boolean canAfford(@NotNull final Player player,
final double multiplier) {
return true; return true;
} }
@Override @Override
public void pay(@NotNull final Player player) { public void pay(@NotNull final Player player,
// Do nothing. final double multiplier) {
// Nothing.
}
@Override
public void giveTo(@NotNull final Player player,
final double multiplier) {
// Nothing.
}
@Override
public double getMultiplier(@NotNull final Player player) {
return 1.0;
}
@Override
public void setMultiplier(@NotNull final Player player,
final double multiplier) {
// Nothing.
}
@Override
public double getValue(@NotNull final Player player,
final double multiplier) {
return 0;
}
@Override
public String getIdentifier() {
return "eco:free";
} }
} }

View File

@@ -1,6 +1,7 @@
package com.willfp.eco.core.price.impl; package com.willfp.eco.core.price.impl;
import com.willfp.eco.core.drops.DropQueue; import com.willfp.eco.core.drops.DropQueue;
import com.willfp.eco.core.items.HashedItem;
import com.willfp.eco.core.items.TestableItem; import com.willfp.eco.core.items.TestableItem;
import com.willfp.eco.core.math.MathContext; import com.willfp.eco.core.math.MathContext;
import com.willfp.eco.core.price.Price; import com.willfp.eco.core.price.Price;
@@ -74,8 +75,9 @@ public final class PriceItem implements Price {
} }
@Override @Override
public boolean canAfford(@NotNull final Player player) { public boolean canAfford(@NotNull final Player player,
int toRemove = (int) getValue(player); final double multiplier) {
int toRemove = (int) getValue(player, multiplier);
if (toRemove <= 0) { if (toRemove <= 0) {
return true; return true;
} }
@@ -92,8 +94,9 @@ public final class PriceItem implements Price {
} }
@Override @Override
public void pay(@NotNull final Player player) { public void pay(@NotNull final Player player,
int toRemove = (int) getValue(player); final double multiplier) {
int toRemove = (int) getValue(player, multiplier);
int count = 0; int count = 0;
for (ItemStack itemStack : player.getInventory().getContents()) { for (ItemStack itemStack : player.getInventory().getContents()) {
@@ -119,9 +122,10 @@ public final class PriceItem implements Price {
} }
@Override @Override
public void giveTo(@NotNull final Player player) { public void giveTo(@NotNull final Player player,
final double multiplier) {
ItemStack itemStack = item.getItem().clone(); ItemStack itemStack = item.getItem().clone();
itemStack.setAmount((int) getValue(player)); itemStack.setAmount((int) getValue(player, multiplier));
new DropQueue(player) new DropQueue(player)
.addItem(itemStack) .addItem(itemStack)
@@ -130,9 +134,11 @@ public final class PriceItem implements Price {
} }
@Override @Override
public double getValue(@NotNull final Player player) { public double getValue(@NotNull final Player player,
final double multiplier) {
return Math.toIntExact(Math.round( return Math.toIntExact(Math.round(
this.function.apply(MathContext.copyWithPlayer(baseContext, player)) * getMultiplier(player) this.function.apply(MathContext.copyWithPlayer(baseContext, player))
* getMultiplier(player) * multiplier
)); ));
} }
@@ -146,4 +152,9 @@ public final class PriceItem implements Price {
final double multiplier) { final double multiplier) {
this.multipliers.put(player.getUniqueId(), multiplier); this.multipliers.put(player.getUniqueId(), multiplier);
} }
@Override
public String getIdentifier() {
return "eco:item-" + HashedItem.of(this.item.getItem()).getHash();
}
} }

View File

@@ -21,7 +21,8 @@ public final class ProxyConstants {
"v1_17_R1", "v1_17_R1",
"v1_18_R1", "v1_18_R1",
"v1_18_R2", "v1_18_R2",
"v1_19_R1" "v1_19_R1",
"v1_19_R2"
); );
private ProxyConstants() { private ProxyConstants() {

View File

@@ -85,8 +85,8 @@ public record PlayableSound(@NotNull Sound sound,
try { try {
Sound sound = Sound.valueOf(config.getString("sound").toUpperCase()); Sound sound = Sound.valueOf(config.getString("sound").toUpperCase());
double pitch = Objects.requireNonNullElse(config.getDouble("pitch"), 1.0); double pitch = Objects.requireNonNullElse(config.getDoubleOrNull("pitch"), 1.0);
double volume = Objects.requireNonNullElse(config.getDouble("volume"), 1.0); double volume = Objects.requireNonNullElse(config.getDoubleOrNull("volume"), 1.0);
return new PlayableSound( return new PlayableSound(
sound, sound,

View File

@@ -16,6 +16,8 @@ import org.jetbrains.annotations.NotNull;
/** /**
* Utilities / API methods for item durability. * Utilities / API methods for item durability.
*/ */
// Have to suppress casts to ItemMeta because the methods don't exist for some older versions that eco supports.
@SuppressWarnings("RedundantCast")
public final class DurabilityUtils { public final class DurabilityUtils {
/** /**
* Damage an item in a player's inventory. * Damage an item in a player's inventory.

View File

@@ -579,7 +579,7 @@ public final class StringUtils {
* *
* @param lookup The lookup string. * @param lookup The lookup string.
* @return An array of tokens to be processed. * @return An array of tokens to be processed.
* @author Shawn (https://stackoverflow.com/questions/70606170/split-a-list-on-spaces-and-group-quoted-characters/70606653#70606653) * @author Shawn (<a href="https://stackoverflow.com/questions/70606170/split-a-list-on-spaces-and-group-quoted-characters/70606653#70606653">...</a>)
*/ */
@NotNull @NotNull
public static String[] parseTokens(@NotNull final String lookup) { public static String[] parseTokens(@NotNull final String lookup) {

View File

@@ -4,9 +4,14 @@ package com.willfp.eco.core.commands
import com.willfp.eco.core.EcoPlugin import com.willfp.eco.core.EcoPlugin
import com.willfp.eco.core.command.CommandBase import com.willfp.eco.core.command.CommandBase
import com.willfp.eco.core.command.NotificationException
import com.willfp.eco.core.command.impl.PluginCommand import com.willfp.eco.core.command.impl.PluginCommand
import com.willfp.eco.core.command.impl.Subcommand import com.willfp.eco.core.command.impl.Subcommand
import org.bukkit.Bukkit
import org.bukkit.OfflinePlayer
import org.bukkit.command.CommandSender import org.bukkit.command.CommandSender
import org.bukkit.entity.Player
import java.util.function.Predicate
/** /**
* Helper class for creating commands with builders. * Helper class for creating commands with builders.
@@ -140,3 +145,92 @@ fun CommandBase.addSubcommand(
init(command) init(command)
return command return command
} }
/**
* Throws an exception containing a langYml key if obj is null.
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and Subcommand
* automatically handles sending the message to the sender.</p>
* <br>
* @param key key of notification message in langYml
* @return Returns the object given or throws an exception
* @throws NotificationException exception thrown when null
*/
fun <T> T.notifyNull(key: String): T {
return this ?: throw NotificationException(key)
}
/**
* Throws an exception containing a langYml key if predicate tests false
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and Subcommand
* automatically handles sending the message to the sender.</p>
* <br>
* @param predicate predicate to test
* @param key key of notification message in langYml
* @param <T> the generic type of object
* @return Returns the object given or throws an exception
*/
fun <T> T.notifyFalse(predicate: Predicate<T>, key: String): T {
predicate.test(this).notifyFalse(key)
return this
}
/**
* Throws an exception containing a langYml key if condition is false.
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and Subcommand
* automatically handles sending the message to the sender.</p>
* <br>
* @param key value in the langYml
* @return Returns the condition given or throws an exception
* @throws NotificationException exception thrown when false
*/
fun Boolean?.notifyFalse(key: String): Boolean {
return if (this == true) true else throw NotificationException(key)
}
/**
* Throws an exception containing a langYml key if Bukkit.getPlayer(playerName) is null.
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and Subcommand
* automatically handles sending the message to the sender.</p>
* <br>
* @param key value in the langYml
* @return Returns the player
* @throws NotificationException exception thrown when invalid playerName
*/
fun String?.notifyPlayerRequired(key: String): Player {
return Bukkit.getPlayer(this ?: "") ?: throw NotificationException(key)
}
/**
* Throws an exception containing a langYml key if Bukkit.getPlayer(playerName) is null.
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and Subcommand
* automatically handles sending the message to the sender.</p>
* <br>
* @param key value in the langYml
* @return Returns the player
* @throws NotificationException exception thrown when invalid playerName
*/
fun String?.notifyOfflinePlayerRequired(key: String): OfflinePlayer {
@Suppress("DEPRECATION")
val player = Bukkit.getOfflinePlayer(this ?: "")
if (!player.hasPlayedBefore() && !player.isOnline) {
throw NotificationException(key)
}
return player
}
/**
* Throws an exception containing a langYml key if player doesn't have permission.
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and Subcommand
* automatically handles sending the message to the sender.</p>
* <br>
* @param permission the permission
* @param key value in the langYml
* @return Returns the player
* @throws NotificationException exception thrown when player doesn't have permission
*/
fun Player?.notifyPermissionRequired(permission: String, key: String): Player {
this ?: throw NotificationException(key)
return this.notifyFalse({ this.hasPermission(permission) }, key)
}

View File

@@ -74,12 +74,15 @@ fun SlotBuilder.onClick(clickType: ClickType, action: (Player, InventoryClickEve
fun SlotBuilder.notCaptiveFor(test: (Player) -> Boolean): SlotBuilder = fun SlotBuilder.notCaptiveFor(test: (Player) -> Boolean): SlotBuilder =
this.notCaptiveFor { test(it) } this.notCaptiveFor { test(it) }
/** @see SlotBuilder.setCaptiveFilter */
fun SlotBuilder.setCaptiveFilter(test: (Player, Menu, ItemStack?) -> Boolean): SlotBuilder =
this.setCaptiveFilter { a, b, c -> test(a, b, c) }
/** /**
* @see SlotBuilder.setModifier * @see SlotBuilder.setModifier
* @deprecated Use SlotUpdater instead. * @deprecated Use SlotUpdater instead.
*/ */
@Deprecated("Use SlotUpdater instead") @Deprecated("Use SlotUpdater instead")
@Suppress("DEPRECATION")
fun SlotBuilder.setModifier(action: (Player, Menu, item: ItemStack) -> Unit): SlotBuilder = fun SlotBuilder.setModifier(action: (Player, Menu, item: ItemStack) -> Unit): SlotBuilder =
this.setUpdater { a, b, c -> c.apply { action(a, b, c) } } this.setUpdater { a, b, c -> c.apply { action(a, b, c) } }

View File

@@ -2,13 +2,31 @@
package com.willfp.eco.core.integrations.shop package com.willfp.eco.core.integrations.shop
import com.willfp.eco.core.price.Price
import org.bukkit.entity.Player import org.bukkit.entity.Player
import org.bukkit.inventory.ItemStack import org.bukkit.inventory.ItemStack
/** @see ShopManager.getItemPrice **/ /** @see ShopManager.getItemPrice * */
@Deprecated(
"Prices depend on players, this will always return 0.",
level = DeprecationLevel.ERROR,
replaceWith = ReplaceWith("this.getValue(player)")
)
val ItemStack.price: Double val ItemStack.price: Double
get() = ShopManager.getItemPrice(this) get() = 0.0
/** @see ShopManager.getItemPrice **/ /** @see ShopManager.getItemPrice * */
@Deprecated(
"Use the price system instead, prices may not be currencies.",
ReplaceWith("this.getValue(player)"),
)
fun ItemStack.getPrice(player: Player): Double = fun ItemStack.getPrice(player: Player): Double =
ShopManager.getItemPrice(this, player) this.getUnitValue(player).getValue(player, this.amount.toDouble())
/** @see ShopManager.getUnitValue */
fun ItemStack.getUnitValue(player: Player): Price =
ShopManager.getUnitValue(this, player)
/** @see ShopManager.isSellable */
fun ItemStack?.isSellable(player: Player): Boolean =
ShopManager.isSellable(this, player)

View File

@@ -0,0 +1,9 @@
@file:JvmName("PacketExtensions")
package com.willfp.eco.core.packet
import org.bukkit.entity.Player
/** @see Packet.send */
fun Player.sendPacket(packet: Packet) =
packet.send(this)

View File

@@ -0,0 +1,41 @@
package com.willfp.eco.internal.command
import org.bukkit.command.Command
import org.bukkit.command.CommandSender
import org.bukkit.command.PluginIdentifiableCommand
import org.bukkit.command.TabCompleter
class DelegatedBukkitCommand(
private val delegate: EcoPluginCommand
) : Command(delegate.name), TabCompleter, PluginIdentifiableCommand {
private var _aliases: List<String>? = null
private var _description: String? = null
override fun execute(sender: CommandSender, label: String, args: Array<out String>?): Boolean {
return delegate.onCommand(sender, this, label, args)
}
override fun onTabComplete(
sender: CommandSender,
command: Command,
label: String,
args: Array<out String>?
): List<String> {
return delegate.onTabComplete(sender, this, label, args) ?: emptyList()
}
override fun getPlugin() = delegate.plugin
override fun getPermission() = delegate.permission
override fun getDescription() = _description ?: delegate.description ?: ""
override fun getAliases(): List<String> = _aliases ?: delegate.aliases
override fun setDescription(description: String): Command {
this._description = description
return this
}
override fun setAliases(aliases: List<String>): Command {
this._aliases = aliases
return this
}
}

Some files were not shown because too many files have changed in this diff Show More