diff --git a/.github/workflows/attach_jar.yml b/.github/workflows/attach_jar.yml index 4f653d86..26af7ffe 100644 --- a/.github/workflows/attach_jar.yml +++ b/.github/workflows/attach_jar.yml @@ -38,13 +38,13 @@ jobs: - name: Build Pathetic-Example run: | - mvn -U -V -e -B -ntp clean install compile package -pl pathetic-example -amd -DskipTests + mvn -U -V -e -B -ntp clean install compile package -pl pathetic-bukkit/pathetic-example -amd -DskipTests - name: Upload Pathetic-Example uses: actions/upload-artifact@v3 with: name: pathetic-example - path: D:\a\pathetic\pathetic\pathetic-example\target\pathetic-example.jar + path: D:\a\pathetic\pathetic\pathetic-bukkit\pathetic-example\target\pathetic-example.jar - name: Attach pathetic-example jar to release uses: actions/upload-release-asset@v1 @@ -52,6 +52,6 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ github.event.release.upload_url }} - asset_path: D:\a\pathetic\pathetic\pathetic-example\target\pathetic-example.jar + asset_path: D:\a\pathetic\pathetic\pathetic-bukkit\pathetic-example\target\pathetic-example.jar asset_name: pathetic-example.jar asset_content_type: application/java-archive diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fbd35b4e..0eb0cb9a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -65,4 +65,4 @@ jobs: uses: actions/upload-artifact@v3 with: name: pathetic-${{ fromJSON(steps.determine.outputs.result).pr }} - path: pathetic-example/target/pathetic-example-*-SNAPSHOT.jar + path: pathetic-bukkit/pathetic-example/target/pathetic-example.jar diff --git a/.github/workflows/code_quality.yml b/.github/workflows/code_quality.yml deleted file mode 100644 index 29b8802d..00000000 --- a/.github/workflows/code_quality.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Qodana -on: - workflow_dispatch: - pull_request: - push: - branches: - - trunk - -jobs: - qodana: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - name: 'Qodana Scan' - uses: JetBrains/qodana-action@v2022.3.2 \ No newline at end of file diff --git a/.gitignore b/.gitignore index fd14d2ab..fb477885 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,5 @@ -/target/ +target/ /.idea/ *.iml -/PathingLegacy/target/ -/PathingMain/target/ dependency-reduced-pom.xml /javadoc/ diff --git a/LICENSE b/LICENSE index f288702d..4dc0d668 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +MIT License + +Copyright (c) 2024 Benjamin Sommerfeld + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 68882cde..72797ba4 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,10 @@ Transparent

-

Pathetic - A Pathfinding library for Minecraft

+

Pathetic - A Pathfinding library for 3D environments

-

A high-performance, backwards-compatible, and asynchronous easy-to-use pathfinding library written in Java. -
Pathetic leverages the A* algorithm with customizable heuristics for real-time pathfinding in Spigot/Paper environments.

- -

Key Features

- -
    -
  • Advanced A* Algorithm: Employs multiple distance metrics (Manhattan, Octile, Perpendicular) and height differences for pathfinding, optimized for 3D worlds like Minecraft.
  • -
  • Asynchronous Pathfinding: Non-blocking operations using CompletableFuture to minimize server impact during pathfinding.
  • -
  • Fibonacci Heap for Efficient Queuing: The open set (frontier) is managed using a Fibonacci heap, ensuring optimal node retrieval with faster insert and extract min operations.
  • -
  • Customizable Heuristics: Fine-tune pathfinding behavior using HeuristicWeights for balanced navigation in any world configuration.
  • -
  • Regional Grid Optimization: Uses ExpiringHashMap and Bloom filters to efficiently track explored regions, minimizing memory overhead.
  • -
  • Dynamic Path Filters: Define custom filters to modify node validity or prioritize paths based on criteria such as passability, block type, or world boundaries.
  • -
- -

Showcase

- -![ezgif-3-caa688a773](https://github.com/user-attachments/assets/ab243485-f122-4067-bab0-a5ed97b717c1) - -

Installation

- -To integrate pathetic into your project, follow the following steps: -
-*(We advise you to relocate pathetic)* - -

Maven

- -```xml - - - - jitpack.io - https://jitpack.io - - - - - com.github.Metaphoriker.pathetic - pathetic-mapping - VERSION - -``` - -

Gradle

- -```groovy -allprojects { - repositories { - maven { url 'https://jitpack.io' } - } -} - -dependencies { - implementation 'com.github.Metaphoriker.pathetic:pathetic-mapping:VERSION' -} -``` - -

Example Usage

- -

See the pathetic-example module for a detailed example usage.

+

A high-performance, backwards-compatible, and asynchronous easy-to-use pathfinding library written in Java for 3D environments. +
Pathetic leverages the A* algorithm with customizable heuristics for real-time pathfinding.

Documentation

diff --git a/pathetic-api/README.md b/pathetic-api/README.md new file mode 100644 index 00000000..6815f6c6 --- /dev/null +++ b/pathetic-api/README.md @@ -0,0 +1,4 @@ +# API +The API of Pathetic. + +For a better overview [check the javadocs](https://javadocs.pathetic.ollieee.xyz/). diff --git a/pathetic-api/pom.xml b/pathetic-api/pom.xml index 1b7b2e3b..4e1da53a 100644 --- a/pathetic-api/pom.xml +++ b/pathetic-api/pom.xml @@ -7,20 +7,9 @@ pathetic-main de.metaphoriker - 3.3.1 + 4.0 pathetic-api - 3.3.1 - - - - org.spigotmc - spigot-api - - - org.projectlombok - lombok - - + 4.0 diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/EventPublisher.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/EventPublisher.java deleted file mode 100644 index 08e366af..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/EventPublisher.java +++ /dev/null @@ -1,41 +0,0 @@ -package de.metaphoriker.pathetic.api.event; - -import com.google.common.eventbus.EventBus; -import lombok.experimental.UtilityClass; - -/** - * Utility class for publishing and managing events using the Google Guava EventBus. This class - * provides methods to raise events and register/unregister event listeners. - */ -@UtilityClass -public class EventPublisher { - - private static final EventBus eventBus = new EventBus(); - - /** - * Raises an event by posting it to the EventBus. - * - * @param pathingEvent the event to be raised - */ - public static void raiseEvent(PathingEvent pathingEvent) { - eventBus.post(pathingEvent); - } - - /** - * Registers an event listener with the EventBus. - * - * @param listener the listener to be registered - */ - public static void registerListener(Object listener) { - eventBus.register(listener); - } - - /** - * Unregisters an event listener from the EventBus. - * - * @param listener the listener to be unregistered - */ - public static void unregisterListener(Object listener) { - eventBus.unregister(listener); - } -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingEvent.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingEvent.java deleted file mode 100644 index 562765d8..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingEvent.java +++ /dev/null @@ -1,4 +0,0 @@ -package de.metaphoriker.pathetic.api.event; - -/** Represents all pathing events */ -public interface PathingEvent {} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingFinishedEvent.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingFinishedEvent.java deleted file mode 100644 index 6d306abc..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingFinishedEvent.java +++ /dev/null @@ -1,17 +0,0 @@ -package de.metaphoriker.pathetic.api.event; - -import lombok.AllArgsConstructor; -import lombok.Getter; -import lombok.NonNull; -import de.metaphoriker.pathetic.api.pathing.result.PathfinderResult; - -/** - * An event called when a pathfinder finishes pathing. Therefor, the result does not matter. Means - * that the event is called even if the pathing fails. - */ -@Getter -@AllArgsConstructor -public class PathingFinishedEvent implements PathingEvent { - - @NonNull private final PathfinderResult pathfinderResult; -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingStartFindEvent.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingStartFindEvent.java deleted file mode 100644 index 28f9ba82..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/PathingStartFindEvent.java +++ /dev/null @@ -1,20 +0,0 @@ -package de.metaphoriker.pathetic.api.event; - -import java.util.List; -import lombok.Getter; -import lombok.NonNull; -import lombok.RequiredArgsConstructor; -import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; -import de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage; -import de.metaphoriker.pathetic.api.wrapper.PathPosition; - -/** An event called when a Pathfinder starts pathing. */ -@Getter -@RequiredArgsConstructor -public class PathingStartFindEvent implements PathingEvent { - - @NonNull private final PathPosition start; - @NonNull private final PathPosition target; - @NonNull private final List filters; - @NonNull private final List filterStages; -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/package-info.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/package-info.java deleted file mode 100644 index f6fe6e1e..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/event/package-info.java +++ /dev/null @@ -1,43 +0,0 @@ -/** - * This package contains classes related to the event system of pathetic. - * - *

The event system is built around the Guava EventBus. It provides a way to define, raise, and - * handle custom events within the application. The main class in this package is the - * EventPublisher, which provides static methods to raise events and register/unregister listeners. - * - *

To create a new event, you would extend the PathingEvent class. To handle an event, you would - * create a method in your listener class that is annotated with @Subscribe and takes a single - * argument of your event type. - * - *

For example: - * - *

{@code
- * // Define a new event
- *  public class CustomEvent extends PathingEvent {
- *    private final String message;
- *
- *    public CustomEvent(String message) {
- *      this.message = message;
- *    }
- *
- *    public String getMessage() {
- *      return message;
- *    }
- *  }
- *
- *  // Define a listener for the new event
- *  public class CustomEventListener {
- *
- *   {@literal @}Subscribe
- *   public void onCustomEvent(CustomEvent event) {
- *     System.out.println("Received custom event with message: " + event.getMessage());
- *    }
- *  }
- *
- * // Register the listener and raise the event
- * EventPublisher.registerListener(new CustomEventListener());
- * EventPublisher.raiseEvent(new CustomEvent("Hello, world!"));
- *
- * }
- */ -package de.metaphoriker.pathetic.api.event; diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/factory/PathfinderFactory.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/factory/PathfinderFactory.java new file mode 100644 index 00000000..45a66e45 --- /dev/null +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/factory/PathfinderFactory.java @@ -0,0 +1,33 @@ +package de.metaphoriker.pathetic.api.factory; + +import de.metaphoriker.pathetic.api.pathing.Pathfinder; +import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; + +/** + * A factory interface for creating {@link Pathfinder} instances. + */ +public interface PathfinderFactory { + + /** + * Creates a new {@link Pathfinder} instance with the given configuration. + * + * @param configuration The configuration for the pathfinder. + * @return A new {@link Pathfinder} instance. + */ + Pathfinder createPathfinder(PathfinderConfiguration configuration); + + /** + * Creates a new {@link Pathfinder} instance with the given configuration and initializer. This method + * first creates a pathfinder using the {@link #createPathfinder(PathfinderConfiguration)} method and then + * initializes it using the provided {@link PathfinderInitializer}. + * + * @param configuration The configuration for the pathfinder. + * @param initializer The initializer to use for initializing the pathfinder. + * @return A new, initialized {@link Pathfinder} instance. + */ + default Pathfinder createPathfinder(PathfinderConfiguration configuration, PathfinderInitializer initializer) { + Pathfinder pathfinder = createPathfinder(configuration); + initializer.initialize(pathfinder, configuration); + return pathfinder; + } +} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/factory/PathfinderInitializer.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/factory/PathfinderInitializer.java new file mode 100644 index 00000000..71f9a17e --- /dev/null +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/factory/PathfinderInitializer.java @@ -0,0 +1,18 @@ +package de.metaphoriker.pathetic.api.factory; + +import de.metaphoriker.pathetic.api.pathing.Pathfinder; +import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; + +/** + * An interface for initializing {@link Pathfinder} instances. + */ +public interface PathfinderInitializer { + + /** + * Initializes the given {@link Pathfinder} with the given {@link PathfinderConfiguration}. + * + * @param pathfinder The pathfinder to initialize. + * @param configuration The configuration for the pathfinder. + */ + void initialize(Pathfinder pathfinder, PathfinderConfiguration configuration); +} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/Pathfinder.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/Pathfinder.java index ce146161..dcb7353a 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/Pathfinder.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/Pathfinder.java @@ -1,15 +1,13 @@ package de.metaphoriker.pathetic.api.pathing; -import java.util.List; -import java.util.concurrent.CompletionStage; -import javax.annotation.Nullable; - -import de.metaphoriker.pathetic.api.pathing.result.PathState; -import lombok.NonNull; import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; import de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage; +import de.metaphoriker.pathetic.api.pathing.hook.PathfinderHook; +import de.metaphoriker.pathetic.api.pathing.result.PathState; import de.metaphoriker.pathetic.api.pathing.result.PathfinderResult; import de.metaphoriker.pathetic.api.wrapper.PathPosition; +import java.util.List; +import java.util.concurrent.CompletionStage; /** * A Pathfinder is a class that can find a path between two positions while following a given set of @@ -23,11 +21,8 @@ public interface Pathfinder { * @param filters A list of {@link PathFilter}'s to apply to the pathfinding process. * @return An {@link CompletionStage} that will contain a {@link PathfinderResult}. */ - @NonNull CompletionStage findPath( - @NonNull PathPosition start, - @NonNull PathPosition target, - @Nullable List<@NonNull PathFilter> filters); + PathPosition start, PathPosition target, List filters); /** * Tries to find a Path between the two {@link PathPosition}'s provided with the given @@ -36,24 +31,23 @@ CompletionStage findPath( *

Other than the {@link #findPath(PathPosition, PathPosition, List)} method, this method * allows for more complex filtering by using {@link PathFilterStage}'s. * - *

The filters in the stages will be applied in the order they are provided. If a filter in - * a stage returns false, the next stage will be checked. Only one stage needs to - * return true for the path to be considered valid. + *

The filters in the stages will be applied in the order they are provided. If a filter in a + * stage returns false, the next stage will be checked. Only one stage needs to return true for + * the path to be considered valid. * - * @api.Note The stages will be checked in the order they are provided. The sharedFilters will - * be applied before the stages. + * @api.Note The stages will be checked in the order they are provided. The sharedFilters will be + * applied before the stages. * @param start The start position of the path. * @param target The target position of the path. * @param sharedFilters A list of {@link PathFilter}'s, which will be applied to all stages. * @param filterStages A list of {@link PathFilterStage}'s to apply to the pathfinding * @return An {@link CompletionStage} that will contain a {@link PathfinderResult}. */ - @NonNull CompletionStage findPath( - @NonNull PathPosition start, - @NonNull PathPosition target, - @Nullable List sharedFilters, - @Nullable List<@NonNull PathFilterStage> filterStages); + PathPosition start, + PathPosition target, + List sharedFilters, + List filterStages); /** * Aborts the running pathfinding process. @@ -62,4 +56,12 @@ CompletionStage findPath( * will be {@link PathState#ABORTED}. */ void abort(); + + /** + * Registers a {@link PathfinderHook} that will be called on every step of the pathfinding + * process. This can be used to modify the pathfinding process or to collect data. + * + * @param hook The hook to register. + */ + void registerPathfindingHook(PathfinderHook hook); } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/HeuristicWeights.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/HeuristicWeights.java index b1daddb6..aefc7c95 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/HeuristicWeights.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/HeuristicWeights.java @@ -1,7 +1,5 @@ package de.metaphoriker.pathetic.api.pathing.configuration; -import lombok.Value; - /** * Represents a set of weights used to calculate a heuristic for the A* pathfinding algorithm. These * weights influence the prioritization of different path characteristics during the search. @@ -16,8 +14,7 @@ *

  • Height Difference: Factors in elevation changes when calculating path costs. * */ -@Value(staticConstructor = "create") -public class HeuristicWeights { +public final class HeuristicWeights { /** * Provides a set of default heuristic weights that may be suitable for natural pathfinding. These @@ -34,25 +31,98 @@ public class HeuristicWeights { * The weight applied to the Manhattan distance component of the heuristic. A higher weight * favours paths with a greater emphasis on direct, axis-aligned movement. */ - double manhattanWeight; + private final double manhattanWeight; /** * The weight applied to the Octile distance component of the heuristic. A higher weight allows * diagonal movement, enabling more flexible paths in 3D environments. */ - double octileWeight; + private final double octileWeight; /** * The weight applied to the perpendicular distance component of the heuristic. Increased weight * discourages deviations from the straight line between the start and target, resulting in * smoother paths. */ - double perpendicularWeight; + private final double perpendicularWeight; /** * The weight applied to the height difference (elevation change) component of the heuristic. A * higher weight gives more consideration to vertical distance, important for terrains with * varying verticality. */ - double heightWeight; + private final double heightWeight; + + private HeuristicWeights( + double manhattanWeight, + double octileWeight, + double perpendicularWeight, + double heightWeight) { + this.manhattanWeight = manhattanWeight; + this.octileWeight = octileWeight; + this.perpendicularWeight = perpendicularWeight; + this.heightWeight = heightWeight; + } + + public static HeuristicWeights create( + double manhattanWeight, + double octileWeight, + double perpendicularWeight, + double heightWeight) { + return new HeuristicWeights(manhattanWeight, octileWeight, perpendicularWeight, heightWeight); + } + + public double getManhattanWeight() { + return this.manhattanWeight; + } + + public double getOctileWeight() { + return this.octileWeight; + } + + public double getPerpendicularWeight() { + return this.perpendicularWeight; + } + + public double getHeightWeight() { + return this.heightWeight; + } + + public boolean equals(final Object o) { + if (o == this) return true; + if (!(o instanceof HeuristicWeights)) return false; + final HeuristicWeights other = (HeuristicWeights) o; + if (Double.compare(this.getManhattanWeight(), other.getManhattanWeight()) != 0) return false; + if (Double.compare(this.getOctileWeight(), other.getOctileWeight()) != 0) return false; + if (Double.compare(this.getPerpendicularWeight(), other.getPerpendicularWeight()) != 0) + return false; + if (Double.compare(this.getHeightWeight(), other.getHeightWeight()) != 0) return false; + return true; + } + + public int hashCode() { + final int PRIME = 59; + int result = 1; + final long $manhattanWeight = Double.doubleToLongBits(this.getManhattanWeight()); + result = result * PRIME + (int) ($manhattanWeight >>> 32 ^ $manhattanWeight); + final long $octileWeight = Double.doubleToLongBits(this.getOctileWeight()); + result = result * PRIME + (int) ($octileWeight >>> 32 ^ $octileWeight); + final long $perpendicularWeight = Double.doubleToLongBits(this.getPerpendicularWeight()); + result = result * PRIME + (int) ($perpendicularWeight >>> 32 ^ $perpendicularWeight); + final long $heightWeight = Double.doubleToLongBits(this.getHeightWeight()); + result = result * PRIME + (int) ($heightWeight >>> 32 ^ $heightWeight); + return result; + } + + public String toString() { + return "HeuristicWeights(manhattanWeight=" + + this.getManhattanWeight() + + ", octileWeight=" + + this.getOctileWeight() + + ", perpendicularWeight=" + + this.getPerpendicularWeight() + + ", heightWeight=" + + this.getHeightWeight() + + ")"; + } } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/PathfinderConfiguration.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/PathfinderConfiguration.java index 9c68c9fb..f4ee182a 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/PathfinderConfiguration.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/configuration/PathfinderConfiguration.java @@ -1,27 +1,12 @@ package de.metaphoriker.pathetic.api.pathing.configuration; -import de.metaphoriker.pathetic.api.annotation.Experimental; -import de.metaphoriker.pathetic.api.pathing.Pathfinder; -import de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage; -import de.metaphoriker.pathetic.api.wrapper.PathPosition; -import java.util.List; -import lombok.AccessLevel; -import lombok.Builder; -import lombok.Getter; -import lombok.RequiredArgsConstructor; -import lombok.Value; -import lombok.With; +import de.metaphoriker.pathetic.api.provider.NavigationPointProvider; /** * Defines a set of configurable parameters that govern the behavior of the A* pathfinding * algorithm. By adjusting these parameters, you can fine-tune the pathfinding process to suit the * specific needs of your Minecraft environment. */ -@With -@Value -@Getter -@Builder(toBuilder = true, access = AccessLevel.PRIVATE) -@RequiredArgsConstructor(access = AccessLevel.PRIVATE) public class PathfinderConfiguration { /** @@ -30,57 +15,34 @@ public class PathfinderConfiguration { * * @default 5000 */ - @Builder.Default int maxIterations = 5000; + private final int maxIterations; /** * The maximum permissible length of a calculated path (in blocks). Use this to constrain long * searches that could impact performance. A value of 0 indicates no limit. */ - int maxLength; + private final int maxLength; /** * Determines whether pathfinding calculations should be executed asynchronously in a separate * thread. This can improve responsiveness in the main thread, but may introduce synchronization * complexities. */ - boolean async; - - /** - * If set to true, the pathfinding process will terminate immediately if either the start or - * target or both are unreachable. - * - *

    NOTE: This prevents fallback strategies. - * @deprecated Will be removed in future releases - */ - @Deprecated - boolean allowingFailFast; + private final boolean async; /** * If pathfinding fails, this parameter determines whether the algorithm should fall back to the * last successfully calculated path. This can help maintain progress, but might use an outdated * path. */ - boolean allowingFallback; - - /** - * Controls whether chunks should be loaded or generated as needed during the pathfinding process. - * This is essential for exploring uncharted areas, but may impact performance. - */ - boolean loadingChunks; + private final boolean fallback; /** - * Determines whether the pathfinding algorithm should see PathFilterStages as prioritization, - * instead of filtering. This means that the pathfinding algorithm will prioritize paths that pass - * the filters over paths that do not. - * - *

    Setting this to true will no longer take the {@link PathFilterStage}s into the validation - * process. Shared filters must still be passed. - * - *

    {@link Pathfinder#findPath(PathPosition, PathPosition, List, List)} - * - * @experimental This feature is experimental and may be subject to change. + * The provider responsible for supplying navigation points to the pathfinding algorithm. This + * provider determines how the pathfinder interacts with the world and accesses information about + * valid movement locations. */ - @Experimental @Builder.Default boolean prioritizing = false; + private final NavigationPointProvider provider; /** * The set of weights used to calculate heuristics within the A* algorithm. These influence the @@ -88,30 +50,21 @@ public class PathfinderConfiguration { * * @default HeuristicWeights.NATURAL_PATH_WEIGHTS */ - @Builder.Default HeuristicWeights heuristicWeights = HeuristicWeights.NATURAL_PATH_WEIGHTS; + private final HeuristicWeights heuristicWeights; - /** - * Determines whether the pathfinding algorithm should collect statistics about the pathfinding - * process. This can be useful for debugging and performance tuning. - * - *

    Help us improve the API by providing feedback with the collected statistics! - * - * @default true - */ - @Builder.Default boolean bStats = true; - - /** - * @return A new {@link PathfinderConfiguration} with default parameters but async. - */ - public static PathfinderConfiguration createAsyncConfiguration() { - return builder().async(true).build(); - } - - /** - * @return A new {@link PathfinderConfiguration} with default parameters. - */ - public static PathfinderConfiguration createConfiguration() { - return builder().build(); + private PathfinderConfiguration( + int maxIterations, + int maxLength, + boolean async, + boolean fallback, + NavigationPointProvider provider, + HeuristicWeights heuristicWeights) { + this.maxIterations = maxIterations; + this.maxLength = maxLength; + this.async = async; + this.fallback = fallback; + this.provider = provider; + this.heuristicWeights = heuristicWeights; } /** @@ -129,10 +82,163 @@ public static PathfinderConfiguration deepCopy(PathfinderConfiguration pathfinde .maxIterations(pathfinderConfiguration.maxIterations) .maxLength(pathfinderConfiguration.maxLength) .async(pathfinderConfiguration.async) - .allowingFailFast(pathfinderConfiguration.allowingFailFast) - .allowingFallback(pathfinderConfiguration.allowingFallback) - .loadingChunks(pathfinderConfiguration.loadingChunks) + .fallback(pathfinderConfiguration.fallback) + .provider(pathfinderConfiguration.provider) .heuristicWeights(pathfinderConfiguration.heuristicWeights) .build(); } + + public static PathfinderConfigurationBuilder builder() { + return new PathfinderConfigurationBuilder(); + } + + public int getMaxIterations() { + return this.maxIterations; + } + + public int getMaxLength() { + return this.maxLength; + } + + public boolean isAsync() { + return this.async; + } + + public boolean isFallback() { + return this.fallback; + } + + public NavigationPointProvider getProvider() { + return provider; + } + + public HeuristicWeights getHeuristicWeights() { + return this.heuristicWeights; + } + + public String toString() { + return "PathfinderConfiguration(maxIterations=" + + this.getMaxIterations() + + ", maxLength=" + + this.getMaxLength() + + ", async=" + + this.isAsync() + + ", allowingFallback=" + + this.isFallback() + + ", provider=" + + this.getProvider() + + ", heuristicWeights=" + + this.getHeuristicWeights() + + ")"; + } + + public boolean equals(final Object o) { + if (o == this) return true; + if (!(o instanceof PathfinderConfiguration)) return false; + final PathfinderConfiguration other = (PathfinderConfiguration) o; + if (!other.canEqual((Object) this)) return false; + if (this.getMaxIterations() != other.getMaxIterations()) return false; + if (this.getMaxLength() != other.getMaxLength()) return false; + if (this.isAsync() != other.isAsync()) return false; + if (this.isFallback() != other.isFallback()) return false; + if (this.getProvider() == null + ? other.getProvider() != null + : !this.getProvider().equals(other.getProvider())) return false; + final Object this$heuristicWeights = this.getHeuristicWeights(); + final Object other$heuristicWeights = other.getHeuristicWeights(); + if (this$heuristicWeights == null + ? other$heuristicWeights != null + : !this$heuristicWeights.equals(other$heuristicWeights)) return false; + return true; + } + + protected boolean canEqual(final Object other) { + return other instanceof PathfinderConfiguration; + } + + public int hashCode() { + final int PRIME = 59; + int result = 1; + result = result * PRIME + this.getMaxIterations(); + result = result * PRIME + this.getMaxLength(); + result = result * PRIME + (this.isAsync() ? 79 : 97); + result = result * PRIME + (this.isFallback() ? 79 : 97); + result = result * PRIME + (this.getProvider() == null ? 43 : this.getProvider().hashCode()); + final Object $heuristicWeights = this.getHeuristicWeights(); + result = result * PRIME + ($heuristicWeights == null ? 43 : $heuristicWeights.hashCode()); + return result; + } + + public static class PathfinderConfigurationBuilder { + private int maxIterations = 5000; + private int maxLength; + private boolean async; + private boolean fallback = true; + private NavigationPointProvider provider; + private HeuristicWeights heuristicWeights = HeuristicWeights.NATURAL_PATH_WEIGHTS; + + PathfinderConfigurationBuilder() {} + + public PathfinderConfiguration.PathfinderConfigurationBuilder maxIterations(int maxIterations) { + this.maxIterations = maxIterations; + return this; + } + + public PathfinderConfiguration.PathfinderConfigurationBuilder maxLength(int maxLength) { + this.maxLength = maxLength; + return this; + } + + public PathfinderConfiguration.PathfinderConfigurationBuilder async(boolean async) { + this.async = async; + return this; + } + + public PathfinderConfiguration.PathfinderConfigurationBuilder fallback( + boolean allowingFallback) { + this.fallback = allowingFallback; + return this; + } + + public PathfinderConfiguration.PathfinderConfigurationBuilder provider( + NavigationPointProvider provider) { + this.provider = provider; + return this; + } + + public PathfinderConfiguration.PathfinderConfigurationBuilder heuristicWeights( + HeuristicWeights heuristicWeights) { + this.heuristicWeights = heuristicWeights; + return this; + } + + public PathfinderConfiguration build() { + if (provider == null) { + throw new IllegalStateException("NavigationPointProvider cannot be null."); + } + return new PathfinderConfiguration( + this.maxIterations, + this.maxLength, + this.async, + this.fallback, + this.provider, + this.heuristicWeights); + } + + public String toString() { + return "PathfinderConfiguration.PathfinderConfigurationBuilder(maxIterations=" + + this.maxIterations + + ", maxLength=" + + this.maxLength + + ", async=" + + this.async + + ", fallback=" + + this.fallback + + ", provider=" + + this.provider + + ", heuristicWeights=" + + this.heuristicWeights + + ")"; + } + } } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilter.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilter.java index b2c535b1..a767ee1c 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilter.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilter.java @@ -1,6 +1,5 @@ package de.metaphoriker.pathetic.api.pathing.filter; -import lombok.NonNull; import de.metaphoriker.pathetic.api.pathing.Pathfinder; /** @@ -23,7 +22,7 @@ public interface PathFilter { * @param pathValidationContext The context providing the information necessary to evaluate * @return true if the path is valid, false otherwise */ - boolean filter(@NonNull PathValidationContext pathValidationContext); + boolean filter(PathValidationContext pathValidationContext); /** * Cleans up the resources used during the pathfinding process. This method is guaranteed to diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilterStage.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilterStage.java index 7de6ce27..6fdb656c 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilterStage.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathFilterStage.java @@ -3,13 +3,11 @@ import java.util.Arrays; import java.util.HashSet; import java.util.Set; -import lombok.Value; /** A stage for multiple PathFilters. */ -@Value -public class PathFilterStage { +public final class PathFilterStage { - Set filters = new HashSet<>(); + private final Set filters = new HashSet<>(); public PathFilterStage(PathFilter... pathFilter) { filters.addAll(Arrays.asList(pathFilter)); @@ -29,4 +27,31 @@ public boolean filter(PathValidationContext context) { public void cleanup() { filters.forEach(PathFilter::cleanup); } + + public Set getFilters() { + return this.filters; + } + + public boolean equals(final Object o) { + if (o == this) return true; + if (!(o instanceof PathFilterStage)) return false; + final PathFilterStage other = (PathFilterStage) o; + final Object this$filters = this.getFilters(); + final Object other$filters = other.getFilters(); + if (this$filters == null ? other$filters != null : !this$filters.equals(other$filters)) + return false; + return true; + } + + public int hashCode() { + final int PRIME = 59; + int result = 1; + final Object $filters = this.getFilters(); + result = result * PRIME + ($filters == null ? 43 : $filters.hashCode()); + return result; + } + + public String toString() { + return "PathFilterStage(filters=" + this.getFilters() + ")"; + } } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathValidationContext.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathValidationContext.java index 8f40b0f3..3d3c9b89 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathValidationContext.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/PathValidationContext.java @@ -1,7 +1,6 @@ package de.metaphoriker.pathetic.api.pathing.filter; -import lombok.Value; -import de.metaphoriker.pathetic.api.snapshot.SnapshotManager; +import de.metaphoriker.pathetic.api.provider.NavigationPointProvider; import de.metaphoriker.pathetic.api.wrapper.PathPosition; /** @@ -11,38 +10,130 @@ *

    This context is passed to {@link PathFilter#filter} methods during the pathfinding process and * allows filters to validate or invalidate nodes based on the provided context. */ -@Value -public class PathValidationContext { +public final class PathValidationContext { /** * The current position being evaluated in the pathfinding process. This represents the position * that is being validated by the filter to determine if it can be part of a valid path. */ - PathPosition position; + private final PathPosition position; /** * The parent position of the current position. This is the previous node from which the current * position was reached. It is used to trace the path and ensure logical continuity between nodes. */ - PathPosition parent; + private final PathPosition parent; /** * The absolute start position of the pathfinding process. This represents the original starting * point of the path and remains constant throughout the algorithm, providing a stable reference. */ - PathPosition absoluteStart; + private final PathPosition absoluteStart; /** * The absolute target position of the pathfinding process. This is the final goal or destination * that the pathfinding algorithm is trying to reach. Like the start, it remains constant and * provides a clear end-point for the path. */ - PathPosition absoluteTarget; + private final PathPosition absoluteTarget; /** - * The snapshot manager provides access to world data, such as block information, in the context - * of the pathfinding process. It is used to retrieve block data from the world at different + * The BlockProvider provides access to world data, such as block information, in the context of + * the pathfinding process. It is used to retrieve block data from the world at different * positions during path validation. */ - SnapshotManager snapshotManager; + private final NavigationPointProvider navigationPointProvider; + + public PathValidationContext( + PathPosition position, + PathPosition parent, + PathPosition absoluteStart, + PathPosition absoluteTarget, + NavigationPointProvider navigationPointProvider) { + this.position = position; + this.parent = parent; + this.absoluteStart = absoluteStart; + this.absoluteTarget = absoluteTarget; + this.navigationPointProvider = navigationPointProvider; + } + + public PathPosition getPosition() { + return this.position; + } + + public PathPosition getParent() { + return this.parent; + } + + public PathPosition getAbsoluteStart() { + return this.absoluteStart; + } + + public PathPosition getAbsoluteTarget() { + return this.absoluteTarget; + } + + public NavigationPointProvider getNavigationPointProvider() { + return this.navigationPointProvider; + } + + public boolean equals(final Object o) { + if (o == this) return true; + if (!(o instanceof PathValidationContext)) return false; + final PathValidationContext other = (PathValidationContext) o; + final Object this$position = this.getPosition(); + final Object other$position = other.getPosition(); + if (this$position == null ? other$position != null : !this$position.equals(other$position)) + return false; + final Object this$parent = this.getParent(); + final Object other$parent = other.getParent(); + if (this$parent == null ? other$parent != null : !this$parent.equals(other$parent)) + return false; + final Object this$absoluteStart = this.getAbsoluteStart(); + final Object other$absoluteStart = other.getAbsoluteStart(); + if (this$absoluteStart == null + ? other$absoluteStart != null + : !this$absoluteStart.equals(other$absoluteStart)) return false; + final Object this$absoluteTarget = this.getAbsoluteTarget(); + final Object other$absoluteTarget = other.getAbsoluteTarget(); + if (this$absoluteTarget == null + ? other$absoluteTarget != null + : !this$absoluteTarget.equals(other$absoluteTarget)) return false; + final Object this$blockProvider = this.getNavigationPointProvider(); + final Object other$blockProvider = other.getNavigationPointProvider(); + if (this$blockProvider == null + ? other$blockProvider != null + : !this$blockProvider.equals(other$blockProvider)) return false; + return true; + } + + public int hashCode() { + final int PRIME = 59; + int result = 1; + final Object $position = this.getPosition(); + result = result * PRIME + ($position == null ? 43 : $position.hashCode()); + final Object $parent = this.getParent(); + result = result * PRIME + ($parent == null ? 43 : $parent.hashCode()); + final Object $absoluteStart = this.getAbsoluteStart(); + result = result * PRIME + ($absoluteStart == null ? 43 : $absoluteStart.hashCode()); + final Object $absoluteTarget = this.getAbsoluteTarget(); + result = result * PRIME + ($absoluteTarget == null ? 43 : $absoluteTarget.hashCode()); + final Object $blockProvider = this.getNavigationPointProvider(); + result = result * PRIME + ($blockProvider == null ? 43 : $blockProvider.hashCode()); + return result; + } + + public String toString() { + return "PathValidationContext(position=" + + this.getPosition() + + ", parent=" + + this.getParent() + + ", absoluteStart=" + + this.getAbsoluteStart() + + ", absoluteTarget=" + + this.getAbsoluteTarget() + + ", navigationPointProvider=" + + this.getNavigationPointProvider() + + ")"; + } } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/PassablePathFilter.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/PassablePathFilter.java index c1465520..b1cc0863 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/PassablePathFilter.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/PassablePathFilter.java @@ -1,22 +1,16 @@ package de.metaphoriker.pathetic.api.pathing.filter.filters; -import lombok.NonNull; import de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext; import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; -import de.metaphoriker.pathetic.api.wrapper.PathBlock; -/** - * A PathFilter implementation that determines if a path is passable. - * - * @see PathBlock#isPassable() - */ +/** A PathFilter implementation that determines if a path is passable. */ public class PassablePathFilter implements PathFilter { @Override - public boolean filter(@NonNull PathValidationContext pathValidationContext) { + public boolean filter(PathValidationContext pathValidationContext) { return pathValidationContext - .getSnapshotManager() - .getBlock(pathValidationContext.getPosition()) - .isPassable(); + .getNavigationPointProvider() + .getNavigationPoint(pathValidationContext.getPosition()) + .isTraversable(); } } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/SolidGroundPathFilter.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/SolidGroundPathFilter.java deleted file mode 100644 index 95ed64b9..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/SolidGroundPathFilter.java +++ /dev/null @@ -1,25 +0,0 @@ -package de.metaphoriker.pathetic.api.pathing.filter.filters; - -import lombok.NonNull; -import de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext; -import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; -import de.metaphoriker.pathetic.api.snapshot.SnapshotManager; -import de.metaphoriker.pathetic.api.wrapper.PathBlock; - -/** - * A PathFilter implementation that determines if a path is on solid ground. - */ -public class SolidGroundPathFilter implements PathFilter { - - @Override - public boolean filter(@NonNull PathValidationContext pathValidationContext) { - SnapshotManager snapshotManager = pathValidationContext.getSnapshotManager(); - PathBlock block = snapshotManager.getBlock(pathValidationContext.getPosition()); - return hasGround(block, snapshotManager); - } - - protected boolean hasGround(PathBlock block, SnapshotManager snapshotManager) { - PathBlock below = snapshotManager.getBlock(block.getPathPosition().add(0, -1, 0)); - return below.isSolid(); - } -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/WaterPathFilter.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/WaterPathFilter.java deleted file mode 100644 index 2c399004..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/filter/filters/WaterPathFilter.java +++ /dev/null @@ -1,21 +0,0 @@ -package de.metaphoriker.pathetic.api.pathing.filter.filters; - -import lombok.NonNull; -import org.bukkit.Material; -import de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext; -import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; -import de.metaphoriker.pathetic.api.snapshot.SnapshotManager; -import de.metaphoriker.pathetic.api.wrapper.PathPosition; - -/** A PathFilter implementation that determines if a path is through water. */ -public class WaterPathFilter implements PathFilter { - - @Override - public boolean filter(@NonNull PathValidationContext pathValidationContext) { - SnapshotManager snapshotManager = pathValidationContext.getSnapshotManager(); - PathPosition pathPosition = pathValidationContext.getPosition(); - - return snapshotManager.getBlock(pathPosition).getBlockInformation().getMaterial() - == Material.WATER; - } -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/hook/PathfinderHook.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/hook/PathfinderHook.java new file mode 100644 index 00000000..a2bf7e5e --- /dev/null +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/hook/PathfinderHook.java @@ -0,0 +1,14 @@ +package de.metaphoriker.pathetic.api.pathing.hook; + +/** + * Interface for hooks that are called during the pathfinding process. + */ +public interface PathfinderHook { + + /** + * Called on each step of the pathfinding process. + * + * @param pathfindingContext the context of the current pathfinding step + */ + void onPathfindingStep(PathfindingContext pathfindingContext); +} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/hook/PathfindingContext.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/hook/PathfindingContext.java new file mode 100644 index 00000000..8ce82ef1 --- /dev/null +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/hook/PathfindingContext.java @@ -0,0 +1,40 @@ +package de.metaphoriker.pathetic.api.pathing.hook; + +import de.metaphoriker.pathetic.api.wrapper.Depth; + +/** Context for the current step of the pathfinding process. */ +public final class PathfindingContext { + + /** The depth of the current pathfinding step. */ + private final Depth depth; + + public PathfindingContext(Depth depth) { + this.depth = depth; + } + + public Depth getDepth() { + return this.depth; + } + + public boolean equals(final Object o) { + if (o == this) return true; + if (!(o instanceof PathfindingContext)) return false; + final PathfindingContext other = (PathfindingContext) o; + final Object this$depth = this.getDepth(); + final Object other$depth = other.getDepth(); + if (this$depth == null ? other$depth != null : !this$depth.equals(other$depth)) return false; + return true; + } + + public int hashCode() { + final int PRIME = 59; + int result = 1; + final Object $depth = this.getDepth(); + result = result * PRIME + ($depth == null ? 43 : $depth.hashCode()); + return result; + } + + public String toString() { + return "PathfindingContext(depth=" + this.getDepth() + ")"; + } +} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/Path.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/Path.java index fd1c6b1a..3cee41a7 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/Path.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/Path.java @@ -1,6 +1,5 @@ package de.metaphoriker.pathetic.api.pathing.result; -import lombok.NonNull; import de.metaphoriker.pathetic.api.util.ParameterizedSupplier; import de.metaphoriker.pathetic.api.wrapper.PathPosition; @@ -63,7 +62,6 @@ public interface Path extends Iterable { * @param mutator the {@link ParameterizedSupplier} to mutate the positions with * @return {@link Path} the new Path */ - @NonNull Path mutatePositions(ParameterizedSupplier mutator); /** @@ -71,7 +69,6 @@ public interface Path extends Iterable { * * @return {@link PathPosition} The position of the start */ - @NonNull PathPosition getStart(); /** @@ -79,6 +76,5 @@ public interface Path extends Iterable { * * @return {@link PathPosition} The position of the target */ - @NonNull PathPosition getEnd(); } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/PathfinderResult.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/PathfinderResult.java index 1e6664a5..48f3291f 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/PathfinderResult.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/pathing/result/PathfinderResult.java @@ -1,7 +1,5 @@ package de.metaphoriker.pathetic.api.pathing.result; -import lombok.NonNull; - public interface PathfinderResult { /** @@ -32,7 +30,6 @@ public interface PathfinderResult { * * @return The {@link PathState} */ - @NonNull PathState getPathState(); /** @@ -41,6 +38,5 @@ public interface PathfinderResult { * * @return The found {@link Path} */ - @NonNull Path getPath(); } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/provider/NavigationPoint.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/provider/NavigationPoint.java new file mode 100644 index 00000000..f5b9de40 --- /dev/null +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/provider/NavigationPoint.java @@ -0,0 +1,14 @@ +package de.metaphoriker.pathetic.api.provider; + +/** + * Represents information about a position in the pathfinding environment. + */ +public interface NavigationPoint { + + /** + * Checks if the block is traversable. + * + * @return true if the block is traversable, false otherwise + */ + boolean isTraversable(); +} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/provider/NavigationPointProvider.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/provider/NavigationPointProvider.java new file mode 100644 index 00000000..7f6a7f92 --- /dev/null +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/provider/NavigationPointProvider.java @@ -0,0 +1,18 @@ +package de.metaphoriker.pathetic.api.provider; + +import de.metaphoriker.pathetic.api.wrapper.PathPosition; + +/** + * The NavigationPointProvider interface defines methods for retrieving navigation point data + * at specific positions within a 3D environment. + */ +public interface NavigationPointProvider { + + /** + * Gets the navigation point at the given position. + * + * @param position the position to get the navigation point for. + * @return {@link NavigationPoint} the navigation point. + */ + NavigationPoint getNavigationPoint(PathPosition position); +} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/snapshot/SnapshotManager.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/snapshot/SnapshotManager.java deleted file mode 100644 index 34471fd1..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/snapshot/SnapshotManager.java +++ /dev/null @@ -1,31 +0,0 @@ -package de.metaphoriker.pathetic.api.snapshot; - -import de.metaphoriker.pathetic.api.wrapper.PathBlock; -import de.metaphoriker.pathetic.api.wrapper.PathPosition; - -/** - * The SnapshotManager interface defines methods for retrieving block data snapshots at specific - * positions within a Minecraft world. - */ -public interface SnapshotManager { - - /** - * Gets the block at the given position - * - * @api.Note If the pathfinder is not permitted to load chunks, this method will return null if - * the chunk is not loaded. - * @param position the position to get as block-form - * @return {@link PathBlock} the block. - */ - PathBlock getBlock(PathPosition position); - - /** - * Gets the highest block at the given position - * - * @api.Note If the pathfinder is not permitted to load chunks, this method will return null if - * the chunk is not loaded. - * @param position the position to get as block-form - * @return {@link PathBlock} the block. - */ - PathBlock getHighestBlockAt(PathPosition position); -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/NumberUtils.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/NumberUtils.java index abf2b53a..220b94ed 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/NumberUtils.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/NumberUtils.java @@ -1,11 +1,12 @@ package de.metaphoriker.pathetic.api.util; -import lombok.experimental.UtilityClass; - /** Utility class for common number operations. */ -@UtilityClass public final class NumberUtils { + private NumberUtils() { + throw new UnsupportedOperationException("This is a utility class and cannot be instantiated"); + } + /** * Interpolates between two values based on the given progress. * diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/ParameterizedSupplier.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/ParameterizedSupplier.java index 54db17b0..c872ed6e 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/ParameterizedSupplier.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/util/ParameterizedSupplier.java @@ -1,10 +1,18 @@ package de.metaphoriker.pathetic.api.util; /** - * Represents a supplier that accepts a parameter. + * A functional interface representing a supplier that accepts a parameter and returns a result. + * + * @param the type of the input to the supplier and the result */ @FunctionalInterface public interface ParameterizedSupplier { + /** + * Applies this supplier to the given argument. + * + * @param value the input argument + * @return the supplier result + */ T accept(T value); } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/BlockInformation.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/BlockInformation.java deleted file mode 100644 index c5a3eb16..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/BlockInformation.java +++ /dev/null @@ -1,26 +0,0 @@ -package de.metaphoriker.pathetic.api.wrapper; - -import javax.annotation.Nullable; -import lombok.EqualsAndHashCode; -import lombok.NonNull; -import lombok.ToString; -import lombok.Value; -import org.bukkit.Material; -import org.bukkit.block.BlockState; - -@Value -@ToString -@EqualsAndHashCode -public class BlockInformation { - - /** The material of the represented block */ - @NonNull Material material; - - /** - * The block state of the represented block -- GETTER -- Gets the block state of the represented - * block - * - * @api.Note This is only available in v. 1.13 or above and therefore nullable - */ - @Nullable BlockState blockState; -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/Depth.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/Depth.java new file mode 100644 index 00000000..02e9d48f --- /dev/null +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/Depth.java @@ -0,0 +1,47 @@ +package de.metaphoriker.pathetic.api.wrapper; + +/** + * Represents the depth of a pathfinding node or element. This class provides methods to get and + * increment the depth value. + */ +public class Depth { + + private int value; + + private Depth(int value) { + this.value = value; + } + + public static Depth of(int value) { + return new Depth(value); + } + + /** Increments the depth value by one. */ + public void increment() { + value++; + } + + public int getValue() { + return this.value; + } + + public boolean equals(final Object o) { + if (o == this) return true; + if (!(o instanceof Depth)) return false; + final Depth other = (Depth) o; + if (!other.canEqual((Object) this)) return false; + if (this.getValue() != other.getValue()) return false; + return true; + } + + protected boolean canEqual(final Object other) { + return other instanceof Depth; + } + + public int hashCode() { + final int PRIME = 59; + int result = 1; + result = result * PRIME + this.getValue(); + return result; + } +} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathBlock.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathBlock.java deleted file mode 100644 index ed55f2f4..00000000 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathBlock.java +++ /dev/null @@ -1,65 +0,0 @@ -package de.metaphoriker.pathetic.api.wrapper; - -import lombok.EqualsAndHashCode; -import lombok.Getter; -import lombok.RequiredArgsConstructor; -import lombok.ToString; - -/** A Class to represent a block in the world, except exempt of Bukkit */ -@Getter -@RequiredArgsConstructor -@ToString -@EqualsAndHashCode -public final class PathBlock { - - private final PathPosition pathPosition; - private final BlockInformation blockInformation; - - /** - * @return Whether the block is air - */ - public boolean isAir() { - return blockInformation.getMaterial().isAir(); - } - - /** - * @return Whether the block is possible to walk through - */ - public boolean isPassable() { - return !isSolid(); - } - - /** - * @return Whether the block is solid - */ - public boolean isSolid() { - return blockInformation.getMaterial().isSolid(); - } - - /** - * Gets the X coordinate of the block - * - * @return The X coordinate of the block - */ - public int getBlockX() { - return this.pathPosition.getBlockX(); - } - - /** - * Gets the Y coordinate of the block - * - * @return The Y coordinate of the block - */ - public int getBlockY() { - return this.pathPosition.getBlockY(); - } - - /** - * Gets the Z coordinate of the block - * - * @return The Z coordinate of the block - */ - public int getBlockZ() { - return this.pathPosition.getBlockZ(); - } -} diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathEnvironment.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathEnvironment.java index c78979ae..b8132476 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathEnvironment.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathEnvironment.java @@ -1,22 +1,21 @@ package de.metaphoriker.pathetic.api.wrapper; import java.util.UUID; -import lombok.Getter; -import lombok.RequiredArgsConstructor; -import lombok.ToString; -import lombok.Value; - -@Value -@Getter -@ToString -@RequiredArgsConstructor + /** Represents the pathing environment */ -public class PathEnvironment { +public final class PathEnvironment { + + private final UUID uuid; + private final String name; + private final Integer minHeight; + private final Integer maxHeight; - UUID uuid; - String name; - Integer minHeight; - Integer maxHeight; + public PathEnvironment(UUID uuid, String name, Integer minHeight, Integer maxHeight) { + this.uuid = uuid; + this.name = name; + this.minHeight = minHeight; + this.maxHeight = maxHeight; + } @Override public boolean equals(final Object o) { @@ -36,4 +35,32 @@ public int hashCode() { result = result * PRIME + this.name.hashCode(); return result; } + + public UUID getUuid() { + return this.uuid; + } + + public String getName() { + return this.name; + } + + public Integer getMinHeight() { + return this.minHeight; + } + + public Integer getMaxHeight() { + return this.maxHeight; + } + + public String toString() { + return "PathEnvironment(uuid=" + + this.getUuid() + + ", name=" + + this.getName() + + ", minHeight=" + + this.getMinHeight() + + ", maxHeight=" + + this.getMaxHeight() + + ")"; + } } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathPosition.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathPosition.java index 7357fbf4..ee33f77f 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathPosition.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathPosition.java @@ -1,23 +1,23 @@ package de.metaphoriker.pathetic.api.wrapper; -import java.util.Objects; -import lombok.AllArgsConstructor; -import lombok.Getter; -import lombok.NonNull; -import lombok.ToString; import de.metaphoriker.pathetic.api.util.NumberUtils; +import java.util.Objects; -@AllArgsConstructor -@Getter -@ToString public class PathPosition implements Cloneable { - @NonNull private PathEnvironment pathEnvironment; + private PathEnvironment pathEnvironment; private double x; private double y; private double z; + public PathPosition(PathEnvironment pathEnvironment, double x, double y, double z) { + this.pathEnvironment = pathEnvironment; + this.x = x; + this.y = y; + this.z = z; + } + /** * Interpolates between two positions based on the given progress. * @@ -39,9 +39,9 @@ public PathPosition interpolate(PathPosition other, double progress) { * @return True if the positions are in the same block */ public boolean isInSameBlock(PathPosition otherPosition) { - return this.getBlockX() == otherPosition.getBlockX() - && this.getBlockY() == otherPosition.getBlockY() - && this.getBlockZ() == otherPosition.getBlockZ(); + return this.getFlooredX() == otherPosition.getFlooredX() + && this.getFlooredY() == otherPosition.getFlooredY() + && this.getFlooredZ() == otherPosition.getFlooredZ(); } /** @@ -51,9 +51,9 @@ public boolean isInSameBlock(PathPosition otherPosition) { * @return the distance */ public int manhattanDistance(PathPosition otherPosition) { - return Math.abs(this.getBlockX() - otherPosition.getBlockX()) - + Math.abs(this.getBlockY() - otherPosition.getBlockY()) - + Math.abs(this.getBlockZ() - otherPosition.getBlockZ()); + return Math.abs(this.getFlooredX() - otherPosition.getFlooredX()) + + Math.abs(this.getFlooredY() - otherPosition.getFlooredY()) + + Math.abs(this.getFlooredZ() - otherPosition.getFlooredZ()); } /** @@ -134,7 +134,7 @@ public PathPosition setZ(double z) { * * @return The X coordinate of the block */ - public int getBlockX() { + public int getFlooredX() { return (int) Math.floor(this.x); } @@ -143,7 +143,7 @@ public int getBlockX() { * * @return The Y coordinate of the block */ - public int getBlockY() { + public int getFlooredY() { return (int) Math.floor(this.y); } @@ -152,7 +152,7 @@ public int getBlockY() { * * @return The Z coordinate of the block */ - public int getBlockZ() { + public int getFlooredZ() { return (int) Math.floor(this.z); } @@ -164,7 +164,6 @@ public int getBlockZ() { * @param z The value to add to the z * @return A new {@link PathPosition} */ - @NonNull public PathPosition add(final double x, final double y, final double z) { return new PathPosition(this.pathEnvironment, this.x + x, this.y + y, this.z + z); } @@ -175,7 +174,6 @@ public PathPosition add(final double x, final double y, final double z) { * @param vector The {@link PathVector} who's values will be added * @return A new {@link PathPosition} */ - @NonNull public PathPosition add(final PathVector vector) { return add(vector.getX(), vector.getY(), vector.getZ()); } @@ -188,7 +186,6 @@ public PathPosition add(final PathVector vector) { * @param z The value to subtract from the z * @return A new {@link PathPosition} */ - @NonNull public PathPosition subtract(final double x, final double y, final double z) { return new PathPosition(this.pathEnvironment, this.x - x, this.y - y, this.z - z); } @@ -199,7 +196,6 @@ public PathPosition subtract(final double x, final double y, final double z) { * @param vector The {@link PathVector} who's values will be subtracted * @return A new {@link PathPosition} */ - @NonNull public PathPosition subtract(final PathVector vector) { return subtract(vector.getX(), vector.getY(), vector.getZ()); } @@ -209,7 +205,6 @@ public PathPosition subtract(final PathVector vector) { * * @return A {@link PathVector} of the x,y,z */ - @NonNull public PathVector toVector() { return new PathVector(this.x, this.y, this.z); } @@ -221,7 +216,7 @@ public PathVector toVector() { */ public PathPosition floor() { return new PathPosition( - this.pathEnvironment, this.getBlockX(), this.getBlockY(), this.getBlockZ()); + this.pathEnvironment, this.getFlooredX(), this.getFlooredY(), this.getFlooredZ()); } /** @@ -232,11 +227,17 @@ public PathPosition floor() { public PathPosition mid() { return new PathPosition( this.pathEnvironment, - this.getBlockX() + 0.5, - this.getBlockY() + 0.5, - this.getBlockZ() + 0.5); + this.getFlooredX() + 0.5, + this.getFlooredY() + 0.5, + this.getFlooredZ() + 0.5); } + /** + * Calculates the midpoint between the current position and the given end position. + * + * @param end The end position to calculate the midpoint with + * @return A new {@link PathPosition} representing the midpoint + */ public PathPosition midPoint(PathPosition end) { return new PathPosition( this.pathEnvironment, (this.x + end.x) / 2, (this.y + end.y) / 2, (this.z + end.z) / 2); @@ -274,4 +275,32 @@ public boolean equals(Object o) { public int hashCode() { return Objects.hash(pathEnvironment, x, y, z); } + + public PathEnvironment getPathEnvironment() { + return this.pathEnvironment; + } + + public double getX() { + return this.x; + } + + public double getY() { + return this.y; + } + + public double getZ() { + return this.z; + } + + public String toString() { + return "PathPosition(pathEnvironment=" + + this.getPathEnvironment() + + ", x=" + + this.getX() + + ", y=" + + this.getY() + + ", z=" + + this.getZ() + + ")"; + } } diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathVector.java b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathVector.java index 4d4206dd..256517c7 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathVector.java +++ b/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/wrapper/PathVector.java @@ -1,20 +1,19 @@ package de.metaphoriker.pathetic.api.wrapper; -import lombok.AllArgsConstructor; -import lombok.EqualsAndHashCode; -import lombok.Getter; -import lombok.NonNull; import de.metaphoriker.pathetic.api.util.NumberUtils; -@Getter -@AllArgsConstructor -@EqualsAndHashCode public class PathVector implements Cloneable { private double x; private double y; private double z; + public PathVector(double x, double y, double z) { + this.x = x; + this.y = y; + this.z = z; + } + /** * Finds the distance between the line BC and the point A * @@ -103,7 +102,6 @@ public PathVector setZ(double z) { * @param otherVector {@link PathVector} to vector to subtract from the current Vector * @return A new {@link PathVector} */ - @NonNull public PathVector subtract(PathVector otherVector) { return new PathVector(this.x - otherVector.x, this.y - otherVector.y, this.z - otherVector.z); } @@ -114,7 +112,6 @@ public PathVector subtract(PathVector otherVector) { * @param value The constant to multiply by * @return A new {@link PathVector} */ - @NonNull public PathVector multiply(double value) { return new PathVector(this.x * value, this.y * value, this.z * value); } @@ -124,7 +121,6 @@ public PathVector multiply(double value) { * * @return A new {@link PathVector} */ - @NonNull public PathVector normalize() { double magnitude = this.length(); return new PathVector(this.x / magnitude, this.y / magnitude, this.z / magnitude); @@ -177,4 +173,43 @@ public PathVector clone() { clone.z = this.z; return clone; } + + public double getX() { + return this.x; + } + + public double getY() { + return this.y; + } + + public double getZ() { + return this.z; + } + + public boolean equals(final Object o) { + if (o == this) return true; + if (!(o instanceof PathVector)) return false; + final PathVector other = (PathVector) o; + if (!other.canEqual((Object) this)) return false; + if (Double.compare(this.getX(), other.getX()) != 0) return false; + if (Double.compare(this.getY(), other.getY()) != 0) return false; + if (Double.compare(this.getZ(), other.getZ()) != 0) return false; + return true; + } + + protected boolean canEqual(final Object other) { + return other instanceof PathVector; + } + + public int hashCode() { + final int PRIME = 59; + int result = 1; + final long $x = Double.doubleToLongBits(this.getX()); + result = result * PRIME + (int) ($x >>> 32 ^ $x); + final long $y = Double.doubleToLongBits(this.getY()); + result = result * PRIME + (int) ($y >>> 32 ^ $y); + final long $z = Double.doubleToLongBits(this.getZ()); + result = result * PRIME + (int) ($z >>> 32 ^ $z); + return result; + } } diff --git a/pathetic-bukkit/README.md b/pathetic-bukkit/README.md new file mode 100644 index 00000000..ab10e921 --- /dev/null +++ b/pathetic-bukkit/README.md @@ -0,0 +1,45 @@ +# Bukkit Implementation +This is the Bukkit implementation of Pathetic. It provides a simple API to use the Pathetic engine in your Bukkit plugin. + +Currently Paper and Spigot are explicitly supported, every other server software is a lucky hit. + +## How to use it? +To integrate pathetic into your bukkit project, follow the following steps: +
    +*(We advise you to relocate pathetic)* + +

    Maven

    + +```xml + + + + jitpack.io + https://jitpack.io + + + + + com.github.Metaphoriker.pathetic + pathetic-bukkit + VERSION + +``` + +

    Gradle

    + +```groovy +allprojects { + repositories { + maven { url 'https://jitpack.io' } + } +} + +dependencies { + implementation 'com.github.Metaphoriker.pathetic:pathetic-bukkit:VERSION' +} +``` + +

    Example Usage

    + +

    See the pathetic-example module for a detailed bukkit example.

    diff --git a/pathetic-bukkit/pathetic-example/README.md b/pathetic-bukkit/pathetic-example/README.md new file mode 100644 index 00000000..e2d2cf81 --- /dev/null +++ b/pathetic-bukkit/pathetic-example/README.md @@ -0,0 +1,4 @@ +# Example +A fully working 1.21 pathetic-bukkit example. + +This works on both Paper and Spigot and lets you test the engine in a real environment. diff --git a/pathetic-example/pom.xml b/pathetic-bukkit/pathetic-example/pom.xml similarity index 88% rename from pathetic-example/pom.xml rename to pathetic-bukkit/pathetic-example/pom.xml index d8e6c94b..3b33fb6c 100644 --- a/pathetic-example/pom.xml +++ b/pathetic-bukkit/pathetic-example/pom.xml @@ -7,14 +7,15 @@ pathetic-main de.metaphoriker - 3.3.1 + 4.0 + ../../pom.xml pathetic-example - 3.3.1 + 4.0 jar - PatheticTest + pathetic-example 21 @@ -69,11 +70,13 @@ org.spigotmc spigot-api + 1.21.4-R0.1-SNAPSHOT + provided de.metaphoriker - pathetic-mapping - 3.3.1 + pathetic-bukkit + 4.0 diff --git a/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/PatheticPlugin.java b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/PatheticPlugin.java new file mode 100644 index 00000000..d3b92dea --- /dev/null +++ b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/PatheticPlugin.java @@ -0,0 +1,43 @@ +package de.metaphoriker.pathetic.example; + +import de.metaphoriker.pathetic.api.factory.PathfinderFactory; +import de.metaphoriker.pathetic.api.factory.PathfinderInitializer; +import de.metaphoriker.pathetic.api.pathing.Pathfinder; +import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; +import de.metaphoriker.pathetic.bukkit.PatheticBukkit; +import de.metaphoriker.pathetic.bukkit.initializer.BukkitPathfinderInitializer; +import de.metaphoriker.pathetic.bukkit.provider.LoadingNavigationPointProvider; +import de.metaphoriker.pathetic.engine.factory.AStarPathfinderFactory; +import de.metaphoriker.pathetic.example.command.PatheticCommand; +import org.bukkit.plugin.java.JavaPlugin; + +public final class PatheticPlugin extends JavaPlugin { + + // Called when the plugin is enabled + @Override + public void onEnable() { + + // Initialize Pathetic with this plugin instance + PatheticBukkit.initialize(this); + + // Create the respective PathfinderFactory + PathfinderFactory factory = new AStarPathfinderFactory(); + + // Some pathfinders need specific initialization + // For example Bukkit pathfinders need a BukkitPathfinderInitializer + PathfinderInitializer initializer = new BukkitPathfinderInitializer(); + + // Create custom configuration for the pathfinder + // Keep in mind that a provider must always be given + PathfinderConfiguration configuration = + PathfinderConfiguration.builder() + .provider(new LoadingNavigationPointProvider()) // For loading chunks + .fallback(true) // Allow fallback strategies if the primary fails + .build(); + + Pathfinder reusablePathfinder = factory.createPathfinder(configuration, initializer); + + // Register the command executor for the "pathetic" command + getCommand("pathetic").setExecutor(new PatheticCommand(reusablePathfinder)); + } +} diff --git a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/command/PatheticCommand.java b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/command/PatheticCommand.java similarity index 98% rename from pathetic-example/src/main/java/de/metaphoriker/pathetic/example/command/PatheticCommand.java rename to pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/command/PatheticCommand.java index 7f458fdd..3bda9d3e 100644 --- a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/command/PatheticCommand.java +++ b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/command/PatheticCommand.java @@ -7,6 +7,8 @@ import java.util.Map; import java.util.UUID; import java.util.concurrent.CompletionStage; + +import de.metaphoriker.pathetic.bukkit.mapper.BukkitMapper; import org.bukkit.Location; import org.bukkit.Material; import org.bukkit.command.Command; @@ -19,7 +21,6 @@ import de.metaphoriker.pathetic.api.wrapper.PathPosition; import de.metaphoriker.pathetic.example.filter.DangerousMaterialsFilter; import de.metaphoriker.pathetic.example.filter.MinimumHeightFilter; -import de.metaphoriker.pathetic.mapping.bukkit.BukkitMapper; public class PatheticCommand implements TabExecutor { diff --git a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/DangerousMaterialsFilter.java b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/DangerousMaterialsFilter.java similarity index 75% rename from pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/DangerousMaterialsFilter.java rename to pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/DangerousMaterialsFilter.java index 8f5c0efe..34aaf0ed 100644 --- a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/DangerousMaterialsFilter.java +++ b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/DangerousMaterialsFilter.java @@ -1,15 +1,15 @@ package de.metaphoriker.pathetic.example.filter; -import java.util.EnumSet; -import org.bukkit.Material; import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; import de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext; -import de.metaphoriker.pathetic.api.snapshot.SnapshotManager; -import de.metaphoriker.pathetic.api.wrapper.PathBlock; +import de.metaphoriker.pathetic.api.provider.NavigationPointProvider; import de.metaphoriker.pathetic.api.wrapper.PathPosition; +import de.metaphoriker.pathetic.bukkit.provider.BukkitNavigationPoint; +import java.util.EnumSet; +import org.bukkit.Material; /** - * A PathFilter that excludes nodes which are located on or near dangerous materials like lava. + * A PathFilter that excludes nodes which are located on or near dangerous materials like lava. * * @api.Note Due to the radius check, this filter can be computationally expensive. */ @@ -40,14 +40,13 @@ public DangerousMaterialsFilter(EnumSet dangerousMaterials, int radius @Override public boolean filter(PathValidationContext context) { PathPosition position = context.getPosition(); - SnapshotManager snapshotManager = context.getSnapshotManager(); - + NavigationPointProvider navigationPointProvider = context.getNavigationPointProvider(); for (int x = -radius; x <= radius; x++) { for (int y = -radius; y <= radius; y++) { for (int z = -radius; z <= radius; z++) { - PathBlock block = snapshotManager.getBlock(position.add(x, y, z)); - if (block != null - && dangerousMaterials.contains(block.getBlockInformation().getMaterial())) { + BukkitNavigationPoint bukkitNavigationPoint = + (BukkitNavigationPoint) navigationPointProvider.getNavigationPoint(position.add(x, y, z)); + if (dangerousMaterials.contains(bukkitNavigationPoint.getMaterial())) { return false; // The node is near a dangerous material, so it's excluded. } } diff --git a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/MinimumHeightFilter.java b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/MinimumHeightFilter.java similarity index 95% rename from pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/MinimumHeightFilter.java rename to pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/MinimumHeightFilter.java index 9763c70f..fc423abe 100644 --- a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/MinimumHeightFilter.java +++ b/pathetic-bukkit/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/filter/MinimumHeightFilter.java @@ -29,6 +29,6 @@ public MinimumHeightFilter(int minHeight) { @Override public boolean filter(PathValidationContext context) { PathPosition position = context.getPosition(); - return position.getBlockY() >= minHeight; + return position.getFlooredY() >= minHeight; } } diff --git a/pathetic-example/src/main/resources/plugin.yml b/pathetic-bukkit/pathetic-example/src/main/resources/plugin.yml similarity index 100% rename from pathetic-example/src/main/resources/plugin.yml rename to pathetic-bukkit/pathetic-example/src/main/resources/plugin.yml diff --git a/pathetic-bukkit/pathetic-provider/README.md b/pathetic-bukkit/pathetic-provider/README.md new file mode 100644 index 00000000..264a1710 --- /dev/null +++ b/pathetic-bukkit/pathetic-provider/README.md @@ -0,0 +1,4 @@ +# Provider +The provider module is where the actual magic happens for bukkit. + +This gives us the ability to fetch world data async and provide it to the engine. diff --git a/pathetic-nms/paper/pom.xml b/pathetic-bukkit/pathetic-provider/paper/pom.xml similarity index 76% rename from pathetic-nms/paper/pom.xml rename to pathetic-bukkit/pathetic-provider/paper/pom.xml index 68c3274c..af8863cb 100644 --- a/pathetic-nms/paper/pom.xml +++ b/pathetic-bukkit/pathetic-provider/paper/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../pom.xml paper @@ -30,8 +30,15 @@ de.metaphoriker pathetic-api - 3.3.1 + 4.0 provided + + + de.metaphoriker + pathetic-provider + 4.0 + compile + diff --git a/pathetic-nms/paper/src/main/java/de/metaphoriker/pathetic/provider/paper/PaperChunkDataProvider.java b/pathetic-bukkit/pathetic-provider/paper/src/main/java/de/metaphoriker/pathetic/provider/paper/PaperChunkDataProvider.java similarity index 91% rename from pathetic-nms/paper/src/main/java/de/metaphoriker/pathetic/provider/paper/PaperChunkDataProvider.java rename to pathetic-bukkit/pathetic-provider/paper/src/main/java/de/metaphoriker/pathetic/provider/paper/PaperChunkDataProvider.java index dff6f4cf..eb38a71d 100644 --- a/pathetic-nms/paper/src/main/java/de/metaphoriker/pathetic/provider/paper/PaperChunkDataProvider.java +++ b/pathetic-bukkit/pathetic-provider/paper/src/main/java/de/metaphoriker/pathetic/provider/paper/PaperChunkDataProvider.java @@ -1,10 +1,10 @@ package de.metaphoriker.pathetic.provider.paper; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import org.bukkit.Bukkit; import org.bukkit.ChunkSnapshot; import org.bukkit.World; import org.bukkit.block.BlockState; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class PaperChunkDataProvider implements ChunkDataProvider { diff --git a/pathetic-bukkit/pathetic-provider/pom.xml b/pathetic-bukkit/pathetic-provider/pom.xml new file mode 100644 index 00000000..cd1cfd2c --- /dev/null +++ b/pathetic-bukkit/pathetic-provider/pom.xml @@ -0,0 +1,32 @@ + + + + + pathetic-main + de.metaphoriker + 4.0 + ../../pom.xml + + + 4.0.0 + + pathetic-provider + 4.0 + + + + org.spigotmc + spigot-api + 1.21.4-R0.1-SNAPSHOT + provided + + + + de.metaphoriker + pathetic-api + + + + diff --git a/pathetic-bukkit/pathetic-provider/resolver/pom.xml b/pathetic-bukkit/pathetic-provider/resolver/pom.xml new file mode 100644 index 00000000..f1befb41 --- /dev/null +++ b/pathetic-bukkit/pathetic-provider/resolver/pom.xml @@ -0,0 +1,50 @@ + + + 4.0.0 + + de.metaphoriker + pathetic-main + 4.0 + ../../../pom.xml + + + resolver + + + + org.slf4j + slf4j-api + 2.0.16 + provided + + + + org.projectlombok + lombok + 1.18.36 + provided + + + + de.metaphoriker + pathetic-api + + + + de.metaphoriker + paper + 4.0 + compile + + + + de.metaphoriker + spigot + 4.0 + compile + + + + diff --git a/pathetic-bukkit/pathetic-provider/resolver/src/main/java/de/metaphoriker/pathetic/resolver/ChunkDataProviderResolver.java b/pathetic-bukkit/pathetic-provider/resolver/src/main/java/de/metaphoriker/pathetic/resolver/ChunkDataProviderResolver.java new file mode 100644 index 00000000..22b043d9 --- /dev/null +++ b/pathetic-bukkit/pathetic-provider/resolver/src/main/java/de/metaphoriker/pathetic/resolver/ChunkDataProviderResolver.java @@ -0,0 +1,36 @@ +package de.metaphoriker.pathetic.resolver; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; +import de.metaphoriker.pathetic.provider.paper.PaperChunkDataProvider; +import de.metaphoriker.pathetic.provider.spigot.SpigotChunkDataProviderResolver; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; + +@Getter +@Slf4j +public class ChunkDataProviderResolver { + + private final ChunkDataProvider chunkDataProvider; + + public ChunkDataProviderResolver(int major, int minor) { + String version = "1." + major + "." + minor; + + if (isPaper()) { + chunkDataProvider = new PaperChunkDataProvider(); + } else { + chunkDataProvider = SpigotChunkDataProviderResolver.resolve(major, minor); + } + + log.debug( + "Detected version v{}, using {}", version, chunkDataProvider.getClass().getSimpleName()); + } + + private boolean isPaper() { + try { + Class.forName("io.papermc.paper.configuration.GlobalConfiguration"); + return true; + } catch (ClassNotFoundException e) { + return false; + } + } +} diff --git a/pathetic-nms/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/pom.xml similarity index 79% rename from pathetic-nms/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/pom.xml index 142f6b8f..ae3c46ad 100644 --- a/pathetic-nms/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/pom.xml @@ -2,27 +2,30 @@ - + 4.0.0 - pathetic-main de.metaphoriker - 3.3.1 + pathetic-main + 4.0 + ../../../pom.xml - 4.0.0 - - pathetic-nms - 3.3.1 + spigot + 4.0 org.slf4j slf4j-api + 2.0.16 + provided org.projectlombok lombok + 1.18.36 + provided @@ -32,122 +35,121 @@ de.metaphoriker - paper - 3.3.1 + pathetic-provider + 4.0 compile de.metaphoriker v1_21_R3 - 3.3.1 + 4.0 compile de.metaphoriker v1_21_R2 - 3.3.1 + 4.0 compile de.metaphoriker v1_21_R1 - 3.3.1 + 4.0 compile de.metaphoriker v1_20_R4 - 3.3.1 + 4.0 compile de.metaphoriker v1_20_R3 - 3.3.1 + 4.0 compile de.metaphoriker v1_20_R2 - 3.3.1 + 4.0 compile de.metaphoriker v1_20_R1 - 3.3.1 + 4.0 compile de.metaphoriker v1_19_R3 - 3.3.1 + 4.0 compile de.metaphoriker v1_19_R2 - 3.3.1 + 4.0 compile de.metaphoriker v1_18_R2 - 3.3.1 + 4.0 compile de.metaphoriker v1_18 - 3.3.1 + 4.0 compile de.metaphoriker v1_17 - 3.3.1 + 4.0 compile de.metaphoriker v1_16 - 3.3.1 + 4.0 compile de.metaphoriker v1_15 - 3.3.1 + 4.0 compile de.metaphoriker v1_12 - 3.3.1 + 4.0 compile de.metaphoriker v1_8 - 3.3.1 + 4.0 compile - diff --git a/pathetic-nms/src/main/java/de/metaphoriker/pathetic/provider/ChunkDataProviderResolver.java b/pathetic-bukkit/pathetic-provider/spigot/src/main/java/de/metaphoriker/pathetic/provider/spigot/SpigotChunkDataProviderResolver.java similarity index 75% rename from pathetic-nms/src/main/java/de/metaphoriker/pathetic/provider/ChunkDataProviderResolver.java rename to pathetic-bukkit/pathetic-provider/spigot/src/main/java/de/metaphoriker/pathetic/provider/spigot/SpigotChunkDataProviderResolver.java index 0e777f78..c4e439f9 100644 --- a/pathetic-nms/src/main/java/de/metaphoriker/pathetic/provider/ChunkDataProviderResolver.java +++ b/pathetic-bukkit/pathetic-provider/spigot/src/main/java/de/metaphoriker/pathetic/provider/spigot/SpigotChunkDataProviderResolver.java @@ -1,11 +1,9 @@ -package de.metaphoriker.pathetic.provider; +package de.metaphoriker.pathetic.provider.spigot; -import lombok.Getter; -import lombok.extern.slf4j.Slf4j; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; -import de.metaphoriker.pathetic.provider.v1_16.v1_16ChunkDataProviderImpl; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import de.metaphoriker.pathetic.provider.v1_12.v1_12ChunkDataProviderImpl; import de.metaphoriker.pathetic.provider.v1_15.v1_15ChunkDataProviderImpl; +import de.metaphoriker.pathetic.provider.v1_16.v1_16ChunkDataProviderImpl; import de.metaphoriker.pathetic.provider.v1_17.v1_17ChunkDataProviderImpl; import de.metaphoriker.pathetic.provider.v1_18.v1_18ChunkDataProviderImpl; import de.metaphoriker.pathetic.provider.v1_18_R2.v1_18_R2ChunkDataProviderImpl; @@ -17,29 +15,12 @@ import de.metaphoriker.pathetic.provider.v1_20_R4.v1_20_R4ChunkDataProviderImpl; import de.metaphoriker.pathetic.provider.v1_21_R1.v1_21_R1ChunkDataProviderImpl; import de.metaphoriker.pathetic.provider.v1_21_R2.v1_21_R2ChunkDataProviderImpl; +import de.metaphoriker.pathetic.provider.v1_21_R3ChunkDataProviderImpl; import de.metaphoriker.pathetic.provider.v1_8.v1_8ChunkDataProviderImpl; -import de.metaphoriker.pathetic.provider.paper.PaperChunkDataProvider; - -@Getter -@Slf4j -public class ChunkDataProviderResolver { - private final ChunkDataProvider chunkDataProvider; - - public ChunkDataProviderResolver(int major, int minor) { - String version = "1." + major + "." + minor; - - if (isPaper()) { - chunkDataProvider = new PaperChunkDataProvider(); - } else { - chunkDataProvider = determineChunkDataProvider(major, minor); - } +public class SpigotChunkDataProviderResolver { - log.debug( - "Detected version v{}, using {}", version, chunkDataProvider.getClass().getSimpleName()); - } - - private ChunkDataProvider determineChunkDataProvider(int major, int minor) { + public static ChunkDataProvider resolve(int major, int minor) { final ChunkDataProvider chunkDataProvider; switch (major) { case 21: @@ -103,13 +84,4 @@ private ChunkDataProvider determineChunkDataProvider(int major, int minor) { } return chunkDataProvider; } - - private boolean isPaper() { - try { - Class.forName("io.papermc.paper.configuration.GlobalConfiguration"); - return true; - } catch (ClassNotFoundException e) { - return false; - } - } } diff --git a/pathetic-nms/v1_12/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_12/pom.xml similarity index 77% rename from pathetic-nms/v1_12/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_12/pom.xml index 6f9e68a4..edf29bb6 100644 --- a/pathetic-nms/v1_12/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_12/pom.xml @@ -5,8 +5,8 @@ pathetic-main de.metaphoriker - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml 4.0.0 @@ -26,7 +26,12 @@ 1.12.2-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_12/src/main/java/de/metaphoriker/pathetic/provider/v1_12/v1_12ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_12/src/main/java/de/metaphoriker/pathetic/provider/v1_12/v1_12ChunkDataProviderImpl.java similarity index 92% rename from pathetic-nms/v1_12/src/main/java/de/metaphoriker/pathetic/provider/v1_12/v1_12ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_12/src/main/java/de/metaphoriker/pathetic/provider/v1_12/v1_12ChunkDataProviderImpl.java index f83c57c7..0f2614ec 100644 --- a/pathetic-nms/v1_12/src/main/java/de/metaphoriker/pathetic/provider/v1_12/v1_12ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_12/src/main/java/de/metaphoriker/pathetic/provider/v1_12/v1_12ChunkDataProviderImpl.java @@ -1,12 +1,12 @@ package de.metaphoriker.pathetic.provider.v1_12; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.v1_12_R1.Chunk; import net.minecraft.server.v1_12_R1.WorldServer; import org.bukkit.ChunkSnapshot; import org.bukkit.World; import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_12_R1.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_12ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_15/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_15/pom.xml similarity index 77% rename from pathetic-nms/v1_15/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_15/pom.xml index 4fdd37d4..064b254f 100644 --- a/pathetic-nms/v1_15/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_15/pom.xml @@ -5,8 +5,8 @@ pathetic-main de.metaphoriker - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml 4.0.0 @@ -26,7 +26,12 @@ 1.15.2-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_15/src/main/java/de/metaphoriker/pathetic/provider/v1_15/v1_15ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_15/src/main/java/de/metaphoriker/pathetic/provider/v1_15/v1_15ChunkDataProviderImpl.java similarity index 93% rename from pathetic-nms/v1_15/src/main/java/de/metaphoriker/pathetic/provider/v1_15/v1_15ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_15/src/main/java/de/metaphoriker/pathetic/provider/v1_15/v1_15ChunkDataProviderImpl.java index 00c67c86..5c6d2b4b 100644 --- a/pathetic-nms/v1_15/src/main/java/de/metaphoriker/pathetic/provider/v1_15/v1_15ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_15/src/main/java/de/metaphoriker/pathetic/provider/v1_15/v1_15ChunkDataProviderImpl.java @@ -1,5 +1,6 @@ package de.metaphoriker.pathetic.provider.v1_15; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.v1_15_R1.ChunkStatus; import net.minecraft.server.v1_15_R1.WorldServer; import org.bukkit.ChunkSnapshot; @@ -7,7 +8,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_15_R1.CraftChunk; import org.bukkit.craftbukkit.v1_15_R1.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_15ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_16/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_16/pom.xml similarity index 77% rename from pathetic-nms/v1_16/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_16/pom.xml index 1a478533..509218e5 100644 --- a/pathetic-nms/v1_16/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_16/pom.xml @@ -5,8 +5,8 @@ pathetic-main de.metaphoriker - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml 4.0.0 @@ -26,7 +26,12 @@ 1.16.5-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_16/src/main/java/de/metaphoriker/pathetic/provider/v1_16/v1_16ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_16/src/main/java/de/metaphoriker/pathetic/provider/v1_16/v1_16ChunkDataProviderImpl.java similarity index 93% rename from pathetic-nms/v1_16/src/main/java/de/metaphoriker/pathetic/provider/v1_16/v1_16ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_16/src/main/java/de/metaphoriker/pathetic/provider/v1_16/v1_16ChunkDataProviderImpl.java index 75bcd045..aed42357 100644 --- a/pathetic-nms/v1_16/src/main/java/de/metaphoriker/pathetic/provider/v1_16/v1_16ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_16/src/main/java/de/metaphoriker/pathetic/provider/v1_16/v1_16ChunkDataProviderImpl.java @@ -1,5 +1,6 @@ package de.metaphoriker.pathetic.provider.v1_16; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.v1_16_R3.ChunkStatus; import net.minecraft.server.v1_16_R3.WorldServer; import org.bukkit.ChunkSnapshot; @@ -7,7 +8,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_16_R3.CraftChunk; import org.bukkit.craftbukkit.v1_16_R3.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_16ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_17/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_17/pom.xml similarity index 77% rename from pathetic-nms/v1_17/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_17/pom.xml index 081914c0..b2cf50cd 100644 --- a/pathetic-nms/v1_17/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_17/pom.xml @@ -5,8 +5,8 @@ pathetic-main de.metaphoriker - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml 4.0.0 @@ -26,7 +26,12 @@ 1.17.1-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_17/src/main/java/de/metaphoriker/pathetic/provider/v1_17/v1_17ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_17/src/main/java/de/metaphoriker/pathetic/provider/v1_17/v1_17ChunkDataProviderImpl.java similarity index 95% rename from pathetic-nms/v1_17/src/main/java/de/metaphoriker/pathetic/provider/v1_17/v1_17ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_17/src/main/java/de/metaphoriker/pathetic/provider/v1_17/v1_17ChunkDataProviderImpl.java index bc53b140..65f367f3 100644 --- a/pathetic-nms/v1_17/src/main/java/de/metaphoriker/pathetic/provider/v1_17/v1_17ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_17/src/main/java/de/metaphoriker/pathetic/provider/v1_17/v1_17ChunkDataProviderImpl.java @@ -1,5 +1,6 @@ package de.metaphoriker.pathetic.provider.v1_17; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -11,7 +12,6 @@ import org.bukkit.craftbukkit.v1_17_R1.CraftWorld; import org.bukkit.craftbukkit.v1_17_R1.block.CraftBlockStates; import org.bukkit.craftbukkit.v1_17_R1.block.data.CraftBlockData; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_17ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_18/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_18/pom.xml similarity index 77% rename from pathetic-nms/v1_18/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_18/pom.xml index 8445502d..cca02e05 100644 --- a/pathetic-nms/v1_18/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_18/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_18 @@ -26,6 +26,12 @@ 1.18.1-R0.1-SNAPSHOT provided + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_18/src/main/java/de/metaphoriker/pathetic/provider/v1_18/v1_18ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_18/src/main/java/de/metaphoriker/pathetic/provider/v1_18/v1_18ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_18/src/main/java/de/metaphoriker/pathetic/provider/v1_18/v1_18ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_18/src/main/java/de/metaphoriker/pathetic/provider/v1_18/v1_18ChunkDataProviderImpl.java index ca44e37e..bbbb9044 100644 --- a/pathetic-nms/v1_18/src/main/java/de/metaphoriker/pathetic/provider/v1_18/v1_18ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_18/src/main/java/de/metaphoriker/pathetic/provider/v1_18/v1_18ChunkDataProviderImpl.java @@ -1,6 +1,8 @@ package de.metaphoriker.pathetic.provider.v1_18; import java.lang.reflect.Field; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -13,7 +15,6 @@ import org.bukkit.craftbukkit.v1_18_R1.CraftWorld; import org.bukkit.craftbukkit.v1_18_R1.block.CraftBlockStates; import org.bukkit.craftbukkit.v1_18_R1.block.data.CraftBlockData; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_18ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_18_R2/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_18_R2/pom.xml similarity index 77% rename from pathetic-nms/v1_18_R2/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_18_R2/pom.xml index cc3cde35..a6a11884 100644 --- a/pathetic-nms/v1_18_R2/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_18_R2/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_18_R2 @@ -26,7 +26,12 @@ 1.18.2-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_18_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_18_R2/v1_18_R2ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_18_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_18_R2/v1_18_R2ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_18_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_18_R2/v1_18_R2ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_18_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_18_R2/v1_18_R2ChunkDataProviderImpl.java index 7b4c6391..cae4eb89 100644 --- a/pathetic-nms/v1_18_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_18_R2/v1_18_R2ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_18_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_18_R2/v1_18_R2ChunkDataProviderImpl.java @@ -1,6 +1,8 @@ package de.metaphoriker.pathetic.provider.v1_18_R2; import java.lang.reflect.Field; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -13,7 +15,6 @@ import org.bukkit.craftbukkit.v1_18_R2.CraftWorld; import org.bukkit.craftbukkit.v1_18_R2.block.CraftBlockStates; import org.bukkit.craftbukkit.v1_18_R2.block.data.CraftBlockData; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_18_R2ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_19_R2/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R2/pom.xml similarity index 77% rename from pathetic-nms/v1_19_R2/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_19_R2/pom.xml index 0436b7ed..c4c149ed 100644 --- a/pathetic-nms/v1_19_R2/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R2/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_19_R2 @@ -26,7 +26,12 @@ 1.19.3-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_19_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R2/v1_19_R2ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R2/v1_19_R2ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_19_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R2/v1_19_R2ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_19_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R2/v1_19_R2ChunkDataProviderImpl.java index ec38b740..f7ecb659 100644 --- a/pathetic-nms/v1_19_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R2/v1_19_R2ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R2/v1_19_R2ChunkDataProviderImpl.java @@ -1,6 +1,8 @@ package de.metaphoriker.pathetic.provider.v1_19_R2; import java.lang.reflect.Field; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -13,7 +15,6 @@ import org.bukkit.craftbukkit.v1_19_R2.CraftWorld; import org.bukkit.craftbukkit.v1_19_R2.block.CraftBlockStates; import org.bukkit.craftbukkit.v1_19_R2.block.data.CraftBlockData; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_19_R2ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_19_R3/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R3/pom.xml similarity index 77% rename from pathetic-nms/v1_19_R3/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_19_R3/pom.xml index c5f66833..6426193f 100644 --- a/pathetic-nms/v1_19_R3/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R3/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_19_R3 @@ -26,7 +26,12 @@ 1.19.4-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_19_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R3/v1_19_R3ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R3/v1_19_R3ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_19_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R3/v1_19_R3ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_19_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R3/v1_19_R3ChunkDataProviderImpl.java index d3e1222b..54729b83 100644 --- a/pathetic-nms/v1_19_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R3/v1_19_R3ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_19_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_19_R3/v1_19_R3ChunkDataProviderImpl.java @@ -1,6 +1,8 @@ package de.metaphoriker.pathetic.provider.v1_19_R3; import java.lang.reflect.Field; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -13,7 +15,6 @@ import org.bukkit.craftbukkit.v1_19_R3.CraftWorld; import org.bukkit.craftbukkit.v1_19_R3.block.CraftBlockStates; import org.bukkit.craftbukkit.v1_19_R3.block.data.CraftBlockData; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_19_R3ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_20_R1/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R1/pom.xml similarity index 77% rename from pathetic-nms/v1_20_R1/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R1/pom.xml index 3c6d3634..f3596249 100644 --- a/pathetic-nms/v1_20_R1/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R1/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_20_R1 @@ -26,7 +26,12 @@ 1.20.1-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_20_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R1/v1_20_R1ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R1/v1_20_R1ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_20_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R1/v1_20_R1ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R1/v1_20_R1ChunkDataProviderImpl.java index e4faba53..7056d546 100644 --- a/pathetic-nms/v1_20_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R1/v1_20_R1ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R1/v1_20_R1ChunkDataProviderImpl.java @@ -1,6 +1,8 @@ package de.metaphoriker.pathetic.provider.v1_20_R1; import java.lang.reflect.Field; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -10,7 +12,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_20_R1.CraftChunk; import org.bukkit.craftbukkit.v1_20_R1.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_20_R1ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_20_R2/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R2/pom.xml similarity index 77% rename from pathetic-nms/v1_20_R2/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R2/pom.xml index 34739e59..41c88823 100644 --- a/pathetic-nms/v1_20_R2/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R2/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_20_R2 @@ -26,7 +26,12 @@ 1.20.2-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_20_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R2/v1_20_R2ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R2/v1_20_R2ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_20_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R2/v1_20_R2ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R2/v1_20_R2ChunkDataProviderImpl.java index 9621e46e..18fc61cd 100644 --- a/pathetic-nms/v1_20_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R2/v1_20_R2ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R2/v1_20_R2ChunkDataProviderImpl.java @@ -1,5 +1,6 @@ package de.metaphoriker.pathetic.provider.v1_20_R2; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -9,7 +10,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_20_R2.CraftChunk; import org.bukkit.craftbukkit.v1_20_R2.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; import java.lang.reflect.Field; diff --git a/pathetic-nms/v1_20_R3/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R3/pom.xml similarity index 77% rename from pathetic-nms/v1_20_R3/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R3/pom.xml index 58119f61..3347b6ce 100644 --- a/pathetic-nms/v1_20_R3/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R3/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_20_R3 @@ -26,7 +26,12 @@ 1.20.4-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_20_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R3/v1_20_R3ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R3/v1_20_R3ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_20_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R3/v1_20_R3ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R3/v1_20_R3ChunkDataProviderImpl.java index 73b68cda..ff047b91 100644 --- a/pathetic-nms/v1_20_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R3/v1_20_R3ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R3/v1_20_R3ChunkDataProviderImpl.java @@ -1,6 +1,8 @@ package de.metaphoriker.pathetic.provider.v1_20_R3; import java.lang.reflect.Field; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.ChunkStatus; @@ -10,7 +12,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_20_R3.CraftChunk; import org.bukkit.craftbukkit.v1_20_R3.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public final class v1_20_R3ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_20_R4/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R4/pom.xml similarity index 77% rename from pathetic-nms/v1_20_R4/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R4/pom.xml index de40d8b4..13212682 100644 --- a/pathetic-nms/v1_20_R4/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R4/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_20_R4 @@ -26,7 +26,12 @@ 1.20.5-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_20_R4/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R4/v1_20_R4ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R4/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R4/v1_20_R4ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_20_R4/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R4/v1_20_R4ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_20_R4/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R4/v1_20_R4ChunkDataProviderImpl.java index e312f863..f3ece1ef 100644 --- a/pathetic-nms/v1_20_R4/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R4/v1_20_R4ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_20_R4/src/main/java/de/metaphoriker/pathetic/provider/v1_20_R4/v1_20_R4ChunkDataProviderImpl.java @@ -1,5 +1,6 @@ package de.metaphoriker.pathetic.provider.v1_20_R4; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.DataPaletteBlock; @@ -9,7 +10,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_20_R4.CraftChunk; import org.bukkit.craftbukkit.v1_20_R4.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; import java.lang.reflect.Field; diff --git a/pathetic-nms/v1_21_R1/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R1/pom.xml similarity index 77% rename from pathetic-nms/v1_21_R1/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_21_R1/pom.xml index 5c785ba8..89ff971f 100644 --- a/pathetic-nms/v1_21_R1/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R1/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_21_R1 @@ -26,6 +26,12 @@ 1.21.1-R0.1-SNAPSHOT provided + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_21_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R1/v1_21_R1ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R1/v1_21_R1ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_21_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R1/v1_21_R1ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_21_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R1/v1_21_R1ChunkDataProviderImpl.java index 2d690361..679a1b20 100644 --- a/pathetic-nms/v1_21_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R1/v1_21_R1ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R1/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R1/v1_21_R1ChunkDataProviderImpl.java @@ -1,5 +1,6 @@ package de.metaphoriker.pathetic.provider.v1_21_R1; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.DataPaletteBlock; @@ -9,7 +10,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_21_R1.CraftChunk; import org.bukkit.craftbukkit.v1_21_R1.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; import java.lang.reflect.Field; diff --git a/pathetic-nms/v1_21_R2/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R2/pom.xml similarity index 77% rename from pathetic-nms/v1_21_R2/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_21_R2/pom.xml index b423f930..16d15224 100644 --- a/pathetic-nms/v1_21_R2/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R2/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_21_R2 @@ -26,6 +26,12 @@ 1.21.3-R0.1-SNAPSHOT provided + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_21_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R2/v1_21_R2ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R2/v1_21_R2ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_21_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R2/v1_21_R2ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_21_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R2/v1_21_R2ChunkDataProviderImpl.java index 89f8c0dd..f0817da8 100644 --- a/pathetic-nms/v1_21_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R2/v1_21_R2ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R2/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R2/v1_21_R2ChunkDataProviderImpl.java @@ -1,6 +1,8 @@ package de.metaphoriker.pathetic.provider.v1_21_R2; import java.lang.reflect.Field; + +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.DataPaletteBlock; @@ -10,7 +12,6 @@ import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_21_R2.CraftChunk; import org.bukkit.craftbukkit.v1_21_R2.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_21_R2ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-nms/v1_21_R3/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R3/pom.xml similarity index 77% rename from pathetic-nms/v1_21_R3/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_21_R3/pom.xml index b2e510cc..2a8f2858 100644 --- a/pathetic-nms/v1_21_R3/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R3/pom.xml @@ -6,8 +6,8 @@ de.metaphoriker pathetic-main - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml v1_21_R3 @@ -26,6 +26,12 @@ 1.21.4-R0.1-SNAPSHOT provided + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_21_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R3ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R3ChunkDataProviderImpl.java similarity index 96% rename from pathetic-nms/v1_21_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R3ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_21_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R3ChunkDataProviderImpl.java index 4dc55472..90e68fa1 100644 --- a/pathetic-nms/v1_21_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R3ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_21_R3/src/main/java/de/metaphoriker/pathetic/provider/v1_21_R3ChunkDataProviderImpl.java @@ -1,6 +1,5 @@ package de.metaphoriker.pathetic.provider; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; import net.minecraft.server.level.WorldServer; import net.minecraft.world.level.block.state.IBlockData; import net.minecraft.world.level.chunk.DataPaletteBlock; diff --git a/pathetic-nms/v1_8/pom.xml b/pathetic-bukkit/pathetic-provider/spigot/v1_8/pom.xml similarity index 77% rename from pathetic-nms/v1_8/pom.xml rename to pathetic-bukkit/pathetic-provider/spigot/v1_8/pom.xml index ce2119ce..6618a349 100644 --- a/pathetic-nms/v1_8/pom.xml +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_8/pom.xml @@ -5,8 +5,8 @@ pathetic-main de.metaphoriker - 3.3.1 - ../../pom.xml + 4.0 + ../../../../pom.xml 4.0.0 @@ -26,7 +26,12 @@ 1.8.8-R0.1-SNAPSHOT provided - + + de.metaphoriker + pathetic-provider + 4.0 + compile + de.metaphoriker pathetic-api diff --git a/pathetic-nms/v1_8/src/main/java/de/metaphoriker/pathetic/provider/v1_8/v1_8ChunkDataProviderImpl.java b/pathetic-bukkit/pathetic-provider/spigot/v1_8/src/main/java/de/metaphoriker/pathetic/provider/v1_8/v1_8ChunkDataProviderImpl.java similarity index 92% rename from pathetic-nms/v1_8/src/main/java/de/metaphoriker/pathetic/provider/v1_8/v1_8ChunkDataProviderImpl.java rename to pathetic-bukkit/pathetic-provider/spigot/v1_8/src/main/java/de/metaphoriker/pathetic/provider/v1_8/v1_8ChunkDataProviderImpl.java index e18c8731..e68376e4 100644 --- a/pathetic-nms/v1_8/src/main/java/de/metaphoriker/pathetic/provider/v1_8/v1_8ChunkDataProviderImpl.java +++ b/pathetic-bukkit/pathetic-provider/spigot/v1_8/src/main/java/de/metaphoriker/pathetic/provider/v1_8/v1_8ChunkDataProviderImpl.java @@ -1,12 +1,12 @@ package de.metaphoriker.pathetic.provider.v1_8; +import de.metaphoriker.pathetic.provider.ChunkDataProvider; import net.minecraft.server.v1_8_R3.Chunk; import net.minecraft.server.v1_8_R3.WorldServer; import org.bukkit.ChunkSnapshot; import org.bukkit.World; import org.bukkit.block.BlockState; import org.bukkit.craftbukkit.v1_8_R3.CraftWorld; -import de.metaphoriker.pathetic.api.snapshot.ChunkDataProvider; public class v1_8ChunkDataProviderImpl implements ChunkDataProvider { diff --git a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/snapshot/ChunkDataProvider.java b/pathetic-bukkit/pathetic-provider/src/main/java/de/metaphoriker/pathetic/provider/ChunkDataProvider.java similarity index 94% rename from pathetic-api/src/main/java/de/metaphoriker/pathetic/api/snapshot/ChunkDataProvider.java rename to pathetic-bukkit/pathetic-provider/src/main/java/de/metaphoriker/pathetic/provider/ChunkDataProvider.java index 0e772838..62d458aa 100644 --- a/pathetic-api/src/main/java/de/metaphoriker/pathetic/api/snapshot/ChunkDataProvider.java +++ b/pathetic-bukkit/pathetic-provider/src/main/java/de/metaphoriker/pathetic/provider/ChunkDataProvider.java @@ -1,4 +1,4 @@ -package de.metaphoriker.pathetic.api.snapshot; +package de.metaphoriker.pathetic.provider; import org.bukkit.ChunkSnapshot; import org.bukkit.World; diff --git a/pathetic-bukkit/pom.xml b/pathetic-bukkit/pom.xml new file mode 100644 index 00000000..71e71bde --- /dev/null +++ b/pathetic-bukkit/pom.xml @@ -0,0 +1,58 @@ + + + 4.0.0 + + de.metaphoriker + pathetic-main + 4.0 + + + pathetic-bukkit + 4.0 + + + + org.spigotmc + spigot-api + 1.21.4-R0.1-SNAPSHOT + provided + + + org.projectlombok + lombok + 1.18.36 + provided + + + org.slf4j + slf4j-api + 2.0.16 + provided + + + de.metaphoriker + pathetic-engine + 4.0 + + + com.google.guava + guava + + + + + de.metaphoriker + resolver + 4.0 + compile + + + de.metaphoriker + pathetic-provider + 4.0 + compile + + + diff --git a/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/PatheticBukkit.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/PatheticBukkit.java new file mode 100644 index 00000000..342d5bc9 --- /dev/null +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/PatheticBukkit.java @@ -0,0 +1,47 @@ +package de.metaphoriker.pathetic.bukkit; + +import de.metaphoriker.pathetic.engine.Pathetic; +import de.metaphoriker.pathetic.bukkit.listener.ChunkInvalidateListener; +import de.metaphoriker.pathetic.bukkit.util.BukkitVersionUtil; +import de.metaphoriker.pathetic.engine.util.ErrorLogger; +import lombok.experimental.UtilityClass; +import lombok.extern.slf4j.Slf4j; +import org.bukkit.Bukkit; +import org.bukkit.plugin.java.JavaPlugin; + +@Slf4j +@UtilityClass +public class PatheticBukkit { + + private static JavaPlugin instance; + + /** + * @throws IllegalStateException If an attempt is made to initialize more than 1 time + */ + public static void initialize(JavaPlugin javaPlugin) { + + if (instance != null) throw ErrorLogger.logFatalError("Can't be initialized twice"); + + instance = javaPlugin; + Bukkit.getPluginManager().registerEvents(new ChunkInvalidateListener(), javaPlugin); + + Pathetic.loadEngineVersion(); + + if (BukkitVersionUtil.getVersion().isUnder(16, 0) + || BukkitVersionUtil.getVersion().isEqual(BukkitVersionUtil.Version.of(16, 0))) { + log.warn( + "Pathetic is currently running in a version older than or equal to 1.16. " + + "Some functionalities might not be accessible, such as accessing the BlockState of blocks."); + } + + log.debug("Pathetic v{} initialized", Pathetic.getEngineVersion()); + } + + public static boolean isInitialized() { + return instance != null; + } + + public static JavaPlugin getPluginInstance() { + return instance; + } +} diff --git a/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/hook/SpigotPathfindingHook.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/hook/SpigotPathfindingHook.java new file mode 100644 index 00000000..c5f8a85a --- /dev/null +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/hook/SpigotPathfindingHook.java @@ -0,0 +1,20 @@ +package de.metaphoriker.pathetic.bukkit.hook; + +import de.metaphoriker.pathetic.api.pathing.hook.PathfinderHook; +import de.metaphoriker.pathetic.api.pathing.hook.PathfindingContext; +import de.metaphoriker.pathetic.api.wrapper.Depth; +import de.metaphoriker.pathetic.bukkit.util.WatchdogUtil; + +public class SpigotPathfindingHook implements PathfinderHook { + + @Override + public void onPathfindingStep(PathfindingContext pathfindingContext) { + tickWatchdogIfNeeded(pathfindingContext.getDepth()); + } + + private void tickWatchdogIfNeeded(Depth depth) { + if (depth.getValue() % 500 == 0) { + WatchdogUtil.tickWatchdog(); + } + } +} diff --git a/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/initializer/BukkitPathfinderInitializer.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/initializer/BukkitPathfinderInitializer.java new file mode 100644 index 00000000..3e5c892f --- /dev/null +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/initializer/BukkitPathfinderInitializer.java @@ -0,0 +1,14 @@ +package de.metaphoriker.pathetic.bukkit.initializer; + +import de.metaphoriker.pathetic.api.pathing.Pathfinder; +import de.metaphoriker.pathetic.api.factory.PathfinderInitializer; +import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; +import de.metaphoriker.pathetic.bukkit.hook.SpigotPathfindingHook; + +public class BukkitPathfinderInitializer implements PathfinderInitializer { + + @Override + public void initialize(Pathfinder pathfinder, PathfinderConfiguration configuration) { + pathfinder.registerPathfindingHook(new SpigotPathfindingHook()); + } +} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/bukkit/listeners/ChunkInvalidateListener.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/listener/ChunkInvalidateListener.java similarity index 91% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/bukkit/listeners/ChunkInvalidateListener.java rename to pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/listener/ChunkInvalidateListener.java index 63e80bb0..370da03f 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/bukkit/listeners/ChunkInvalidateListener.java +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/listener/ChunkInvalidateListener.java @@ -1,5 +1,6 @@ -package de.metaphoriker.pathetic.bukkit.listeners; +package de.metaphoriker.pathetic.bukkit.listener; +import de.metaphoriker.pathetic.bukkit.provider.FailingNavigationPointProvider; import org.bukkit.block.Block; import org.bukkit.event.EventHandler; import org.bukkit.event.Listener; @@ -13,7 +14,6 @@ import org.bukkit.event.block.BlockPistonRetractEvent; import org.bukkit.event.block.BlockPlaceEvent; import org.bukkit.event.block.LeavesDecayEvent; -import de.metaphoriker.pathetic.model.snapshot.FailingSnapshotManager; public class ChunkInvalidateListener implements Listener { @@ -69,7 +69,7 @@ public void onDecay(LeavesDecayEvent event) { private void handleEvent(Block... blocks) { for (Block block : blocks) - FailingSnapshotManager.invalidateChunk( + FailingNavigationPointProvider.invalidateChunk( block.getWorld().getUID(), block.getChunk().getX(), block.getChunk().getZ()); } } diff --git a/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/bukkit/BukkitMapper.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/mapper/BukkitMapper.java similarity index 75% rename from pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/bukkit/BukkitMapper.java rename to pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/mapper/BukkitMapper.java index ad41c368..0916359e 100644 --- a/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/bukkit/BukkitMapper.java +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/mapper/BukkitMapper.java @@ -1,19 +1,17 @@ -package de.metaphoriker.pathetic.mapping.bukkit; +package de.metaphoriker.pathetic.bukkit.mapper; import java.util.Arrays; + import lombok.NonNull; import lombok.experimental.UtilityClass; import org.bukkit.Bukkit; import org.bukkit.Location; import org.bukkit.World; -import org.bukkit.block.Block; import org.bukkit.util.Vector; -import de.metaphoriker.pathetic.api.wrapper.BlockInformation; -import de.metaphoriker.pathetic.api.wrapper.PathBlock; import de.metaphoriker.pathetic.api.wrapper.PathEnvironment; import de.metaphoriker.pathetic.api.wrapper.PathPosition; import de.metaphoriker.pathetic.api.wrapper.PathVector; -import de.metaphoriker.pathetic.util.ErrorLogger; +import de.metaphoriker.pathetic.engine.util.ErrorLogger; @UtilityClass public class BukkitMapper { @@ -57,18 +55,6 @@ public PathVector toPathVector(Vector vector) { return new PathVector(vector.getX(), vector.getY(), vector.getZ()); } - @NonNull - public Block toBlock(@NonNull PathBlock pathBlock) { - return toLocation(pathBlock.getPathPosition()).getBlock(); - } - - @NonNull - public PathBlock toPathBlock(@NonNull Block block) { - return new PathBlock( - new PathPosition(toPathWorld(block.getWorld()), block.getX(), block.getY(), block.getZ()), - new BlockInformation(block.getType(), block.getState())); - } - public World toWorld(@NonNull PathEnvironment pathEnvironment) { return Bukkit.getWorld(pathEnvironment.getUuid()); } diff --git a/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/BukkitNavigationPoint.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/BukkitNavigationPoint.java new file mode 100644 index 00000000..e91f05ec --- /dev/null +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/BukkitNavigationPoint.java @@ -0,0 +1,20 @@ +package de.metaphoriker.pathetic.bukkit.provider; + +import de.metaphoriker.pathetic.api.provider.NavigationPoint; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import org.bukkit.Material; +import org.bukkit.block.BlockState; + +@Getter +@RequiredArgsConstructor +public class BukkitNavigationPoint implements NavigationPoint { + + private final Material material; + private final BlockState blockState; + + @Override + public boolean isTraversable() { + return !material.isSolid(); + } +} diff --git a/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/FailingNavigationPointProvider.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/FailingNavigationPointProvider.java new file mode 100644 index 00000000..e5ee45c8 --- /dev/null +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/FailingNavigationPointProvider.java @@ -0,0 +1,167 @@ +package de.metaphoriker.pathetic.bukkit.provider; + +import de.metaphoriker.pathetic.api.provider.NavigationPointProvider; +import de.metaphoriker.pathetic.api.provider.NavigationPoint; +import de.metaphoriker.pathetic.api.wrapper.PathPosition; +import de.metaphoriker.pathetic.bukkit.provider.world.WorldDomain; +import de.metaphoriker.pathetic.bukkit.util.BukkitVersionUtil; +import de.metaphoriker.pathetic.bukkit.util.ChunkUtil; +import de.metaphoriker.pathetic.resolver.ChunkDataProviderResolver; +import java.util.Map; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import lombok.NonNull; +import org.bukkit.Bukkit; +import org.bukkit.ChunkSnapshot; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.block.BlockState; + +/** + * The {@code FailingNavigationPointProvider} class implements the {@link NavigationPointProvider} + * interface and provides a default implementation for retrieving navigation point data from a + * Minecraft world. It utilizes chunk snapshots to efficiently access information, even in + * asynchronous contexts. + * + *

    This provider also uses NMS (net.minecraft.server) utilities to bypass the Spigot AsyncCatcher + * and fetch snapshots natively from an asynchronous context. This allows for more flexible and + * efficient access to world data. + * + *

    Note: While this provider is designed to efficiently retrieve navigation point data, it may + * encounter failures or null results if the pathfinder is not permitted to load chunks or if chunks + * are not loaded in the world. Developers using this provider should handle potential failures + * gracefully. + */ +public class FailingNavigationPointProvider implements NavigationPointProvider { + + /** + * A map storing chunk snapshots for each world, indexed by the world's UUID. This allows for + * efficient retrieval of chunk data without repeatedly accessing the world. + */ + protected static final Map SNAPSHOTS_MAP = new ConcurrentHashMap<>(); + + /** + * A resolver responsible for providing access to chunk data based on the server's version. This + * ensures compatibility across different Minecraft versions. + */ + protected static final ChunkDataProviderResolver CHUNK_DATA_PROVIDER_RESOLVER; + + static { + BukkitVersionUtil.Version version = BukkitVersionUtil.getVersion(); + CHUNK_DATA_PROVIDER_RESOLVER = + new ChunkDataProviderResolver((int) version.getMajor(), (int) version.getMinor()); + } + + /** + * Invalidates the cached chunk snapshot for the specified world and chunk coordinates. This + * method should be called when a chunk is modified to ensure that the provider uses the updated + * chunk data. + * + * @param worldUUID The UUID of the world. + * @param chunkX The X coordinate of the chunk. + * @param chunkZ The Z coordinate of the chunk. + */ + public static void invalidateChunk(UUID worldUUID, int chunkX, int chunkZ) { + if (SNAPSHOTS_MAP.containsKey(worldUUID)) { + WorldDomain worldDomain = SNAPSHOTS_MAP.get(worldUUID); + long chunkKey = ChunkUtil.getChunkKey(chunkX, chunkZ); + worldDomain.removeSnapshot(chunkKey); + } + } + + /** + * Fetches the navigation point data at the given position. This method retrieves the chunk + * snapshot containing the position and extracts the relevant information, such as the material + * and block state. + * + * @param position The position to fetch the navigation point for. + * @return An optional containing the navigation point if found, or an empty optional if the chunk + * is not loaded or the position is invalid. + */ + private static Optional fetchNavigationPoint(PathPosition position) { + Optional chunkSnapshotOptional = getChunkSnapshot(position); + + int chunkX = position.getFlooredX() >> 4; + int chunkZ = position.getFlooredZ() >> 4; + + if (chunkSnapshotOptional.isPresent()) { + int x = position.getFlooredX() - chunkX * 16; + int z = position.getFlooredZ() - chunkZ * 16; + + Material material = + ChunkUtil.getMaterial(chunkSnapshotOptional.get(), x, position.getFlooredY(), z); + BlockState blockState = + CHUNK_DATA_PROVIDER_RESOLVER + .getChunkDataProvider() + .getBlockState(chunkSnapshotOptional.get(), x, position.getFlooredY(), z); + return Optional.of(new BukkitNavigationPoint(material, blockState)); + } + + return Optional.empty(); + } + + /** + * Retrieves the chunk snapshot containing the given position. This method first checks if a + * snapshot is already cached for the world. If not, it attempts to load the chunk and create a + * new snapshot. + * + * @param position The position used to determine the chunk coordinates. + * @return An optional containing the chunk snapshot if found, or an empty optional if the chunk + * is not loaded or the world is invalid. + */ + protected static Optional getChunkSnapshot(PathPosition position) { + int chunkX = position.getFlooredX() >> 4; + int chunkZ = position.getFlooredZ() >> 4; + + if (SNAPSHOTS_MAP.containsKey(position.getPathEnvironment().getUuid())) { + + WorldDomain worldDomain = SNAPSHOTS_MAP.get(position.getPathEnvironment().getUuid()); + long chunkKey = ChunkUtil.getChunkKey(chunkX, chunkZ); + + Optional snapshot = worldDomain.getSnapshot(chunkKey); + if (snapshot.isPresent()) return snapshot; + } + + World world = Bukkit.getWorld(position.getPathEnvironment().getUuid()); + if (world == null) return Optional.empty(); + + if (world.isChunkLoaded(chunkX, chunkZ)) + return Optional.ofNullable( + processChunkSnapshot( + position, + chunkX, + chunkZ, + CHUNK_DATA_PROVIDER_RESOLVER + .getChunkDataProvider() + .getSnapshot(world, chunkX, chunkZ))); + + return Optional.empty(); + } + + /** + * Processes a chunk snapshot by caching it in the {@link #SNAPSHOTS_MAP}. This method ensures + * that future requests for the same chunk can be served from the cache. + * + * @param position The position used to access the world's UUID. + * @param chunkX The X coordinate of the chunk. + * @param chunkZ The Z coordinate of the chunk. + * @param chunkSnapshot The chunk snapshot to process. + * @return The processed chunk snapshot. + */ + protected static ChunkSnapshot processChunkSnapshot( + PathPosition position, int chunkX, int chunkZ, ChunkSnapshot chunkSnapshot) { + WorldDomain worldDomain = + SNAPSHOTS_MAP.computeIfAbsent( + position.getPathEnvironment().getUuid(), uuid -> new WorldDomain()); + worldDomain.addSnapshot(ChunkUtil.getChunkKey(chunkX, chunkZ), chunkSnapshot); + return chunkSnapshot; + } + + /** {@inheritDoc} */ + @Override + public NavigationPoint getNavigationPoint(@NonNull PathPosition position) { + Optional point = fetchNavigationPoint(position); + return point.orElse(null); + } +} diff --git a/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/LoadingNavigationPointProvider.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/LoadingNavigationPointProvider.java new file mode 100644 index 00000000..abcc26a2 --- /dev/null +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/LoadingNavigationPointProvider.java @@ -0,0 +1,114 @@ +package de.metaphoriker.pathetic.bukkit.provider; + +import de.metaphoriker.pathetic.api.provider.NavigationPoint; +import de.metaphoriker.pathetic.api.wrapper.PathEnvironment; +import de.metaphoriker.pathetic.api.wrapper.PathPosition; +import de.metaphoriker.pathetic.bukkit.util.ChunkUtil; +import de.metaphoriker.pathetic.engine.util.ErrorLogger; +import java.util.Optional; +import lombok.NonNull; +import org.bukkit.Bukkit; +import org.bukkit.ChunkSnapshot; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.block.BlockState; + +/** + * The {@code LoadingNavigationPointProvider} extends the {@link FailingNavigationPointProvider} and + * provides an implementation for retrieving navigation point data from a Minecraft world, ensuring + * that the required chunks are loaded if necessary. + * + *

    This provider builds upon the functionality of {@link FailingNavigationPointProvider} by + * actively loading chunks when they are not readily available, guaranteeing the retrieval of + * navigation point data even in situations where chunks might not be loaded initially. + */ +public class LoadingNavigationPointProvider extends FailingNavigationPointProvider { + + /** + * Retrieves a chunk snapshot for the specified world and chunk coordinates, loading the chunk if + * it's not already loaded. + * + * @param world The {@link PathEnvironment} representing the world. + * @param chunkX The X coordinate of the chunk. + * @param chunkZ The Z coordinate of the chunk. + * @return The {@link ChunkSnapshot} for the specified chunk. + */ + private static ChunkSnapshot retrieveChunkSnapshot( + PathEnvironment world, int chunkX, int chunkZ) { + World bukkitWorld = Bukkit.getWorld(world.getUuid()); + return CHUNK_DATA_PROVIDER_RESOLVER + .getChunkDataProvider() + .getSnapshot(bukkitWorld, chunkX, chunkZ); + } + + /** + * Retrieves a chunk snapshot for the specified {@link PathPosition}, loading the chunk if + * necessary. This method first checks if a snapshot is already cached; if not, it retrieves and + * caches a new snapshot. + * + * @param position The {@link PathPosition} used to determine the chunk coordinates. + * @return The {@link ChunkSnapshot} for the specified position. + * @throws IllegalStateException If the chunk snapshot cannot be retrieved. + */ + private static ChunkSnapshot retrieveSnapshot(PathPosition position) { + int chunkX = position.getFlooredX() >> 4; + int chunkZ = position.getFlooredZ() >> 4; + + Optional chunkSnapshotOptional = getChunkSnapshot(position); + + return chunkSnapshotOptional.orElseGet( + () -> { + ChunkSnapshot chunkSnapshot = + retrieveChunkSnapshot(position.getPathEnvironment(), chunkX, chunkZ); + + if (chunkSnapshot == null) { + throw ErrorLogger.logFatalError( + "Could not retrieve chunk snapshot for chunk at (" + + chunkX + + ", " + + chunkZ + + ") in world: " + + position.getPathEnvironment().getUuid()); + } + + processChunkSnapshot(position, chunkX, chunkZ, chunkSnapshot); + return chunkSnapshot; + }); + } + + /** + * Ensures that a {@link NavigationPoint} is available for the given {@link PathPosition} by + * retrieving the necessary chunk snapshot and extracting the relevant block data. + * + * @param pathPosition The {@link PathPosition} to get the {@link NavigationPoint} for. + * @return The {@link NavigationPoint} at the specified position. + */ + private static NavigationPoint ensureNavigationPoint(PathPosition pathPosition) { + int chunkX = pathPosition.getFlooredX() >> 4; + int chunkZ = pathPosition.getFlooredZ() >> 4; + + ChunkSnapshot chunkSnapshot = retrieveSnapshot(pathPosition); + int x = pathPosition.getFlooredX() - chunkX * 16; + int z = pathPosition.getFlooredZ() - chunkZ * 16; + + Material material = ChunkUtil.getMaterial(chunkSnapshot, x, pathPosition.getFlooredY(), z); + BlockState blockState = + CHUNK_DATA_PROVIDER_RESOLVER + .getChunkDataProvider() + .getBlockState(chunkSnapshot, x, pathPosition.getFlooredY(), z); + return new BukkitNavigationPoint(material, blockState); + } + + /** + * {@inheritDoc} + * + *

    This implementation first checks if the superclass can provide the {@link NavigationPoint}. + * If not, it ensures that the necessary chunk is loaded and retrieves the {@link NavigationPoint} + * data. + */ + @Override + public NavigationPoint getNavigationPoint(@NonNull PathPosition position) { + NavigationPoint navigationPoint = super.getNavigationPoint(position); + return navigationPoint == null ? ensureNavigationPoint(position) : navigationPoint; + } +} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/snapshot/world/WorldDomain.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/world/WorldDomain.java similarity index 87% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/model/snapshot/world/WorldDomain.java rename to pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/world/WorldDomain.java index 94fd0dfd..28f37c84 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/snapshot/world/WorldDomain.java +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/provider/world/WorldDomain.java @@ -1,9 +1,9 @@ -package de.metaphoriker.pathetic.model.snapshot.world; +package de.metaphoriker.pathetic.bukkit.provider.world; +import de.metaphoriker.pathetic.engine.util.ExpiringHashMap; import java.util.Map; import java.util.Optional; import org.bukkit.ChunkSnapshot; -import de.metaphoriker.pathetic.util.ExpiringHashMap; public class WorldDomain { diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/BukkitVersionUtil.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/BukkitVersionUtil.java similarity index 97% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/util/BukkitVersionUtil.java rename to pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/BukkitVersionUtil.java index e5f7a414..23058f3c 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/BukkitVersionUtil.java +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/BukkitVersionUtil.java @@ -1,12 +1,11 @@ -package de.metaphoriker.pathetic.util; +package de.metaphoriker.pathetic.bukkit.util; +import java.util.regex.Matcher; +import java.util.regex.Pattern; import lombok.Getter; import lombok.experimental.UtilityClass; import org.bukkit.Bukkit; -import java.util.regex.Matcher; -import java.util.regex.Pattern; - @UtilityClass public class BukkitVersionUtil { diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ChunkUtils.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/ChunkUtil.java similarity index 92% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ChunkUtils.java rename to pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/ChunkUtil.java index 29687271..b9a1fd9c 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ChunkUtils.java +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/ChunkUtil.java @@ -1,15 +1,15 @@ -package de.metaphoriker.pathetic.util; +package de.metaphoriker.pathetic.bukkit.util; +import de.metaphoriker.pathetic.engine.util.ErrorLogger; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; import lombok.SneakyThrows; import lombok.experimental.UtilityClass; import org.bukkit.ChunkSnapshot; import org.bukkit.Material; -import java.lang.reflect.InvocationTargetException; -import java.lang.reflect.Method; - @UtilityClass -public class ChunkUtils { +public class ChunkUtil { private static Method materialMethod; private static Method blockTypeMethod; diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/WatchdogUtil.java b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/WatchdogUtil.java similarity index 89% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/util/WatchdogUtil.java rename to pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/WatchdogUtil.java index aaa593ef..4c258dc6 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/WatchdogUtil.java +++ b/pathetic-bukkit/src/main/java/de/metaphoriker/pathetic/bukkit/util/WatchdogUtil.java @@ -1,5 +1,6 @@ -package de.metaphoriker.pathetic.util; +package de.metaphoriker.pathetic.bukkit.util; +import de.metaphoriker.pathetic.engine.util.ErrorLogger; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import lombok.experimental.UtilityClass; diff --git a/pathetic-engine/README.md b/pathetic-engine/README.md new file mode 100644 index 00000000..051073b6 --- /dev/null +++ b/pathetic-engine/README.md @@ -0,0 +1,54 @@ +# The Engine +Ah, pathetics core. This is where the magic happens. + +## How does it work? +A quick overview over the key features: +

      +
    • Advanced A* Algorithm: Employs multiple distance metrics (Manhattan, Octile, Perpendicular) and height differences for pathfinding, optimized for 3D worlds like Minecraft.
    • +
    • Asynchronous Pathfinding: Non-blocking operations using CompletableFuture to minimize server impact during pathfinding.
    • +
    • Fibonacci Heap for Efficient Queuing: The open set (frontier) is managed using a Fibonacci heap, ensuring optimal node retrieval with faster insert and extract min operations.
    • +
    • Customizable Heuristics: Fine-tune pathfinding behavior using HeuristicWeights for balanced navigation in any world configuration.
    • +
    • Regional Grid Optimization: Uses ExpiringHashMap and Bloom filters to efficiently track explored regions, minimizing memory overhead.
    • +
    • Dynamic Path Filters: Define custom filters to modify node validity or prioritize paths based on criteria such as passability, block type, or world boundaries.
    • +
    + +## What to do with it? +To use the engine to bend it for your own purposes, you can use the following dependency: +```xml + + + jitpack.io + https://jitpack.io + + + + + de.metaphoriker + pathetic-engine + VERSION + + + + de.metaphoriker + pathetic-api + VERSION + +``` + +

    Gradle

    + +```groovy +allprojects { + repositories { + maven { url 'https://jitpack.io' } + } +} + +dependencies { + implementation 'de.metaphoriker:pathetic-engine:VERSION' + implementation 'de.metaphoriker:pathetic-api:VERSION' +} +``` + +After that it is required to implement your own NavigationPointProvider and PathfinderFactory. +You can see a full example in the [pathetic-bukkit](https://github.com/Metaphoriker/pathetic/tree/production/pathetic-bukkit) module. diff --git a/pathetic-engine/pom.xml b/pathetic-engine/pom.xml new file mode 100644 index 00000000..988a8e68 --- /dev/null +++ b/pathetic-engine/pom.xml @@ -0,0 +1,169 @@ + + 4.0.0 + + + pathetic-main + de.metaphoriker + 4.0 + + + pathetic-engine + 4.0 + + + + + org.apache.maven.plugins + maven-shade-plugin + 3.5.1 + + + + org.jheaps + de.metaphoriker.pathetic.shaded.jheaps + + + org.tinylog + de.metaphoriker.pathetic.shaded.tinylog + + + org.checkerframework + de.metaphoriker.pathetic.shaded.checkerframework + + + javax.annotation + de.metaphoriker.pathetic.shaded.javax + + + com.google + de.metaphoriker.pathetic.shaded.google + + + + + org.jheaps:jheaps + + org/jheaps/tree/FibonacciHeap.class + org/jheaps/tree/FibonacciHeap$Node.class + org/jheaps/annotations/ConstantTime.class + org/jheaps/annotations/LogarithmicTime.class + org/jheaps/MergeableAddressableHeap.class + org/jheaps/AddressableHeap.class + org/jheaps/AddressableHeap$Handle.class + + + + com.google.guava:guava + + com/google/common/hash/BloomFilter.class + com/google/common/hash/BloomFilterStrategies.class + com/google/common/hash/BloomFilter$Strategy.class + com/google/common/hash/BloomFilterStrategies$1.class + com/google/common/hash/BloomFilterStrategies$2.class + com/google/common/hash/BloomFilterStrategies$LockFreeBitArray.class + com/google/common/hash/Funnel.class + com/google/common/hash/PrimitiveSink.class + + com/google/common/collect/Iterables.class + com/google/common/collect/Iterators.class + com/google/common/collect/ImmutableList.class + com/google/common/collect/RegularImmutableList.class + com/google/common/collect/SingletonImmutableList.class + com/google/common/collect/UnmodifiableIterator.class + com/google/common/collect/AbstractIndexedListIterator.class + + com/google/common/base/Predicate.class + com/google/common/base/Supplier.class + com/google/common/base/Objects.class + + com/google/common/base/Preconditions.class + com/google/common/math/LongMath.class + com/google/common/math/LongMath$1.class + com/google/common/primitives/Ints.class + com/google/common/primitives/UnsignedBytes.class + com/google/common/primitives/IntsMethodsForWeb.class + com/google/common/primitives/Longs.class + com/google/common/hash/Hashing.class + com/google/common/hash/Murmur3_32HashFunction.class + com/google/common/hash/Murmur3_128HashFunction.class + com/google/common/hash/AbstractCompositeHashFunction.class + com/google/common/hash/Striped64.class + com/google/common/hash/LongAddable.class + com/google/common/hash/LongAddables.class + com/google/common/hash/LongAddables$PureJavaLongAddable.class + com/google/common/hash/LongAddables$2.class + com/google/common/hash/LongAdder.class + com/google/common/hash/HashFunction.class + com/google/common/hash/Hasher.class + com/google/common/hash/HashCode.class + com/google/common/hash/HashCode$BytesHashCode.class + com/google/common/hash/HashCode$IntHashCode.class + com/google/common/hash/HashCode$LongHashCode.class + com/google/common/hash/AbstractHasher.class + com/google/common/hash/AbstractHashFunction.class + com/google/common/hash/AbstractStreamingHasher.class + com/google/common/hash/Murmur3_128HashFunction$Murmur3_128Hasher.class + com/google/common/hash/Java8Compatibility.class + + + + + + + package + + shade + + + + + + + + + + org.tinylog + tinylog-api + 2.7.0 + compile + + + org.tinylog + tinylog-impl + 2.7.0 + compile + + + com.google.guava + guava + 33.4.0-jre + compile + + + de.metaphoriker + pathetic-api + 4.0 + compile + + + org.jheaps + jheaps + 0.14 + compile + + + org.junit.jupiter + junit-jupiter-api + 5.11.4 + test + + + org.mockito + mockito-core + 5.14.2 + test + + + diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/Node.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Node.java similarity index 64% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/Node.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Node.java index f5a296b0..9b5e255a 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/Node.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Node.java @@ -1,21 +1,15 @@ -package de.metaphoriker.pathetic.model.pathing; +package de.metaphoriker.pathetic.engine; -import lombok.EqualsAndHashCode; -import lombok.Getter; -import lombok.NonNull; -import lombok.RequiredArgsConstructor; -import lombok.Setter; import de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights; import de.metaphoriker.pathetic.api.wrapper.PathPosition; import de.metaphoriker.pathetic.api.wrapper.PathVector; -import de.metaphoriker.pathetic.util.ComputingCache; +import de.metaphoriker.pathetic.engine.util.ComputingCache; + +import java.util.Objects; -@Getter -@EqualsAndHashCode(onlyExplicitlyIncluded = true) -@RequiredArgsConstructor public class Node implements Comparable { - @EqualsAndHashCode.Include private final PathPosition position; + private final PathPosition position; private final PathPosition start; private final PathPosition target; private final HeuristicWeights heuristicWeights; @@ -25,12 +19,53 @@ public class Node implements Comparable { private final ComputingCache gCostCache = new ComputingCache<>(this::calculateGCost); private final ComputingCache heuristic = new ComputingCache<>(this::heuristic); - @Setter private Node parent; + private Node parent; + + public Node( + PathPosition position, + PathPosition start, + PathPosition target, + HeuristicWeights heuristicWeights, + int depth) { + this.position = position; + this.start = start; + this.target = target; + this.heuristicWeights = heuristicWeights; + this.depth = depth; + } + + public PathPosition getPosition() { + return position; + } + + public PathPosition getStart() { + return start; + } + + public PathPosition getTarget() { + return target; + } + + public ComputingCache getHeuristic() { + return heuristic; + } + + public Node getParent() { + return parent; + } + + public int getDepth() { + return depth; + } + + public void setParent(Node parent) { + this.parent = parent; + } public boolean isTarget() { - return this.position.getBlockX() == target.getBlockX() - && this.position.getBlockY() == target.getBlockY() - && this.position.getBlockZ() == target.getBlockZ(); + return this.position.getFlooredX() == target.getFlooredX() + && this.position.getFlooredY() == target.getFlooredY() + && this.position.getFlooredZ() == target.getFlooredZ(); } /** @@ -67,14 +102,14 @@ private double heuristic() { double manhattanDistance = this.position.manhattanDistance(target); double octileDistance = this.position.octileDistance(target); double perpendicularDistance = calculatePerpendicularDistance(); - double heightDifference = Math.abs(this.position.getBlockY() - target.getBlockY()); + double heightDifference = Math.abs(this.position.getFlooredY() - target.getFlooredY()); double manhattanWeight = heuristicWeights.getManhattanWeight(); double octileWeight = heuristicWeights.getOctileWeight(); double perpendicularWeight = heuristicWeights.getPerpendicularWeight(); double heightWeight = heuristicWeights.getHeightWeight(); - double directionalPenalty = Math.abs(this.position.getBlockY() - start.getBlockY()); + double directionalPenalty = Math.abs(this.position.getFlooredY() - start.getFlooredY()); return (manhattanDistance * manhattanWeight) + (octileDistance * octileWeight) @@ -91,7 +126,19 @@ private double calculatePerpendicularDistance() { } @Override - public int compareTo(@NonNull Node o) { + public boolean equals(Object o) { + if (o == null || getClass() != o.getClass()) return false; + Node node = (Node) o; + return Objects.equals(position, node.position); + } + + @Override + public int hashCode() { + return Objects.hashCode(position); + } + + @Override + public int compareTo(Node o) { int fCostComparison = Double.compare(this.getFCost(), o.getFCost()); if (fCostComparison != 0) { return fCostComparison; diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/Offset.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Offset.java similarity index 90% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/Offset.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Offset.java index e16310ea..d9aa6e19 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/Offset.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Offset.java @@ -1,12 +1,8 @@ -package de.metaphoriker.pathetic.model.pathing; +package de.metaphoriker.pathetic.engine; -import java.util.stream.Stream; -import lombok.AllArgsConstructor; -import lombok.Getter; import de.metaphoriker.pathetic.api.wrapper.PathVector; +import java.util.stream.Stream; -@Getter -@AllArgsConstructor public enum Offset { VERTICAL_AND_HORIZONTAL( new PathVector[] { @@ -54,4 +50,12 @@ public enum Offset { .toArray(PathVector[]::new)); private final PathVector[] vectors; + + Offset(PathVector[] vectors) { + this.vectors = vectors; + } + + public PathVector[] getVectors() { + return vectors; + } } diff --git a/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Pathetic.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Pathetic.java new file mode 100644 index 00000000..0ece5df0 --- /dev/null +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/Pathetic.java @@ -0,0 +1,33 @@ +package de.metaphoriker.pathetic.engine; + +import de.metaphoriker.pathetic.engine.util.ErrorLogger; +import java.io.IOException; +import java.io.InputStream; +import java.util.Properties; + +public class Pathetic { + + private static final String PROPERTIES_FILE = "pathetic.properties"; + + private static String engineVersion; + + private Pathetic() { + throw new AssertionError("Pathetic is a utility class and should not be instantiated"); + } + + public static void loadEngineVersion() { + try (InputStream inputStream = + Pathetic.class.getClassLoader().getResourceAsStream(PROPERTIES_FILE)) { + Properties properties = new Properties(); + properties.load(inputStream); + + engineVersion = properties.getProperty("engine.version"); + } catch (IOException e) { + throw ErrorLogger.logFatalError("Error loading engine version", e); + } + } + + public static String getEngineVersion() { + return engineVersion; + } +} diff --git a/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/factory/AStarPathfinderFactory.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/factory/AStarPathfinderFactory.java new file mode 100644 index 00000000..ff6904e1 --- /dev/null +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/factory/AStarPathfinderFactory.java @@ -0,0 +1,24 @@ +package de.metaphoriker.pathetic.engine.factory; + +import de.metaphoriker.pathetic.api.factory.PathfinderFactory; +import de.metaphoriker.pathetic.api.pathing.Pathfinder; +import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; +import de.metaphoriker.pathetic.api.provider.NavigationPointProvider; +import de.metaphoriker.pathetic.engine.pathfinder.AStarPathfinder; + +public class AStarPathfinderFactory implements PathfinderFactory { + + /** + * Creates a new {@link AStarPathfinder} instance with the given configuration. The created + * pathfinder is initialized using the initializer provided to this factory. The {@link + * NavigationPointProvider} is obtained from the provided {@link PathfinderConfiguration}. + * + * @param configuration The configuration for the pathfinder, including the navigation point + * provider. + * @return A new, initialized {@link AStarPathfinder} instance. + */ + @Override + public Pathfinder createPathfinder(PathfinderConfiguration configuration) { + return new AStarPathfinder(configuration.getProvider(), configuration); + } +} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/AStarPathfinder.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/pathfinder/AStarPathfinder.java similarity index 73% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/AStarPathfinder.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/pathfinder/AStarPathfinder.java index 11b7d0e7..683cbd05 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/AStarPathfinder.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/pathfinder/AStarPathfinder.java @@ -1,24 +1,24 @@ -package de.metaphoriker.pathetic.model.pathing.pathfinder; +package de.metaphoriker.pathetic.engine.pathfinder; import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; import de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage; import de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext; +import de.metaphoriker.pathetic.api.provider.NavigationPointProvider; +import de.metaphoriker.pathetic.api.wrapper.Depth; import de.metaphoriker.pathetic.api.wrapper.PathPosition; import de.metaphoriker.pathetic.api.wrapper.PathVector; -import de.metaphoriker.pathetic.model.pathing.Node; -import de.metaphoriker.pathetic.model.pathing.Offset; -import de.metaphoriker.pathetic.util.ExpiringHashMap; -import de.metaphoriker.pathetic.util.GridRegionData; -import de.metaphoriker.pathetic.util.Tuple3; -import de.metaphoriker.pathetic.util.WatchdogUtil; +import de.metaphoriker.pathetic.engine.Node; +import de.metaphoriker.pathetic.engine.Offset; +import de.metaphoriker.pathetic.engine.util.ExpiringHashMap; +import de.metaphoriker.pathetic.engine.util.GridRegionData; +import de.metaphoriker.pathetic.engine.util.Tuple3; import java.util.*; import org.jheaps.tree.FibonacciHeap; public class AStarPathfinder extends AbstractPathfinder { private static final int DEFAULT_GRID_CELL_SIZE = 12; - private static final int PRIORITY_BOOST_IN_PERCENTAGE = 80; /** * The grid map used to store the regional examined positions and Bloom filters for each grid @@ -27,8 +27,11 @@ public class AStarPathfinder extends AbstractPathfinder { private final Map, ExpiringHashMap.Entry> gridMap = new ExpiringHashMap<>(); - public AStarPathfinder(PathfinderConfiguration pathfinderConfiguration) { + private final NavigationPointProvider navigationPointProvider; + + public AStarPathfinder(NavigationPointProvider navigationPointProvider, PathfinderConfiguration pathfinderConfiguration) { super(pathfinderConfiguration); + this.navigationPointProvider = navigationPointProvider; } @Override @@ -42,18 +45,10 @@ protected void tick( List filters, List filterStages) { - tickWatchdogIfNeeded(depth); - evaluateNewNodes(nodeQueue, examinedPositions, currentNode, filters, filterStages); depth.increment(); } - private void tickWatchdogIfNeeded(Depth depth) { - if (depth.getDepth() % 500 == 0) { - WatchdogUtil.tickWatchdog(); - } - } - private void evaluateNewNodes( FibonacciHeap nodeQueue, Set examinedPositions, @@ -66,32 +61,10 @@ private void evaluateNewNodes( for (Node newNode : newNodes) { double nodeCost = newNode.getHeuristic().get(); - if (pathfinderConfiguration.isPrioritizing()) { - double priorityAdjustment = calculatePriorityAdjustment(newNode, filterStages); - nodeCost -= priorityAdjustment; - } nodeQueue.insert(nodeCost, newNode); } } - private double calculatePriorityAdjustment(Node node, List filterStages) { - for (PathFilterStage filterStage : filterStages) { - boolean filterResult = - filterStage.filter( - new PathValidationContext( - node.getPosition(), - node.getParent() != null ? node.getParent().getPosition() : null, - node.getStart(), - node.getTarget(), - snapshotManager)); - - if (filterResult) { - return node.getHeuristic().get() * (PRIORITY_BOOST_IN_PERCENTAGE / 100.0); - } - } - return 0.0; - } - private boolean isNodeValid( Node currentNode, Node newNode, @@ -108,8 +81,8 @@ private boolean isNodeValid( } private boolean isDiagonalMove(Node from, Node to) { - int xDifference = Math.abs(from.getPosition().getBlockX() - to.getPosition().getBlockX()); - int zDifference = Math.abs(from.getPosition().getBlockZ() - to.getPosition().getBlockZ()); + int xDifference = Math.abs(from.getPosition().getFlooredX() - to.getPosition().getFlooredX()); + int zDifference = Math.abs(from.getPosition().getFlooredZ() - to.getPosition().getFlooredZ()); return xDifference != 0 && zDifference != 0; } @@ -120,7 +93,7 @@ private boolean isDiagonalMove(Node from, Node to) { */ private boolean isReachable( Node from, Node to, List filters, List filterStages) { - boolean hasYDifference = from.getPosition().getBlockY() != to.getPosition().getBlockY(); + boolean hasYDifference = from.getPosition().getFlooredY() != to.getPosition().getFlooredY(); PathVector[] offsets = Offset.VERTICAL_AND_HORIZONTAL.getVectors(); for (PathVector vector1 : offsets) { @@ -141,8 +114,7 @@ private boolean isReachable( isHeightDifferencePassable(from, to, vector1, hasYDifference); if (doAllFiltersPass(filters, neighbour1) - && (!pathfinderConfiguration.isPrioritizing() - && doAnyFilterStagePass(filterStages, neighbour1)) + && doAnyFilterStagePass(filterStages, neighbour1) && heightDifferencePassable) return true; } } @@ -155,10 +127,11 @@ private boolean isHeightDifferencePassable( Node from, Node to, PathVector vector1, boolean hasHeightDifference) { if (!hasHeightDifference) return true; - int yDifference = from.getPosition().getBlockY() - to.getPosition().getBlockY(); + int yDifference = from.getPosition().getFlooredY() - to.getPosition().getFlooredY(); Node neighbour3 = createNeighbourNode(from, vector1.add(new PathVector(0, yDifference, 0))); - return snapshotManager.getBlock(neighbour3.getPosition()).isPassable(); + // TODO: 15.12.2024: do we really need to check if the block is passable, or can we use the filters? + return navigationPointProvider.getNavigationPoint(neighbour3.getPosition()).isTraversable(); } private Collection fetchValidNeighbours( @@ -198,9 +171,9 @@ private Node createNeighbourNode(Node currentNode, PathVector offset) { private boolean isNodeInvalid( Node node, List filters, List filterStages) { - int gridX = node.getPosition().getBlockX() / DEFAULT_GRID_CELL_SIZE; - int gridY = node.getPosition().getBlockY() / DEFAULT_GRID_CELL_SIZE; - int gridZ = node.getPosition().getBlockZ() / DEFAULT_GRID_CELL_SIZE; + int gridX = node.getPosition().getFlooredX() / DEFAULT_GRID_CELL_SIZE; + int gridY = node.getPosition().getFlooredY() / DEFAULT_GRID_CELL_SIZE; + int gridZ = node.getPosition().getFlooredZ() / DEFAULT_GRID_CELL_SIZE; GridRegionData regionData = gridMap @@ -228,7 +201,7 @@ private boolean isNodeInvalid( return true; // Node is invalid if filters fail } - return !pathfinderConfiguration.isPrioritizing() && !stagesPass; + return !stagesPass; } private boolean doAllFiltersPass(List filters, Node node) { @@ -239,7 +212,7 @@ private boolean doAllFiltersPass(List filters, Node node) { node.getParent() != null ? node.getParent().getPosition() : null, node.getStart(), node.getTarget(), - snapshotManager); + navigationPointProvider); if (!filter.filter(context)) { return false; @@ -258,7 +231,7 @@ private boolean doAnyFilterStagePass(List filterStages, Node no node.getParent() != null ? node.getParent().getPosition() : null, node.getStart(), node.getTarget(), - snapshotManager))) { + navigationPointProvider))) { return true; } } @@ -266,7 +239,7 @@ private boolean doAnyFilterStagePass(List filterStages, Node no } private boolean isWithinWorldBounds(PathPosition position) { - return position.getPathEnvironment().getMinHeight() < position.getBlockY() - && position.getBlockY() < position.getPathEnvironment().getMaxHeight(); + return position.getPathEnvironment().getMinHeight() < position.getFlooredY() + && position.getFlooredY() < position.getPathEnvironment().getMaxHeight(); } } diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/AbstractPathfinder.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/pathfinder/AbstractPathfinder.java similarity index 62% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/AbstractPathfinder.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/pathfinder/AbstractPathfinder.java index d8cb3ead..5183ab49 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/AbstractPathfinder.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/pathfinder/AbstractPathfinder.java @@ -1,5 +1,20 @@ -package de.metaphoriker.pathetic.model.pathing.pathfinder; +package de.metaphoriker.pathetic.engine.pathfinder; +import de.metaphoriker.pathetic.api.pathing.Pathfinder; +import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; +import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; +import de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage; +import de.metaphoriker.pathetic.api.pathing.hook.PathfinderHook; +import de.metaphoriker.pathetic.api.pathing.hook.PathfindingContext; +import de.metaphoriker.pathetic.api.pathing.result.Path; +import de.metaphoriker.pathetic.api.pathing.result.PathState; +import de.metaphoriker.pathetic.api.pathing.result.PathfinderResult; +import de.metaphoriker.pathetic.api.wrapper.Depth; +import de.metaphoriker.pathetic.api.wrapper.PathPosition; +import de.metaphoriker.pathetic.engine.Node; +import de.metaphoriker.pathetic.engine.result.PathImpl; +import de.metaphoriker.pathetic.engine.result.PathfinderResultImpl; +import de.metaphoriker.pathetic.engine.util.ErrorLogger; import java.util.ArrayList; import java.util.Collections; import java.util.HashSet; @@ -11,31 +26,8 @@ import java.util.concurrent.CompletionStage; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; -import javax.annotation.Nullable; -import lombok.NonNull; + import org.jheaps.tree.FibonacciHeap; -import de.metaphoriker.pathetic.BStatsHandler; -import de.metaphoriker.pathetic.Pathetic; -import de.metaphoriker.pathetic.api.event.EventPublisher; -import de.metaphoriker.pathetic.api.event.PathingFinishedEvent; -import de.metaphoriker.pathetic.api.event.PathingStartFindEvent; -import de.metaphoriker.pathetic.api.pathing.Pathfinder; -import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; -import de.metaphoriker.pathetic.api.pathing.filter.PathFilter; -import de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage; -import de.metaphoriker.pathetic.api.pathing.result.Path; -import de.metaphoriker.pathetic.api.pathing.result.PathState; -import de.metaphoriker.pathetic.api.pathing.result.PathfinderResult; -import de.metaphoriker.pathetic.api.snapshot.SnapshotManager; -import de.metaphoriker.pathetic.api.wrapper.PathBlock; -import de.metaphoriker.pathetic.api.wrapper.PathPosition; -import de.metaphoriker.pathetic.api.wrapper.PathVector; -import de.metaphoriker.pathetic.model.pathing.Node; -import de.metaphoriker.pathetic.model.pathing.Offset; -import de.metaphoriker.pathetic.model.pathing.result.PathImpl; -import de.metaphoriker.pathetic.model.pathing.result.PathfinderResultImpl; -import de.metaphoriker.pathetic.model.snapshot.FailingSnapshotManager; -import de.metaphoriker.pathetic.util.ErrorLogger; /** * The AbstractPathfinder class provides a skeletal implementation of the Pathfinder interface and @@ -52,57 +44,41 @@ abstract class AbstractPathfinder implements Pathfinder { protected static final Set EMPTY_LINKED_HASHSET = Collections.unmodifiableSet(new LinkedHashSet<>(0)); - private static final SnapshotManager SIMPLE_SNAPSHOT_MANAGER = new FailingSnapshotManager(); - private static final SnapshotManager LOADING_SNAPSHOT_MANAGER = - new FailingSnapshotManager.RequestingSnapshotManager(); - private static final ExecutorService PATHING_EXECUTOR = Executors.newWorkStealingPool(); static { - Pathetic.addShutdownListener(PATHING_EXECUTOR::shutdown); + Runtime.getRuntime().addShutdownHook(new Thread(PATHING_EXECUTOR::shutdown)); } + private final Set pathfinderHooks = new HashSet<>(); + protected final PathfinderConfiguration pathfinderConfiguration; - protected final SnapshotManager snapshotManager; private volatile boolean aborted; protected AbstractPathfinder(PathfinderConfiguration pathfinderConfiguration) { this.pathfinderConfiguration = pathfinderConfiguration; - this.snapshotManager = determineSnapshotManager(pathfinderConfiguration); - } - - private SnapshotManager determineSnapshotManager( - PathfinderConfiguration pathfinderConfiguration) { - return pathfinderConfiguration.isLoadingChunks() - ? LOADING_SNAPSHOT_MANAGER - : SIMPLE_SNAPSHOT_MANAGER; } @Override - public @NonNull CompletionStage findPath( - @NonNull PathPosition start, - @NonNull PathPosition target, - @Nullable List filters) { + public CompletionStage findPath( + PathPosition start, PathPosition target, List filters) { return findPath(start, target, filters, null); } @Override - public @NonNull CompletionStage findPath( - @NonNull PathPosition start, - @NonNull PathPosition target, - @Nullable List sharedFilters, - @Nullable List<@NonNull PathFilterStage> filterStages) { + public CompletionStage findPath( + PathPosition start, + PathPosition target, + List sharedFilters, + List filterStages) { if (sharedFilters == null) sharedFilters = Collections.emptyList(); if (filterStages == null) filterStages = Collections.emptyList(); - raiseStartEvent(start, target, sharedFilters, filterStages); - if (shouldSkipPathing(start, target)) { return CompletableFuture.completedFuture( - finishPathing( - new PathfinderResultImpl( - PathState.INITIALLY_FAILED, new PathImpl(start, target, EMPTY_LINKED_HASHSET)))); + new PathfinderResultImpl( + PathState.INITIALLY_FAILED, new PathImpl(start, target, EMPTY_LINKED_HASHSET))); } return initiatePathing(start, target, sharedFilters, filterStages); @@ -114,10 +90,13 @@ public void abort() { this.aborted = true; } + @Override + public void registerPathfindingHook(PathfinderHook hook) { + pathfinderHooks.add(hook); + } + private boolean shouldSkipPathing(PathPosition start, PathPosition target) { - return !isSameEnvironment(start, target) - || isSameBlock(start, target) - || isFastFailEnabledAndBlockUnreachable(start, target); + return !isSameEnvironment(start, target) || isSameBlock(start, target); } private boolean isSameEnvironment(PathPosition start, PathPosition target) { @@ -128,43 +107,19 @@ private boolean isSameBlock(PathPosition start, PathPosition target) { return start.isInSameBlock(target); } - private boolean isFastFailEnabledAndBlockUnreachable(PathPosition start, PathPosition target) { - return this.pathfinderConfiguration.isAllowingFailFast() - && (isBlockUnreachable(target) || isBlockUnreachable(start)); - } - - private boolean isBlockUnreachable(PathPosition position) { - for (PathVector vector : Offset.MERGED.getVectors()) { - PathPosition offsetPosition = position.add(vector); - PathBlock pathBlock = this.snapshotManager.getBlock(offsetPosition); - if (pathBlock != null && pathBlock.isPassable()) { - return false; - } - } - return true; - } - private CompletionStage initiatePathing( PathPosition start, PathPosition target, List filters, List filterStages) { - pushToBStatsIfActivated(); return pathfinderConfiguration.isAsync() ? CompletableFuture.supplyAsync( () -> executePathingAndCleanupFilters(start, target, filters, filterStages), PATHING_EXECUTOR) - .thenApply(this::finishPathing) .exceptionally(throwable -> handleException(start, target, throwable)) : initiateSyncPathing(start, target, filters, filterStages); } - private void pushToBStatsIfActivated() { - if (pathfinderConfiguration.isBStats()) { - BStatsHandler.increasePathCount(); - } - } - private PathfinderResult executePathing( PathPosition start, PathPosition target, @@ -176,11 +131,13 @@ private PathfinderResult executePathing( nodeQueue.insert(startNode.getFCost(), startNode); Set examinedPositions = new HashSet<>(); - Depth depth = new Depth(1); + Depth depth = Depth.of(1); Node fallbackNode = startNode; while (!nodeQueue.isEmpty() - && depth.getDepth() <= pathfinderConfiguration.getMaxIterations()) { + && depth.getValue() <= pathfinderConfiguration.getMaxIterations()) { + + pathfinderHooks.forEach(hook -> hook.onPathfindingStep(new PathfindingContext(depth))); if (isAborted()) return abortedPathing(fallbackNode); @@ -188,11 +145,11 @@ private PathfinderResult executePathing( fallbackNode = currentNode; if (hasReachedLengthLimit(currentNode)) { - return finishPathing(PathState.LENGTH_LIMITED, currentNode); + return new PathfinderResultImpl(PathState.LENGTH_LIMITED, fetchRetracedPath(currentNode)); } if (currentNode.isTarget()) { - return finishPathing(PathState.FOUND, currentNode); + return new PathfinderResultImpl(PathState.FOUND, fetchRetracedPath(currentNode)); } tick( @@ -209,7 +166,7 @@ private PathfinderResult executePathing( private PathfinderResult abortedPathing(Node fallbackNode) { aborted = false; - return finishPathing(PathState.ABORTED, fallbackNode); + return new PathfinderResultImpl(PathState.ABORTED, fetchRetracedPath(fallbackNode)); } private boolean isAborted() { @@ -243,29 +200,8 @@ private PathfinderResult executePathingAndCleanupFilters( private PathfinderResult handleException( PathPosition start, PathPosition target, Throwable throwable) { ErrorLogger.logFatalError("Failed to find path async", throwable); - return finishPathing( - new PathfinderResultImpl( - PathState.FAILED, new PathImpl(start, target, EMPTY_LINKED_HASHSET))); - } - - protected PathfinderResult finishPathing(PathfinderResult pathfinderResult) { - raiseFinishedEvent(pathfinderResult); - return pathfinderResult; - } - - private void raiseFinishedEvent(PathfinderResult pathfinderResult) { - PathingFinishedEvent finishedEvent = new PathingFinishedEvent(pathfinderResult); - EventPublisher.raiseEvent(finishedEvent); - } - - private void raiseStartEvent( - PathPosition start, - PathPosition target, - List filters, - List filterStages) { - PathingStartFindEvent startEvent = - new PathingStartFindEvent(start, target, filters, filterStages); - EventPublisher.raiseEvent(startEvent); + return new PathfinderResultImpl( + PathState.FAILED, new PathImpl(start, target, EMPTY_LINKED_HASHSET)); } private Node createStartNode(PathPosition start, PathPosition target) { @@ -282,10 +218,6 @@ private boolean hasReachedLengthLimit(Node currentNode) { && currentNode.getDepth() > pathfinderConfiguration.getMaxLength(); } - private PathfinderResult finishPathing(PathState pathState, Node currentNode) { - return finishPathing(new PathfinderResultImpl(pathState, fetchRetracedPath(currentNode))); - } - /** If the pathfinder has failed to find a path, it will try to still give a result. */ private PathfinderResult backupPathfindingOrFailure( Depth depth, PathPosition start, PathPosition target, Node fallbackNode) { @@ -298,29 +230,26 @@ private PathfinderResult backupPathfindingOrFailure( Optional fallbackResult = fallback(fallbackNode); return fallbackResult.orElseGet( () -> - finishPathing( - new PathfinderResultImpl( - PathState.FAILED, new PathImpl(start, target, EMPTY_LINKED_HASHSET)))); + new PathfinderResultImpl( + PathState.FAILED, new PathImpl(start, target, EMPTY_LINKED_HASHSET))); } private Optional maxIterationsReached(Depth depth, Node fallbackNode) { - if (depth.getDepth() > pathfinderConfiguration.getMaxIterations()) + if (depth.getValue() > pathfinderConfiguration.getMaxIterations()) return Optional.of( - finishPathing( - new PathfinderResultImpl( - PathState.MAX_ITERATIONS_REACHED, fetchRetracedPath(fallbackNode)))); + new PathfinderResultImpl( + PathState.MAX_ITERATIONS_REACHED, fetchRetracedPath(fallbackNode))); return Optional.empty(); } private Optional fallback(Node fallbackNode) { - if (pathfinderConfiguration.isAllowingFallback()) + if (pathfinderConfiguration.isFallback()) return Optional.of( - finishPathing( - new PathfinderResultImpl(PathState.FALLBACK, fetchRetracedPath(fallbackNode)))); + new PathfinderResultImpl(PathState.FALLBACK, fetchRetracedPath(fallbackNode))); return Optional.empty(); } - private Path fetchRetracedPath(@NonNull Node node) { + private Path fetchRetracedPath(Node node) { if (node.getParent() == null) return new PathImpl( node.getStart(), node.getTarget(), Collections.singletonList(node.getPosition())); diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/result/PathImpl.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/result/PathImpl.java similarity index 86% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/result/PathImpl.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/result/PathImpl.java index 987ded3b..8cb27d9d 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/result/PathImpl.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/result/PathImpl.java @@ -1,4 +1,4 @@ -package de.metaphoriker.pathetic.model.pathing.result; +package de.metaphoriker.pathetic.engine.result; import com.google.common.collect.Iterables; import java.util.ArrayList; @@ -10,36 +10,45 @@ import java.util.function.Consumer; import java.util.stream.Collectors; import java.util.stream.Stream; -import lombok.AccessLevel; -import lombok.Getter; -import lombok.NonNull; -import lombok.Value; import de.metaphoriker.pathetic.api.pathing.result.Path; import de.metaphoriker.pathetic.api.util.ParameterizedSupplier; import de.metaphoriker.pathetic.api.wrapper.PathPosition; -import de.metaphoriker.pathetic.util.ErrorLogger; +import de.metaphoriker.pathetic.engine.util.ErrorLogger; -@Value public class PathImpl implements Path { - @NonNull @Getter(AccessLevel.NONE) Iterable positions; - @NonNull PathPosition start; - @NonNull PathPosition end; + private final Iterable positions; + private final PathPosition start; + private final PathPosition end; - int length; + private final int length; public PathImpl( - @NonNull PathPosition start, - @NonNull PathPosition end, - @NonNull Iterable<@NonNull PathPosition> positions) { + PathPosition start, + PathPosition end, + Iterable< PathPosition> positions) { this.start = start; this.end = end; this.positions = positions; this.length = Iterables.size(positions); } + public Iterable getPositions() { + return positions; + } + + @Override + public PathPosition getStart() { + return start; + } + + @Override + public PathPosition getEnd() { + return end; + } + @Override - public @NonNull Iterator iterator() { + public Iterator iterator() { return positions.iterator(); } @@ -125,7 +134,7 @@ public Path trim(int length) { return new PathImpl(start, Iterables.getLast(limitedPositions), limitedPositions); } - @NonNull + @Override public Path mutatePositions(ParameterizedSupplier mutator) { List positionList = new LinkedList<>(); diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/result/PathfinderResultImpl.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/result/PathfinderResultImpl.java similarity index 83% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/result/PathfinderResultImpl.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/result/PathfinderResultImpl.java index 647e7005..baa6a3ae 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/result/PathfinderResultImpl.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/result/PathfinderResultImpl.java @@ -1,17 +1,19 @@ -package de.metaphoriker.pathetic.model.pathing.result; +package de.metaphoriker.pathetic.engine.result; -import lombok.AllArgsConstructor; -import lombok.NonNull; import de.metaphoriker.pathetic.api.pathing.result.Path; import de.metaphoriker.pathetic.api.pathing.result.PathState; import de.metaphoriker.pathetic.api.pathing.result.PathfinderResult; -@AllArgsConstructor public class PathfinderResultImpl implements PathfinderResult { private final PathState pathState; private final Path path; + public PathfinderResultImpl(PathState pathState, Path path) { + this.pathState = pathState; + this.path = path; + } + @Override public boolean successful() { return pathState == PathState.FOUND; @@ -30,12 +32,10 @@ public boolean hasFallenBack() { } @Override - @NonNull public PathState getPathState() { return this.pathState; } - @NonNull @Override public Path getPath() { return this.path; diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ComputingCache.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ComputingCache.java similarity index 87% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ComputingCache.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ComputingCache.java index 59b4c618..af7c4c5c 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ComputingCache.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ComputingCache.java @@ -1,4 +1,4 @@ -package de.metaphoriker.pathetic.util; +package de.metaphoriker.pathetic.engine.util; import java.util.function.Supplier; diff --git a/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ErrorLogger.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ErrorLogger.java new file mode 100644 index 00000000..0b372c20 --- /dev/null +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ErrorLogger.java @@ -0,0 +1,33 @@ +package de.metaphoriker.pathetic.engine.util; + +import de.metaphoriker.pathetic.engine.Pathetic; +import org.tinylog.Logger; + +public class ErrorLogger { + + private ErrorLogger() { + throw new AssertionError("ErrorLogger is a utility class and should not be instantiated"); + } + + public static IllegalStateException logFatalError(String message) { + return logFatalError(message, null); + } + + public static IllegalStateException logFatalError(String message, Throwable cause) { + Logger.error("==============================="); + Logger.error("A fatal error has occurred: {}", message); + Logger.error("Please open an issue on the Pathetic GitHub page with all this information:"); + Logger.error("Version: {}", Pathetic.getEngineVersion()); + Logger.error("Java Version: {}", System.getProperty("java.version")); + Logger.error("OS: {}", System.getProperty("os.name")); + Logger.error("OS Architecture: {}", System.getProperty("os.arch")); + Logger.error("==============================="); + return new IllegalStateException(message, cause); + } + + public static IllegalStateException logFatalErrorWithStacktrace(String message, Throwable cause) { + IllegalStateException exception = logFatalError(message, cause); + Logger.error("Stacktrace:", cause); + return exception; + } +} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ExpiringHashMap.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ExpiringHashMap.java similarity index 92% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ExpiringHashMap.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ExpiringHashMap.java index 69f62c3b..2bca0efe 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ExpiringHashMap.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/ExpiringHashMap.java @@ -1,7 +1,6 @@ -package de.metaphoriker.pathetic.util; +package de.metaphoriker.pathetic.engine.util; import java.util.concurrent.ConcurrentHashMap; -import lombok.Getter; /** * A {@link ConcurrentHashMap} that removes entries on access if they are expired. @@ -52,7 +51,7 @@ private void removeExpiredEntries() { public static class Entry { - @Getter private final V value; + private final V value; private final long expirationTime; public Entry(V value) { @@ -60,6 +59,10 @@ public Entry(V value) { this.expirationTime = System.currentTimeMillis() + EXPIRATION_TIME; } + public V getValue() { + return value; + } + public boolean isExpired() { return System.currentTimeMillis() > expirationTime; } diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/GridRegionData.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/GridRegionData.java similarity index 82% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/util/GridRegionData.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/GridRegionData.java index 2627d61a..da0438b4 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/GridRegionData.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/GridRegionData.java @@ -1,11 +1,10 @@ -package de.metaphoriker.pathetic.util; +package de.metaphoriker.pathetic.engine.util; import com.google.common.hash.BloomFilter; import com.google.common.hash.Funnel; import java.util.HashSet; import java.util.Set; -import lombok.Getter; import de.metaphoriker.pathetic.api.wrapper.PathPosition; /** @@ -13,7 +12,6 @@ * Bloom filter used to quickly check if a position is within the region and a set of positions that * have been examined by the pathfinder. */ -@Getter public class GridRegionData { /** @@ -46,11 +44,19 @@ public class GridRegionData { public GridRegionData() { Funnel pathPositionFunnel = (pathPosition, into) -> - into.putInt(pathPosition.getBlockX()) - .putInt(pathPosition.getBlockY()) - .putInt(pathPosition.getBlockZ()); + into.putInt(pathPosition.getFlooredX()) + .putInt(pathPosition.getFlooredY()) + .putInt(pathPosition.getFlooredZ()); bloomFilter = BloomFilter.create(pathPositionFunnel, DEFAULT_BLOOM_FILTER_SIZE, DEFAULT_FPP); regionalExaminedPositions = new HashSet<>(); } + + public BloomFilter getBloomFilter() { + return bloomFilter; + } + + public Set getRegionalExaminedPositions() { + return regionalExaminedPositions; + } } diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/Tuple3.java b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/Tuple3.java similarity index 92% rename from pathetic-model/src/main/java/de/metaphoriker/pathetic/util/Tuple3.java rename to pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/Tuple3.java index c1ceb0e1..711f6f87 100644 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/Tuple3.java +++ b/pathetic-engine/src/main/java/de/metaphoriker/pathetic/engine/util/Tuple3.java @@ -1,4 +1,4 @@ -package de.metaphoriker.pathetic.util; +package de.metaphoriker.pathetic.engine.util; import java.util.Objects; diff --git a/pathetic-engine/src/main/resources/pathetic.properties b/pathetic-engine/src/main/resources/pathetic.properties new file mode 100644 index 00000000..c367fd6b --- /dev/null +++ b/pathetic-engine/src/main/resources/pathetic.properties @@ -0,0 +1 @@ +engine.version=${project.version} diff --git a/pathetic-engine/src/test/java/de/metaphoriker/pathetic/engine/result/PathImplTest.java b/pathetic-engine/src/test/java/de/metaphoriker/pathetic/engine/result/PathImplTest.java new file mode 100644 index 00000000..dd4c6859 --- /dev/null +++ b/pathetic-engine/src/test/java/de/metaphoriker/pathetic/engine/result/PathImplTest.java @@ -0,0 +1,130 @@ +package de.metaphoriker.pathetic.engine.result; + +import static org.junit.jupiter.api.Assertions.*; + +import de.metaphoriker.pathetic.api.pathing.result.Path; +import de.metaphoriker.pathetic.api.wrapper.PathEnvironment; +import de.metaphoriker.pathetic.api.wrapper.PathPosition; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +class PathImplTest { + + @Test + void testIterator() { + List positions = createPathPositions(5); + Path path = new PathImpl(positions.get(0), positions.get(4), positions); + + int count = 0; + for (PathPosition position : path) { + assertEquals(positions.get(count), position); + count++; + } + assertEquals(positions.size(), count); + } + + @Test + void testForEach() { + List positions = createPathPositions(5); + Path path = new PathImpl(positions.get(0), positions.get(4), positions); + + List collectedPositions = new ArrayList<>(); + path.forEach(collectedPositions::add); + + assertEquals(positions, collectedPositions); + } + + @Test + void testInterpolate() { + List positions = createPathPositions(2); + Path path = new PathImpl(positions.get(0), positions.get(1), positions); + + Path interpolatedPath = path.interpolate(0.5); + + assertEquals(6, interpolatedPath.length()); + } + + @Test + void testSimplify() { + List positions = createPathPositions(10); + Path path = new PathImpl(positions.get(0), positions.get(9), positions); + + Path simplifiedPath = path.simplify(0.5); + + assertTrue(simplifiedPath.length() < path.length()); + } + + @Test + void testSimplifyInvalidEpsilon() { + List positions = createPathPositions(10); + Path path = new PathImpl(positions.get(0), positions.get(9), positions); + + assertThrows(IllegalStateException.class, () -> path.simplify(-0.5)); + assertThrows(IllegalStateException.class, () -> path.simplify(1.5)); + } + + @Test + void testJoin() { + List positions1 = createPathPositions(5); + List positions2 = createPathPositions(5, 5); + Path path1 = new PathImpl(positions1.get(0), positions1.get(4), positions1); + Path path2 = new PathImpl(positions2.get(0), positions2.get(4), positions2); + + Path joinedPath = path1.join(path2); + + assertEquals(positions1.get(0), joinedPath.getStart()); + assertEquals(positions2.get(4), joinedPath.getEnd()); + assertEquals(10, joinedPath.length()); + } + + @Test + void testTrim() { + List positions = createPathPositions(5); + Path path = new PathImpl(positions.get(0), positions.get(4), positions); + + Path trimmedPath = path.trim(3); + + assertEquals(3, trimmedPath.length()); + assertEquals(positions.get(0), trimmedPath.getStart()); + assertEquals(positions.get(2), trimmedPath.getEnd()); + } + + @Test + void testMutatePositions() { + List positions = createPathPositions(5); + Path path = new PathImpl(positions.get(0), positions.get(4), positions); + + Path mutatedPath = + path.mutatePositions( + position -> + new PathPosition( + Mockito.mock(PathEnvironment.class), + position.getX() + 1, + position.getY() + 1, + position.getZ() + 1)); + + assertEquals(5, mutatedPath.length()); + } + + @Test + void testLength() { + List positions = createPathPositions(5); + Path path = new PathImpl(positions.get(0), positions.get(4), positions); + + assertEquals(5, path.length()); + } + + private List createPathPositions(int numPositions) { + return createPathPositions(numPositions, 0); + } + + private List createPathPositions(int numPositions, int startIndex) { + List positions = new ArrayList<>(); + for (int i = startIndex; i < startIndex + numPositions; i++) { + positions.add(new PathPosition(Mockito.mock(PathEnvironment.class), i, i, i)); + } + return positions; + } +} diff --git a/pathetic-example/README.md b/pathetic-example/README.md deleted file mode 100644 index 4848c9cf..00000000 --- a/pathetic-example/README.md +++ /dev/null @@ -1 +0,0 @@ -A Spigot latest version Test Plugin to demonstrate the use of Pathetic. diff --git a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/PatheticPlugin.java b/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/PatheticPlugin.java deleted file mode 100644 index c225f546..00000000 --- a/pathetic-example/src/main/java/de/metaphoriker/pathetic/example/PatheticPlugin.java +++ /dev/null @@ -1,38 +0,0 @@ -package de.metaphoriker.pathetic.example; - -import de.metaphoriker.pathetic.api.pathing.Pathfinder; -import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; -import de.metaphoriker.pathetic.example.command.PatheticCommand; -import de.metaphoriker.pathetic.mapping.PatheticFacade; -import de.metaphoriker.pathetic.mapping.PathfinderFactory; -import org.bukkit.plugin.java.JavaPlugin; - -public final class PatheticPlugin extends JavaPlugin { - - // Called when the plugin is enabled - @Override - public void onEnable() { - - // Initialize the PatheticMapper with this plugin instance - PatheticFacade.initialize(this); - - // Create a new Pathfinder instance with a custom configuration - Pathfinder reusablePathfinder = - PathfinderFactory.createPathfinder( // Use the factory to create a new pathfinder instance - PathfinderConfiguration.createConfiguration() - .withAllowingFailFast(true) // Allow pathfinding to fail fast if necessary - .withAllowingFallback(true) // Allow fallback strategies if the primary fails - .withLoadingChunks(true) // Allow chunks to be loaded during pathfinding - ); - - // Register the command executor for the "pathetic" command - getCommand("pathetic").setExecutor(new PatheticCommand(reusablePathfinder)); - } - - // Called when the plugin is disabled - @Override - public void onDisable() { - // Shutdown the PatheticMapper to clear any resources it holds - PatheticFacade.shutdown(); - } -} diff --git a/pathetic-mapping/pom.xml b/pathetic-mapping/pom.xml deleted file mode 100644 index a00fa6ff..00000000 --- a/pathetic-mapping/pom.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - pathetic-main - de.metaphoriker - 3.3.1 - - 4.0.0 - - pathetic-mapping - 3.3.1 - - - - - org.apache.maven.plugins - maven-shade-plugin - 3.5.1 - - - package - - shade - - - - - - - - - - de.metaphoriker - pathetic-model - 3.3.1 - compile - - - org.spigotmc - spigot-api - - - org.projectlombok - lombok - - - - diff --git a/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/PatheticFacade.java b/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/PatheticFacade.java deleted file mode 100644 index 086e685f..00000000 --- a/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/PatheticFacade.java +++ /dev/null @@ -1,29 +0,0 @@ -package de.metaphoriker.pathetic.mapping; - -import de.metaphoriker.pathetic.Pathetic; -import lombok.experimental.UtilityClass; -import org.bukkit.plugin.java.JavaPlugin; - -/** PatheticMapper is a utility class that maps the Pathetic API to the Pathetic Implementation. */ -@UtilityClass -public class PatheticFacade { - - /** - * @apiNote If Pathetic is not initialized yet but is used anyways, this will cause many things to - * break. - * @param javaPlugin the JavaPlugin which initializes the lib - * @throws IllegalStateException If an attempt is made to initialize more than once - */ - public void initialize(JavaPlugin javaPlugin) { - Pathetic.initialize(javaPlugin); - } - - /** - * Signals Pathetic to initiate its shutdown process, releasing resources and finalizing - * operations. This method should be called when Pathetic is no longer needed or the plugin is - * being disabled. - */ - public void shutdown() { - Pathetic.shutdown(); - } -} diff --git a/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/PathfinderFactory.java b/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/PathfinderFactory.java deleted file mode 100644 index 4e61e0a5..00000000 --- a/pathetic-mapping/src/main/java/de/metaphoriker/pathetic/mapping/PathfinderFactory.java +++ /dev/null @@ -1,27 +0,0 @@ -package de.metaphoriker.pathetic.mapping; - -import de.metaphoriker.pathetic.Pathetic; -import de.metaphoriker.pathetic.api.pathing.Pathfinder; -import de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration; -import de.metaphoriker.pathetic.model.pathing.pathfinder.AStarPathfinder; -import de.metaphoriker.pathetic.util.ErrorLogger; - -/** A factory class for creating {@link Pathfinder} instances. */ -public final class PathfinderFactory { - - private PathfinderFactory() {} - - /** - * Creates a new {@link Pathfinder} instance. - * - * @param pathfinderConfiguration The configuration for the pathfinder. - * @return A new {@link Pathfinder} instance. - * @throws IllegalStateException If Pathetic is not initialized. - */ - public static Pathfinder createPathfinder(PathfinderConfiguration pathfinderConfiguration) { - if (!Pathetic.isInitialized()) { - throw ErrorLogger.logFatalError("Pathetic is not initialized yet."); - } - return new AStarPathfinder(pathfinderConfiguration); - } -} diff --git a/pathetic-model/pom.xml b/pathetic-model/pom.xml deleted file mode 100644 index 9f2a9c45..00000000 --- a/pathetic-model/pom.xml +++ /dev/null @@ -1,125 +0,0 @@ - - 4.0.0 - - - pathetic-main - de.metaphoriker - 3.3.1 - - - pathetic-model - 3.3.1 - - - - - src/main/resources - true - - - - - - org.apache.maven.plugins - maven-shade-plugin - 3.5.1 - - - - org.bstats - de.metaphoriker.pathetic.shaded.bstats - - - org.jheaps - de.metaphoriker.pathetic.shaded.jheaps - - - - - org.jheaps:jheaps - - org/jheaps/tree/FibonacciHeap.class - org/jheaps/tree/FibonacciHeap$Node.class - org/jheaps/annotations/ConstantTime.class - org/jheaps/annotations/LogarithmicTime.class - org/jheaps/MergeableAddressableHeap.class - org/jheaps/AddressableHeap.class - org/jheaps/AddressableHeap$Handle.class - - - - - - - package - - shade - - - - - - org.apache.maven.plugins - maven-compiler-plugin - - 8 - 8 - - - - - - - - spigot-repo - https://hub.spigotmc.org/nexus/content/repositories/snapshots/ - - - - - - org.spigotmc - spigot-api - - - org.projectlombok - lombok - - - org.slf4j - slf4j-api - - - com.google.guava - guava - 33.3.1-jre - provided - - - de.metaphoriker - pathetic-api - 3.3.1 - compile - - - de.metaphoriker - pathetic-nms - 3.3.1 - compile - - - org.bstats - bstats-bukkit - 3.1.0 - compile - - - org.jheaps - jheaps - 0.14 - compile - - - diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/BStatsHandler.java b/pathetic-model/src/main/java/de/metaphoriker/pathetic/BStatsHandler.java deleted file mode 100644 index 2e27e918..00000000 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/BStatsHandler.java +++ /dev/null @@ -1,42 +0,0 @@ -package de.metaphoriker.pathetic; - -import lombok.experimental.UtilityClass; -import org.bstats.bukkit.Metrics; -import org.bstats.charts.SimplePie; -import org.bstats.charts.SingleLineChart; -import org.bukkit.plugin.java.JavaPlugin; - -@UtilityClass -public class BStatsHandler { - - private Metrics metrics; - - private int paths; - - private void init(JavaPlugin javaPlugin) { - if (metrics != null) return; - - metrics = new Metrics(javaPlugin, 20529); - metrics.addCustomChart( - new SingleLineChart( - "total_paths", - () -> { - int totalPaths = paths; - paths = 0; - return totalPaths; - })); - metrics.addCustomChart(new SimplePie("pathetic-model_version", Pathetic::getModelVersion)); - } - - private void makeSureBStatsIsInitialized() { - if (!Pathetic.isInitialized()) - throw new IllegalStateException("Pathetic has not been initialized yet"); - - init(Pathetic.getPluginInstance()); - } - - public synchronized void increasePathCount() { - makeSureBStatsIsInitialized(); - paths++; - } -} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/Pathetic.java b/pathetic-model/src/main/java/de/metaphoriker/pathetic/Pathetic.java deleted file mode 100644 index 433e8bf4..00000000 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/Pathetic.java +++ /dev/null @@ -1,81 +0,0 @@ -package de.metaphoriker.pathetic; - -import java.io.IOException; -import java.io.InputStream; -import java.util.HashSet; -import java.util.Properties; -import java.util.Set; -import lombok.Getter; -import lombok.experimental.UtilityClass; -import lombok.extern.slf4j.Slf4j; -import org.bukkit.Bukkit; -import org.bukkit.plugin.java.JavaPlugin; -import de.metaphoriker.pathetic.bukkit.listeners.ChunkInvalidateListener; -import de.metaphoriker.pathetic.util.BukkitVersionUtil; -import de.metaphoriker.pathetic.util.ErrorLogger; - -@UtilityClass -@Slf4j -public class Pathetic { - - private static final String PROPERTIES_FILE = "pathetic.properties"; - - private static final Set SHUTDOWN_LISTENERS = new HashSet<>(); - - private static JavaPlugin instance; - @Getter private static String modelVersion; - - /** - * @throws IllegalStateException If an attempt is made to initialize more than 1 time - */ - public static void initialize(JavaPlugin javaPlugin) { - - if (instance != null) throw ErrorLogger.logFatalError("Can't be initialized twice"); - - instance = javaPlugin; - Bukkit.getPluginManager().registerEvents(new ChunkInvalidateListener(), javaPlugin); - - loadModelVersion(); - - if (BukkitVersionUtil.getVersion().isUnder(16, 0) - || BukkitVersionUtil.getVersion().isEqual(BukkitVersionUtil.Version.of(16, 0))) { - log.warn( - "Pathetic is currently running in a version older than or equal to 1.16. " - + "Some functionalities might not be accessible, such as accessing the BlockState of blocks."); - } - - log.debug("Pathetic v{} initialized", modelVersion); - } - - public static void shutdown() { - SHUTDOWN_LISTENERS.forEach(Runnable::run); - SHUTDOWN_LISTENERS.clear(); - - instance = null; - log.debug("Pathetic shutdown"); - } - - public static boolean isInitialized() { - return instance != null; - } - - public static JavaPlugin getPluginInstance() { - return instance; - } - - public static void addShutdownListener(Runnable listener) { - SHUTDOWN_LISTENERS.add(listener); - } - - private static void loadModelVersion() { - try (InputStream inputStream = - Pathetic.class.getClassLoader().getResourceAsStream(PROPERTIES_FILE)) { - Properties properties = new Properties(); - properties.load(inputStream); - - modelVersion = properties.getProperty("model.version"); - } catch (IOException e) { - throw ErrorLogger.logFatalError("Error loading model version", e); - } - } -} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/Depth.java b/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/Depth.java deleted file mode 100644 index 7f19b203..00000000 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/pathing/pathfinder/Depth.java +++ /dev/null @@ -1,19 +0,0 @@ -package de.metaphoriker.pathetic.model.pathing.pathfinder; - -import lombok.EqualsAndHashCode; -import lombok.Getter; - -@Getter -@EqualsAndHashCode -public class Depth { - - private int depth; - - public Depth(int depth) { - this.depth = depth; - } - - public void increment() { - depth++; - } -} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/snapshot/FailingSnapshotManager.java b/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/snapshot/FailingSnapshotManager.java deleted file mode 100644 index 82da0553..00000000 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/model/snapshot/FailingSnapshotManager.java +++ /dev/null @@ -1,237 +0,0 @@ -package de.metaphoriker.pathetic.model.snapshot; - -import java.util.Map; -import java.util.Optional; -import java.util.UUID; -import java.util.concurrent.ConcurrentHashMap; -import lombok.NonNull; -import org.bukkit.Bukkit; -import org.bukkit.ChunkSnapshot; -import org.bukkit.Material; -import org.bukkit.World; -import org.bukkit.block.BlockState; -import de.metaphoriker.pathetic.api.snapshot.SnapshotManager; -import de.metaphoriker.pathetic.api.wrapper.BlockInformation; -import de.metaphoriker.pathetic.api.wrapper.PathBlock; -import de.metaphoriker.pathetic.api.wrapper.PathEnvironment; -import de.metaphoriker.pathetic.api.wrapper.PathPosition; -import de.metaphoriker.pathetic.model.snapshot.world.WorldDomain; -import de.metaphoriker.pathetic.provider.ChunkDataProviderResolver; -import de.metaphoriker.pathetic.util.BukkitVersionUtil; -import de.metaphoriker.pathetic.util.ChunkUtils; -import de.metaphoriker.pathetic.util.ErrorLogger; - -/** - * The FailingSnapshotManager class implements the SnapshotManager interface and provides a default - * implementation for retrieving block data snapshots from a Minecraft world. It utilizes chunk - * snapshots to efficiently access block information, even in asynchronous contexts. - * - *

    FailingSnapshotManager also uses NMS (net.minecraft.server) utilities to bypass the Spigot - * AsyncCatcher and fetch snapshots natively from an asynchronous context. This allows for more - * flexible and efficient access to world data. - * - *

    Note: While this manager is designed to efficiently retrieve block data snapshots, it may - * encounter failures or null results if the pathfinder is not permitted to load chunks or if chunks - * are not loaded in the world. Developers using this manager should handle potential failures - * gracefully. - */ -public class FailingSnapshotManager implements SnapshotManager { - - private static final Map SNAPSHOTS_MAP = new ConcurrentHashMap<>(); - - private static final ChunkDataProviderResolver CHUNK_DATA_PROVIDER_RESOLVER; - - static { - BukkitVersionUtil.Version version = BukkitVersionUtil.getVersion(); - CHUNK_DATA_PROVIDER_RESOLVER = - new ChunkDataProviderResolver((int) version.getMajor(), (int) version.getMinor()); - } - - public static void invalidateChunk(UUID worldUUID, int chunkX, int chunkZ) { - if (SNAPSHOTS_MAP.containsKey(worldUUID)) { - WorldDomain worldDomain = SNAPSHOTS_MAP.get(worldUUID); - long chunkKey = ChunkUtils.getChunkKey(chunkX, chunkZ); - worldDomain.removeSnapshot(chunkKey); - } - } - - private static Optional fetchBlock(PathPosition position) { - Optional chunkSnapshotOptional = getChunkSnapshot(position); - - int chunkX = position.getBlockX() >> 4; - int chunkZ = position.getBlockZ() >> 4; - - if (chunkSnapshotOptional.isPresent()) { - int x = position.getBlockX() - chunkX * 16; - int z = position.getBlockZ() - chunkZ * 16; - - Material material = - ChunkUtils.getMaterial(chunkSnapshotOptional.get(), x, position.getBlockY(), z); - BlockState blockState = - CHUNK_DATA_PROVIDER_RESOLVER - .getChunkDataProvider() - .getBlockState(chunkSnapshotOptional.get(), x, position.getBlockY(), z); - return Optional.of(new PathBlock(position, new BlockInformation(material, blockState))); - } - - return Optional.empty(); - } - - private static Optional getChunkSnapshot(PathPosition position) { - int chunkX = position.getBlockX() >> 4; - int chunkZ = position.getBlockZ() >> 4; - - if (SNAPSHOTS_MAP.containsKey(position.getPathEnvironment().getUuid())) { - - WorldDomain worldDomain = SNAPSHOTS_MAP.get(position.getPathEnvironment().getUuid()); - long chunkKey = ChunkUtils.getChunkKey(chunkX, chunkZ); - - Optional snapshot = worldDomain.getSnapshot(chunkKey); - if (snapshot.isPresent()) return snapshot; - } - - World world = Bukkit.getWorld(position.getPathEnvironment().getUuid()); - if (world == null) return Optional.empty(); - - if (world.isChunkLoaded(chunkX, chunkZ)) - return Optional.ofNullable( - processChunkSnapshot( - position, - chunkX, - chunkZ, - CHUNK_DATA_PROVIDER_RESOLVER - .getChunkDataProvider() - .getSnapshot(world, chunkX, chunkZ))); - - return Optional.empty(); - } - - private static ChunkSnapshot processChunkSnapshot( - PathPosition position, int chunkX, int chunkZ, ChunkSnapshot chunkSnapshot) { - WorldDomain worldDomain = - SNAPSHOTS_MAP.computeIfAbsent( - position.getPathEnvironment().getUuid(), uuid -> new WorldDomain()); - worldDomain.addSnapshot(ChunkUtils.getChunkKey(chunkX, chunkZ), chunkSnapshot); - return chunkSnapshot; - } - - @Override - public PathBlock getBlock(@NonNull PathPosition position) { - Optional block = fetchBlock(position); - return block.orElse(null); - } - - @Override - public PathBlock getHighestBlockAt(PathPosition position) { - Optional chunkSnapshotOptional = getChunkSnapshot(position); - - if (chunkSnapshotOptional.isPresent()) { - ChunkSnapshot chunkSnapshot = chunkSnapshotOptional.get(); - - int chunkX = position.getBlockX() & 0xF; - int chunkZ = position.getBlockZ() & 0xF; - - int highestY = chunkSnapshot.getHighestBlockYAt(chunkX, chunkZ); - - PathPosition highestBlockPosition = - new PathPosition( - position.getPathEnvironment(), position.getBlockX(), highestY, position.getBlockZ()); - BlockState blockState = - CHUNK_DATA_PROVIDER_RESOLVER - .getChunkDataProvider() - .getBlockState(chunkSnapshot, chunkX, highestY, chunkZ); - - Material material = chunkSnapshot.getBlockType(chunkX, highestY, chunkZ); - return new PathBlock(highestBlockPosition, new BlockInformation(material, blockState)); - } - - // if no valid chunk snapshot was found - return null; - } - - /** - * The RequestingSnapshotManager is an inner class of FailingSnapshotManager, extending it. This - * class provides additional functionality for ensuring that block data snapshots are available, - * even if not initially loaded. - */ - public static class RequestingSnapshotManager extends FailingSnapshotManager { - - private static ChunkSnapshot retrieveChunkSnapshot( - PathEnvironment world, int chunkX, int chunkZ) { - World bukkitWorld = Bukkit.getWorld(world.getUuid()); - return CHUNK_DATA_PROVIDER_RESOLVER - .getChunkDataProvider() - .getSnapshot(bukkitWorld, chunkX, chunkZ); - } - - private static ChunkSnapshot retrieveSnapshot(PathPosition position) { - int chunkX = position.getBlockX() >> 4; - int chunkZ = position.getBlockZ() >> 4; - - Optional chunkSnapshotOptional = getChunkSnapshot(position); - - return chunkSnapshotOptional.orElseGet( - () -> { - ChunkSnapshot chunkSnapshot = - retrieveChunkSnapshot(position.getPathEnvironment(), chunkX, chunkZ); - - if (chunkSnapshot == null) - throw ErrorLogger.logFatalError("Could not retrieve chunk snapshot --> BOOM!"); - - processChunkSnapshot(position, chunkX, chunkZ, chunkSnapshot); - return chunkSnapshot; - }); - } - - private static PathBlock ensureBlock(PathPosition pathPosition) { - int chunkX = pathPosition.getBlockX() >> 4; - int chunkZ = pathPosition.getBlockZ() >> 4; - - ChunkSnapshot chunkSnapshot = retrieveSnapshot(pathPosition); - int x = pathPosition.getBlockX() - chunkX * 16; - int z = pathPosition.getBlockZ() - chunkZ * 16; - - Material material = ChunkUtils.getMaterial(chunkSnapshot, x, pathPosition.getBlockY(), z); - BlockState blockState = - CHUNK_DATA_PROVIDER_RESOLVER - .getChunkDataProvider() - .getBlockState(chunkSnapshot, x, pathPosition.getBlockY(), z); - return new PathBlock(pathPosition, new BlockInformation(material, blockState)); - } - - @Override - public PathBlock getBlock(@NonNull PathPosition position) { - PathBlock block = super.getBlock(position); - return block == null ? ensureBlock(position) : block; - } - - @Override - public PathBlock getHighestBlockAt(@NonNull PathPosition position) { - PathBlock block = super.getHighestBlockAt(position); - return block == null ? ensureHighestBlock(position) : block; - } - - private PathBlock ensureHighestBlock(PathPosition pathPosition) { - ChunkSnapshot chunkSnapshot = retrieveSnapshot(pathPosition); - - int chunkX = pathPosition.getBlockX() & 0xF; - int chunkZ = pathPosition.getBlockZ() & 0xF; - - int highestY = chunkSnapshot.getHighestBlockYAt(chunkX, chunkZ); - - PathPosition highestBlockPosition = - new PathPosition( - pathPosition.getPathEnvironment(), - pathPosition.getBlockX(), - highestY, - pathPosition.getBlockZ()); - BlockState blockState = - CHUNK_DATA_PROVIDER_RESOLVER - .getChunkDataProvider() - .getBlockState(chunkSnapshot, chunkX, highestY, chunkZ); - - Material material = chunkSnapshot.getBlockType(chunkX, highestY, chunkZ); - return new PathBlock(highestBlockPosition, new BlockInformation(material, blockState)); - } - } -} diff --git a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ErrorLogger.java b/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ErrorLogger.java deleted file mode 100644 index 9d217875..00000000 --- a/pathetic-model/src/main/java/de/metaphoriker/pathetic/util/ErrorLogger.java +++ /dev/null @@ -1,31 +0,0 @@ -package de.metaphoriker.pathetic.util; - -import lombok.extern.slf4j.Slf4j; -import de.metaphoriker.pathetic.Pathetic; - -@Slf4j -public class ErrorLogger { - - public static IllegalStateException logFatalError(String message) { - return logFatalError(message, null); - } - - public static IllegalStateException logFatalError(String message, Throwable cause) { - log.error("==============================="); - log.error("A fatal error has occurred: {}", message); - log.error("Please open an issue on the Pathetic GitHub page with all this information:"); - log.error("Version: {}", Pathetic.getModelVersion()); - log.error("Server Version: {}", Pathetic.getPluginInstance().getServer().getVersion()); - log.error("Java Version: {}", System.getProperty("java.version")); - log.error("OS: {}", System.getProperty("os.name")); - log.error("OS Architecture: {}", System.getProperty("os.arch")); - log.error("==============================="); - return new IllegalStateException(message, cause); - } - - public static IllegalStateException logFatalErrorWithStacktrace(String message, Throwable cause) { - IllegalStateException exception = logFatalError(message, cause); - log.error("Stacktrace:", cause); - return exception; - } -} diff --git a/pathetic-model/src/main/resources/pathetic.properties b/pathetic-model/src/main/resources/pathetic.properties deleted file mode 100644 index 4c5349c4..00000000 --- a/pathetic-model/src/main/resources/pathetic.properties +++ /dev/null @@ -1 +0,0 @@ -model.version=${project.version} \ No newline at end of file diff --git a/pom.xml b/pom.xml index a6854d2d..a51bd1ee 100644 --- a/pom.xml +++ b/pom.xml @@ -7,7 +7,7 @@ de.metaphoriker pathetic-main pom - 3.3.1 + 4.0 8 @@ -17,27 +17,29 @@ pathetic-api - pathetic-example - pathetic-mapping - pathetic-nms - pathetic-nms/paper - pathetic-model - pathetic-nms/v1_8 - pathetic-nms/v1_12 - pathetic-nms/v1_15 - pathetic-nms/v1_16 - pathetic-nms/v1_17 - pathetic-nms/v1_18 - pathetic-nms/v1_18_R2 - pathetic-nms/v1_19_R2 - pathetic-nms/v1_19_R3 - pathetic-nms/v1_20_R1 - pathetic-nms/v1_20_R2 - pathetic-nms/v1_20_R3 - pathetic-nms/v1_20_R4 - pathetic-nms/v1_21_R1 - pathetic-nms/v1_21_R2 - pathetic-nms/v1_21_R3 + pathetic-bukkit + pathetic-bukkit/pathetic-example + pathetic-engine + pathetic-bukkit/pathetic-provider + pathetic-bukkit/pathetic-provider/paper + pathetic-bukkit/pathetic-provider/spigot + pathetic-bukkit/pathetic-provider/spigot/v1_8 + pathetic-bukkit/pathetic-provider/spigot/v1_12 + pathetic-bukkit/pathetic-provider/spigot/v1_15 + pathetic-bukkit/pathetic-provider/spigot/v1_16 + pathetic-bukkit/pathetic-provider/spigot/v1_17 + pathetic-bukkit/pathetic-provider/spigot/v1_18 + pathetic-bukkit/pathetic-provider/spigot/v1_18_R2 + pathetic-bukkit/pathetic-provider/spigot/v1_19_R2 + pathetic-bukkit/pathetic-provider/spigot/v1_19_R3 + pathetic-bukkit/pathetic-provider/spigot/v1_20_R1 + pathetic-bukkit/pathetic-provider/spigot/v1_20_R2 + pathetic-bukkit/pathetic-provider/spigot/v1_20_R3 + pathetic-bukkit/pathetic-provider/spigot/v1_20_R4 + pathetic-bukkit/pathetic-provider/spigot/v1_21_R1 + pathetic-bukkit/pathetic-provider/spigot/v1_21_R2 + pathetic-bukkit/pathetic-provider/spigot/v1_21_R3 + pathetic-bukkit/pathetic-provider/resolver @@ -45,7 +47,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.11.1 + 3.11.2 ${project.reporting.outputDirectory}/myoutput myapidocs @@ -63,28 +65,10 @@ - - org.spigotmc - spigot-api - 1.21.4-R0.1-SNAPSHOT - provided - - - org.projectlombok - lombok - 1.18.36 - provided - - - org.slf4j - slf4j-api - 2.0.16 - provided - de.metaphoriker pathetic-api - 3.3.1 + 4.0 provided @@ -97,7 +81,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.11.1 + 3.11.2 8 ../