Compare commits
532 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
87f90d8b26 | ||
|
|
899d5cc054 | ||
|
|
c1ed771eb3 | ||
|
|
08a4d9d6b1 | ||
|
|
7ef8dcfd64 | ||
|
|
5bedf88b4c | ||
|
|
1d241651b5 | ||
|
|
3ff2bfa412 | ||
|
|
3a508c693b | ||
|
|
a4c5ff921e | ||
|
|
137e9dc7d6 | ||
|
|
710cec4bc1 | ||
|
|
fa0ec7d6b0 | ||
|
|
5093799775 | ||
|
|
8535f23ede | ||
|
|
8e09ae7f4c | ||
|
|
bbc2513b40 | ||
|
|
c7f8063a3a | ||
|
|
14b0f1be0c | ||
|
|
af20bb315b | ||
|
|
6645e216d5 | ||
|
|
eddf240f0c | ||
|
|
4f406353ba | ||
|
|
095494dd2e | ||
|
|
fd92645500 | ||
|
|
1a6ac29083 | ||
|
|
7edc00d459 | ||
|
|
a51bad058f | ||
|
|
89ebb8ba59 | ||
|
|
f0ae8f4f84 | ||
|
|
7d6cf78442 | ||
|
|
780d8f3b86 | ||
|
|
146a0130f9 | ||
|
|
df8c3411cb | ||
|
|
4fc3c22a7d | ||
|
|
cfc4808bb8 | ||
|
|
4ac6325a41 | ||
|
|
4aed33751d | ||
|
|
3fe1c2c69f | ||
|
|
5feaa84b2c | ||
|
|
d8793bc2bb | ||
|
|
15c512f3ca | ||
|
|
15ff2fb1d6 | ||
|
|
862b588c8d | ||
|
|
3c2a99b5f4 | ||
|
|
2d23c05c47 | ||
|
|
8fc55d3393 | ||
|
|
5900a756e4 | ||
|
|
c18b85f223 | ||
|
|
85116108c2 | ||
|
|
044f141bd0 | ||
|
|
9ca7f99fdb | ||
|
|
7aa7770a3e | ||
|
|
10202917fa | ||
|
|
43df79e3b1 | ||
|
|
5ef244f0bc | ||
|
|
861f076c11 | ||
|
|
7bed43059f | ||
|
|
37e271c96c | ||
|
|
3dad48e24d | ||
|
|
ae77e4810b | ||
|
|
3d50e37c37 | ||
|
|
421fd3bd04 | ||
|
|
5ecae0a366 | ||
|
|
5de4914fd7 | ||
|
|
0f9bf094ae | ||
|
|
e67680f397 | ||
|
|
73c0a5d655 | ||
|
|
220ed26f4a | ||
|
|
edf2ea41c7 | ||
|
|
16859b8ce5 | ||
|
|
10fe7d190a | ||
|
|
60a1f2429c | ||
|
|
cc6dc1e67c | ||
|
|
f4f5941691 | ||
|
|
f973281dd9 | ||
|
|
8acd76f363 | ||
|
|
4a165a86dc | ||
|
|
43b7c393b9 | ||
|
|
714952bc45 | ||
|
|
322e179b81 | ||
|
|
469be73ada | ||
|
|
7eac60146f | ||
|
|
ad0223e1bb | ||
|
|
430117f342 | ||
|
|
fa87cae81e | ||
|
|
5695750fc5 | ||
|
|
45e8a57880 | ||
|
|
17fcd2c1b5 | ||
|
|
0c1e17c351 | ||
|
|
9415515849 | ||
|
|
d0e957ea37 | ||
|
|
69514e2f85 | ||
|
|
259e35c978 | ||
|
|
40aec26f15 | ||
|
|
67b2fdd594 | ||
|
|
83f86983f6 | ||
|
|
3ba98a9a5e | ||
|
|
f19e565fbe | ||
|
|
ee3ecb643b | ||
|
|
3aefb0e481 | ||
|
|
d9eb1e1c26 | ||
|
|
70631e67c5 | ||
|
|
82797e7342 | ||
|
|
d2917341b1 | ||
|
|
760f42be0c | ||
|
|
bb01af2ab2 | ||
|
|
517d890c05 | ||
|
|
f02fc56778 | ||
|
|
4417b09c14 | ||
|
|
6b37fafa90 | ||
|
|
f8c5c9f06d | ||
|
|
0fd6cbaa08 | ||
|
|
81afa32eb0 | ||
|
|
7387fe2332 | ||
|
|
80fa05da98 | ||
|
|
77754249ad | ||
|
|
1843cf0f8a | ||
|
|
05eb5ee993 | ||
|
|
7bc11ee716 | ||
|
|
f566aec00e | ||
|
|
36d47c55a1 | ||
|
|
40463213ac | ||
|
|
6ec80d30ad | ||
|
|
7ccee60a0c | ||
|
|
0805b48763 | ||
|
|
d737322aaa | ||
|
|
4ddc150e1c | ||
|
|
0da119d89d | ||
|
|
fc0a07d1c5 | ||
|
|
4ce2850138 | ||
|
|
58316c2a06 | ||
|
|
d96ad10960 | ||
|
|
21283b0928 | ||
|
|
2797687f01 | ||
|
|
9c68d1fbc3 | ||
|
|
9371d9b88d | ||
|
|
14e2ead488 | ||
|
|
5473bb8ef8 | ||
|
|
90c55849ae | ||
|
|
9809140cf9 | ||
|
|
49a82dc005 | ||
|
|
92dec03b9a | ||
|
|
7453c70b87 | ||
|
|
3038ea43d0 | ||
|
|
3c6ddd8255 | ||
|
|
925ee04cc1 | ||
|
|
6f7de8716b | ||
|
|
a17b951a8b | ||
|
|
f003ed06a8 | ||
|
|
f864953da2 | ||
|
|
6ef31444ac | ||
|
|
99258116de | ||
|
|
a59c68102e | ||
|
|
2482525fe2 | ||
|
|
acb326c0c8 | ||
|
|
11d947e24b | ||
|
|
3cced3012c | ||
|
|
520523e903 | ||
|
|
ee36cc74f8 | ||
|
|
55344e0550 | ||
|
|
75f6f05c7d | ||
|
|
17fa519501 | ||
|
|
1a72cf3ca9 | ||
|
|
d11f355c44 | ||
|
|
1852ff86ec | ||
|
|
ffe9219f45 | ||
|
|
f67a5d3b3d | ||
|
|
bbd541abe0 | ||
|
|
3de8d0fed9 | ||
|
|
df4abe39eb | ||
|
|
f5e289966f | ||
|
|
bcfa4bd82e | ||
|
|
229c9e58c3 | ||
|
|
4f30a6e04e | ||
|
|
9ea45ee0d0 | ||
|
|
192316214d | ||
|
|
feb8898a87 | ||
|
|
1e64815e47 | ||
|
|
dc10648c25 | ||
|
|
70131a6cae | ||
|
|
6d23cc7141 | ||
|
|
473202527a | ||
|
|
bc24aaeb3c | ||
|
|
52072bd935 | ||
|
|
ad47b7898e | ||
|
|
19d6533db6 | ||
|
|
3a37d40271 | ||
|
|
cb3ccbb39a | ||
|
|
5c3bb678b3 | ||
|
|
4f4ee82e6b | ||
|
|
32d88f55f8 | ||
|
|
bc8d615079 | ||
|
|
55b7c3c16f | ||
|
|
9535986f59 | ||
|
|
fb17fc1383 | ||
|
|
4221368388 | ||
|
|
d4432d0cb8 | ||
|
|
f9093c2ed6 | ||
|
|
15f4d5c098 | ||
|
|
dc47bc7995 | ||
|
|
29ce0deb1b | ||
|
|
fd78402bf5 | ||
|
|
5f65e3f520 | ||
|
|
ceaf4d34a5 | ||
|
|
2d2e5f8150 | ||
|
|
323a4aefef | ||
|
|
af486580c1 | ||
|
|
7955a94f14 | ||
|
|
c99a1bd50a | ||
|
|
93364247de | ||
|
|
49612eddcb | ||
|
|
834c29f843 | ||
|
|
a806ac039d | ||
|
|
0ca2651af0 | ||
|
|
6157fdcfa1 | ||
|
|
36cfcd24c2 | ||
|
|
d4558db40c | ||
|
|
3f8448fee1 | ||
|
|
8b6e15457c | ||
|
|
b99e822db3 | ||
|
|
02f8d33a81 | ||
|
|
76042bea68 | ||
|
|
51ad09c536 | ||
|
|
264c591020 | ||
|
|
6bd3ca0f5c | ||
|
|
98df14a23a | ||
|
|
ccb6e38064 | ||
|
|
50f1ba6a19 | ||
|
|
501e7b05a6 | ||
|
|
ebf8abf764 | ||
|
|
aff8fa8e88 | ||
|
|
1accad88fe | ||
|
|
a3a5e4df38 | ||
|
|
6e8dc1d729 | ||
|
|
a8556008f9 | ||
|
|
ab18a8bd29 | ||
|
|
a053f512f8 | ||
|
|
add5390787 | ||
|
|
49687f9a91 | ||
|
|
5480c70f8c | ||
|
|
ef922f6d3f | ||
|
|
026bc55ffb | ||
|
|
270fdbb18c | ||
|
|
fbf5967d17 | ||
|
|
4102be1201 | ||
|
|
f6bdb9cc65 | ||
|
|
c8282d1acf | ||
|
|
b056b537ef | ||
|
|
f69b458731 | ||
|
|
b035fa8940 | ||
|
|
25c087592d | ||
|
|
083cb39771 | ||
|
|
eb3e0f5c09 | ||
|
|
08f43ddafd | ||
|
|
9d3efb5e83 | ||
|
|
8a5d1a604a | ||
|
|
ef67c6d6ae | ||
|
|
5b2654db15 | ||
|
|
eccd793317 | ||
|
|
1bc44755a0 | ||
|
|
ec606d9ebe | ||
|
|
c5556f15ab | ||
|
|
399cce21f5 | ||
|
|
b25feffdfa | ||
|
|
1a96fdf465 | ||
|
|
cee1ac4cc2 | ||
|
|
ac10fa46dc | ||
|
|
7c616e64ae | ||
|
|
708f9130c6 | ||
|
|
9118d49c67 | ||
|
|
a1ce72476f | ||
|
|
2cfab99644 | ||
|
|
cc9b3f7710 | ||
|
|
5bfe48c8d9 | ||
|
|
22ff157ffc | ||
|
|
720dbe789c | ||
|
|
b51dd51941 | ||
|
|
f3ffaa4cf6 | ||
|
|
085032e315 | ||
|
|
3d920ee2b4 | ||
|
|
06a04e4375 | ||
|
|
7349f15784 | ||
|
|
a4c77857d5 | ||
|
|
999fafc8df | ||
|
|
0d533850f6 | ||
|
|
569f9cfcb4 | ||
|
|
f0619f2374 | ||
|
|
7e8d97e11d | ||
|
|
d3414f25ad | ||
|
|
f0cf118448 | ||
|
|
297bb10b85 | ||
|
|
751624bc8d | ||
|
|
8b1b15a3e4 | ||
|
|
7fe330bafb | ||
|
|
20584b2a9b | ||
|
|
bd7594a117 | ||
|
|
f1bfa21270 | ||
|
|
01aa1e708a | ||
|
|
8424baa285 | ||
|
|
d9a8d26990 | ||
|
|
4d3eeaaefc | ||
|
|
d54a2b9516 | ||
|
|
f7f12b6255 | ||
|
|
42eb1344a6 | ||
|
|
4c2a8585cc | ||
|
|
8cccc67b0d | ||
|
|
396d74497c | ||
|
|
49602dce04 | ||
|
|
5da811ba74 | ||
|
|
a4d57e21fe | ||
|
|
4b8efdc79f | ||
|
|
610110efde | ||
|
|
a87f675269 | ||
|
|
a371d314b8 | ||
|
|
9a9097adc5 | ||
|
|
0669a57e4b | ||
|
|
692eaf6836 | ||
|
|
7f9052c64d | ||
|
|
55a841b3f5 | ||
|
|
85f02c5ca2 | ||
|
|
74c428b90d | ||
|
|
fd8c67fa66 | ||
|
|
a396754e2e | ||
|
|
6f97f47712 | ||
|
|
d1109e485a | ||
|
|
476e5c7cae | ||
|
|
dc2b7a6fda | ||
|
|
00f18519b0 | ||
|
|
f7ea5fd182 | ||
|
|
70d29c872a | ||
|
|
f79f4a84c3 | ||
|
|
9af63907ef | ||
|
|
c9aa92895b | ||
|
|
c57c824027 | ||
|
|
7cb905e65a | ||
|
|
31a2c7e338 | ||
|
|
1759b52f82 | ||
|
|
ccf93e3a4d | ||
|
|
abd07389ab | ||
|
|
80ad738bb2 | ||
|
|
b01105819a | ||
|
|
a7c08b0731 | ||
|
|
7e4c071698 | ||
|
|
f94f7ead08 | ||
|
|
b21c5bf3a9 | ||
|
|
7a9e8c5c10 | ||
|
|
a6ddbc46ab | ||
|
|
ffaee137d8 | ||
|
|
18d882dac6 | ||
|
|
52841f7f04 | ||
|
|
47b72e9243 | ||
|
|
854a10e8fd | ||
|
|
823ef6477b | ||
|
|
eccb146852 | ||
|
|
d877b707d6 | ||
|
|
bcb7401c74 | ||
|
|
f05c5f3cd6 | ||
|
|
3bd8bccb81 | ||
|
|
6f55787c84 | ||
|
|
eb4dc168fc | ||
|
|
c5085de5d1 | ||
|
|
019cdbf9c8 | ||
|
|
d5ddcaea4b | ||
|
|
d3a7ef72e8 | ||
|
|
a311ce1227 | ||
|
|
5c0d4540a8 | ||
|
|
7e66ee8071 | ||
|
|
fd233df736 | ||
|
|
6baf636e6a | ||
|
|
9ee579f2c4 | ||
|
|
3b5ea87353 | ||
|
|
00d32ed218 | ||
|
|
5ce9a1c04e | ||
|
|
966549065d | ||
|
|
ee2911b57c | ||
|
|
f15ec5eec0 | ||
|
|
a9c32000d8 | ||
|
|
b68459951f | ||
|
|
b520c76169 | ||
|
|
d081afbd8e | ||
|
|
46fd0439a5 | ||
|
|
ad58ce4a74 | ||
|
|
b5cd8f42e0 | ||
|
|
d0baf50709 | ||
|
|
2496f318fa | ||
|
|
048c200c95 | ||
|
|
17446acb2e | ||
|
|
7929113c91 | ||
|
|
6acc5864bd | ||
|
|
fa64950d28 | ||
|
|
730c20dbc0 | ||
|
|
0c5ae54c3a | ||
|
|
b48e80837d | ||
|
|
17eb4cf5f8 | ||
|
|
890f85fa56 | ||
|
|
86b427c95e | ||
|
|
8c1fde57b0 | ||
|
|
2efc040a8e | ||
|
|
54b2b42512 | ||
|
|
e67d9d634c | ||
|
|
39fb676b9a | ||
|
|
ec8936b765 | ||
|
|
cf347de4b8 | ||
|
|
2b7122c5c2 | ||
|
|
062b5c9b92 | ||
|
|
052cd74756 | ||
|
|
082b39a2e4 | ||
|
|
616fa032d9 | ||
|
|
ea997239fc | ||
|
|
ad04abab73 | ||
|
|
f440ef922b | ||
|
|
933271fb4a | ||
|
|
9679d3100f | ||
|
|
6e20763522 | ||
|
|
18dea2c20c | ||
|
|
62b666559c | ||
|
|
465563523b | ||
|
|
f0f014ed89 | ||
|
|
58811c5d77 | ||
|
|
81d495e76e | ||
|
|
c78e397959 | ||
|
|
95740f155e | ||
|
|
5638d5e152 | ||
|
|
4d3712057c | ||
|
|
458fcd78b3 | ||
|
|
ee13de31f4 | ||
|
|
9588d49788 | ||
|
|
8e7ce298b0 | ||
|
|
32a11ce5b8 | ||
|
|
960f62cc8b | ||
|
|
28ceb83eb5 | ||
|
|
6f748b6b8a | ||
|
|
190ea5d49f | ||
|
|
c0ed083a5c | ||
|
|
04f04bb7a6 | ||
|
|
b8a3806ff9 | ||
|
|
ae49d41542 | ||
|
|
5f2255a3bc | ||
|
|
065ccfbe67 | ||
|
|
17727c9015 | ||
|
|
ea64e69b4d | ||
|
|
07ca6c2359 | ||
|
|
162558b1c2 | ||
|
|
10f9e8dce0 | ||
|
|
b02943d7ff | ||
|
|
40ad970ffa | ||
|
|
aefdfa786d | ||
|
|
1cf08955a0 | ||
|
|
4077a4c28b | ||
|
|
6c375ef297 | ||
|
|
f77fc5d182 | ||
|
|
6d1cc4c05d | ||
|
|
0775f0992f | ||
|
|
debb39105d | ||
|
|
3b4aa59bfb | ||
|
|
4e902c3964 | ||
|
|
3e325697e7 | ||
|
|
13b3e1e440 | ||
|
|
2b2406a4d0 | ||
|
|
048982c74a | ||
|
|
29b63a2ebb | ||
|
|
2a9cbdacfd | ||
|
|
35cfcdf4a9 | ||
|
|
06c1dc9afb | ||
|
|
18b58d584f | ||
|
|
a774791e65 | ||
|
|
bc22adae84 | ||
|
|
0eba82b221 | ||
|
|
4822ec3955 | ||
|
|
b845001467 | ||
|
|
25b6a15c9c | ||
|
|
1a3d035f78 | ||
|
|
a69f9f6e11 | ||
|
|
6efd9e4fcd | ||
|
|
3e948beb7a | ||
|
|
a8a491a0b7 | ||
|
|
2c0330898c | ||
|
|
e9794cfbf4 | ||
|
|
1694d858bc | ||
|
|
b79955ae9e | ||
|
|
803a8c5d17 | ||
|
|
c5cd15ad92 | ||
|
|
489b170888 | ||
|
|
9f57a322e8 | ||
|
|
86e113214d | ||
|
|
e791bb8893 | ||
|
|
f1220bd186 | ||
|
|
21d933cb11 | ||
|
|
e1c063d5f4 | ||
|
|
27d2b5c8a4 | ||
|
|
3b34d6ef27 | ||
|
|
bc1c8b8f46 | ||
|
|
2fa926ec02 | ||
|
|
d7891e1218 | ||
|
|
11685cd352 | ||
|
|
785127fe16 | ||
|
|
4a13bc5fea | ||
|
|
c7ad122050 | ||
|
|
28d63fc2e3 | ||
|
|
bb62cc0bcd | ||
|
|
740c79f087 | ||
|
|
33ab8e04a0 | ||
|
|
fcd3aac363 | ||
|
|
753d148d1b | ||
|
|
1bb47a9f13 | ||
|
|
40b4c26e0f | ||
|
|
97adae7b32 | ||
|
|
3d35a91314 | ||
|
|
0caa328b1e | ||
|
|
ab8c946914 | ||
|
|
e667537404 | ||
|
|
6bd2f2b823 | ||
|
|
8d8a8045c0 | ||
|
|
d5c669c72c | ||
|
|
28b268e175 | ||
|
|
33937d1ce7 | ||
|
|
e971778cc3 | ||
|
|
f99612ded3 | ||
|
|
50272bbbcf | ||
|
|
9a703f6190 | ||
|
|
f8fec7eec4 | ||
|
|
f6aadda4ed | ||
|
|
d8fca0f348 | ||
|
|
65ff4c4a31 | ||
|
|
90702bc7aa | ||
|
|
e81b788a1b | ||
|
|
ebc0ee7940 | ||
|
|
82d269daf1 | ||
|
|
9d5300d6ae | ||
|
|
8870e4d6fb | ||
|
|
7767e48e51 |
15
.github/workflows/checkstyle.yml
vendored
15
.github/workflows/checkstyle.yml
vendored
@@ -1,15 +0,0 @@
|
|||||||
name: Check PR Codestyle
|
|
||||||
on: [ pull_request ]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
checkstyle:
|
|
||||||
name: Checkstyle
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: dbelyaev/action-checkstyle@v0.5.1
|
|
||||||
with:
|
|
||||||
github_token: ${{ secrets.github_token }}
|
|
||||||
reporter: github-pr-review
|
|
||||||
level: warning
|
|
||||||
checkstyle_config: ../../config/checkstyle/checkstyle.xml
|
|
||||||
2
.github/workflows/publish-release.yml
vendored
2
.github/workflows/publish-release.yml
vendored
@@ -28,6 +28,8 @@ jobs:
|
|||||||
- name: Publish artifact
|
- name: Publish artifact
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
|
||||||
|
MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
|
||||||
|
|
||||||
# The GITHUB_REF tag comes in the format 'refs/tags/xxx'.
|
# The GITHUB_REF tag comes in the format 'refs/tags/xxx'.
|
||||||
# So if we split on '/' and take the 3rd value, we can get the release name.
|
# So if we split on '/' and take the 3rd value, we can get the release name.
|
||||||
|
|||||||
@@ -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.
|
|
||||||
60
README.md
60
README.md
@@ -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.38.2 Javadoc can be found [here](https://javadoc.jitpack.io/com/willfp/eco/6.38.2/javadoc/)
|
The 6.53.0 Javadoc can be found [here](https://javadoc.jitpack.io/com/willfp/eco/6.53.0/javadoc/)
|
||||||
|
|
||||||
## Plugin Information
|
## Plugin Information
|
||||||
|
|
||||||
@@ -51,31 +75,31 @@ depend:
|
|||||||
- eco
|
- eco
|
||||||
```
|
```
|
||||||
|
|
||||||
## Get from JitPack:
|
## Dependency Information:
|
||||||
|
|
||||||
Gradle:
|
Gradle:
|
||||||
|
|
||||||
```groovy
|
```kts
|
||||||
repositories {
|
repositories {
|
||||||
maven { url 'https://jitpack.io' }
|
maven("https://repo.auxilor.io/repository/maven-public/")
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
```groovy
|
```groovy
|
||||||
dependencies {
|
dependencies {
|
||||||
compileOnly 'com.willfp:eco:Tag'
|
compileOnly("com.willfp:eco:Tag")
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Replace `Tag` with a release tag for eco, eg `6.27.2`.
|
Replace `Tag` with a release tag for eco, eg `6.53.0`.
|
||||||
|
|
||||||
Maven:
|
Maven:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<repository>
|
<repository>
|
||||||
<id>jitpack.io</id>
|
<id>auxilor</id>
|
||||||
<url>https://jitpack.io</url>
|
<url>https://repo.auxilor.io/repository/maven-public/</url>
|
||||||
</repository>
|
</repository>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -88,7 +112,7 @@ Maven:
|
|||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
Replace `Tag` with a release tag for eco, eg `6.27.2`.
|
Replace `Tag` with a release tag for eco, eg `6.53.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!
|
||||||
|
|||||||
@@ -25,6 +25,8 @@ 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"))
|
||||||
|
implementation(project(path = ":eco-core:core-nms:v1_19_R3", configuration = "reobf"))
|
||||||
}
|
}
|
||||||
|
|
||||||
allprojects {
|
allprojects {
|
||||||
@@ -55,7 +57,7 @@ allprojects {
|
|||||||
maven("https://repo.extendedclip.com/content/repositories/placeholderapi/")
|
maven("https://repo.extendedclip.com/content/repositories/placeholderapi/")
|
||||||
|
|
||||||
// ProtocolLib
|
// ProtocolLib
|
||||||
maven("https://repo.dmulloy2.net/nexus/repository/public/")
|
//maven("https://repo.dmulloy2.net/nexus/repository/public/")
|
||||||
|
|
||||||
// WorldGuard
|
// WorldGuard
|
||||||
maven("https://maven.enginehub.org/repo/")
|
maven("https://maven.enginehub.org/repo/")
|
||||||
@@ -77,6 +79,15 @@ allprojects {
|
|||||||
|
|
||||||
// LibsDisguises
|
// LibsDisguises
|
||||||
maven("https://repo.md-5.net/content/groups/public/")
|
maven("https://repo.md-5.net/content/groups/public/")
|
||||||
|
|
||||||
|
// UltraEconomy
|
||||||
|
maven("https://repo.techscode.com/repository/maven-releases/")
|
||||||
|
|
||||||
|
// PlayerPoints
|
||||||
|
maven("https://repo.rosewooddev.io/repository/public/")
|
||||||
|
|
||||||
|
// Denizen
|
||||||
|
maven("https://maven.citizensnpcs.co/repo")
|
||||||
}
|
}
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
@@ -158,6 +169,7 @@ allprojects {
|
|||||||
relocate("org.litote", "com.willfp.eco.libs.litote")
|
relocate("org.litote", "com.willfp.eco.libs.litote")
|
||||||
relocate("org.reactivestreams", "com.willfp.eco.libs.reactivestreams")
|
relocate("org.reactivestreams", "com.willfp.eco.libs.reactivestreams")
|
||||||
relocate("reactor.", "com.willfp.eco.libs.reactor.") // Dot in name to be safe
|
relocate("reactor.", "com.willfp.eco.libs.reactor.") // Dot in name to be safe
|
||||||
|
relocate("com.moandjiezana.toml", "com.willfp.eco.libs.toml")
|
||||||
|
|
||||||
/*
|
/*
|
||||||
Kotlin and caffeine are not shaded so that they can be accessed directly by eco plugins.
|
Kotlin and caffeine are not shaded so that they can be accessed directly by eco plugins.
|
||||||
|
|||||||
@@ -1,38 +0,0 @@
|
|||||||
dependencies {
|
|
||||||
// Adventure
|
|
||||||
compileOnly 'net.kyori:adventure-platform-bukkit:4.1.0'
|
|
||||||
|
|
||||||
// Other
|
|
||||||
compileOnly 'org.spigotmc:spigot-api:1.17.1-R0.1-SNAPSHOT'
|
|
||||||
compileOnly 'com.comphenix.protocol:ProtocolLib:4.6.1-SNAPSHOT'
|
|
||||||
compileOnly 'com.google.code.gson:gson:2.8.8'
|
|
||||||
}
|
|
||||||
|
|
||||||
group 'com.willfp'
|
|
||||||
version rootProject.version
|
|
||||||
|
|
||||||
java {
|
|
||||||
withJavadocJar()
|
|
||||||
}
|
|
||||||
|
|
||||||
build.dependsOn publishToMavenLocal
|
|
||||||
|
|
||||||
publishing {
|
|
||||||
publications {
|
|
||||||
shadow(MavenPublication) {
|
|
||||||
from components.java
|
|
||||||
artifactId 'eco'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
repositories {
|
|
||||||
maven {
|
|
||||||
name = "GitHubPackages"
|
|
||||||
url = uri("https://maven.pkg.github.com/Auxilor/eco")
|
|
||||||
credentials {
|
|
||||||
username = System.getenv("GITHUB_ACTOR")
|
|
||||||
password = System.getenv("GITHUB_TOKEN")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
55
eco-api/build.gradle.kts
Normal file
55
eco-api/build.gradle.kts
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
dependencies {
|
||||||
|
// Adventure
|
||||||
|
compileOnly("net.kyori:adventure-platform-bukkit:4.1.0")
|
||||||
|
|
||||||
|
// Other
|
||||||
|
compileOnly("org.spigotmc:spigot-api:1.17.1-R0.1-SNAPSHOT")
|
||||||
|
compileOnly("com.comphenix.protocol:ProtocolLib:4.6.1-SNAPSHOT")
|
||||||
|
compileOnly("com.google.code.gson:gson:2.8.8")
|
||||||
|
}
|
||||||
|
|
||||||
|
group = "com.willfp"
|
||||||
|
version = rootProject.version
|
||||||
|
|
||||||
|
java {
|
||||||
|
withJavadocJar()
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks {
|
||||||
|
build {
|
||||||
|
dependsOn(publishToMavenLocal)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
publishing {
|
||||||
|
publications {
|
||||||
|
create<MavenPublication>("shadow") {
|
||||||
|
from(components["java"])
|
||||||
|
artifactId = "eco"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
name = "GitHubPackages"
|
||||||
|
url = uri("https://maven.pkg.github.com/Auxilor/eco")
|
||||||
|
credentials {
|
||||||
|
username = System.getenv("GITHUB_ACTOR")
|
||||||
|
password = System.getenv("GITHUB_TOKEN")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
publishing {
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
name = "Auxilor"
|
||||||
|
url = uri("https://repo.auxilor.io/repository/maven-releases/")
|
||||||
|
credentials {
|
||||||
|
username = System.getenv("MAVEN_USERNAME")
|
||||||
|
password = System.getenv("MAVEN_PASSWORD")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,82 +1,636 @@
|
|||||||
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.interfaces.Config;
|
||||||
|
import com.willfp.eco.core.config.interfaces.LoadableConfig;
|
||||||
|
import com.willfp.eco.core.config.updating.ConfigHandler;
|
||||||
|
import com.willfp.eco.core.data.ExtendedPersistentDataContainer;
|
||||||
|
import com.willfp.eco.core.data.PlayerProfile;
|
||||||
|
import com.willfp.eco.core.data.ServerProfile;
|
||||||
|
import com.willfp.eco.core.data.keys.PersistentDataKey;
|
||||||
|
import com.willfp.eco.core.drops.DropQueue;
|
||||||
|
import com.willfp.eco.core.entities.ai.EntityController;
|
||||||
|
import com.willfp.eco.core.events.EventManager;
|
||||||
|
import com.willfp.eco.core.extensions.ExtensionLoader;
|
||||||
|
import com.willfp.eco.core.factory.MetadataValueFactory;
|
||||||
|
import com.willfp.eco.core.factory.NamespacedKeyFactory;
|
||||||
|
import com.willfp.eco.core.factory.RunnableFactory;
|
||||||
|
import com.willfp.eco.core.fast.FastItemStack;
|
||||||
|
import com.willfp.eco.core.gui.menu.Menu;
|
||||||
|
import com.willfp.eco.core.gui.menu.MenuBuilder;
|
||||||
|
import com.willfp.eco.core.gui.menu.MenuType;
|
||||||
|
import com.willfp.eco.core.gui.slot.SlotBuilder;
|
||||||
|
import com.willfp.eco.core.gui.slot.functional.SlotProvider;
|
||||||
|
import com.willfp.eco.core.items.TestableItem;
|
||||||
|
import com.willfp.eco.core.packet.Packet;
|
||||||
|
import com.willfp.eco.core.placeholder.context.PlaceholderContext;
|
||||||
|
import com.willfp.eco.core.proxy.ProxyFactory;
|
||||||
|
import com.willfp.eco.core.scheduling.Scheduler;
|
||||||
|
import net.kyori.adventure.platform.bukkit.BukkitAudiences;
|
||||||
import org.apache.commons.lang.Validate;
|
import org.apache.commons.lang.Validate;
|
||||||
|
import org.bukkit.Location;
|
||||||
|
import org.bukkit.NamespacedKey;
|
||||||
|
import org.bukkit.configuration.ConfigurationSection;
|
||||||
|
import org.bukkit.entity.Entity;
|
||||||
|
import org.bukkit.entity.Mob;
|
||||||
|
import org.bukkit.entity.Player;
|
||||||
|
import org.bukkit.inventory.ItemStack;
|
||||||
|
import org.bukkit.inventory.meta.SkullMeta;
|
||||||
|
import org.bukkit.persistence.PersistentDataContainer;
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
import org.jetbrains.annotations.ApiStatus;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
import java.lang.annotation.Documented;
|
import java.util.List;
|
||||||
import java.lang.annotation.ElementType;
|
import java.util.Map;
|
||||||
import java.lang.annotation.Retention;
|
import java.util.Set;
|
||||||
import java.lang.annotation.RetentionPolicy;
|
import java.util.UUID;
|
||||||
import java.lang.annotation.Target;
|
import java.util.logging.Logger;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the instance of the eco handler for bridging between the frontend
|
* Holds the instance of eco for bridging between the frontend and backend.
|
||||||
* and backend.
|
* <p>
|
||||||
|
* <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 compatibility
|
||||||
|
* issues by. All parts of this have been abstracted into logically named API components that you
|
||||||
|
* can use.
|
||||||
*
|
*
|
||||||
* @see Eco#getHandler()
|
* @see Eco#get()
|
||||||
* @see Handler
|
|
||||||
*/
|
*/
|
||||||
@ApiStatus.Internal
|
@ApiStatus.Internal
|
||||||
public final class Eco {
|
public interface Eco {
|
||||||
/**
|
|
||||||
* Instance of eco handler.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
private static Handler handler;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the handler.
|
* Create a scheduler.
|
||||||
*
|
*
|
||||||
* @param handler The handler.
|
* @param plugin The plugin.
|
||||||
|
* @return The scheduler.
|
||||||
*/
|
*/
|
||||||
@ApiStatus.Internal
|
@NotNull
|
||||||
public static void setHandler(@NotNull final Handler handler) {
|
Scheduler createScheduler(@NotNull EcoPlugin plugin);
|
||||||
Validate.isTrue(Eco.handler == null, "Already initialized!");
|
|
||||||
|
|
||||||
Eco.handler = handler;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the instance of the eco handler; the bridge between the api frontend
|
* Create an event manager.
|
||||||
* and the implementation backend.
|
|
||||||
* <p>
|
|
||||||
* <strong>Do not use the handler in your plugins!</strong> It can and will contain
|
|
||||||
* breaking changes between minor versions and even patches, and you will create
|
|
||||||
* compatibility issues by using the handler. All parts of the handler have been abstracted
|
|
||||||
* into logically named API components that you can use.
|
|
||||||
* <p>
|
|
||||||
* Prior to version 6.12.0, the handler was considered as an API component, but it has
|
|
||||||
* since been moved into an internal component, and in 6.17.0, the first breaking change
|
|
||||||
* was introduced to {@link com.willfp.eco.core.config.wrapper.ConfigFactory}. This means
|
|
||||||
* that any usages of the handler can now cause problems in your plugins.
|
|
||||||
*
|
*
|
||||||
|
* @param plugin The plugin.F
|
||||||
|
* @return The event manager.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
EventManager createEventManager(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a NamespacedKey factory.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @return The factory.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
NamespacedKeyFactory createNamespacedKeyFactory(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a MetadataValue factory.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @return The factory.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
MetadataValueFactory createMetadataValueFactory(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a Runnable factory.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @return The factory.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
RunnableFactory createRunnableFactory(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create an ExtensionLoader.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @return The factory.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
ExtensionLoader createExtensionLoader(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a config handler.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
* @return The handler.
|
* @return The handler.
|
||||||
*/
|
*/
|
||||||
|
@NotNull
|
||||||
|
ConfigHandler createConfigHandler(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a logger.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @return The logger.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Logger createLogger(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get NOOP logger.
|
||||||
|
*
|
||||||
|
* @return The logger.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Logger getNOOPLogger();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a PAPI integration.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
*/
|
||||||
|
void createPAPIIntegration(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a proxy factory.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @return The factory.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
ProxyFactory createProxyFactory(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get eco Spigot plugin.
|
||||||
|
*
|
||||||
|
* @return The plugin.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
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 PluginCommandBase 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.
|
||||||
|
*
|
||||||
|
* @param configName The name of the config
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @param subDirectoryPath The subdirectory path.
|
||||||
|
* @param source The class that owns the resource.
|
||||||
|
* @param removeUnused Whether keys not present in the default config should be removed on update.
|
||||||
|
* @param type The config type.
|
||||||
|
* @param updateBlacklist Substring of keys to not add/remove keys for.
|
||||||
|
* @param requiresChangesToSave If the config must be changed in order to save the config.
|
||||||
|
* @return The config implementation.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
LoadableConfig createUpdatableConfig(@NotNull String configName,
|
||||||
|
@NotNull PluginLike plugin,
|
||||||
|
@NotNull String subDirectoryPath,
|
||||||
|
@NotNull Class<?> source,
|
||||||
|
boolean removeUnused,
|
||||||
|
@NotNull ConfigType type,
|
||||||
|
boolean requiresChangesToSave,
|
||||||
|
@NotNull String... updateBlacklist);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loadable config.
|
||||||
|
*
|
||||||
|
* @param configName The name of the config
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @param subDirectoryPath The subdirectory path.
|
||||||
|
* @param source The class that owns the resource.
|
||||||
|
* @param type The config type.
|
||||||
|
* @param requiresChangesToSave If the config must be changed in order to save the config.
|
||||||
|
* @return The config implementation.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
LoadableConfig createLoadableConfig(@NotNull String configName,
|
||||||
|
@NotNull PluginLike plugin,
|
||||||
|
@NotNull String subDirectoryPath,
|
||||||
|
@NotNull Class<?> source,
|
||||||
|
@NotNull ConfigType type,
|
||||||
|
boolean requiresChangesToSave);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create config.
|
||||||
|
*
|
||||||
|
* @param config The handle.
|
||||||
|
* @return The config implementation.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Config wrapConfigurationSection(@NotNull ConfigurationSection config);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create config.
|
||||||
|
*
|
||||||
|
* @param values The values.
|
||||||
|
* @param type The config type.
|
||||||
|
* @return The config implementation.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Config createConfig(@NotNull Map<String, Object> values,
|
||||||
|
@NotNull ConfigType type);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create config.
|
||||||
|
*
|
||||||
|
* @param contents The file contents.
|
||||||
|
* @param type The type.
|
||||||
|
* @return The config implementation.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Config createConfig(@NotNull String contents,
|
||||||
|
@NotNull ConfigType type);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a Drop Queue.
|
||||||
|
*
|
||||||
|
* @param player The player.
|
||||||
|
* @return The drop queue.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
DropQueue createDropQueue(@NotNull Player player);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create slot builder.
|
||||||
|
*
|
||||||
|
* @param provider The provider.
|
||||||
|
* @return The builder.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
SlotBuilder createSlotBuilder(@NotNull SlotProvider provider);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create menu builder.
|
||||||
|
*
|
||||||
|
* @param rows The amount of rows.
|
||||||
|
* @param type The type.
|
||||||
|
* @return The builder.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
MenuBuilder createMenuBuilder(int rows,
|
||||||
|
@NotNull MenuType type);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Combine the state of two menus together.
|
||||||
|
*
|
||||||
|
* @param base The base menu.
|
||||||
|
* @param additional The additional state.
|
||||||
|
* @return The menu.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Menu blendMenuState(@NotNull Menu base,
|
||||||
|
@NotNull Menu additional);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clean up ClassLoader (etc.) to allow PlugMan support.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin to clean up.
|
||||||
|
*/
|
||||||
|
void clean(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new plugin.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
*/
|
||||||
|
void addNewPlugin(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get plugin by name.
|
||||||
|
*
|
||||||
|
* @param name The name.
|
||||||
|
* @return The plugin.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
EcoPlugin getPluginByName(@NotNull String name);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all loaded eco plugins.
|
||||||
|
*
|
||||||
|
* @return A list of plugin names in lowercase.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
List<String> getLoadedPlugins();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a FastItemStack.
|
||||||
|
*
|
||||||
|
* @param itemStack The base ItemStack.
|
||||||
|
* @return The FastItemStack.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
FastItemStack createFastItemStack(@NotNull ItemStack itemStack);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register bStats metrics.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin.
|
||||||
|
*/
|
||||||
|
void registerBStats(@NotNull EcoPlugin plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get Adventure audiences.
|
||||||
|
*
|
||||||
|
* @return The audiences.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
BukkitAudiences getAdventure();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register a persistent data key to be stored.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
*/
|
||||||
|
void registerPersistentKey(@NotNull PersistentDataKey<?> key);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all registered keys.
|
||||||
|
*
|
||||||
|
* @return The keys.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Set<PersistentDataKey<?>> getRegisteredPersistentDataKeys();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load a player profile.
|
||||||
|
*
|
||||||
|
* @param uuid The UUID.
|
||||||
|
* @return The profile.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
PlayerProfile loadPlayerProfile(@NotNull UUID uuid);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load the server profile.
|
||||||
|
*
|
||||||
|
* @return The profile.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
ServerProfile getServerProfile();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create dummy entity - never spawned, exists purely in code.
|
||||||
|
*
|
||||||
|
* @param location The location.
|
||||||
|
* @return The entity.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
Entity createDummyEntity(@NotNull Location location);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a {@link NamespacedKey} quickly
|
||||||
|
* <p>
|
||||||
|
* Bypasses the constructor, allowing for the creation of invalid keys, therefore this is
|
||||||
|
* considered unsafe and should only be called after the key has been confirmed to be valid.
|
||||||
|
*
|
||||||
|
* @param namespace The namespace.
|
||||||
|
* @param key The key.
|
||||||
|
* @return The key.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
NamespacedKey createNamespacedKey(@NotNull String namespace,
|
||||||
|
@NotNull String key);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return or get props for a plugin.
|
||||||
|
*
|
||||||
|
* @param existing The existing constructor props.
|
||||||
|
* @param plugin The plugin.
|
||||||
|
* @return The props.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
PluginProps getProps(@Nullable PluginProps existing,
|
||||||
|
@NotNull Class<? extends EcoPlugin> plugin);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Format a string with MiniMessage.
|
||||||
|
*
|
||||||
|
* @param message The message.
|
||||||
|
* @return The formatted string.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
String formatMiniMessage(@NotNull String message);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create controlled entity from a mob.
|
||||||
|
*
|
||||||
|
* @param mob The mob.
|
||||||
|
* @param <T> The mob type.
|
||||||
|
* @return The controlled entity.
|
||||||
|
*/
|
||||||
|
@NotNull <T extends Mob> EntityController<T> createEntityController(@NotNull T mob);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adapt base PDC to extended PDC.
|
||||||
|
*
|
||||||
|
* @param container The container.
|
||||||
|
* @return The extended container.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
ExtendedPersistentDataContainer adaptPdc(@NotNull PersistentDataContainer container);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create new PDC.
|
||||||
|
*
|
||||||
|
* @return The container.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
PersistentDataContainer newPdc();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get item from SNBT.
|
||||||
|
*
|
||||||
|
* @param snbt The NBT string.
|
||||||
|
* @return The ItemStack, or null if invalid.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
ItemStack fromSNBT(@NotNull String snbt);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert item to SNBT.
|
||||||
|
*
|
||||||
|
* @param itemStack The item.
|
||||||
|
* @return The NBT string.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
String toSNBT(@NotNull ItemStack itemStack);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make TestableItem from SNBT.
|
||||||
|
*
|
||||||
|
* @param snbt The NBT string.
|
||||||
|
* @return The TestableItem.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
TestableItem testableItemFromSNBT(@NotNull String snbt);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the texture of a skull.
|
||||||
|
*
|
||||||
|
* @param meta The skull meta.
|
||||||
|
* @return The texture, or null if not found.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
String getSkullTexture(@NotNull SkullMeta meta);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the texture of a skull.
|
||||||
|
*
|
||||||
|
* @param meta The skull meta.
|
||||||
|
* @param base64 The texture.
|
||||||
|
*/
|
||||||
|
void setSkullTexture(@NotNull SkullMeta meta,
|
||||||
|
@NotNull String base64);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the current server TPS.
|
||||||
|
*
|
||||||
|
* @return The TPS.
|
||||||
|
*/
|
||||||
|
double getTPS();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Evaluate an expression.
|
||||||
|
*
|
||||||
|
* @param expression The expression.
|
||||||
|
* @param context The context.
|
||||||
|
* @return The value of the expression, or zero if invalid.
|
||||||
|
*/
|
||||||
|
double evaluate(@NotNull String expression,
|
||||||
|
@NotNull PlaceholderContext context);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the menu a player currently has open.
|
||||||
|
*
|
||||||
|
* @param player The player.
|
||||||
|
* @return The menu, or null if no menu open.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
Menu getOpenMenu(@NotNull Player player);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sync commands.
|
||||||
|
*/
|
||||||
|
void syncCommands();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unregister a command.
|
||||||
|
*
|
||||||
|
* @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);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translate placeholders in a string.
|
||||||
|
*
|
||||||
|
* @param text The text.
|
||||||
|
* @param context The context.
|
||||||
|
* @return The translated text.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
String translatePlaceholders(@NotNull String text,
|
||||||
|
@NotNull PlaceholderContext context);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the value of a placeholder.
|
||||||
|
*
|
||||||
|
* @param plugin The plugin that owns the placeholder.
|
||||||
|
* @param args The placeholder arguments.
|
||||||
|
* @param context The context.
|
||||||
|
* @return The value, or null if invalid.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
String getPlaceholderValue(@Nullable EcoPlugin plugin,
|
||||||
|
@NotNull String args,
|
||||||
|
@NotNull PlaceholderContext context);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the instance of eco; the bridge between the api frontend and the implementation backend.
|
||||||
|
*
|
||||||
|
* @return The instance of eco.
|
||||||
|
*/
|
||||||
@ApiStatus.Internal
|
@ApiStatus.Internal
|
||||||
public static Handler getHandler() {
|
static Eco get() {
|
||||||
return handler;
|
return Instance.get();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Eco Handler components are internals, so if a class is marked as a handler component,
|
* Manages the internal frontend -> backend communication.
|
||||||
* then it should be treated the same as if it was marked with {@link ApiStatus.Internal}.
|
|
||||||
* <p>
|
|
||||||
* If a class is marked with {@link HandlerComponent}, <strong>Do not reference it in
|
|
||||||
* your code!</strong> It can and will contain breaking changes between minor versions and
|
|
||||||
* even patches, and you will create compatibility issues by using them.
|
|
||||||
* <p>
|
|
||||||
* Handler components should also be marked with {@link ApiStatus.Internal} in order to
|
|
||||||
* cause compiler / IDE warnings.
|
|
||||||
*/
|
*/
|
||||||
@Documented
|
@ApiStatus.Internal
|
||||||
@Retention(RetentionPolicy.CLASS)
|
final class Instance {
|
||||||
@Target({ElementType.TYPE})
|
|
||||||
public @interface HandlerComponent {
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Instance of eco.
|
||||||
|
*/
|
||||||
|
@ApiStatus.Internal
|
||||||
|
private static Eco eco;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initialize eco.
|
||||||
|
*
|
||||||
|
* @param eco The instance of eco.
|
||||||
|
*/
|
||||||
|
@ApiStatus.Internal
|
||||||
|
static void set(@NotNull final Eco eco) {
|
||||||
|
Validate.isTrue(Instance.eco == null, "Already initialized!");
|
||||||
|
|
||||||
|
Instance.eco = eco;
|
||||||
}
|
}
|
||||||
|
|
||||||
private Eco() {
|
/**
|
||||||
|
* Get eco.
|
||||||
|
*
|
||||||
|
* @return eco.
|
||||||
|
*/
|
||||||
|
static Eco get() {
|
||||||
|
return eco;
|
||||||
|
}
|
||||||
|
|
||||||
|
private Instance() {
|
||||||
throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
|
throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
|
||||||
}
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,26 +13,34 @@ 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.integrations.placeholder.PlaceholderManager;
|
import com.willfp.eco.core.map.ListMap;
|
||||||
|
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.registry.Registrable;
|
||||||
|
import com.willfp.eco.core.registry.Registry;
|
||||||
import com.willfp.eco.core.scheduling.Scheduler;
|
import com.willfp.eco.core.scheduling.Scheduler;
|
||||||
|
import com.willfp.eco.core.version.OutdatedEcoVersionError;
|
||||||
|
import com.willfp.eco.core.version.Version;
|
||||||
import com.willfp.eco.core.web.UpdateChecker;
|
import com.willfp.eco.core.web.UpdateChecker;
|
||||||
import org.apache.commons.lang.Validate;
|
import org.apache.commons.lang.Validate;
|
||||||
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
|
|
||||||
import org.bukkit.Bukkit;
|
import org.bukkit.Bukkit;
|
||||||
|
import org.bukkit.NamespacedKey;
|
||||||
import org.bukkit.configuration.file.FileConfiguration;
|
import org.bukkit.configuration.file.FileConfiguration;
|
||||||
import org.bukkit.event.Listener;
|
import org.bukkit.event.Listener;
|
||||||
|
import org.bukkit.metadata.FixedMetadataValue;
|
||||||
import org.bukkit.plugin.Plugin;
|
import org.bukkit.plugin.Plugin;
|
||||||
import org.bukkit.plugin.java.JavaPlugin;
|
import org.bukkit.plugin.java.JavaPlugin;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.Arrays;
|
import java.util.Arrays;
|
||||||
import java.util.HashSet;
|
import java.util.HashSet;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Objects;
|
import java.util.Objects;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
|
import java.util.logging.Level;
|
||||||
import java.util.logging.Logger;
|
import java.util.logging.Logger;
|
||||||
import java.util.stream.Collectors;
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
@@ -51,27 +59,12 @@ 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", "MismatchedQueryAndUpdateOfCollection"})
|
||||||
public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
public abstract class EcoPlugin extends JavaPlugin implements PluginLike, Registrable {
|
||||||
/**
|
/**
|
||||||
* The polymart resource ID of the plugin.
|
* The properties (eco.yml).
|
||||||
*/
|
*/
|
||||||
private final int resourceId;
|
private final PluginProps props;
|
||||||
|
|
||||||
/**
|
|
||||||
* The bStats resource ID of the plugin.
|
|
||||||
*/
|
|
||||||
private final int bStatsId;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The package where proxy implementations are.
|
|
||||||
*/
|
|
||||||
private final String proxyPackage;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The color of the plugin, used in messages.
|
|
||||||
*/
|
|
||||||
private final String color;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loaded integrations.
|
* Loaded integrations.
|
||||||
@@ -79,12 +72,12 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
private final Set<String> loadedIntegrations = new HashSet<>();
|
private final Set<String> loadedIntegrations = new HashSet<>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The internal plugin scheduler.
|
* The plugin scheduler.
|
||||||
*/
|
*/
|
||||||
private final Scheduler scheduler;
|
private final Scheduler scheduler;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The internal plugin Event Manager.
|
* The plugin Event Manager.
|
||||||
*/
|
*/
|
||||||
private final EventManager eventManager;
|
private final EventManager eventManager;
|
||||||
|
|
||||||
@@ -99,17 +92,17 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
private final LangYml langYml;
|
private final LangYml langYml;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The internal factory to produce {@link org.bukkit.NamespacedKey}s.
|
* The factory to produce {@link org.bukkit.NamespacedKey}s.
|
||||||
*/
|
*/
|
||||||
private final NamespacedKeyFactory namespacedKeyFactory;
|
private final NamespacedKeyFactory namespacedKeyFactory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The internal factory to produce {@link org.bukkit.metadata.FixedMetadataValue}s.
|
* The factory to produce {@link org.bukkit.metadata.FixedMetadataValue}s.
|
||||||
*/
|
*/
|
||||||
private final MetadataValueFactory metadataValueFactory;
|
private final MetadataValueFactory metadataValueFactory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The internal factory to produce {@link com.willfp.eco.core.scheduling.RunnableTask}s.
|
* The factory to produce {@link com.willfp.eco.core.scheduling.RunnableTask}s.
|
||||||
*/
|
*/
|
||||||
private final RunnableFactory runnableFactory;
|
private final RunnableFactory runnableFactory;
|
||||||
|
|
||||||
@@ -133,24 +126,49 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
/**
|
/**
|
||||||
* The logger for the plugin.
|
* The logger for the plugin.
|
||||||
*/
|
*/
|
||||||
private final Logger logger;
|
private Logger logger;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If the server is running an outdated version of the plugin.
|
* If the server is running an outdated version of the plugin.
|
||||||
*/
|
*/
|
||||||
private boolean outdated = false;
|
private boolean outdated = false;
|
||||||
|
|
||||||
/**
|
|
||||||
* If the plugin supports extensions.
|
|
||||||
*/
|
|
||||||
private final boolean supportingExtensions;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The proxy factory.
|
* The proxy factory.
|
||||||
*/
|
*/
|
||||||
@Nullable
|
@Nullable
|
||||||
private final ProxyFactory proxyFactory;
|
private final ProxyFactory proxyFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tasks to run on enable.
|
||||||
|
*/
|
||||||
|
private final ListMap<LifecyclePosition, Runnable> onEnable = new ListMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tasks to run on disable.
|
||||||
|
*/
|
||||||
|
private final ListMap<LifecyclePosition, Runnable> onDisable = new ListMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tasks to run on reload.
|
||||||
|
*/
|
||||||
|
private final ListMap<LifecyclePosition, Runnable> onReload = new ListMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tasks to run on load.
|
||||||
|
*/
|
||||||
|
private final ListMap<LifecyclePosition, Runnable> onLoad = new ListMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tasks to run after load.
|
||||||
|
*/
|
||||||
|
private final ListMap<LifecyclePosition, Runnable> afterLoad = new ListMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tasks to run on task creation.
|
||||||
|
*/
|
||||||
|
private final ListMap<LifecyclePosition, Runnable> createTasks = new ListMap<>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new plugin.
|
* Create a new plugin.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -166,7 +184,9 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* Create a new plugin without proxy support, polymart, or bStats.
|
* Create a new plugin without proxy support, polymart, or bStats.
|
||||||
*
|
*
|
||||||
* @param color The color.
|
* @param color The color.
|
||||||
|
* @deprecated Use eco.yml instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0", forRemoval = true)
|
||||||
protected EcoPlugin(@NotNull final String color) {
|
protected EcoPlugin(@NotNull final String color) {
|
||||||
this("", color);
|
this("", color);
|
||||||
}
|
}
|
||||||
@@ -177,7 +197,9 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
*
|
*
|
||||||
* @param proxyPackage The package where proxy implementations are stored.
|
* @param proxyPackage The package where proxy implementations are stored.
|
||||||
* @param color The color of the plugin (used in messages, using standard formatting)
|
* @param color The color of the plugin (used in messages, using standard formatting)
|
||||||
|
* @deprecated Use eco.yml instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0", forRemoval = true)
|
||||||
protected EcoPlugin(@NotNull final String proxyPackage,
|
protected EcoPlugin(@NotNull final String proxyPackage,
|
||||||
@NotNull final String color) {
|
@NotNull final String color) {
|
||||||
this(0, 0, proxyPackage, color);
|
this(0, 0, proxyPackage, color);
|
||||||
@@ -189,7 +211,9 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @param resourceId The polymart resource ID for the plugin.
|
* @param resourceId The polymart resource ID for the plugin.
|
||||||
* @param bStatsId The bStats resource ID for the plugin.
|
* @param bStatsId The bStats resource ID for the plugin.
|
||||||
* @param color The color of the plugin (used in messages, using standard formatting)
|
* @param color The color of the plugin (used in messages, using standard formatting)
|
||||||
|
* @deprecated Use eco.yml instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0", forRemoval = true)
|
||||||
protected EcoPlugin(final int resourceId,
|
protected EcoPlugin(final int resourceId,
|
||||||
final int bStatsId,
|
final int bStatsId,
|
||||||
@NotNull final String color) {
|
@NotNull final String color) {
|
||||||
@@ -203,7 +227,9 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @param bStatsId The bStats resource ID for the plugin.
|
* @param bStatsId The bStats resource ID for the plugin.
|
||||||
* @param color The color of the plugin (used in messages, using standard formatting)
|
* @param color The color of the plugin (used in messages, using standard formatting)
|
||||||
* @param supportingExtensions If the plugin supports extensions.
|
* @param supportingExtensions If the plugin supports extensions.
|
||||||
|
* @deprecated Use eco.yml instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0", forRemoval = true)
|
||||||
protected EcoPlugin(final int resourceId,
|
protected EcoPlugin(final int resourceId,
|
||||||
final int bStatsId,
|
final int bStatsId,
|
||||||
@NotNull final String color,
|
@NotNull final String color,
|
||||||
@@ -218,7 +244,9 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @param bStatsId The bStats resource ID for the plugin.
|
* @param bStatsId The bStats resource ID for the plugin.
|
||||||
* @param proxyPackage The package where proxy implementations are stored.
|
* @param proxyPackage The package where proxy implementations are stored.
|
||||||
* @param color The color of the plugin (used in messages, using standard formatting)
|
* @param color The color of the plugin (used in messages, using standard formatting)
|
||||||
|
* @deprecated Use eco.yml instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0", forRemoval = true)
|
||||||
protected EcoPlugin(final int resourceId,
|
protected EcoPlugin(final int resourceId,
|
||||||
final int bStatsId,
|
final int bStatsId,
|
||||||
@NotNull final String proxyPackage,
|
@NotNull final String proxyPackage,
|
||||||
@@ -234,21 +262,15 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @param proxyPackage The package where proxy implementations are stored.
|
* @param proxyPackage The package where proxy implementations are stored.
|
||||||
* @param color The color of the plugin (used in messages, using standard formatting)
|
* @param color The color of the plugin (used in messages, using standard formatting)
|
||||||
* @param supportingExtensions If the plugin supports extensions.
|
* @param supportingExtensions If the plugin supports extensions.
|
||||||
|
* @deprecated Use eco.yml instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0", forRemoval = true)
|
||||||
protected EcoPlugin(final int resourceId,
|
protected EcoPlugin(final int resourceId,
|
||||||
final int bStatsId,
|
final int bStatsId,
|
||||||
@NotNull final String proxyPackage,
|
@NotNull final String proxyPackage,
|
||||||
@NotNull final String color,
|
@NotNull final String color,
|
||||||
final boolean supportingExtensions) {
|
final boolean supportingExtensions) {
|
||||||
this(
|
this(PluginProps.createSimple(resourceId, bStatsId, proxyPackage, color, supportingExtensions));
|
||||||
PluginProps.createSimple(
|
|
||||||
resourceId,
|
|
||||||
bStatsId,
|
|
||||||
proxyPackage,
|
|
||||||
color,
|
|
||||||
supportingExtensions
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -258,69 +280,72 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
*/
|
*/
|
||||||
protected EcoPlugin(@Nullable final PluginProps pluginProps) {
|
protected EcoPlugin(@Nullable final PluginProps pluginProps) {
|
||||||
/*
|
/*
|
||||||
The handler must be initialized before any plugin's constructors
|
Eco must be initialized before any plugin's constructors
|
||||||
are called, as the constructors call Eco#getHandler().
|
are called, as the constructors call Eco#get().
|
||||||
|
|
||||||
To fix this, EcoSpigotPlugin an abstract class and the 'actual'
|
To fix this, EcoSpigotPlugin an abstract class and the 'actual'
|
||||||
plugin class is EcoHandler - that way I can create the handler
|
plugin class is EcoImpl - that way I can initialize eco
|
||||||
before any plugins are loaded while still having a separation between
|
before any plugins are loaded while still having a separation between
|
||||||
the plugin class and the handler class (for code clarity).
|
the plugin class and the implementation class (for code clarity).
|
||||||
|
|
||||||
I don't really like the fact that the handler class *is* the
|
I don't really like the fact that the implementation class *is* the
|
||||||
spigot plugin, but it is what it is.
|
spigot plugin, but it is what it is.
|
||||||
|
|
||||||
There is probably a better way of doing it - maybe with
|
There is probably a better way of doing it - maybe with
|
||||||
some sort of HandlerCreator interface in order to still have
|
some sort of EcoCrater interface in order to still have
|
||||||
a standalone handler class, but then there would be an interface
|
a standalone eco class, but then there would be an interface
|
||||||
left in the API that doesn't really help anything.
|
left in the API that doesn't really help anything.
|
||||||
|
|
||||||
The other alternative would be to use reflection to get a 'createHandler'
|
The other alternative would be to use reflection to get a 'createEco'
|
||||||
method that only exists in EcoSpigotPlugin - but that feels filthy,
|
method that only exists in EcoSpigotPlugin - but that feels filthy,
|
||||||
and I'd rather only use reflection where necessary.
|
and I'd rather only use reflection where necessary.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
if (Eco.getHandler() == null && this instanceof Handler) {
|
if (Eco.get() == null && this instanceof Eco) {
|
||||||
/*
|
/*
|
||||||
This code is only ever called by EcoSpigotPlugin (EcoHandler)
|
This code is only ever called by EcoSpigotPlugin (EcoImpl)
|
||||||
as it's the first plugin to load, and it is a handler.
|
as it's the first plugin to load, and it's an instance of eco.
|
||||||
|
|
||||||
Any other plugins will never call this code as the handler
|
Any other plugins will never call this code as eco will have already
|
||||||
will have already been initialized.
|
been initialized.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
Eco.setHandler((Handler) this);
|
Eco.Instance.set((Eco) this);
|
||||||
}
|
}
|
||||||
|
|
||||||
assert Eco.getHandler() != null;
|
assert Eco.get() != null;
|
||||||
|
|
||||||
PluginProps generatedProps = Eco.getHandler().getProps(pluginProps, this.getClass());
|
PluginProps generatedProps = Eco.get().getProps(pluginProps, this.getClass());
|
||||||
generatedProps.validate();
|
generatedProps.validate();
|
||||||
PluginProps props = this.mutateProps(generatedProps);
|
PluginProps props = this.mutateProps(generatedProps);
|
||||||
props.validate();
|
props.validate();
|
||||||
|
|
||||||
this.resourceId = props.getResourceId();
|
this.props = props;
|
||||||
this.bStatsId = props.getBStatsId();
|
|
||||||
this.proxyPackage = props.getProxyPackage();
|
|
||||||
this.color = props.getColor();
|
|
||||||
this.supportingExtensions = props.isSupportingExtensions();
|
|
||||||
|
|
||||||
this.proxyFactory = this.proxyPackage.equalsIgnoreCase("") ? null : Eco.getHandler().createProxyFactory(this);
|
this.proxyFactory = this.props.getProxyPackage().equalsIgnoreCase("") ? null : Eco.get().createProxyFactory(this);
|
||||||
this.logger = Eco.getHandler().createLogger(this);
|
this.logger = Eco.get().createLogger(this);
|
||||||
|
|
||||||
this.getLogger().info("Initializing " + this.getColor() + this.getName());
|
this.getLogger().info("Initializing " + this.getColor() + this.getName());
|
||||||
|
|
||||||
this.scheduler = Eco.getHandler().createScheduler(this);
|
this.scheduler = Eco.get().createScheduler(this);
|
||||||
this.eventManager = Eco.getHandler().createEventManager(this);
|
this.eventManager = Eco.get().createEventManager(this);
|
||||||
this.namespacedKeyFactory = Eco.getHandler().createNamespacedKeyFactory(this);
|
this.namespacedKeyFactory = Eco.get().createNamespacedKeyFactory(this);
|
||||||
this.metadataValueFactory = Eco.getHandler().createMetadataValueFactory(this);
|
this.metadataValueFactory = Eco.get().createMetadataValueFactory(this);
|
||||||
this.runnableFactory = Eco.getHandler().createRunnableFactory(this);
|
this.runnableFactory = Eco.get().createRunnableFactory(this);
|
||||||
this.extensionLoader = Eco.getHandler().createExtensionLoader(this);
|
this.extensionLoader = Eco.get().createExtensionLoader(this);
|
||||||
this.configHandler = Eco.getHandler().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.getHandler().addNewPlugin(this);
|
Eco.get().addNewPlugin(this);
|
||||||
|
|
||||||
/*
|
/*
|
||||||
The minimum eco version check was moved here because it's very common
|
The minimum eco version check was moved here because it's very common
|
||||||
@@ -329,14 +354,14 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
they have an outdated version of eco installed.
|
they have an outdated version of eco installed.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
DefaultArtifactVersion runningVersion = new DefaultArtifactVersion(Eco.getHandler().getEcoPlugin().getDescription().getVersion());
|
Version runningVersion = new Version(Eco.get().getEcoPlugin().getDescription().getVersion());
|
||||||
DefaultArtifactVersion requiredVersion = new DefaultArtifactVersion(this.getMinimumEcoVersion());
|
Version requiredVersion = new Version(this.getMinimumEcoVersion());
|
||||||
if (!(runningVersion.compareTo(requiredVersion) > 0 || runningVersion.equals(requiredVersion))) {
|
if (!(runningVersion.compareTo(requiredVersion) > 0 || runningVersion.equals(requiredVersion))) {
|
||||||
this.getLogger().severe("You are running an outdated version of eco!");
|
this.getLogger().severe("You are running an outdated version of eco!");
|
||||||
this.getLogger().severe("You must be on at least" + this.getMinimumEcoVersion());
|
this.getLogger().severe("You must be on at least" + this.getMinimumEcoVersion());
|
||||||
this.getLogger().severe("Download the newest version here:");
|
this.getLogger().severe("Download the newest version here:");
|
||||||
this.getLogger().severe("https://polymart.org/download/773/recent/JSpprMspkuyecf5y1wQ2Jn8OoLQSQ_IW");
|
this.getLogger().severe("https://polymart.org/download/773/recent/JSpprMspkuyecf5y1wQ2Jn8OoLQSQ_IW");
|
||||||
Bukkit.getPluginManager().disablePlugin(this);
|
throw new OutdatedEcoVersionError("This plugin requires at least eco version " + this.getMinimumEcoVersion() + " to run.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -347,13 +372,12 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
public final void onEnable() {
|
public final void onEnable() {
|
||||||
super.onEnable();
|
super.onEnable();
|
||||||
|
|
||||||
this.getLogger().info("");
|
|
||||||
this.getLogger().info("Loading " + this.getColor() + this.getName());
|
this.getLogger().info("Loading " + this.getColor() + this.getName());
|
||||||
|
|
||||||
if (this.getResourceId() != 0 && !Eco.getHandler().getEcoPlugin().getConfigYml().getBool("no-update-checker")) {
|
if (this.getResourceId() != 0 && !Eco.get().getEcoPlugin().getConfigYml().getBool("no-update-checker")) {
|
||||||
new UpdateChecker(this).getVersion(version -> {
|
new UpdateChecker(this).getVersion(version -> {
|
||||||
DefaultArtifactVersion currentVersion = new DefaultArtifactVersion(this.getDescription().getVersion());
|
Version currentVersion = new Version(this.getDescription().getVersion());
|
||||||
DefaultArtifactVersion mostRecentVersion = new DefaultArtifactVersion(version);
|
Version mostRecentVersion = new Version(version);
|
||||||
if (!(currentVersion.compareTo(mostRecentVersion) > 0 || currentVersion.equals(mostRecentVersion))) {
|
if (!(currentVersion.compareTo(mostRecentVersion) > 0 || currentVersion.equals(mostRecentVersion))) {
|
||||||
this.outdated = true;
|
this.outdated = true;
|
||||||
this.getLogger().warning(this.getName() + " is out of date! (Version " + this.getDescription().getVersion() + ")");
|
this.getLogger().warning(this.getName() + " is out of date! (Version " + this.getDescription().getVersion() + ")");
|
||||||
@@ -364,56 +388,97 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (this.getBStatsId() != 0) {
|
if (this.getBStatsId() != 0) {
|
||||||
Eco.getHandler().registerBStats(this);
|
Eco.get().registerBStats(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
Set<String> enabledPlugins = Arrays.stream(Bukkit.getPluginManager().getPlugins())
|
Set<String> enabledPlugins = Arrays.stream(Bukkit.getPluginManager().getPlugins()).map(Plugin::getName).map(String::toLowerCase).collect(Collectors.toSet());
|
||||||
.map(Plugin::getName)
|
|
||||||
.map(String::toLowerCase)
|
|
||||||
.collect(Collectors.toSet());
|
|
||||||
|
|
||||||
if (enabledPlugins.contains("PlaceholderAPI".toLowerCase())) {
|
if (enabledPlugins.contains("PlaceholderAPI".toLowerCase())) {
|
||||||
this.loadedIntegrations.add("PlaceholderAPI");
|
Eco.get().createPAPIIntegration(this);
|
||||||
PlaceholderManager.addIntegration(Eco.getHandler().createPAPIIntegration(this));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
this.loadIntegrationLoaders().forEach(integrationLoader -> {
|
this.loadIntegrationLoaders().forEach(integrationLoader -> {
|
||||||
if (enabledPlugins.contains(integrationLoader.getPluginName().toLowerCase())) {
|
if (enabledPlugins.contains(integrationLoader.getPluginName().toLowerCase())) {
|
||||||
this.loadedIntegrations.add(integrationLoader.getPluginName());
|
try {
|
||||||
integrationLoader.load();
|
integrationLoader.load();
|
||||||
|
this.loadedIntegrations.add(integrationLoader.getPluginName());
|
||||||
|
} catch (Exception e) {
|
||||||
|
this.getLogger().warning("Failed to load integration for " + integrationLoader.getPluginName());
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
this.loadedIntegrations.removeIf(pl -> pl.equalsIgnoreCase(this.getName()));
|
||||||
|
|
||||||
|
if (!this.getLoadedIntegrations().isEmpty()) {
|
||||||
this.getLogger().info("Loaded integrations: " + String.join(", ", this.getLoadedIntegrations()));
|
this.getLogger().info("Loaded integrations: " + String.join(", ", this.getLoadedIntegrations()));
|
||||||
|
}
|
||||||
|
|
||||||
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);
|
||||||
|
|
||||||
this.getScheduler().runLater(this::afterLoad, 1);
|
// Run preliminary reload to resolve load order issues
|
||||||
|
this.getScheduler().runLater(() -> {
|
||||||
|
Logger before = this.getLogger();
|
||||||
|
// Temporary silence logger.
|
||||||
|
this.logger = Eco.get().getNOOPLogger();
|
||||||
|
|
||||||
|
this.reload(false);
|
||||||
|
|
||||||
|
this.logger = before;
|
||||||
|
}, 1);
|
||||||
|
|
||||||
|
this.getScheduler().runLater(this::afterLoad, 2);
|
||||||
|
|
||||||
if (this.isSupportingExtensions()) {
|
if (this.isSupportingExtensions()) {
|
||||||
this.getExtensionLoader().loadExtensions();
|
this.getExtensionLoader().loadExtensions();
|
||||||
|
|
||||||
if (this.getExtensionLoader().getLoadedExtensions().isEmpty()) {
|
if (!this.getExtensionLoader().getLoadedExtensions().isEmpty()) {
|
||||||
this.getLogger().info("&cNo extensions found");
|
List<String> loadedExtensions = this.getExtensionLoader().getLoadedExtensions().stream().map(
|
||||||
} else {
|
extension -> extension.getName() + " v" + extension.getVersion()
|
||||||
this.getLogger().info("Extensions Loaded:");
|
).toList();
|
||||||
this.getExtensionLoader().getLoadedExtensions().forEach(extension -> this.getLogger().info("- " + extension.getName() + " v" + extension.getVersion()));
|
|
||||||
|
this.getLogger().info(
|
||||||
|
"Loaded extensions: " +
|
||||||
|
String.join(", ", loadedExtensions)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this.handleEnable();
|
this.handleLifecycle(this.onEnable, this::handleEnable);
|
||||||
|
}
|
||||||
|
|
||||||
this.getLogger().info("");
|
/**
|
||||||
|
* Add new task to run on enable.
|
||||||
|
*
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onEnable(@NotNull final Runnable task) {
|
||||||
|
this.onEnable(LifecyclePosition.END, task);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run on enable.
|
||||||
|
*
|
||||||
|
* @param position The position to run the task.
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onEnable(@NotNull final LifecyclePosition position,
|
||||||
|
@NotNull final Runnable task) {
|
||||||
|
this.onEnable.append(position, task);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -426,14 +491,34 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
this.getEventManager().unregisterAllListeners();
|
this.getEventManager().unregisterAllListeners();
|
||||||
this.getScheduler().cancelAll();
|
this.getScheduler().cancelAll();
|
||||||
|
|
||||||
this.handleDisable();
|
this.handleLifecycle(this.onDisable, this::handleDisable);
|
||||||
|
|
||||||
if (this.isSupportingExtensions()) {
|
if (this.isSupportingExtensions()) {
|
||||||
this.getExtensionLoader().unloadExtensions();
|
this.getExtensionLoader().unloadExtensions();
|
||||||
}
|
}
|
||||||
|
|
||||||
this.getLogger().info("Cleaning up...");
|
this.getLogger().info("Cleaning up...");
|
||||||
Eco.getHandler().getCleaner().clean(this);
|
Eco.get().clean(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run on disable.
|
||||||
|
*
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onDisable(@NotNull final Runnable task) {
|
||||||
|
this.onDisable(LifecyclePosition.END, task);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run on disable.
|
||||||
|
*
|
||||||
|
* @param position The position to run the task.
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onDisable(@NotNull final LifecyclePosition position,
|
||||||
|
@NotNull final Runnable task) {
|
||||||
|
this.onDisable.append(position, task);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -443,7 +528,27 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
public final void onLoad() {
|
public final void onLoad() {
|
||||||
super.onLoad();
|
super.onLoad();
|
||||||
|
|
||||||
this.handleLoad();
|
this.handleLifecycle(this.onLoad, this::handleLoad);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run on load.
|
||||||
|
*
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onLoad(@NotNull final Runnable task) {
|
||||||
|
this.onLoad(LifecyclePosition.END, task);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run on load.
|
||||||
|
*
|
||||||
|
* @param position The position to run the task.
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onLoad(@NotNull final LifecyclePosition position,
|
||||||
|
@NotNull final Runnable task) {
|
||||||
|
this.onLoad.append(position, task);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -456,11 +561,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("");
|
||||||
@@ -475,7 +582,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
this.getLogger().severe("");
|
this.getLogger().severe("");
|
||||||
}
|
}
|
||||||
|
|
||||||
this.handleAfterLoad();
|
this.handleLifecycle(this.afterLoad, this::handleAfterLoad);
|
||||||
|
|
||||||
this.reload();
|
this.reload();
|
||||||
|
|
||||||
@@ -483,26 +590,82 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
extension.handleAfterLoad();
|
extension.handleAfterLoad();
|
||||||
}
|
}
|
||||||
|
|
||||||
this.getLogger().info("Loaded " + this.color + this.getName());
|
this.getLogger().info("Loaded " + this.props.getColor() + this.getName());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run after load.
|
||||||
|
*
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void afterLoad(@NotNull final Runnable task) {
|
||||||
|
this.afterLoad(LifecyclePosition.END, task);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run after load.
|
||||||
|
*
|
||||||
|
* @param position The position to run the task.
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void afterLoad(@NotNull final LifecyclePosition position,
|
||||||
|
@NotNull final Runnable task) {
|
||||||
|
this.afterLoad.append(position, task);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reload the plugin.
|
* Reload the plugin.
|
||||||
*/
|
*/
|
||||||
public final void reload() {
|
public final void reload() {
|
||||||
|
this.reload(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reload the plugin.
|
||||||
|
*
|
||||||
|
* @param cancelTasks If tasks should be cancelled.
|
||||||
|
*/
|
||||||
|
public final void reload(final boolean cancelTasks) {
|
||||||
this.getConfigHandler().updateConfigs();
|
this.getConfigHandler().updateConfigs();
|
||||||
|
|
||||||
|
if (cancelTasks) {
|
||||||
this.getScheduler().cancelAll();
|
this.getScheduler().cancelAll();
|
||||||
|
}
|
||||||
|
|
||||||
this.getConfigHandler().callUpdate();
|
this.getConfigHandler().callUpdate();
|
||||||
this.getConfigHandler().callUpdate(); // Call twice to fix issues
|
this.getConfigHandler().callUpdate(); // Call twice to fix issues
|
||||||
|
|
||||||
this.handleReload();
|
this.handleLifecycle(this.onReload, this::handleReload);
|
||||||
|
|
||||||
|
if (cancelTasks) {
|
||||||
|
this.handleLifecycle(this.createTasks, this::createTasks);
|
||||||
|
}
|
||||||
|
|
||||||
for (Extension extension : this.extensionLoader.getLoadedExtensions()) {
|
for (Extension extension : this.extensionLoader.getLoadedExtensions()) {
|
||||||
extension.handleReload();
|
extension.handleReload();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run on reload.
|
||||||
|
*
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onReload(@NotNull final Runnable task) {
|
||||||
|
this.onReload(LifecyclePosition.END, task);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new task to run on reload.
|
||||||
|
*
|
||||||
|
* @param position The position to run the task.
|
||||||
|
* @param task The task.
|
||||||
|
*/
|
||||||
|
public final void onReload(@NotNull final LifecyclePosition position,
|
||||||
|
@NotNull final Runnable task) {
|
||||||
|
this.onReload.append(position, task);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reload the plugin and return the time taken to reload.
|
* Reload the plugin and return the time taken to reload.
|
||||||
*
|
*
|
||||||
@@ -516,6 +679,43 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
return System.currentTimeMillis() - startTime;
|
return System.currentTimeMillis() - startTime;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle lifecycle.
|
||||||
|
*
|
||||||
|
* @param tasks The tasks.
|
||||||
|
* @param handler The handler.
|
||||||
|
*/
|
||||||
|
private void handleLifecycle(@NotNull final ListMap<LifecyclePosition, Runnable> tasks,
|
||||||
|
@NotNull final Runnable handler) {
|
||||||
|
for (Runnable task : tasks.get(LifecyclePosition.START)) {
|
||||||
|
try {
|
||||||
|
task.run();
|
||||||
|
} catch (final Exception e) {
|
||||||
|
this.getLogger().log(Level.SEVERE, "Error while running lifecycle task!");
|
||||||
|
this.getLogger().log(Level.SEVERE, "The plugin may not function properly");
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
handler.run();
|
||||||
|
} catch (final Exception e) {
|
||||||
|
this.getLogger().log(Level.SEVERE, "Error while running lifecycle task!");
|
||||||
|
this.getLogger().log(Level.SEVERE, "The plugin may not function properly");
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
|
||||||
|
for (Runnable task : tasks.get(LifecyclePosition.END)) {
|
||||||
|
try {
|
||||||
|
task.run();
|
||||||
|
} catch (final Exception e) {
|
||||||
|
this.getLogger().log(Level.SEVERE, "Error while running lifecycle task!");
|
||||||
|
this.getLogger().log(Level.SEVERE, "The plugin may not function properly");
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The plugin-specific code to be executed on enable.
|
* The plugin-specific code to be executed on enable.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -554,6 +754,15 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The plugin-specific code to create tasks.
|
||||||
|
* <p>
|
||||||
|
* Override when needed.
|
||||||
|
*/
|
||||||
|
protected void createTasks() {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The plugin-specific code to be executed after the server is up.
|
* The plugin-specific code to be executed after the server is up.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -597,22 +806,35 @@ 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.
|
||||||
*
|
*
|
||||||
* @return A list of all listeners.
|
* @return A list of all listeners.
|
||||||
*/
|
*/
|
||||||
protected abstract List<Listener> loadListeners();
|
protected List<Listener> loadListeners() {
|
||||||
|
return new ArrayList<>();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Useful for custom LangYml implementations.
|
* Useful for custom LangYml implementations.
|
||||||
@@ -622,7 +844,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;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -633,7 +863,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;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -643,10 +881,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
*/
|
*/
|
||||||
@Nullable
|
@Nullable
|
||||||
protected DisplayModule createDisplayModule() {
|
protected DisplayModule createDisplayModule() {
|
||||||
Validate.isTrue(
|
Validate.isTrue(this.getDisplayModule() == null, "Display module exists!");
|
||||||
this.getDisplayModule() == null,
|
|
||||||
"Display module exists!"
|
|
||||||
);
|
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
@@ -745,8 +980,9 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @param pluginName The name.
|
* @param pluginName The name.
|
||||||
* @return The plugin.
|
* @return The plugin.
|
||||||
*/
|
*/
|
||||||
|
@Nullable
|
||||||
public static EcoPlugin getPlugin(@NotNull final String pluginName) {
|
public static EcoPlugin getPlugin(@NotNull final String pluginName) {
|
||||||
return Eco.getHandler().getPluginByName(pluginName);
|
return Eco.get().getPluginByName(pluginName);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -754,8 +990,19 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
*
|
*
|
||||||
* @return The set of names.
|
* @return The set of names.
|
||||||
*/
|
*/
|
||||||
|
@NotNull
|
||||||
public static Set<String> getPluginNames() {
|
public static Set<String> getPluginNames() {
|
||||||
return new HashSet<>(Eco.getHandler().getLoadedPlugins());
|
return new HashSet<>(Eco.get().getLoadedPlugins());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the plugin props. (eco.yml).
|
||||||
|
*
|
||||||
|
* @return The props.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public PluginProps getProps() {
|
||||||
|
return this.props;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -764,7 +1011,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @return The resource ID.
|
* @return The resource ID.
|
||||||
*/
|
*/
|
||||||
public int getResourceId() {
|
public int getResourceId() {
|
||||||
return this.resourceId;
|
return this.getProps().getResourceId();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -773,7 +1020,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @return The ID.
|
* @return The ID.
|
||||||
*/
|
*/
|
||||||
public int getBStatsId() {
|
public int getBStatsId() {
|
||||||
return this.bStatsId;
|
return this.getProps().getBStatsId();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -782,7 +1029,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @return The package where proxies are contained.
|
* @return The package where proxies are contained.
|
||||||
*/
|
*/
|
||||||
public String getProxyPackage() {
|
public String getProxyPackage() {
|
||||||
return this.proxyPackage;
|
return this.getProps().getProxyPackage();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -791,7 +1038,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @return The color.
|
* @return The color.
|
||||||
*/
|
*/
|
||||||
public String getColor() {
|
public String getColor() {
|
||||||
return this.color;
|
return this.getProps().getColor();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -880,7 +1127,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
*
|
*
|
||||||
* @return The config handler.
|
* @return The config handler.
|
||||||
*/
|
*/
|
||||||
public ConfigHandler getConfigHandler() {
|
public @NotNull ConfigHandler getConfigHandler() {
|
||||||
return this.configHandler;
|
return this.configHandler;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -909,7 +1156,7 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
* @return If extensions are supported.
|
* @return If extensions are supported.
|
||||||
*/
|
*/
|
||||||
public boolean isSupportingExtensions() {
|
public boolean isSupportingExtensions() {
|
||||||
return this.supportingExtensions;
|
return this.getProps().isSupportingExtensions();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -921,4 +1168,47 @@ public abstract class EcoPlugin extends JavaPlugin implements PluginLike {
|
|||||||
public ProxyFactory getProxyFactory() {
|
public ProxyFactory getProxyFactory() {
|
||||||
return this.proxyFactory;
|
return this.proxyFactory;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a NamespacedKey.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
* @return The namespaced key.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public NamespacedKey createNamespacedKey(@NotNull final String key) {
|
||||||
|
return this.getNamespacedKeyFactory().create(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a metadata value.
|
||||||
|
*
|
||||||
|
* @param value The value.
|
||||||
|
* @return The metadata value.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public FixedMetadataValue createMetadataValue(@NotNull final Object value) {
|
||||||
|
return this.getMetadataValueFactory().create(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get if all {@link com.willfp.eco.core.data.keys.PersistentDataKey}'s for this
|
||||||
|
* plugin should be saved locally (via data.yml.) even if eco is using a database.
|
||||||
|
*
|
||||||
|
* @return If using local storage.
|
||||||
|
*/
|
||||||
|
public boolean isUsingLocalStorage() {
|
||||||
|
return this.configYml.isUsingLocalStorage();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
@NotNull
|
||||||
|
public final String getID() {
|
||||||
|
return Registry.tryFitPattern(this.getName());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public @NotNull File getFile() {
|
||||||
|
return super.getFile();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,312 +0,0 @@
|
|||||||
package com.willfp.eco.core;
|
|
||||||
|
|
||||||
import com.willfp.eco.core.config.updating.ConfigHandler;
|
|
||||||
import com.willfp.eco.core.config.wrapper.ConfigFactory;
|
|
||||||
import com.willfp.eco.core.data.ExtendedPersistentDataContainer;
|
|
||||||
import com.willfp.eco.core.data.ProfileHandler;
|
|
||||||
import com.willfp.eco.core.data.keys.KeyRegistry;
|
|
||||||
import com.willfp.eco.core.drops.DropQueueFactory;
|
|
||||||
import com.willfp.eco.core.entities.ai.EntityController;
|
|
||||||
import com.willfp.eco.core.events.EventManager;
|
|
||||||
import com.willfp.eco.core.extensions.ExtensionLoader;
|
|
||||||
import com.willfp.eco.core.factory.MetadataValueFactory;
|
|
||||||
import com.willfp.eco.core.factory.NamespacedKeyFactory;
|
|
||||||
import com.willfp.eco.core.factory.RunnableFactory;
|
|
||||||
import com.willfp.eco.core.fast.FastItemStack;
|
|
||||||
import com.willfp.eco.core.gui.GUIFactory;
|
|
||||||
import com.willfp.eco.core.integrations.placeholder.PlaceholderIntegration;
|
|
||||||
import com.willfp.eco.core.items.SNBTHandler;
|
|
||||||
import com.willfp.eco.core.proxy.Cleaner;
|
|
||||||
import com.willfp.eco.core.proxy.ProxyFactory;
|
|
||||||
import com.willfp.eco.core.scheduling.Scheduler;
|
|
||||||
import net.kyori.adventure.platform.bukkit.BukkitAudiences;
|
|
||||||
import org.bukkit.Location;
|
|
||||||
import org.bukkit.NamespacedKey;
|
|
||||||
import org.bukkit.entity.Entity;
|
|
||||||
import org.bukkit.entity.Mob;
|
|
||||||
import org.bukkit.inventory.ItemStack;
|
|
||||||
import org.bukkit.persistence.PersistentDataContainer;
|
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
import org.jetbrains.annotations.Nullable;
|
|
||||||
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.logging.Logger;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @see Eco#getHandler()
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
public interface Handler {
|
|
||||||
/**
|
|
||||||
* Create a scheduler.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The scheduler.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
Scheduler createScheduler(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create an event manager.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The event manager.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
EventManager createEventManager(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a NamespacedKey factory.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
NamespacedKeyFactory createNamespacedKeyFactory(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a MetadataValue factory.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
MetadataValueFactory createMetadataValueFactory(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a Runnable factory.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
RunnableFactory createRunnableFactory(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create an ExtensionLoader.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
ExtensionLoader createExtensionLoader(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a config handler.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The handler.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
ConfigHandler createConfigHandler(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a logger.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The logger.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
Logger createLogger(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a PAPI integration.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The integration.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
PlaceholderIntegration createPAPIIntegration(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a proxy factory.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
ProxyFactory createProxyFactory(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get eco Spigot plugin.
|
|
||||||
*
|
|
||||||
* @return The plugin.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
EcoPlugin getEcoPlugin();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get config factory.
|
|
||||||
*
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
ConfigFactory getConfigFactory();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get drop queue factory.
|
|
||||||
*
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
DropQueueFactory getDropQueueFactory();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get GUI factory.
|
|
||||||
*
|
|
||||||
* @return The factory.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
GUIFactory getGUIFactory();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get cleaner.
|
|
||||||
*
|
|
||||||
* @return The cleaner.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
Cleaner getCleaner();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add new plugin.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
*/
|
|
||||||
void addNewPlugin(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get plugin by name.
|
|
||||||
*
|
|
||||||
* @param name The name.
|
|
||||||
* @return The plugin.
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
EcoPlugin getPluginByName(@NotNull String name);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all loaded eco plugins.
|
|
||||||
*
|
|
||||||
* @return A list of plugin names in lowercase.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
List<String> getLoadedPlugins();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a FastItemStack.
|
|
||||||
*
|
|
||||||
* @param itemStack The base ItemStack.
|
|
||||||
* @return The FastItemStack.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
FastItemStack createFastItemStack(@NotNull ItemStack itemStack);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register bStats metrics.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin.
|
|
||||||
*/
|
|
||||||
void registerBStats(@NotNull EcoPlugin plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get Adventure audiences.
|
|
||||||
*
|
|
||||||
* @return The audiences.
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
BukkitAudiences getAdventure();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the key registry.
|
|
||||||
*
|
|
||||||
* @return The registry.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
KeyRegistry getKeyRegistry();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the PlayerProfile handler.
|
|
||||||
*
|
|
||||||
* @return The handler.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
ProfileHandler getProfileHandler();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create dummy entity - never spawned, exists purely in code.
|
|
||||||
*
|
|
||||||
* @param location The location.
|
|
||||||
* @return The entity.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
Entity createDummyEntity(@NotNull Location location);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a {@link NamespacedKey} quickly
|
|
||||||
* <p>
|
|
||||||
* Bypasses the constructor, allowing for the creation of invalid keys,
|
|
||||||
* therefore this is considered unsafe and should only be called after
|
|
||||||
* the key has been confirmed to be valid.
|
|
||||||
*
|
|
||||||
* @param namespace The namespace.
|
|
||||||
* @param key The key.
|
|
||||||
* @return The key.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
NamespacedKey createNamespacedKey(@NotNull String namespace,
|
|
||||||
@NotNull String key);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return or get props for a plugin.
|
|
||||||
*
|
|
||||||
* @param existing The existing constructor props.
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @return The props.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
PluginProps getProps(@Nullable PluginProps existing,
|
|
||||||
@NotNull Class<? extends EcoPlugin> plugin);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Format a string with MiniMessage.
|
|
||||||
*
|
|
||||||
* @param message The message.
|
|
||||||
* @return The formatted string.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
String formatMiniMessage(@NotNull String message);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create controlled entity from a mob.
|
|
||||||
*
|
|
||||||
* @param mob The mob.
|
|
||||||
* @param <T> The mob type.
|
|
||||||
* @return The controlled entity.
|
|
||||||
*/
|
|
||||||
@NotNull <T extends Mob> EntityController<T> createEntityController(@NotNull T mob);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Adapt base PDC to extended PDC.
|
|
||||||
*
|
|
||||||
* @param container The container.
|
|
||||||
* @return The extended container.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
ExtendedPersistentDataContainer adaptPdc(@NotNull PersistentDataContainer container);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create new PDC.
|
|
||||||
*
|
|
||||||
* @return The container.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
PersistentDataContainer newPdc();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get SNBT handler.
|
|
||||||
*
|
|
||||||
* @return The SNBT handler.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
SNBTHandler getSNBTHandler();
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
package com.willfp.eco.core;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks a position in a lifecycle (e.g. enable, reload, etc).
|
||||||
|
*/
|
||||||
|
public enum LifecyclePosition {
|
||||||
|
/**
|
||||||
|
* Run at the start of the lifecycle.
|
||||||
|
*/
|
||||||
|
START,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run at the end of the lifecycle.
|
||||||
|
*/
|
||||||
|
END
|
||||||
|
}
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
package com.willfp.eco.core;
|
|
||||||
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Quick DI class to manage passing eco plugins.
|
|
||||||
* <p>
|
|
||||||
* Basically just a quick bit of laziness if you can't be bothered to add a private field
|
|
||||||
* and a protected getter, don't use this in kotlin as you can just specify
|
|
||||||
* {@code
|
|
||||||
* private val plugin: EcoPlugin
|
|
||||||
* }
|
|
||||||
* in the constructor.
|
|
||||||
*
|
|
||||||
* @param <T> The eco plugin type.
|
|
||||||
*/
|
|
||||||
public abstract class PluginDependent<T extends EcoPlugin> {
|
|
||||||
/**
|
|
||||||
* The {@link EcoPlugin} that is stored.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
private final T plugin;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Pass an {@link EcoPlugin} in order to interface with it.
|
|
||||||
*
|
|
||||||
* @param plugin The plugin to manage.
|
|
||||||
*/
|
|
||||||
protected PluginDependent(@NotNull final T plugin) {
|
|
||||||
this.plugin = plugin;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the plugin.
|
|
||||||
*
|
|
||||||
* @return The plugin.
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
protected T getPlugin() {
|
|
||||||
return this.plugin;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
package com.willfp.eco.core;
|
package com.willfp.eco.core;
|
||||||
|
|
||||||
import com.willfp.eco.core.config.updating.ConfigHandler;
|
import com.willfp.eco.core.config.updating.ConfigHandler;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
import java.io.File;
|
import java.io.File;
|
||||||
import java.util.logging.Logger;
|
import java.util.logging.Logger;
|
||||||
@@ -13,12 +15,13 @@ import java.util.logging.Logger;
|
|||||||
*/
|
*/
|
||||||
public interface PluginLike {
|
public interface PluginLike {
|
||||||
/**
|
/**
|
||||||
* Get the data folder of the object.
|
* Get the data folder.
|
||||||
* <p>
|
* <p>
|
||||||
* Returns the plugin data folder for a plugin, or the extension's parent plugin's folder
|
* Returns the plugin data folder for a plugin, or the extension's parent plugin's folder
|
||||||
*
|
*
|
||||||
* @return The data folder.
|
* @return The data folder.
|
||||||
*/
|
*/
|
||||||
|
@NotNull
|
||||||
File getDataFolder();
|
File getDataFolder();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -26,6 +29,7 @@ public interface PluginLike {
|
|||||||
*
|
*
|
||||||
* @return The config handler.
|
* @return The config handler.
|
||||||
*/
|
*/
|
||||||
|
@NotNull
|
||||||
ConfigHandler getConfigHandler();
|
ConfigHandler getConfigHandler();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -33,5 +37,16 @@ public interface PluginLike {
|
|||||||
*
|
*
|
||||||
* @return The logger.
|
* @return The logger.
|
||||||
*/
|
*/
|
||||||
|
@NotNull
|
||||||
Logger getLogger();
|
Logger getLogger();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the actual file.
|
||||||
|
*
|
||||||
|
* @return The file, i.e. the jar file.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
default File getFile() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,6 +49,16 @@ public final class PluginProps {
|
|||||||
@Nullable
|
@Nullable
|
||||||
private Boolean supportingExtensions;
|
private Boolean supportingExtensions;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The environment variables.
|
||||||
|
*/
|
||||||
|
private final Map<String, String> environment = new HashMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the plugin uses reflective reload (via {@link com.willfp.eco.core.config.updating.ConfigUpdater}).
|
||||||
|
*/
|
||||||
|
private boolean usesReflectiveReload = true;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create new blank props.
|
* Create new blank props.
|
||||||
*/
|
*/
|
||||||
@@ -153,6 +163,46 @@ public final class PluginProps {
|
|||||||
this.supportingExtensions = supportingExtensions;
|
this.supportingExtensions = supportingExtensions;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get an environment variable.
|
||||||
|
*
|
||||||
|
* @param name The name.
|
||||||
|
* @return The value of the variable.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
public String getEnvironmentVariable(@NotNull final String name) {
|
||||||
|
return environment.get(name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set an environment variable.
|
||||||
|
*
|
||||||
|
* @param name The name.
|
||||||
|
* @param value The value.
|
||||||
|
*/
|
||||||
|
public void setEnvironmentVariable(@NotNull final String name,
|
||||||
|
@NotNull final String value) {
|
||||||
|
environment.put(name, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set if the plugin uses reflective reload.
|
||||||
|
*
|
||||||
|
* @return If the plugin uses reflective reload.
|
||||||
|
*/
|
||||||
|
public boolean isUsingReflectiveReload() {
|
||||||
|
return usesReflectiveReload;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set if the plugin uses reflective reload.
|
||||||
|
*
|
||||||
|
* @param usesReflectiveReload If the plugin uses reflective reload.
|
||||||
|
*/
|
||||||
|
public void setUsesReflectiveReload(final boolean usesReflectiveReload) {
|
||||||
|
this.usesReflectiveReload = usesReflectiveReload;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Ensure that all required props have been set.
|
* Ensure that all required props have been set.
|
||||||
*/
|
*/
|
||||||
@@ -221,7 +271,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.
|
||||||
@@ -232,7 +282,9 @@ public final class PluginProps {
|
|||||||
* @param color The primary color of the plugin.
|
* @param color The primary color of the plugin.
|
||||||
* @param supportsExtensions If the plugin should attempt to look for extensions.
|
* @param supportsExtensions If the plugin should attempt to look for extensions.
|
||||||
* @return The props.
|
* @return The props.
|
||||||
|
* @deprecated Moving to force the usage of eco.yml.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0")
|
||||||
static PluginProps createSimple(final int resourceId,
|
static PluginProps createSimple(final int resourceId,
|
||||||
final int bStatsId,
|
final int bStatsId,
|
||||||
@NotNull final String proxyPackage,
|
@NotNull final String proxyPackage,
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
package com.willfp.eco.core;
|
package com.willfp.eco.core;
|
||||||
|
|
||||||
import com.willfp.eco.core.integrations.economy.EconomyManager;
|
|
||||||
import com.willfp.eco.core.proxy.ProxyConstants;
|
import com.willfp.eco.core.proxy.ProxyConstants;
|
||||||
import com.willfp.eco.util.ClassUtils;
|
import com.willfp.eco.util.ClassUtils;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
@@ -31,14 +30,19 @@ public class Prerequisite {
|
|||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Requires the server to have vault installed.
|
* Requires the server to be running an implementation of paper.
|
||||||
*
|
|
||||||
* @deprecated Use {@link EconomyManager#hasRegistrations()} instead.
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(forRemoval = true)
|
public static final Prerequisite HAS_PROTOCOLLIB = new Prerequisite(
|
||||||
public static final Prerequisite HAS_VAULT = new Prerequisite(
|
() -> ClassUtils.exists("com.comphenix.protocol.events.PacketAdapter"),
|
||||||
() -> ClassUtils.exists("net.milkbowl.vault.economy.Economy"),
|
"Requires server to have ProtocolLib"
|
||||||
"Requires server to have vault"
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Requires the server to be running 1.19.4.
|
||||||
|
*/
|
||||||
|
public static final Prerequisite HAS_1_19_4 = new Prerequisite(
|
||||||
|
() -> ProxyConstants.NMS_VERSION.contains("19_R3"),
|
||||||
|
"Requires server to be running 1.19.4+"
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -57,20 +61,12 @@ public class Prerequisite {
|
|||||||
"Requires server to be running 1.18+"
|
"Requires server to be running 1.18+"
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
|
||||||
* Requires the server to be running 1.17.
|
|
||||||
*
|
|
||||||
* @deprecated eco no longer supports versions before 1.17.
|
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.25.2", forRemoval = true)
|
|
||||||
public static final Prerequisite HAS_1_17 = new Prerequisite(
|
|
||||||
() -> ProxyConstants.NMS_VERSION.contains("17") || HAS_1_18.isMet(),
|
|
||||||
"Requires server to be running 1.17+"
|
|
||||||
);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 +74,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)"
|
||||||
|
|||||||
@@ -1,30 +1,37 @@
|
|||||||
package com.willfp.eco.core.command;
|
package com.willfp.eco.core.command;
|
||||||
|
|
||||||
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.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.
|
||||||
@@ -39,79 +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>
|
* <p>
|
||||||
* Marked as default void with no implementation for backwards compatibility.
|
* 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.
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command execution from players.
|
||||||
|
* <p>
|
||||||
|
* This will only be called if the sender is a player.
|
||||||
|
*
|
||||||
|
* @param sender The sender.
|
||||||
|
* @param args The args.
|
||||||
|
* @throws NotificationException naturally, this is handled as a part of the command system.
|
||||||
|
*/
|
||||||
|
default void onExecute(@NotNull final Player sender, @NotNull final List<String> args) throws NotificationException {
|
||||||
// Do nothing.
|
// Do nothing.
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle tab completion.
|
* Handle tab completion.
|
||||||
* <p>
|
* <p>
|
||||||
* Marked as default void with no implementation for backwards compatibility.
|
* 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.
|
||||||
*/
|
*/
|
||||||
default List<String> tabComplete(@NotNull CommandSender sender,
|
@NotNull
|
||||||
@NotNull List<String> args) {
|
default List<String> tabComplete(@NotNull final CommandSender sender, @NotNull final List<String> args) {
|
||||||
return new ArrayList<>();
|
return new ArrayList<>();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle tab completion.
|
||||||
|
* <p>
|
||||||
|
* This will only be called if the sender is a player.
|
||||||
|
*
|
||||||
|
* @param sender The sender.
|
||||||
|
* @param args The args.
|
||||||
|
* @return The results.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
default List<String> tabComplete(@NotNull final Player sender, @NotNull final List<String> args) {
|
||||||
|
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)
|
|
||||||
CommandHandler getHandler();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the handler.
|
|
||||||
*
|
|
||||||
* @param handler The handler.
|
|
||||||
* @see CommandHandler
|
|
||||||
* @deprecated Handlers have been deprecated.
|
|
||||||
*/
|
|
||||||
@Deprecated(forRemoval = true)
|
|
||||||
void setHandler(@NotNull CommandHandler handler);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the tab completer.
|
|
||||||
*
|
|
||||||
* @return The tab completer.
|
|
||||||
* @see TabCompleteHandler
|
|
||||||
* @deprecated Use {@link CommandBase#tabComplete(CommandSender, List)} instead.
|
|
||||||
*/
|
|
||||||
@Deprecated(forRemoval = true)
|
|
||||||
TabCompleteHandler getTabCompleter();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the tab completer.
|
|
||||||
*
|
|
||||||
* @param handler The handler.
|
|
||||||
* @see TabCompleteHandler
|
|
||||||
* @deprecated Handlers have been deprecated.
|
|
||||||
*/
|
|
||||||
@Deprecated(forRemoval = true)
|
|
||||||
void setTabCompleter(@NotNull TabCompleteHandler handler);
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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);
|
|
||||||
}
|
|
||||||
@@ -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;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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);
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
package com.willfp.eco.core.command.impl;
|
||||||
|
|
||||||
|
import org.bukkit.command.Command;
|
||||||
|
import org.bukkit.command.CommandSender;
|
||||||
|
import org.bukkit.command.PluginIdentifiableCommand;
|
||||||
|
import org.bukkit.command.TabCompleter;
|
||||||
|
import org.bukkit.plugin.Plugin;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delegates a bukkit command to an eco command (for registrations).
|
||||||
|
*
|
||||||
|
* @deprecated Internal command implementations have been removed from the API.
|
||||||
|
*/
|
||||||
|
@Deprecated(since = "6.49.0", forRemoval = true)
|
||||||
|
public final class DelegatedBukkitCommand extends Command implements TabCompleter, PluginIdentifiableCommand {
|
||||||
|
/**
|
||||||
|
* The delegate command.
|
||||||
|
*/
|
||||||
|
private final PluginCommand delegate;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new delegated command.
|
||||||
|
*
|
||||||
|
* @param delegate The delegate.
|
||||||
|
*/
|
||||||
|
public DelegatedBukkitCommand(@NotNull final PluginCommand delegate) {
|
||||||
|
super(delegate.getName());
|
||||||
|
|
||||||
|
this.delegate = delegate;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean execute(@NotNull final CommandSender commandSender,
|
||||||
|
@NotNull final String label,
|
||||||
|
@NotNull final String[] args) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<String> onTabComplete(@NotNull final CommandSender commandSender,
|
||||||
|
@NotNull final Command command,
|
||||||
|
@NotNull final String label,
|
||||||
|
@NotNull final String[] args) {
|
||||||
|
return List.of();
|
||||||
|
}
|
||||||
|
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public Plugin getPlugin() {
|
||||||
|
return this.delegate.getPlugin();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public @NotNull String getPermission() {
|
||||||
|
return this.delegate.getPermission();
|
||||||
|
}
|
||||||
|
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String getDescription() {
|
||||||
|
return this.delegate.getDescription() == null ? "" : this.delegate.getDescription();
|
||||||
|
}
|
||||||
|
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public List<String> getAliases() {
|
||||||
|
return this.delegate.getAliases();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,287 +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));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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 {
|
|
||||||
return this.tabComplete(sender, Arrays.asList(args));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,26 +1,28 @@
|
|||||||
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 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.CommandSender;
|
|
||||||
import org.bukkit.command.TabCompleter;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
|
||||||
|
|
||||||
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.
|
||||||
*
|
*
|
||||||
@@ -33,64 +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,
|
|
||||||
* <p>
|
|
||||||
* Requires the command name to exist, defined in plugin.yml.
|
|
||||||
*/
|
|
||||||
public final void register() {
|
|
||||||
org.bukkit.command.PluginCommand command = Bukkit.getPluginCommand(this.getName());
|
|
||||||
assert command != null;
|
|
||||||
command.setExecutor(this);
|
|
||||||
command.setTabCompleter(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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
|
||||||
|
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 void register() {
|
||||||
|
delegate.register();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void unregister() {
|
||||||
|
delegate.unregister();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public EcoPlugin getPlugin() {
|
||||||
|
return delegate.getPlugin();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ public abstract class BaseConfig extends LoadableConfigWrapper {
|
|||||||
final boolean removeUnused,
|
final boolean removeUnused,
|
||||||
@NotNull final ConfigType type,
|
@NotNull final ConfigType type,
|
||||||
final boolean requiresChangeToSave) {
|
final boolean requiresChangeToSave) {
|
||||||
super(Eco.getHandler().getConfigFactory().createUpdatableConfig(
|
super(Eco.get().createUpdatableConfig(
|
||||||
configName,
|
configName,
|
||||||
plugin,
|
plugin,
|
||||||
"",
|
"",
|
||||||
|
|||||||
@@ -6,12 +6,12 @@ import org.jetbrains.annotations.Nullable;
|
|||||||
/**
|
/**
|
||||||
* Builder for configs to create them programmatically.
|
* Builder for configs to create them programmatically.
|
||||||
*/
|
*/
|
||||||
public class BuildableConfig extends TransientConfig {
|
public class BuildableConfig extends GenericConfig {
|
||||||
/**
|
/**
|
||||||
* Create a new empty config builder.
|
* Create a new empty config builder.
|
||||||
*/
|
*/
|
||||||
public BuildableConfig() {
|
public BuildableConfig() {
|
||||||
super();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -14,7 +14,12 @@ public enum ConfigType {
|
|||||||
/**
|
/**
|
||||||
* .yml config.
|
* .yml config.
|
||||||
*/
|
*/
|
||||||
YAML("yml");
|
YAML("yml"),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* .toml config.
|
||||||
|
*/
|
||||||
|
TOML("toml");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The file extension.
|
* The file extension.
|
||||||
|
|||||||
157
eco-api/src/main/java/com/willfp/eco/core/config/Configs.java
Normal file
157
eco-api/src/main/java/com/willfp/eco/core/config/Configs.java
Normal file
@@ -0,0 +1,157 @@
|
|||||||
|
package com.willfp.eco.core.config;
|
||||||
|
|
||||||
|
import com.willfp.eco.core.Eco;
|
||||||
|
import com.willfp.eco.core.config.interfaces.Config;
|
||||||
|
import org.bukkit.configuration.ConfigurationSection;
|
||||||
|
import org.bukkit.configuration.file.YamlConfiguration;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.InputStreamReader;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utilities / API methods for configs.
|
||||||
|
*/
|
||||||
|
public final class Configs {
|
||||||
|
/**
|
||||||
|
* Load a Config from a bukkit {@link ConfigurationSection}.
|
||||||
|
*
|
||||||
|
* @param config The ConfigurationSection.
|
||||||
|
* @return The config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config fromBukkit(@Nullable final ConfigurationSection config) {
|
||||||
|
return config == null ? empty() : Eco.get().wrapConfigurationSection(config);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load a config from an {@link InputStream}.
|
||||||
|
* <p>
|
||||||
|
* Only for yaml configs.
|
||||||
|
*
|
||||||
|
* @param stream The InputStream.
|
||||||
|
* @return The config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config fromStream(@Nullable final InputStream stream) {
|
||||||
|
return stream != null ? fromBukkit(YamlConfiguration.loadConfiguration(
|
||||||
|
new InputStreamReader(stream)
|
||||||
|
)) : empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load a config from a file.
|
||||||
|
*
|
||||||
|
* @param file The file.
|
||||||
|
* @return The config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config fromFile(@Nullable final File file) {
|
||||||
|
if (file == null) {
|
||||||
|
return empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
int lastIndex = file.getName().lastIndexOf(".");
|
||||||
|
|
||||||
|
if (lastIndex < 0) {
|
||||||
|
return empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
for (ConfigType type : ConfigType.values()) {
|
||||||
|
if (file.getName().substring(lastIndex + 1).equalsIgnoreCase(type.getExtension())) {
|
||||||
|
return fromFile(file, type);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load a config from a file.
|
||||||
|
*
|
||||||
|
* @param file The file.
|
||||||
|
* @param type The type.
|
||||||
|
* @return The config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config fromFile(@Nullable final File file,
|
||||||
|
@NotNull final ConfigType type) {
|
||||||
|
if (file == null) {
|
||||||
|
return empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return Eco.get().createConfig(Files.readString(file.toPath()), type);
|
||||||
|
} catch (IOException e) {
|
||||||
|
return empty();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load config from map (uses {@link ConfigType#JSON}).
|
||||||
|
*
|
||||||
|
* @param values The values.
|
||||||
|
* @return The config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config fromMap(@NotNull final Map<String, Object> values) {
|
||||||
|
return fromMap(values, ConfigType.JSON);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load config from map.
|
||||||
|
*
|
||||||
|
* @param values The values.
|
||||||
|
* @param type The type.
|
||||||
|
* @return The config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config fromMap(@NotNull final Map<String, Object> values,
|
||||||
|
@NotNull final ConfigType type) {
|
||||||
|
return Eco.get().createConfig(values, type);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create empty config (uses {@link ConfigType#JSON}).
|
||||||
|
*
|
||||||
|
* @return An empty config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config empty() {
|
||||||
|
return fromMap(new HashMap<>(), ConfigType.JSON);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create empty config.
|
||||||
|
*
|
||||||
|
* @param type The type.
|
||||||
|
* @return An empty config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config empty(@NotNull final ConfigType type) {
|
||||||
|
return fromMap(new HashMap<>(), type);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load config from string.
|
||||||
|
*
|
||||||
|
* @param contents The contents of the config.
|
||||||
|
* @param type The config type.
|
||||||
|
* @return The config.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static Config fromString(@NotNull final String contents,
|
||||||
|
@NotNull final ConfigType type) {
|
||||||
|
return Eco.get().createConfig(contents, type);
|
||||||
|
}
|
||||||
|
|
||||||
|
private Configs() {
|
||||||
|
throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -16,6 +16,8 @@ import org.jetbrains.annotations.NotNull;
|
|||||||
*/
|
*/
|
||||||
public abstract class ExtendableConfig extends LoadableConfigWrapper {
|
public abstract class ExtendableConfig extends LoadableConfigWrapper {
|
||||||
/**
|
/**
|
||||||
|
* Create a new extendable config.
|
||||||
|
*
|
||||||
* @param configName The name of the config
|
* @param configName The name of the config
|
||||||
* @param removeUnused Whether keys not present in the default config should be removed on update.
|
* @param removeUnused Whether keys not present in the default config should be removed on update.
|
||||||
* @param plugin The plugin.
|
* @param plugin The plugin.
|
||||||
@@ -31,7 +33,7 @@ public abstract class ExtendableConfig extends LoadableConfigWrapper {
|
|||||||
@NotNull final String subDirectoryPath,
|
@NotNull final String subDirectoryPath,
|
||||||
@NotNull final ConfigType type,
|
@NotNull final ConfigType type,
|
||||||
@NotNull final String... updateBlacklist) {
|
@NotNull final String... updateBlacklist) {
|
||||||
super(Eco.getHandler().getConfigFactory().createUpdatableConfig(
|
super(Eco.get().createUpdatableConfig(
|
||||||
configName,
|
configName,
|
||||||
plugin,
|
plugin,
|
||||||
subDirectoryPath,
|
subDirectoryPath,
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
package com.willfp.eco.core.config;
|
||||||
|
|
||||||
|
import com.willfp.eco.core.config.interfaces.Config;
|
||||||
|
import com.willfp.eco.core.config.wrapper.ConfigWrapper;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generic config to simplify creating custom configs without having
|
||||||
|
* to meddle with delegation.
|
||||||
|
*/
|
||||||
|
public abstract class GenericConfig extends ConfigWrapper<Config> {
|
||||||
|
/**
|
||||||
|
* Create a new generic config.
|
||||||
|
*/
|
||||||
|
protected GenericConfig() {
|
||||||
|
super(Configs.empty());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new generic config.
|
||||||
|
*
|
||||||
|
* @param type The config type.
|
||||||
|
*/
|
||||||
|
protected GenericConfig(@NotNull final ConfigType type) {
|
||||||
|
super(Configs.empty(type));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -21,7 +21,7 @@ public abstract class StaticBaseConfig extends LoadableConfigWrapper {
|
|||||||
protected StaticBaseConfig(@NotNull final String configName,
|
protected StaticBaseConfig(@NotNull final String configName,
|
||||||
@NotNull final PluginLike plugin,
|
@NotNull final PluginLike plugin,
|
||||||
@NotNull final ConfigType type) {
|
@NotNull final ConfigType type) {
|
||||||
super(Eco.getHandler().getConfigFactory().createLoadableConfig(
|
super(Eco.get().createLoadableConfig(
|
||||||
configName,
|
configName,
|
||||||
plugin,
|
plugin,
|
||||||
"",
|
"",
|
||||||
|
|||||||
@@ -20,13 +20,18 @@ import java.util.Map;
|
|||||||
* Config that exists purely in the code, not linked to any file.
|
* Config that exists purely in the code, not linked to any file.
|
||||||
* <p>
|
* <p>
|
||||||
* Use for inline configs to move data around or to add subsections to other configs.
|
* Use for inline configs to move data around or to add subsections to other configs.
|
||||||
|
*
|
||||||
|
* @deprecated Poorly named class, makes the config system seem needlessly complicated.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.44.0", forRemoval = true)
|
||||||
public class TransientConfig extends ConfigWrapper<Config> {
|
public class TransientConfig extends ConfigWrapper<Config> {
|
||||||
/**
|
/**
|
||||||
|
* Create new transient config from bukkit config.
|
||||||
|
*
|
||||||
* @param config The ConfigurationSection handle.
|
* @param config The ConfigurationSection handle.
|
||||||
*/
|
*/
|
||||||
public TransientConfig(@NotNull final ConfigurationSection config) {
|
public TransientConfig(@NotNull final ConfigurationSection config) {
|
||||||
super(Eco.getHandler().getConfigFactory().createConfig(config));
|
super(Eco.get().wrapConfigurationSection(config));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -39,30 +44,25 @@ public class TransientConfig extends ConfigWrapper<Config> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Create a transient config from an input stream.
|
||||||
|
*
|
||||||
* @param stream The InputStream.
|
* @param stream The InputStream.
|
||||||
*/
|
*/
|
||||||
public TransientConfig(@Nullable final InputStream stream) {
|
public TransientConfig(@Nullable final InputStream stream) {
|
||||||
super(stream != null ? Eco.getHandler().getConfigFactory().createConfig(YamlConfiguration.loadConfiguration(
|
super(stream != null ? Eco.get().wrapConfigurationSection(YamlConfiguration.loadConfiguration(
|
||||||
new InputStreamReader(stream)
|
new InputStreamReader(stream)
|
||||||
)) : new TransientConfig());
|
)) : new TransientConfig());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param file The File.
|
* Load a file to a config.
|
||||||
* @deprecated Specify the config type to prevent bugs.
|
*
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.30.0", forRemoval = true)
|
|
||||||
public TransientConfig(@Nullable final File file) {
|
|
||||||
this(file, ConfigType.YAML);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param file The file.
|
* @param file The file.
|
||||||
* @param type The config type to try read from.
|
* @param type The config type to try read from.
|
||||||
*/
|
*/
|
||||||
public TransientConfig(@Nullable final File file,
|
public TransientConfig(@Nullable final File file,
|
||||||
@NotNull final ConfigType type) {
|
@NotNull final ConfigType type) {
|
||||||
super(file != null ? Eco.getHandler().getConfigFactory().createConfig(readFile(file), type)
|
super(file != null ? Eco.get().createConfig(readFile(file), type)
|
||||||
: new TransientConfig());
|
: new TransientConfig());
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ public class TransientConfig extends ConfigWrapper<Config> {
|
|||||||
* @param values The values.
|
* @param values The values.
|
||||||
*/
|
*/
|
||||||
public TransientConfig(@NotNull final Map<String, Object> values) {
|
public TransientConfig(@NotNull final Map<String, Object> values) {
|
||||||
super(Eco.getHandler().getConfigFactory().createConfig(values, ConfigType.YAML));
|
super(Eco.get().createConfig(values, ConfigType.YAML));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -83,7 +83,7 @@ public class TransientConfig extends ConfigWrapper<Config> {
|
|||||||
*/
|
*/
|
||||||
public TransientConfig(@NotNull final Map<String, Object> values,
|
public TransientConfig(@NotNull final Map<String, Object> values,
|
||||||
@NotNull final ConfigType type) {
|
@NotNull final ConfigType type) {
|
||||||
super(Eco.getHandler().getConfigFactory().createConfig(values, type));
|
super(Eco.get().createConfig(values, type));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -94,12 +94,14 @@ public class TransientConfig extends ConfigWrapper<Config> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Load a config from a string.
|
||||||
|
*
|
||||||
* @param contents The contents of the config.
|
* @param contents The contents of the config.
|
||||||
* @param type The config type.
|
* @param type The config type.
|
||||||
*/
|
*/
|
||||||
public TransientConfig(@NotNull final String contents,
|
public TransientConfig(@NotNull final String contents,
|
||||||
@NotNull final ConfigType type) {
|
@NotNull final ConfigType type) {
|
||||||
super(Eco.getHandler().getConfigFactory().createConfig(contents, type));
|
super(Eco.get().createConfig(contents, type));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -9,6 +9,11 @@ import org.jetbrains.annotations.NotNull;
|
|||||||
* Default plugin config.yml.
|
* Default plugin config.yml.
|
||||||
*/
|
*/
|
||||||
public class ConfigYml extends BaseConfig {
|
public class ConfigYml extends BaseConfig {
|
||||||
|
/**
|
||||||
|
* The use local storage key.
|
||||||
|
*/
|
||||||
|
public static final String KEY_USES_LOCAL_STORAGE = "use-local-storage";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Config.yml.
|
* Config.yml.
|
||||||
*
|
*
|
||||||
@@ -52,4 +57,13 @@ public class ConfigYml extends BaseConfig {
|
|||||||
final boolean removeUnused) {
|
final boolean removeUnused) {
|
||||||
super(name, plugin, removeUnused, ConfigType.YAML);
|
super(name, plugin, removeUnused, ConfigType.YAML);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get if the plugin is using local storage.
|
||||||
|
*
|
||||||
|
* @return The prefix.
|
||||||
|
*/
|
||||||
|
public boolean isUsingLocalStorage() {
|
||||||
|
return this.getBool(KEY_USES_LOCAL_STORAGE);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,10 +2,11 @@ package com.willfp.eco.core.config.interfaces;
|
|||||||
|
|
||||||
import com.willfp.eco.core.config.BuildableConfig;
|
import com.willfp.eco.core.config.BuildableConfig;
|
||||||
import com.willfp.eco.core.config.ConfigType;
|
import com.willfp.eco.core.config.ConfigType;
|
||||||
import com.willfp.eco.core.config.TransientConfig;
|
import com.willfp.eco.core.config.Configs;
|
||||||
import com.willfp.eco.core.placeholder.AdditionalPlayer;
|
import com.willfp.eco.core.placeholder.AdditionalPlayer;
|
||||||
import com.willfp.eco.core.placeholder.InjectablePlaceholder;
|
import com.willfp.eco.core.placeholder.InjectablePlaceholder;
|
||||||
import com.willfp.eco.core.placeholder.PlaceholderInjectable;
|
import com.willfp.eco.core.placeholder.PlaceholderInjectable;
|
||||||
|
import com.willfp.eco.core.placeholder.context.PlaceholderContext;
|
||||||
import com.willfp.eco.util.NumberUtils;
|
import com.willfp.eco.util.NumberUtils;
|
||||||
import com.willfp.eco.util.StringUtils;
|
import com.willfp.eco.util.StringUtils;
|
||||||
import org.bukkit.configuration.ConfigurationSection;
|
import org.bukkit.configuration.ConfigurationSection;
|
||||||
@@ -30,16 +31,6 @@ import java.util.Set;
|
|||||||
*/
|
*/
|
||||||
@SuppressWarnings("unused")
|
@SuppressWarnings("unused")
|
||||||
public interface Config extends Cloneable, PlaceholderInjectable {
|
public interface Config extends Cloneable, PlaceholderInjectable {
|
||||||
/**
|
|
||||||
* Clears cache.
|
|
||||||
* <p>
|
|
||||||
* Configs no longer have caches as they have in previous versions.
|
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.31.1", forRemoval = true)
|
|
||||||
default void clearCache() {
|
|
||||||
// Do nothing.
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert the config into readable text.
|
* Convert the config into readable text.
|
||||||
*
|
*
|
||||||
@@ -103,7 +94,7 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull
|
||||||
default Config getSubsection(@NotNull String path) {
|
default Config getSubsection(@NotNull String path) {
|
||||||
return Objects.requireNonNullElse(getSubsectionOrNull(path), new TransientConfig());
|
return Objects.requireNonNullElse(getSubsectionOrNull(path), Configs.empty());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -144,7 +135,7 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
* @return The computed value, or 0 if not found or invalid.
|
* @return The computed value, or 0 if not found or invalid.
|
||||||
*/
|
*/
|
||||||
default int getIntFromExpression(@NotNull String path) {
|
default int getIntFromExpression(@NotNull String path) {
|
||||||
return getIntFromExpression(path, null);
|
return getIntFromExpression(path, PlaceholderContext.of(this));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -173,6 +164,18 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
return Double.valueOf(getDoubleFromExpression(path, player, additionalPlayers)).intValue();
|
return Double.valueOf(getDoubleFromExpression(path, player, additionalPlayers)).intValue();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a decimal value via a mathematical expression.
|
||||||
|
*
|
||||||
|
* @param path The key to fetch the value from.
|
||||||
|
* @param context The placeholder context.
|
||||||
|
* @return The computed value, or 0 if not found or invalid.
|
||||||
|
*/
|
||||||
|
default int getIntFromExpression(@NotNull String path,
|
||||||
|
@NotNull PlaceholderContext context) {
|
||||||
|
return Double.valueOf(getDoubleFromExpression(path, context)).intValue();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an integer from config.
|
* Get an integer from config.
|
||||||
@@ -266,6 +269,22 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
return getString(path, true, option);
|
return getString(path, true, option);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a formatted string from config.
|
||||||
|
*
|
||||||
|
* @param path The key to fetch the value from.
|
||||||
|
* @param context The placeholder context.
|
||||||
|
* @return The found value, or an empty string if not found.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
default String getFormattedString(@NotNull String path,
|
||||||
|
@NotNull PlaceholderContext context) {
|
||||||
|
return Objects.requireNonNullElse(
|
||||||
|
getFormattedStringOrNull(path, context),
|
||||||
|
""
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a string from config.
|
* Get a string from config.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -298,7 +317,7 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
* Get a formatted string from config.
|
* Get a formatted string from config.
|
||||||
*
|
*
|
||||||
* @param path The key to fetch the value from.
|
* @param path The key to fetch the value from.
|
||||||
* @return The found value, or an empty string if not found.
|
* @return The found value, or null if not found.
|
||||||
*/
|
*/
|
||||||
@Nullable
|
@Nullable
|
||||||
default String getFormattedStringOrNull(@NotNull String path) {
|
default String getFormattedStringOrNull(@NotNull String path) {
|
||||||
@@ -310,7 +329,7 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
*
|
*
|
||||||
* @param path The key to fetch the value from.
|
* @param path The key to fetch the value from.
|
||||||
* @param option The format option.
|
* @param option The format option.
|
||||||
* @return The found value, or an empty string if not found.
|
* @return The found value, or null if not found.
|
||||||
*/
|
*/
|
||||||
@Nullable
|
@Nullable
|
||||||
default String getFormattedStringOrNull(@NotNull String path,
|
default String getFormattedStringOrNull(@NotNull String path,
|
||||||
@@ -318,6 +337,25 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
return getStringOrNull(path, true, option);
|
return getStringOrNull(path, true, option);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a formatted string from config.
|
||||||
|
*
|
||||||
|
* @param path The key to fetch the value from.
|
||||||
|
* @param context The placeholder context.
|
||||||
|
* @return The found value, or null if not found.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
default String getFormattedStringOrNull(@NotNull String path,
|
||||||
|
@NotNull PlaceholderContext context) {
|
||||||
|
String nullable = getStringOrNull(path);
|
||||||
|
|
||||||
|
if (nullable == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return StringUtils.format(nullable, context.withInjectableContext(this));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a string from config.
|
* Get a string from config.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -372,6 +410,24 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
return getStrings(path, true, option);
|
return getStrings(path, true, option);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a list of strings from config.
|
||||||
|
* <p>
|
||||||
|
* Formatted.
|
||||||
|
*
|
||||||
|
* @param path The key to fetch the value from.
|
||||||
|
* @param context The placeholder context.
|
||||||
|
* @return The found value, or a blank {@link java.util.ArrayList} if not found.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
default List<String> getFormattedStrings(@NotNull String path,
|
||||||
|
@NotNull PlaceholderContext context) {
|
||||||
|
return Objects.requireNonNullElse(
|
||||||
|
getFormattedStringsOrNull(path, context),
|
||||||
|
new ArrayList<>()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a list of strings from config.
|
* Get a list of strings from config.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -428,6 +484,30 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
return getStringsOrNull(path, true, option);
|
return getStringsOrNull(path, true, option);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a list of strings from config.
|
||||||
|
* <p>
|
||||||
|
* Formatted.
|
||||||
|
*
|
||||||
|
* @param path The key to fetch the value from.
|
||||||
|
* @param context The placeholder context.
|
||||||
|
* @return The found value, or null if not found.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
default List<String> getFormattedStringsOrNull(@NotNull String path,
|
||||||
|
@NotNull PlaceholderContext context) {
|
||||||
|
List<String> nullable = getStringsOrNull(path);
|
||||||
|
|
||||||
|
if (nullable == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return StringUtils.formatList(
|
||||||
|
nullable,
|
||||||
|
context.withInjectableContext(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a list of strings from config.
|
* Get a list of strings from config.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -473,7 +553,7 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
* @return The computed value, or 0 if not found or invalid.
|
* @return The computed value, or 0 if not found or invalid.
|
||||||
*/
|
*/
|
||||||
default double getDoubleFromExpression(@NotNull String path) {
|
default double getDoubleFromExpression(@NotNull String path) {
|
||||||
return getDoubleFromExpression(path, null);
|
return getDoubleFromExpression(path, PlaceholderContext.of(this));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -485,7 +565,7 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
*/
|
*/
|
||||||
default double getDoubleFromExpression(@NotNull String path,
|
default double getDoubleFromExpression(@NotNull String path,
|
||||||
@Nullable Player player) {
|
@Nullable Player player) {
|
||||||
return NumberUtils.evaluateExpression(this.getString(path), player, this);
|
return getDoubleFromExpression(path, player, Collections.emptyList());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -499,7 +579,24 @@ public interface Config extends Cloneable, PlaceholderInjectable {
|
|||||||
default double getDoubleFromExpression(@NotNull String path,
|
default double getDoubleFromExpression(@NotNull String path,
|
||||||
@Nullable Player player,
|
@Nullable Player player,
|
||||||
@NotNull Collection<AdditionalPlayer> additionalPlayers) {
|
@NotNull Collection<AdditionalPlayer> additionalPlayers) {
|
||||||
return NumberUtils.evaluateExpression(this.getString(path), player, this, additionalPlayers);
|
return getDoubleFromExpression(path, new PlaceholderContext(
|
||||||
|
player,
|
||||||
|
null,
|
||||||
|
this,
|
||||||
|
additionalPlayers
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a decimal value via a mathematical expression.
|
||||||
|
*
|
||||||
|
* @param path The key to fetch the value from.
|
||||||
|
* @param context The placeholder context.
|
||||||
|
* @return The computed value, or 0 if not found or invalid.
|
||||||
|
*/
|
||||||
|
default double getDoubleFromExpression(@NotNull String path,
|
||||||
|
@NotNull PlaceholderContext context) {
|
||||||
|
return NumberUtils.evaluateExpression(this.getString(path), context.withInjectableContext(this));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package com.willfp.eco.core.config.interfaces;
|
|||||||
|
|
||||||
import org.bukkit.configuration.file.YamlConfiguration;
|
import org.bukkit.configuration.file.YamlConfiguration;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
|
||||||
|
|
||||||
import java.io.File;
|
import java.io.File;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
@@ -44,21 +43,6 @@ public interface LoadableConfig extends Config {
|
|||||||
*/
|
*/
|
||||||
String getName();
|
String getName();
|
||||||
|
|
||||||
/**
|
|
||||||
* Get bukkit {@link YamlConfiguration}.
|
|
||||||
* <p>
|
|
||||||
* This used to represent the underlying config, but since 6.30.0 configs use
|
|
||||||
* their own implementations internally, without relying on bukkit.
|
|
||||||
*
|
|
||||||
* @return The config, or null if config is not yaml-based.
|
|
||||||
* @deprecated Use toBukkit() instead.
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
@Deprecated(since = "6.30.0", forRemoval = true)
|
|
||||||
default YamlConfiguration getBukkitHandle() {
|
|
||||||
return this.toBukkit();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert the config to a bukkit {@link YamlConfiguration}.
|
* Convert the config to a bukkit {@link YamlConfiguration}.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -38,6 +38,9 @@ import java.lang.annotation.Target;
|
|||||||
* <p>
|
* <p>
|
||||||
* By having a plugin as a parameter, you shouldn't really need getInstance()
|
* By having a plugin as a parameter, you shouldn't really need getInstance()
|
||||||
* calls in your code.
|
* calls in your code.
|
||||||
|
*
|
||||||
|
* While flexible, this can lead to long initialization times, so this feature
|
||||||
|
* can be disabled in eco.yml with the uses-reflective-reload option.
|
||||||
*/
|
*/
|
||||||
@Retention(RetentionPolicy.RUNTIME)
|
@Retention(RetentionPolicy.RUNTIME)
|
||||||
@Target(ElementType.METHOD)
|
@Target(ElementType.METHOD)
|
||||||
|
|||||||
@@ -1,87 +0,0 @@
|
|||||||
package com.willfp.eco.core.config.wrapper;
|
|
||||||
|
|
||||||
import com.willfp.eco.core.Eco;
|
|
||||||
import com.willfp.eco.core.PluginLike;
|
|
||||||
import com.willfp.eco.core.config.ConfigType;
|
|
||||||
import com.willfp.eco.core.config.interfaces.Config;
|
|
||||||
import com.willfp.eco.core.config.interfaces.LoadableConfig;
|
|
||||||
import org.bukkit.configuration.ConfigurationSection;
|
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
|
|
||||||
import java.util.Map;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Internal component to create backend config implementations.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
@Eco.HandlerComponent
|
|
||||||
public interface ConfigFactory {
|
|
||||||
/**
|
|
||||||
* Updatable config.
|
|
||||||
*
|
|
||||||
* @param configName The name of the config
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @param subDirectoryPath The subdirectory path.
|
|
||||||
* @param source The class that owns the resource.
|
|
||||||
* @param removeUnused Whether keys not present in the default config should be removed on update.
|
|
||||||
* @param type The config type.
|
|
||||||
* @param updateBlacklist Substring of keys to not add/remove keys for.
|
|
||||||
* @param requiresChangesToSave If the config must be changed in order to save the config.
|
|
||||||
* @return The config implementation.
|
|
||||||
*/
|
|
||||||
LoadableConfig createUpdatableConfig(@NotNull String configName,
|
|
||||||
@NotNull PluginLike plugin,
|
|
||||||
@NotNull String subDirectoryPath,
|
|
||||||
@NotNull Class<?> source,
|
|
||||||
boolean removeUnused,
|
|
||||||
@NotNull ConfigType type,
|
|
||||||
boolean requiresChangesToSave,
|
|
||||||
@NotNull String... updateBlacklist);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Loadable config.
|
|
||||||
*
|
|
||||||
* @param configName The name of the config
|
|
||||||
* @param plugin The plugin.
|
|
||||||
* @param subDirectoryPath The subdirectory path.
|
|
||||||
* @param source The class that owns the resource.
|
|
||||||
* @param type The config type.
|
|
||||||
* @param requiresChangesToSave If the config must be changed in order to save the config.
|
|
||||||
* @return The config implementation.
|
|
||||||
*/
|
|
||||||
LoadableConfig createLoadableConfig(@NotNull String configName,
|
|
||||||
@NotNull PluginLike plugin,
|
|
||||||
@NotNull String subDirectoryPath,
|
|
||||||
@NotNull Class<?> source,
|
|
||||||
@NotNull ConfigType type,
|
|
||||||
boolean requiresChangesToSave);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create config.
|
|
||||||
*
|
|
||||||
* @param config The handle.
|
|
||||||
* @return The config implementation.
|
|
||||||
*/
|
|
||||||
Config createConfig(@NotNull ConfigurationSection config);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create config.
|
|
||||||
*
|
|
||||||
* @param values The values.
|
|
||||||
* @param type The config type.
|
|
||||||
* @return The config implementation.
|
|
||||||
*/
|
|
||||||
Config createConfig(@NotNull Map<String, Object> values,
|
|
||||||
@NotNull ConfigType type);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create config.
|
|
||||||
*
|
|
||||||
* @param contents The file contents.
|
|
||||||
* @param type The type.
|
|
||||||
* @return The config implementation.
|
|
||||||
*/
|
|
||||||
Config createConfig(@NotNull String contents,
|
|
||||||
@NotNull ConfigType type);
|
|
||||||
}
|
|
||||||
@@ -19,7 +19,7 @@ import java.util.Set;
|
|||||||
*
|
*
|
||||||
* @param <T> The type of the handle.
|
* @param <T> The type of the handle.
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({"MethodDoesntCallSuperMethod", "removal"})
|
@SuppressWarnings("MethodDoesntCallSuperMethod")
|
||||||
public abstract class ConfigWrapper<T extends Config> implements Config {
|
public abstract class ConfigWrapper<T extends Config> implements Config {
|
||||||
/**
|
/**
|
||||||
* Configs from eco have an internal implementation,
|
* Configs from eco have an internal implementation,
|
||||||
@@ -42,12 +42,6 @@ public abstract class ConfigWrapper<T extends Config> implements Config {
|
|||||||
this.handle = handle;
|
this.handle = handle;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
@Deprecated(since = "6.31.1", forRemoval = true)
|
|
||||||
public void clearCache() {
|
|
||||||
handle.clearCache();
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String toPlaintext() {
|
public String toPlaintext() {
|
||||||
return handle.toPlaintext();
|
return handle.toPlaintext();
|
||||||
|
|||||||
@@ -87,7 +87,7 @@ public interface ExtendedPersistentDataContainer {
|
|||||||
* @return The extended container.
|
* @return The extended container.
|
||||||
*/
|
*/
|
||||||
static ExtendedPersistentDataContainer extend(@NotNull PersistentDataContainer base) {
|
static ExtendedPersistentDataContainer extend(@NotNull PersistentDataContainer base) {
|
||||||
return Eco.getHandler().adaptPdc(base);
|
return Eco.get().adaptPdc(base);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -96,6 +96,6 @@ public interface ExtendedPersistentDataContainer {
|
|||||||
* @return The extended container.
|
* @return The extended container.
|
||||||
*/
|
*/
|
||||||
static ExtendedPersistentDataContainer create() {
|
static ExtendedPersistentDataContainer create() {
|
||||||
return extend(Eco.getHandler().newPdc());
|
return extend(Eco.get().newPdc());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,148 @@
|
|||||||
|
package com.willfp.eco.core.data;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.function.Supplier;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A simple store key-value store for data to be stored outside of plugins.
|
||||||
|
*/
|
||||||
|
@SuppressWarnings("unchecked")
|
||||||
|
public final class ExternalDataStore {
|
||||||
|
/**
|
||||||
|
* The store.
|
||||||
|
*/
|
||||||
|
private static final Map<String, Object> DATA = new HashMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The store adapters.
|
||||||
|
*/
|
||||||
|
private static final List<ExternalDataStoreObjectAdapter<?, ?>> STORE_ADAPTERS = new ArrayList<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Put data into the store.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
* @param value The value.
|
||||||
|
*/
|
||||||
|
public static void put(@NotNull final String key,
|
||||||
|
@NotNull final Object value) {
|
||||||
|
doPut(key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Put data into the store.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
* @param value The value.
|
||||||
|
* @param <A> The stored type.
|
||||||
|
*/
|
||||||
|
private static <A> void doPut(@NotNull final String key,
|
||||||
|
@NotNull final A value) {
|
||||||
|
Object storedValue = value;
|
||||||
|
|
||||||
|
for (ExternalDataStoreObjectAdapter<?, ?> unknownAdapter : STORE_ADAPTERS) {
|
||||||
|
if (unknownAdapter.getAccessedClass().isInstance(value)) {
|
||||||
|
ExternalDataStoreObjectAdapter<A, ?> adapter = (ExternalDataStoreObjectAdapter<A, ?>) unknownAdapter;
|
||||||
|
storedValue = adapter.toStoredObject(value);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
DATA.put(key, storedValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get data from the store.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
* @param clazz The class.
|
||||||
|
* @param <T> The type.
|
||||||
|
* @return The value.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
public static <T> T get(@NotNull final String key,
|
||||||
|
@NotNull final Class<T> clazz) {
|
||||||
|
return doGet(key, clazz);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get data from the store.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
* @param clazz The class.
|
||||||
|
* @param <A> The accessed type.
|
||||||
|
* @param <S> The stored type.
|
||||||
|
* @return The value.
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
private static <A, S> A doGet(@NotNull final String key,
|
||||||
|
@NotNull final Class<A> clazz) {
|
||||||
|
Object value = DATA.get(key);
|
||||||
|
|
||||||
|
for (ExternalDataStoreObjectAdapter<?, ?> unknownAdapter : STORE_ADAPTERS) {
|
||||||
|
if (unknownAdapter.getStoredClass().isInstance(value) && unknownAdapter.getAccessedClass().equals(clazz)) {
|
||||||
|
ExternalDataStoreObjectAdapter<A, S> adapter = (ExternalDataStoreObjectAdapter<A, S>) unknownAdapter;
|
||||||
|
value = adapter.toAccessedObject((S) value);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (clazz.isInstance(value)) {
|
||||||
|
return clazz.cast(value);
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get data from the store.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
* @param clazz The class.
|
||||||
|
* @param defaultValue The default value.
|
||||||
|
* @param <T> The type.
|
||||||
|
* @return The value.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static <T> T get(@NotNull final String key,
|
||||||
|
@NotNull final Class<T> clazz,
|
||||||
|
@NotNull final T defaultValue) {
|
||||||
|
T value = get(key, clazz);
|
||||||
|
return value == null ? defaultValue : value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get data from the store.
|
||||||
|
*
|
||||||
|
* @param key The key.
|
||||||
|
* @param clazz The class.
|
||||||
|
* @param defaultValue The default value.
|
||||||
|
* @param <T> The type.
|
||||||
|
* @return The value.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static <T> T get(@NotNull final String key,
|
||||||
|
@NotNull final Class<T> clazz,
|
||||||
|
@NotNull final Supplier<T> defaultValue) {
|
||||||
|
return get(key, clazz, defaultValue.get());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register a new adapter.
|
||||||
|
*
|
||||||
|
* @param adapter The adapter.
|
||||||
|
*/
|
||||||
|
public static void registerAdapter(@NotNull final ExternalDataStoreObjectAdapter<?, ?> adapter) {
|
||||||
|
STORE_ADAPTERS.add(adapter);
|
||||||
|
}
|
||||||
|
|
||||||
|
private ExternalDataStore() {
|
||||||
|
throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
package com.willfp.eco.core.data;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An adapter for objects stored in {@link ExternalDataStore}.
|
||||||
|
*
|
||||||
|
* @param <A> The accessed class.
|
||||||
|
* @param <S> The stored class.
|
||||||
|
*/
|
||||||
|
public abstract class ExternalDataStoreObjectAdapter<A, S> {
|
||||||
|
/**
|
||||||
|
* The class that is accessed (read / written).
|
||||||
|
*/
|
||||||
|
private final Class<? extends A> accessedClass;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The class that is stored internally.
|
||||||
|
*/
|
||||||
|
private final Class<? extends S> storedClass;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new adapter.
|
||||||
|
*
|
||||||
|
* @param accessedClass The class that is accessed (read / written).
|
||||||
|
* @param storedClass The class that is stored internally.
|
||||||
|
*/
|
||||||
|
protected ExternalDataStoreObjectAdapter(@NotNull final Class<? extends A> accessedClass,
|
||||||
|
@NotNull final Class<? extends S> storedClass) {
|
||||||
|
this.accessedClass = accessedClass;
|
||||||
|
this.storedClass = storedClass;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert an object to the stored object.
|
||||||
|
*
|
||||||
|
* @param obj The object.
|
||||||
|
* @return The stored object.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public abstract S toStoredObject(@NotNull final A obj);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert an object to the accessed object.
|
||||||
|
*
|
||||||
|
* @param obj The object.
|
||||||
|
* @return The accessed object.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public abstract A toAccessedObject(@NotNull final S obj);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the class that is accessed (read / written).
|
||||||
|
*
|
||||||
|
* @return The class.
|
||||||
|
*/
|
||||||
|
public Class<? extends A> getAccessedClass() {
|
||||||
|
return accessedClass;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the class that is stored internally.
|
||||||
|
*
|
||||||
|
* @return The class.
|
||||||
|
*/
|
||||||
|
public Class<? extends S> getStoredClass() {
|
||||||
|
return storedClass;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -31,6 +31,6 @@ public interface PlayerProfile extends Profile {
|
|||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull
|
||||||
static PlayerProfile load(@NotNull final UUID uuid) {
|
static PlayerProfile load(@NotNull final UUID uuid) {
|
||||||
return Eco.getHandler().getProfileHandler().load(uuid);
|
return Eco.get().loadPlayerProfile(uuid);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,94 +0,0 @@
|
|||||||
package com.willfp.eco.core.data;
|
|
||||||
|
|
||||||
import com.willfp.eco.core.Eco;
|
|
||||||
import com.willfp.eco.core.data.keys.PersistentDataKey;
|
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
|
|
||||||
import java.util.Set;
|
|
||||||
import java.util.UUID;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* API to handle profiles.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
@Eco.HandlerComponent
|
|
||||||
public interface ProfileHandler {
|
|
||||||
/**
|
|
||||||
* Load a player profile.
|
|
||||||
*
|
|
||||||
* @param uuid The UUID.
|
|
||||||
* @return The profile.
|
|
||||||
*/
|
|
||||||
PlayerProfile load(@NotNull UUID uuid);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Load the server profile.
|
|
||||||
*
|
|
||||||
* @return The profile.
|
|
||||||
*/
|
|
||||||
ServerProfile loadServerProfile();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Unload a player profile from memory.
|
|
||||||
* <p>
|
|
||||||
* This will not save the profile first.
|
|
||||||
*
|
|
||||||
* @param uuid The uuid.
|
|
||||||
*/
|
|
||||||
void unloadPlayer(@NotNull UUID uuid);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Save a player profile.
|
|
||||||
* <p>
|
|
||||||
* Can run async if using MySQL.
|
|
||||||
*
|
|
||||||
* @param uuid The uuid.
|
|
||||||
* @deprecated Saving changes is faster and should be used. Saving a player manually is not recommended.
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
default void savePlayer(@NotNull UUID uuid) {
|
|
||||||
this.saveKeysFor(uuid, PersistentDataKey.values());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Save keys for a player.
|
|
||||||
* <p>
|
|
||||||
* Can run async if using MySQL.
|
|
||||||
*
|
|
||||||
* @param uuid The uuid.
|
|
||||||
* @param keys The keys.
|
|
||||||
*/
|
|
||||||
void saveKeysFor(@NotNull UUID uuid,
|
|
||||||
@NotNull Set<PersistentDataKey<?>> keys);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Save all player data.
|
|
||||||
*
|
|
||||||
* @param async If the saving should be done asynchronously.
|
|
||||||
* @deprecated async is now handled automatically depending on implementation.
|
|
||||||
*/
|
|
||||||
@Deprecated(forRemoval = true)
|
|
||||||
default void saveAll(boolean async) {
|
|
||||||
saveAll();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Save all player data.
|
|
||||||
* <p>
|
|
||||||
* Can run async if using MySQL.
|
|
||||||
*
|
|
||||||
* @deprecated Never used.
|
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.36.0", forRemoval = true)
|
|
||||||
default void saveAll() {
|
|
||||||
// Do nothing.
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Commit all changes to the file.
|
|
||||||
* <p>
|
|
||||||
* Does nothing if using MySQL.
|
|
||||||
*/
|
|
||||||
void save();
|
|
||||||
}
|
|
||||||
@@ -9,6 +9,22 @@ import org.jetbrains.annotations.NotNull;
|
|||||||
* Profiles save automatically, so there is no need to save after changes.
|
* Profiles save automatically, so there is no need to save after changes.
|
||||||
*/
|
*/
|
||||||
public interface ServerProfile extends Profile {
|
public interface ServerProfile extends Profile {
|
||||||
|
/**
|
||||||
|
* Get the server ID.
|
||||||
|
*
|
||||||
|
* @return The server ID.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
String getServerID();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the local server ID.
|
||||||
|
*
|
||||||
|
* @return The local server ID.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
String getLocalServerID();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load the server profile.
|
* Load the server profile.
|
||||||
*
|
*
|
||||||
@@ -16,6 +32,6 @@ public interface ServerProfile extends Profile {
|
|||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull
|
||||||
static ServerProfile load() {
|
static ServerProfile load() {
|
||||||
return Eco.getHandler().getProfileHandler().loadServerProfile();
|
return Eco.get().getServerProfile();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
package com.willfp.eco.core.data.keys;
|
|
||||||
|
|
||||||
import com.willfp.eco.core.Eco;
|
|
||||||
import org.bukkit.NamespacedKey;
|
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
import org.jetbrains.annotations.Nullable;
|
|
||||||
|
|
||||||
import java.util.Set;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* API to register persistent data keys.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
@Eco.HandlerComponent
|
|
||||||
public interface KeyRegistry {
|
|
||||||
/**
|
|
||||||
* Register a persistent data key to be stored.
|
|
||||||
*
|
|
||||||
* @param key The key.
|
|
||||||
*/
|
|
||||||
void registerKey(@NotNull PersistentDataKey<?> key);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all registered keys.
|
|
||||||
*
|
|
||||||
* @return The keys.
|
|
||||||
*/
|
|
||||||
Set<PersistentDataKey<?>> getRegisteredKeys();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get persistent data key from namespaced key.
|
|
||||||
*
|
|
||||||
* @param namespacedKey The key.
|
|
||||||
* @return The key, or null if not found.
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
PersistentDataKey<?> getKeyFrom(@NotNull NamespacedKey namespacedKey);
|
|
||||||
}
|
|
||||||
@@ -43,7 +43,7 @@ public final class PersistentDataKey<T> {
|
|||||||
this.defaultValue = defaultValue;
|
this.defaultValue = defaultValue;
|
||||||
this.type = type;
|
this.type = type;
|
||||||
|
|
||||||
Eco.getHandler().getKeyRegistry().registerKey(this);
|
Eco.get().registerPersistentKey(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
@@ -82,51 +82,13 @@ public final class PersistentDataKey<T> {
|
|||||||
return this.type;
|
return this.type;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* In older eco versions, keys would have to be categorized in order
|
|
||||||
* to register the columns in the MySQL database. This is no longer needed.
|
|
||||||
* <p>
|
|
||||||
* Old description is below:
|
|
||||||
* <p>
|
|
||||||
* Categorize key as a server key, will register new column to MySQL
|
|
||||||
* database immediately rather than waiting for auto-categorization.
|
|
||||||
* <p>
|
|
||||||
* This will improve performance.
|
|
||||||
*
|
|
||||||
* @return The key.
|
|
||||||
* @deprecated Not required since the new MySQL data handler was introduced.
|
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.40.0", forRemoval = true)
|
|
||||||
public PersistentDataKey<T> server() {
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* In older eco versions, keys would have to be categorized in order
|
|
||||||
* to register the columns in the MySQL database. This is no longer needed.
|
|
||||||
* <p>
|
|
||||||
* Old description is below:
|
|
||||||
* <p>
|
|
||||||
* Categorize key as a player key, will register new column to MySQL
|
|
||||||
* database immediately rather than waiting for auto-categorization.
|
|
||||||
* <p>
|
|
||||||
* This will improve performance.
|
|
||||||
*
|
|
||||||
* @return The key.
|
|
||||||
* @deprecated Not required since the new MySQL data handler was introduced.
|
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.40.0", forRemoval = true)
|
|
||||||
public PersistentDataKey<T> player() {
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get all persistent data keys.
|
* Get all persistent data keys.
|
||||||
*
|
*
|
||||||
* @return The keys.
|
* @return The keys.
|
||||||
*/
|
*/
|
||||||
public static Set<PersistentDataKey<?>> values() {
|
public static Set<PersistentDataKey<?>> values() {
|
||||||
return Eco.getHandler().getKeyRegistry().getRegisteredKeys();
|
return Eco.get().getRegisteredPersistentDataKeys();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
@@ -134,7 +96,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());
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
package com.willfp.eco.core.data.keys;
|
package com.willfp.eco.core.data.keys;
|
||||||
|
|
||||||
|
import com.willfp.eco.core.config.interfaces.Config;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.math.BigDecimal;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Objects;
|
import java.util.Objects;
|
||||||
@@ -21,50 +23,43 @@ public final class PersistentDataKeyType<T> {
|
|||||||
/**
|
/**
|
||||||
* String.
|
* String.
|
||||||
*/
|
*/
|
||||||
public static final PersistentDataKeyType<String> STRING = new PersistentDataKeyType<>(String.class, "STRING");
|
public static final PersistentDataKeyType<String> STRING = new PersistentDataKeyType<>("STRING");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Boolean.
|
* Boolean.
|
||||||
*/
|
*/
|
||||||
public static final PersistentDataKeyType<Boolean> BOOLEAN = new PersistentDataKeyType<>(Boolean.class, "BOOLEAN");
|
public static final PersistentDataKeyType<Boolean> BOOLEAN = new PersistentDataKeyType<>("BOOLEAN");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Int.
|
* Int.
|
||||||
*/
|
*/
|
||||||
public static final PersistentDataKeyType<Integer> INT = new PersistentDataKeyType<>(Integer.class, "INT");
|
public static final PersistentDataKeyType<Integer> INT = new PersistentDataKeyType<>("INT");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Double.
|
* Double.
|
||||||
*/
|
*/
|
||||||
public static final PersistentDataKeyType<Double> DOUBLE = new PersistentDataKeyType<>(Double.class, "DOUBLE");
|
public static final PersistentDataKeyType<Double> DOUBLE = new PersistentDataKeyType<>("DOUBLE");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* String List.
|
* String List.
|
||||||
*/
|
*/
|
||||||
public static final PersistentDataKeyType<List<String>> STRING_LIST = new PersistentDataKeyType<>(null, "STRING_LIST");
|
public static final PersistentDataKeyType<List<String>> STRING_LIST = new PersistentDataKeyType<>("STRING_LIST");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The class of the type.
|
* Config.
|
||||||
*/
|
*/
|
||||||
private final Class<T> typeClass;
|
public static final PersistentDataKeyType<Config> CONFIG = new PersistentDataKeyType<>("CONFIG");
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Big Decimal.
|
||||||
|
*/
|
||||||
|
public static final PersistentDataKeyType<BigDecimal> BIG_DECIMAL = new PersistentDataKeyType<>("BIG_DECIMAL");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The name of the key type.
|
* The name of the key type.
|
||||||
*/
|
*/
|
||||||
private final String name;
|
private final String name;
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the class of the type.
|
|
||||||
*
|
|
||||||
* @return The class.
|
|
||||||
* @deprecated String list type will return null.
|
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.36.0", forRemoval = true)
|
|
||||||
@Nullable
|
|
||||||
public Class<T> getTypeClass() {
|
|
||||||
return typeClass;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the name of the key type.
|
* Get the name of the key type.
|
||||||
*
|
*
|
||||||
@@ -77,14 +72,11 @@ public final class PersistentDataKeyType<T> {
|
|||||||
/**
|
/**
|
||||||
* Create new PersistentDataKeyType.
|
* Create new PersistentDataKeyType.
|
||||||
*
|
*
|
||||||
* @param typeClass The type class.
|
|
||||||
* @param name The name.
|
* @param name The name.
|
||||||
*/
|
*/
|
||||||
private PersistentDataKeyType(@Nullable final Class<T> typeClass,
|
private PersistentDataKeyType(@NotNull final String name) {
|
||||||
@NotNull final String name) {
|
|
||||||
VALUES.add(this);
|
VALUES.add(this);
|
||||||
|
|
||||||
this.typeClass = typeClass;
|
|
||||||
this.name = name;
|
this.name = name;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -93,7 +85,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);
|
||||||
|
|||||||
@@ -1,13 +1,27 @@
|
|||||||
package com.willfp.eco.core.display;
|
package com.willfp.eco.core.display;
|
||||||
|
|
||||||
|
import com.willfp.eco.core.fast.FastItemStack;
|
||||||
|
import com.willfp.eco.core.integrations.guidetection.GUIDetectionManager;
|
||||||
|
import com.willfp.eco.util.NamespacedKeyUtils;
|
||||||
|
import org.bukkit.NamespacedKey;
|
||||||
import org.bukkit.entity.Player;
|
import org.bukkit.entity.Player;
|
||||||
|
import org.bukkit.inventory.Inventory;
|
||||||
import org.bukkit.inventory.ItemStack;
|
import org.bukkit.inventory.ItemStack;
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
import org.bukkit.persistence.PersistentDataType;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
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 {
|
||||||
/**
|
/**
|
||||||
@@ -16,9 +30,14 @@ public final class Display {
|
|||||||
public static final String PREFIX = "§z";
|
public static final String PREFIX = "§z";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The display handler.
|
* All registered modules.
|
||||||
*/
|
*/
|
||||||
private static DisplayHandler handler = null;
|
private static final Map<Integer, List<DisplayModule>> REGISTERED_MODULES = new TreeMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The finalize key.
|
||||||
|
*/
|
||||||
|
private static final NamespacedKey FINALIZE_KEY = NamespacedKeyUtils.createEcoKey("finalized");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Display on ItemStacks.
|
* Display on ItemStacks.
|
||||||
@@ -39,7 +58,49 @@ public final class Display {
|
|||||||
*/
|
*/
|
||||||
public static ItemStack display(@NotNull final ItemStack itemStack,
|
public static ItemStack display(@NotNull final ItemStack itemStack,
|
||||||
@Nullable final Player player) {
|
@Nullable final Player player) {
|
||||||
return handler.display(itemStack, player);
|
Map<String, Object[]> pluginVarArgs = new HashMap<>();
|
||||||
|
|
||||||
|
for (List<DisplayModule> modules : REGISTERED_MODULES.values()) {
|
||||||
|
for (DisplayModule module : modules) {
|
||||||
|
pluginVarArgs.put(module.getPluginName(), module.generateVarArgs(itemStack));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Display.revert(itemStack);
|
||||||
|
|
||||||
|
if (!itemStack.hasItemMeta()) {
|
||||||
|
return itemStack;
|
||||||
|
}
|
||||||
|
|
||||||
|
ItemStack original = itemStack.clone();
|
||||||
|
Inventory inventory = player == null ? null : player.getOpenInventory().getTopInventory();
|
||||||
|
boolean inInventory = inventory != null && inventory.contains(original);
|
||||||
|
boolean inGui = player != null && GUIDetectionManager.hasGUIOpen(player);
|
||||||
|
|
||||||
|
DisplayProperties properties = new DisplayProperties(
|
||||||
|
inInventory,
|
||||||
|
inGui,
|
||||||
|
original
|
||||||
|
);
|
||||||
|
|
||||||
|
for (List<DisplayModule> modules : REGISTERED_MODULES.values()) {
|
||||||
|
for (DisplayModule module : modules) {
|
||||||
|
Object[] varargs = pluginVarArgs.get(module.getPluginName());
|
||||||
|
|
||||||
|
if (varargs == null) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.display(itemStack, varargs);
|
||||||
|
|
||||||
|
if (player != null) {
|
||||||
|
module.display(itemStack, player, varargs);
|
||||||
|
module.display(itemStack, player, properties, varargs);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return itemStack;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -71,7 +132,25 @@ public final class Display {
|
|||||||
* @return The ItemStack.
|
* @return The ItemStack.
|
||||||
*/
|
*/
|
||||||
public static ItemStack revert(@NotNull final ItemStack itemStack) {
|
public static ItemStack revert(@NotNull final ItemStack itemStack) {
|
||||||
return handler.revert(itemStack);
|
if (Display.isFinalized(itemStack)) {
|
||||||
|
Display.unfinalize(itemStack);
|
||||||
|
}
|
||||||
|
|
||||||
|
FastItemStack fast = FastItemStack.wrap(itemStack);
|
||||||
|
|
||||||
|
List<String> lore = fast.getLore();
|
||||||
|
|
||||||
|
if (!lore.isEmpty() && lore.removeIf(line -> line.startsWith(Display.PREFIX))) {
|
||||||
|
fast.setLore(lore);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (List<DisplayModule> modules : REGISTERED_MODULES.values()) {
|
||||||
|
for (DisplayModule module : modules) {
|
||||||
|
module.revert(itemStack);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return itemStack;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -81,7 +160,15 @@ public final class Display {
|
|||||||
* @return The ItemStack.
|
* @return The ItemStack.
|
||||||
*/
|
*/
|
||||||
public static ItemStack finalize(@NotNull final ItemStack itemStack) {
|
public static ItemStack finalize(@NotNull final ItemStack itemStack) {
|
||||||
return handler.finalize(itemStack);
|
if (itemStack.getType().getMaxStackSize() > 1) {
|
||||||
|
return itemStack;
|
||||||
|
}
|
||||||
|
|
||||||
|
FastItemStack.wrap(itemStack)
|
||||||
|
.getPersistentDataContainer()
|
||||||
|
.set(FINALIZE_KEY, PersistentDataType.INTEGER, 1);
|
||||||
|
|
||||||
|
return itemStack;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -91,7 +178,11 @@ public final class Display {
|
|||||||
* @return The ItemStack.
|
* @return The ItemStack.
|
||||||
*/
|
*/
|
||||||
public static ItemStack unfinalize(@NotNull final ItemStack itemStack) {
|
public static ItemStack unfinalize(@NotNull final ItemStack itemStack) {
|
||||||
return handler.unfinalize(itemStack);
|
FastItemStack.wrap(itemStack)
|
||||||
|
.getPersistentDataContainer()
|
||||||
|
.remove(FINALIZE_KEY);
|
||||||
|
|
||||||
|
return itemStack;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -101,7 +192,9 @@ public final class Display {
|
|||||||
* @return If finalized.
|
* @return If finalized.
|
||||||
*/
|
*/
|
||||||
public static boolean isFinalized(@NotNull final ItemStack itemStack) {
|
public static boolean isFinalized(@NotNull final ItemStack itemStack) {
|
||||||
return handler.isFinalized(itemStack);
|
return FastItemStack.wrap(itemStack)
|
||||||
|
.getPersistentDataContainer()
|
||||||
|
.has(FINALIZE_KEY, PersistentDataType.INTEGER);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -110,23 +203,15 @@ public final class Display {
|
|||||||
* @param module The module.
|
* @param module The module.
|
||||||
*/
|
*/
|
||||||
public static void registerDisplayModule(@NotNull final DisplayModule module) {
|
public static void registerDisplayModule(@NotNull final DisplayModule module) {
|
||||||
handler.registerDisplayModule(module);
|
List<DisplayModule> modules = REGISTERED_MODULES.getOrDefault(
|
||||||
}
|
module.getWeight(),
|
||||||
|
new ArrayList<>()
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
modules.removeIf(it -> it.getPluginName().equalsIgnoreCase(module.getPluginName()));
|
||||||
* Set the display handler.
|
modules.add(module);
|
||||||
* <p>
|
|
||||||
* Internal API component, you will cause bugs if you create your own handler.
|
|
||||||
*
|
|
||||||
* @param handler The handler.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
public static void setHandler(@NotNull final DisplayHandler handler) {
|
|
||||||
if (Display.handler != null) {
|
|
||||||
throw new IllegalStateException("Display already initialized!");
|
|
||||||
}
|
|
||||||
|
|
||||||
Display.handler = handler;
|
REGISTERED_MODULES.put(module.getWeight(), modules);
|
||||||
}
|
}
|
||||||
|
|
||||||
private Display() {
|
private Display() {
|
||||||
|
|||||||
@@ -1,64 +0,0 @@
|
|||||||
package com.willfp.eco.core.display;
|
|
||||||
|
|
||||||
import com.willfp.eco.core.Eco;
|
|
||||||
import org.bukkit.entity.Player;
|
|
||||||
import org.bukkit.inventory.ItemStack;
|
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
import org.jetbrains.annotations.Nullable;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Interface for display implementations.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
@Eco.HandlerComponent
|
|
||||||
public interface DisplayHandler {
|
|
||||||
/**
|
|
||||||
* Register display module.
|
|
||||||
*
|
|
||||||
* @param module The module.
|
|
||||||
*/
|
|
||||||
void registerDisplayModule(@NotNull DisplayModule module);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Display on ItemStacks.
|
|
||||||
*
|
|
||||||
* @param itemStack The item.
|
|
||||||
* @param player The player.
|
|
||||||
* @return The ItemStack.
|
|
||||||
*/
|
|
||||||
ItemStack display(@NotNull ItemStack itemStack,
|
|
||||||
@Nullable Player player);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Revert on ItemStacks.
|
|
||||||
*
|
|
||||||
* @param itemStack The item.
|
|
||||||
* @return The ItemStack.
|
|
||||||
*/
|
|
||||||
ItemStack revert(@NotNull ItemStack itemStack);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Finalize an ItemStacks.
|
|
||||||
*
|
|
||||||
* @param itemStack The item.
|
|
||||||
* @return The ItemStack.
|
|
||||||
*/
|
|
||||||
ItemStack finalize(@NotNull ItemStack itemStack);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Unfinalize an ItemStacks.
|
|
||||||
*
|
|
||||||
* @param itemStack The item.
|
|
||||||
* @return The ItemStack.
|
|
||||||
*/
|
|
||||||
ItemStack unfinalize(@NotNull ItemStack itemStack);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* If an item is finalized.
|
|
||||||
*
|
|
||||||
* @param itemStack The item.
|
|
||||||
* @return If finalized.
|
|
||||||
*/
|
|
||||||
boolean isFinalized(@NotNull ItemStack itemStack);
|
|
||||||
}
|
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
package com.willfp.eco.core.display;
|
package com.willfp.eco.core.display;
|
||||||
|
|
||||||
import com.willfp.eco.core.EcoPlugin;
|
import com.willfp.eco.core.EcoPlugin;
|
||||||
import com.willfp.eco.core.PluginDependent;
|
|
||||||
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;
|
||||||
@@ -9,13 +8,20 @@ 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 extends PluginDependent<EcoPlugin> {
|
public abstract class DisplayModule {
|
||||||
/**
|
/**
|
||||||
* The priority of the module.
|
* The priority of the module.
|
||||||
*/
|
*/
|
||||||
private final int weight;
|
private final int weight;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The plugin.
|
||||||
|
*/
|
||||||
|
private final EcoPlugin plugin;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new display module.
|
* Create a new display module.
|
||||||
*
|
*
|
||||||
@@ -24,8 +30,7 @@ public abstract class DisplayModule extends PluginDependent<EcoPlugin> {
|
|||||||
*/
|
*/
|
||||||
protected DisplayModule(@NotNull final EcoPlugin plugin,
|
protected DisplayModule(@NotNull final EcoPlugin plugin,
|
||||||
@NotNull final DisplayPriority priority) {
|
@NotNull final DisplayPriority priority) {
|
||||||
super(plugin);
|
this(plugin, priority.getWeight());
|
||||||
this.weight = priority.getWeight();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -36,7 +41,7 @@ public abstract class DisplayModule extends PluginDependent<EcoPlugin> {
|
|||||||
*/
|
*/
|
||||||
protected DisplayModule(@NotNull final EcoPlugin plugin,
|
protected DisplayModule(@NotNull final EcoPlugin plugin,
|
||||||
final int weight) {
|
final int weight) {
|
||||||
super(plugin);
|
this.plugin = plugin;
|
||||||
this.weight = weight;
|
this.weight = weight;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -104,24 +109,7 @@ public abstract class DisplayModule extends PluginDependent<EcoPlugin> {
|
|||||||
* @return The plugin name.
|
* @return The plugin name.
|
||||||
*/
|
*/
|
||||||
public final String getPluginName() {
|
public final String getPluginName() {
|
||||||
return super.getPlugin().getName();
|
return this.getPlugin().getName();
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the display priority.
|
|
||||||
*
|
|
||||||
* @return The priority.
|
|
||||||
* @deprecated Use getWeight instead.
|
|
||||||
*/
|
|
||||||
@Deprecated(since = "6.35.0", forRemoval = true)
|
|
||||||
public DisplayPriority getPriority() {
|
|
||||||
return switch (this.weight) {
|
|
||||||
case 100 -> DisplayPriority.LOWEST;
|
|
||||||
case 200 -> DisplayPriority.LOW;
|
|
||||||
case 300 -> DisplayPriority.HIGH;
|
|
||||||
case 400 -> DisplayPriority.HIGHEST;
|
|
||||||
default -> DisplayPriority.CUSTOM;
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -132,4 +120,13 @@ public abstract class DisplayModule extends PluginDependent<EcoPlugin> {
|
|||||||
public int getWeight() {
|
public int getWeight() {
|
||||||
return this.weight;
|
return this.weight;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the plugin.
|
||||||
|
*
|
||||||
|
* @return The plugin.
|
||||||
|
*/
|
||||||
|
public EcoPlugin getPlugin() {
|
||||||
|
return plugin;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,7 +6,10 @@ package com.willfp.eco.core.display;
|
|||||||
public enum DisplayPriority {
|
public enum DisplayPriority {
|
||||||
/**
|
/**
|
||||||
* Custom weight.
|
* Custom weight.
|
||||||
|
*
|
||||||
|
* @deprecated Will never be used.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated(since = "6.53.0", forRemoval = true)
|
||||||
CUSTOM(250),
|
CUSTOM(250),
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -21,13 +21,25 @@ public class DropQueue {
|
|||||||
/**
|
/**
|
||||||
* The internally used {@link DropQueue}.
|
* The internally used {@link DropQueue}.
|
||||||
*/
|
*/
|
||||||
private final InternalDropQueue handle;
|
private final DropQueue delegate;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Create a new DropQueue.
|
||||||
|
*
|
||||||
* @param player The player.
|
* @param player The player.
|
||||||
*/
|
*/
|
||||||
public DropQueue(@NotNull final Player player) {
|
public DropQueue(@NotNull final Player player) {
|
||||||
handle = Eco.getHandler().getDropQueueFactory().create(player);
|
this.delegate = Eco.get().createDropQueue(player);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new DropQueue with no delegate.
|
||||||
|
* <p>
|
||||||
|
* Call this constructor if you're creating custom DropQueue
|
||||||
|
* implementations.
|
||||||
|
*/
|
||||||
|
protected DropQueue() {
|
||||||
|
this.delegate = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -37,7 +49,11 @@ public class DropQueue {
|
|||||||
* @return The DropQueue.
|
* @return The DropQueue.
|
||||||
*/
|
*/
|
||||||
public DropQueue addItem(@NotNull final ItemStack item) {
|
public DropQueue addItem(@NotNull final ItemStack item) {
|
||||||
handle.addItem(item);
|
if (delegate == null) {
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate.addItem(item);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -48,7 +64,11 @@ public class DropQueue {
|
|||||||
* @return The DropQueue.
|
* @return The DropQueue.
|
||||||
*/
|
*/
|
||||||
public DropQueue addItems(@NotNull final Collection<ItemStack> itemStacks) {
|
public DropQueue addItems(@NotNull final Collection<ItemStack> itemStacks) {
|
||||||
handle.addItems(itemStacks);
|
if (delegate == null) {
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate.addItems(itemStacks);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,7 +79,11 @@ public class DropQueue {
|
|||||||
* @return The DropQueue.
|
* @return The DropQueue.
|
||||||
*/
|
*/
|
||||||
public DropQueue addXP(final int amount) {
|
public DropQueue addXP(final int amount) {
|
||||||
handle.addXP(amount);
|
if (delegate == null) {
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate.addXP(amount);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -70,7 +94,11 @@ public class DropQueue {
|
|||||||
* @return The DropQueue.
|
* @return The DropQueue.
|
||||||
*/
|
*/
|
||||||
public DropQueue setLocation(@NotNull final Location location) {
|
public DropQueue setLocation(@NotNull final Location location) {
|
||||||
handle.setLocation(location);
|
if (delegate == null) {
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate.setLocation(location);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -80,7 +108,11 @@ public class DropQueue {
|
|||||||
* @return The DropQueue.
|
* @return The DropQueue.
|
||||||
*/
|
*/
|
||||||
public DropQueue forceTelekinesis() {
|
public DropQueue forceTelekinesis() {
|
||||||
handle.forceTelekinesis();
|
if (delegate == null) {
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate.forceTelekinesis();
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -88,6 +120,10 @@ public class DropQueue {
|
|||||||
* Push the queue.
|
* Push the queue.
|
||||||
*/
|
*/
|
||||||
public void push() {
|
public void push() {
|
||||||
handle.push();
|
if (delegate == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate.push();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
package com.willfp.eco.core.drops;
|
|
||||||
|
|
||||||
import com.willfp.eco.core.Eco;
|
|
||||||
import org.bukkit.entity.Player;
|
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Internal component to create backend DropQueue implementations.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
@Eco.HandlerComponent
|
|
||||||
public interface DropQueueFactory {
|
|
||||||
/**
|
|
||||||
* Create a DropQueue.
|
|
||||||
*
|
|
||||||
* @param player The player.
|
|
||||||
* @return The Queue.
|
|
||||||
*/
|
|
||||||
InternalDropQueue create(@NotNull Player player);
|
|
||||||
}
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
package com.willfp.eco.core.drops;
|
|
||||||
|
|
||||||
import com.willfp.eco.core.Eco;
|
|
||||||
import org.bukkit.Location;
|
|
||||||
import org.bukkit.inventory.ItemStack;
|
|
||||||
import org.jetbrains.annotations.ApiStatus;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
|
||||||
|
|
||||||
import java.util.Collection;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Internal interface for backend DropQueue implementations.
|
|
||||||
*/
|
|
||||||
@ApiStatus.Internal
|
|
||||||
@Eco.HandlerComponent
|
|
||||||
public interface InternalDropQueue {
|
|
||||||
/**
|
|
||||||
* Add item to queue.
|
|
||||||
*
|
|
||||||
* @param item The item to add.
|
|
||||||
* @return The DropQueue.
|
|
||||||
*/
|
|
||||||
InternalDropQueue addItem(@NotNull ItemStack item);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add multiple items to queue.
|
|
||||||
*
|
|
||||||
* @param itemStacks The items to add.
|
|
||||||
* @return The DropQueue.
|
|
||||||
*/
|
|
||||||
InternalDropQueue addItems(@NotNull Collection<ItemStack> itemStacks);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add xp to queue.
|
|
||||||
*
|
|
||||||
* @param amount The amount to add.
|
|
||||||
* @return The DropQueue.
|
|
||||||
*/
|
|
||||||
InternalDropQueue addXP(int amount);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set location of the origin of the drops.
|
|
||||||
*
|
|
||||||
* @param location The location.
|
|
||||||
* @return The DropQueue.
|
|
||||||
*/
|
|
||||||
InternalDropQueue setLocation(@NotNull Location location);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Force the queue to act as if player is telekinetic.
|
|
||||||
*
|
|
||||||
* @return The DropQueue.
|
|
||||||
*/
|
|
||||||
InternalDropQueue forceTelekinesis();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Push the queue.
|
|
||||||
*/
|
|
||||||
void push();
|
|
||||||
}
|
|
||||||
@@ -20,6 +20,13 @@ public abstract class CustomGoal<T extends Mob> implements EntityGoal<T>, Target
|
|||||||
*/
|
*/
|
||||||
private final Set<GoalFlag> flags = EnumSet.noneOf(GoalFlag.class);
|
private final Set<GoalFlag> flags = EnumSet.noneOf(GoalFlag.class);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new custom goal.
|
||||||
|
*/
|
||||||
|
protected CustomGoal() {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initialize the goal with a mob.
|
* Initialize the goal with a mob.
|
||||||
* <p>
|
* <p>
|
||||||
|
|||||||
@@ -101,6 +101,6 @@ public interface EntityController<T extends Mob> {
|
|||||||
* @return The entity controller.
|
* @return The entity controller.
|
||||||
*/
|
*/
|
||||||
static <T extends Mob> EntityController<T> getFor(@NotNull final T entity) {
|
static <T extends Mob> EntityController<T> getFor(@NotNull final T entity) {
|
||||||
return Eco.getHandler().createEntityController(entity);
|
return Eco.get().createEntityController(entity);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -28,6 +28,8 @@ public record EntityGoalTempt(
|
|||||||
boolean canBeScared
|
boolean canBeScared
|
||||||
) implements EntityGoal<Mob> {
|
) implements EntityGoal<Mob> {
|
||||||
/**
|
/**
|
||||||
|
* Create a new entity goal.
|
||||||
|
*
|
||||||
* @param speed The speed at which the entity follows the item.
|
* @param speed The speed at which the entity follows the item.
|
||||||
* @param item The item that the entity will be attracted by.
|
* @param item The item that the entity will be attracted by.
|
||||||
* @param canBeScared If the entity can be scared and lose track of the item.
|
* @param canBeScared If the entity can be scared and lose track of the item.
|
||||||
@@ -58,7 +60,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 +70,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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -30,6 +30,8 @@ public record TargetGoalNearestAttackable(
|
|||||||
@NotNull Predicate<LivingEntity> targetFilter
|
@NotNull Predicate<LivingEntity> targetFilter
|
||||||
) implements TargetGoal<Raider> {
|
) implements TargetGoal<Raider> {
|
||||||
/**
|
/**
|
||||||
|
* Create a new target goal.
|
||||||
|
*
|
||||||
* @param target The type of entities to attack.
|
* @param target The type of entities to attack.
|
||||||
* @param checkVisibility If visibility should be checked.
|
* @param checkVisibility If visibility should be checked.
|
||||||
* @param checkCanNavigate If navigation should be checked.
|
* @param checkCanNavigate If navigation should be checked.
|
||||||
@@ -63,7 +65,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 +83,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
|
||||||
|
|||||||
@@ -30,6 +30,8 @@ public record TargetGoalNearestAttackableWitch(
|
|||||||
@NotNull Predicate<LivingEntity> targetFilter
|
@NotNull Predicate<LivingEntity> targetFilter
|
||||||
) implements TargetGoal<Raider> {
|
) implements TargetGoal<Raider> {
|
||||||
/**
|
/**
|
||||||
|
* Create a new target goal.
|
||||||
|
*
|
||||||
* @param target The type of entities to attack.
|
* @param target The type of entities to attack.
|
||||||
* @param checkVisibility If visibility should be checked.
|
* @param checkVisibility If visibility should be checked.
|
||||||
* @param checkCanNavigate If navigation should be checked.
|
* @param checkCanNavigate If navigation should be checked.
|
||||||
@@ -63,7 +65,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 +83,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
|
||||||
|
|||||||
@@ -26,6 +26,8 @@ public record TargetGoalNearestHealableRaider(
|
|||||||
@NotNull Predicate<LivingEntity> targetFilter
|
@NotNull Predicate<LivingEntity> targetFilter
|
||||||
) implements TargetGoal<Raider> {
|
) implements TargetGoal<Raider> {
|
||||||
/**
|
/**
|
||||||
|
* Create a new target goal.
|
||||||
|
*
|
||||||
* @param target The target.
|
* @param target The target.
|
||||||
* @param checkVisibility If visibility should be checked.
|
* @param checkVisibility If visibility should be checked.
|
||||||
*/
|
*/
|
||||||
@@ -53,7 +55,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 +69,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
|
||||||
|
|||||||
@@ -26,6 +26,8 @@ public record TargetGoalNonTameRandom(
|
|||||||
@NotNull Predicate<LivingEntity> targetFilter
|
@NotNull Predicate<LivingEntity> targetFilter
|
||||||
) implements TargetGoal<Tameable> {
|
) implements TargetGoal<Tameable> {
|
||||||
/**
|
/**
|
||||||
|
* Create a new target goal.
|
||||||
|
*
|
||||||
* @param target The types of entities to heal.
|
* @param target The types of entities to heal.
|
||||||
* @param checkVisibility If visibility should be checked.
|
* @param checkVisibility If visibility should be checked.
|
||||||
*/
|
*/
|
||||||
@@ -53,7 +55,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 +69,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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ import java.util.function.Consumer;
|
|||||||
import java.util.function.Predicate;
|
import java.util.function.Predicate;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* The result of an arg parses.
|
||||||
|
*
|
||||||
* @param test The test for the entity.
|
* @param test The test for the entity.
|
||||||
* @param modifier The modifier to apply to the entity.
|
* @param modifier The modifier to apply to the entity.
|
||||||
* @see EntityArgParser
|
* @see EntityArgParser
|
||||||
|
|||||||
@@ -28,6 +28,6 @@ public class EmptyTestableEntity implements TestableEntity {
|
|||||||
public Entity spawn(@NotNull final Location location) {
|
public Entity spawn(@NotNull final Location location) {
|
||||||
Validate.notNull(location.getWorld());
|
Validate.notNull(location.getWorld());
|
||||||
|
|
||||||
return Eco.getHandler().createDummyEntity(location);
|
return Eco.get().createDummyEntity(location);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -135,20 +135,26 @@ public abstract class Extension implements PluginLike {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public File getDataFolder() {
|
public @NotNull File getDataFolder() {
|
||||||
return this.plugin.getDataFolder();
|
return this.plugin.getDataFolder();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public ConfigHandler getConfigHandler() {
|
public @NotNull ConfigHandler getConfigHandler() {
|
||||||
return this.plugin.getConfigHandler();
|
return this.plugin.getConfigHandler();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public Logger getLogger() {
|
public @NotNull Logger getLogger() {
|
||||||
return this.plugin.getLogger();
|
return this.plugin.getLogger();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public @NotNull File getFile() {
|
||||||
|
Validate.notNull(metadata, "Metadata cannot be null!");
|
||||||
|
return this.metadata.file();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the plugin for the extension.
|
* Get the plugin for the extension.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
package com.willfp.eco.core.extensions;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generic exception in extension loading.
|
||||||
|
*/
|
||||||
|
public class ExtensionLoadException extends RuntimeException {
|
||||||
|
/**
|
||||||
|
* Create a new ExtensionLoadException.
|
||||||
|
*
|
||||||
|
* @param errorMessage The error message to show.
|
||||||
|
*/
|
||||||
|
public ExtensionLoadException(@NotNull final String errorMessage) {
|
||||||
|
super(errorMessage);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,7 +3,7 @@ package com.willfp.eco.core.extensions;
|
|||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Internal component to manage loading and unloading extensions.
|
* Manages the loading and unloading of extensions for a particular plugin.
|
||||||
*/
|
*/
|
||||||
public interface ExtensionLoader {
|
public interface ExtensionLoader {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
package com.willfp.eco.core.extensions;
|
package com.willfp.eco.core.extensions;
|
||||||
|
|
||||||
|
import com.willfp.eco.core.version.Version;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The extension's metadata.
|
* The extension's metadata.
|
||||||
* <p>
|
* <p>
|
||||||
@@ -12,7 +15,24 @@ import org.jetbrains.annotations.NotNull;
|
|||||||
* @param author The extension's author.
|
* @param author The extension's author.
|
||||||
*/
|
*/
|
||||||
public record ExtensionMetadata(@NotNull String version,
|
public record ExtensionMetadata(@NotNull String version,
|
||||||
|
@NotNull String name,
|
||||||
|
@NotNull String author,
|
||||||
|
@NotNull File file,
|
||||||
|
@NotNull Version minimumPluginVersion) {
|
||||||
|
/**
|
||||||
|
* Legacy constructor.
|
||||||
|
*
|
||||||
|
* @param version The extension version.
|
||||||
|
* @param name The extension name.
|
||||||
|
* @param author The extension's author.
|
||||||
|
* @deprecated Use {@link ExtensionMetadata#ExtensionMetadata(String, String, String, File, Version)} instead.
|
||||||
|
*/
|
||||||
|
@SuppressWarnings("ConstantConditions")
|
||||||
|
@Deprecated(since = "6.57.0", forRemoval = true)
|
||||||
|
public ExtensionMetadata(@NotNull String version,
|
||||||
@NotNull String name,
|
@NotNull String name,
|
||||||
@NotNull String author) {
|
@NotNull String author) {
|
||||||
|
this(version, name, author, null, null);
|
||||||
|
throw new UnsupportedOperationException("Legacy constructor is not supported.");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import org.jetbrains.annotations.NotNull;
|
|||||||
* Missing or invalid extension.yml.
|
* Missing or invalid extension.yml.
|
||||||
* Invalid filetype.
|
* Invalid filetype.
|
||||||
*/
|
*/
|
||||||
public class MalformedExtensionException extends RuntimeException {
|
public class MalformedExtensionException extends ExtensionLoadException {
|
||||||
/**
|
/**
|
||||||
* Create a new MalformedExtensionException.
|
* Create a new MalformedExtensionException.
|
||||||
*
|
*
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user