Wurst7 icon indicating copy to clipboard operation
Wurst7 copied to clipboard

Added option for guide boxes to show where airplace will place blocks

Open yutaoz opened this issue 1 year ago • 2 comments

Description

What have you added and what does it do? (Alternatively, what have you fixed and how does it work?)

Added optional guide boxes for airplace hack to show where the block will be placed (off by default) Sort of fix/feature for https://github.com/Wurst-Imperium/Wurst7/issues/1014 but more just qol

Testing

How have you tested your changes? Any testing tips for the reviewer?

Tested multiplayer and singleplayer, with different colors, ranges, and other render-related hacks

References

List any related issues, forum posts, videos and such here.

https://youtu.be/chV8J5KHzuQ

yutaoz avatar Jun 18 '24 05:06 yutaoz

Walkthrough

Walkthrough

The AirPlaceHack class in AirPlaceHack.java received major updates, including new settings (ColorSetting and CheckboxSetting), additional imports, and the implementation of UpdateListener and RenderListener interfaces. These changes introduced a visual guide feature for block placement, enhancing user experience by displaying colored boxes on potential placement positions.

Changes

Files Change Summary
src/main/java/net/wurstclient/hacks/AirPlaceHack.java Added new import statements for color, rendering, events, and utility classes.
Updated class declaration to include UpdateListener and RenderListener interfaces.
Added new settings: ColorSetting for block placement guide color and CheckboxSetting for enabling/disabling the guide.
Introduced new fields and modified the constructor to incorporate the new settings.
Updated onEnable and onDisable methods to manage event registrations.
Implemented onRender and renderBoxes methods for guiding block placements visually.
Added onUpdate method to update block positions dynamically.

Sequence Diagrams

sequenceDiagram
    participant User
    participant AirPlaceHack
    participant RenderSystem
    participant UpdateSystem

    User->>AirPlaceHack: Enable Hack
    AirPlaceHack->>UpdateSystem: Register UpdateListener
    AirPlaceHack->>RenderSystem: Register RenderListener

    loop While Hack is Enabled 
        Note over AirPlaceHack, UpdateSystem: onUpdate
        UpdateSystem->>AirPlaceHack: Update Block Position
        AirPlaceHack->>RenderSystem: onRender
        RenderSystem->>AirPlaceHack: Render Placement Guide
    end

    User-->>AirPlaceHack: Disable Hack
    AirPlaceHack->>UpdateSystem: Unregister UpdateListener
    AirPlaceHack->>RenderSystem: Unregister RenderListener

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
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 <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 18 '24 05:06 coderabbitai[bot]

This is what I want, is it released?

oldsheep0205 avatar Jun 18 '24 12:06 oldsheep0205