Cleanup Crafting Stations Internals

[Paneedah]

📝 Description

Begins to clean up the code related to crafting and the workbench.

🎯 Goals

Make the code more readable and optimize the code to make it somewhat more efficient.

The following Base Files for stations:

• [x] BlockStation
• [x] GUIContainerStation
• [x] TileEntityStation
• [x] CraftingStation (/mwc/groovyscript/script/CraftingStation.java)

The following Workbench Specific Files:

• [x] ContainerWorkbench
• [x] CustomSearchTextField
• [x] GUIButtonCustom
• [x] GUIContainerWorkbench
• [x] PagesSlot
• [x] PagedSlotItemHandler
• [x] TESRWorkbench
• [x] WorkbenchBlock

Bigger things:

• [x] Fix Luna's port of workbench (can craft when button is disabled).
• [x] Clean up WorkbenchServerMessageHandler
• [x] Clean up WorkbenchClientMessageHandler

❌ Non Goals

Adding new features, editing the UI of the workbenches, or any of the front-end.

🚦 Testing

Ran the mod after editing every file and followed the following:

1. Try craft gun with empty workbench.
2. Try craft gun with all items but insufficient.
3. Try craft gun with one item but sufficient quantity.
4. Try craft gun with sufficient items (all within one stack).
5. Try craft gun with sufficient items (all scattered between stacks).
6. Mixture of 4 and 5.
7. Try craft more than 1 at a time.

⏮️ Backwards Compatibility

Since this is a workbench PR, this will be perfectly backwards compatible. There is nothing here that can cause issues with updating. No weapons have been added/removed.

📚 Related Issues & Documents

N/A

📖 Added to documentation?

• [ ] 📜 README.md
• [ ] 📑 Documentation
• [ ] 📓 Javadoc
• [ ] 🍕 Comments
• [x] 🙅 No documentation needed

Summary by CodeRabbit

• New Features

  • Updated the positioning of GUI elements to enhance user interface experience.
  • Improved the search functionality within the crafting interface for better usability.
  • Enhanced crafting information tooltips for clarity and detail.

• Bug Fixes

  • Added null check to prevent potential crashes during block harvesting.
  • Fixed typo in variable naming for material availability checks.
  • Corrected text input handling in the search field to improve filtering of crafting list results.

• Refactor

  • Improved readability and maintainability of various methods across the crafting system.
  • Shifted towards immutability in class fields to ensure stability and predictability.
  • Restructured internal logic for crafting timer and progress tracking for better performance.

• Style

  • Conducted minor formatting adjustments for a more consistent codebase appearance.
  • Removed redundant code comments and unnecessary line breaks to clean up the code.

• Documentation

  • Updated error messages and comments to better guide users through crafting processes.

• Chores

  • Renamed methods and variables to adhere to naming conventions and improve code clarity.

[coderabbitai[bot]]

[!WARNING]

Rate Limit Exceeded

@Paneedah has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 37 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

Commits

Files that changed from the base of the PR and between 3ae954c566c7b825ec380270f525f71d27b9e837 and 3fbed6052f1e5e047fba30494a3c7370f0700be5.

Walkthrough

The recent updates focus on refining the codebase for a Minecraft mod, enhancing readability, maintainability, and stability. Method names have been standardized, local variables are now often immutable, and GUI elements have been repositioned for better user experience. Null checks and error messages have been improved for robustness. The changes also include refactoring of methods for clarity, removal of redundant code, and adjustments to the control flow and logic, particularly in GUI handling and crafting logic.

Changes

File(s)	Summary of Changes
.../groovyscript/script/CraftingStation.java	Method renaming, parameter adjustment, error message update, comment improvements, and use of final keyword.
.../crafting/base/BlockStation.java	Code reformatting, null check addition, minor formatting changes, and removal of empty methods.
.../crafting/base/GUIContainerStation.java	GUI element positioning, method refactoring, logic improvements, and rendering enhancements.
.../crafting/workbench/ContainerWorkbench.java	Redundant comment removal, code reformatting, control flow adjustments, and logic restructuring.
.../crafting/workbench/CustomSearchTextField.java	Field immutability, parameter naming convention adherence, and method logic improvements.
.../crafting/workbench/GUIButtonCustom.java	Field immutability, method parameter type changes, and method refactoring for readability.
.../crafting/workbench/GUIContainerWorkbench.java	Comment updates, constructor refactoring, and method readability improvements.
.../crafting/workbench/PagedSlot.java .../crafting/workbench/PagedSlotItemHandler.java	Field immutability and shift towards direct field access.
.../crafting/workbench/TESRWorkbench.java	Constant removal, parameter list reformatting, and internal logic reorganization.
.../crafting/workbench/TileEntityWorkbench.java	Constructor condensation, method modifications, and logic adjustments.
.../crafting/base/TileEntityStation.java	No changes made.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

---

Tips

### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

[Paneedah]

Testing - Please do not review just yet.