Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce Ambience module #80

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Introduce Ambience module #80

merged 1 commit into from
Jul 12, 2024

Conversation

L1shed
Copy link

@L1shed L1shed commented Jul 11, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a new "Ambience" module to control in-game settings such as time, weather, and speed.
    • Users can now adjust time, weather conditions, and the speed of time progression in the game environment.

Copy link

coderabbitai bot commented Jul 11, 2024

Walkthrough

The recent changes introduce a new Ambience class to the keystrokesmod module, which allows control over in-game ambience settings like time, weather, and speed. The ModuleManager class has been updated to include a static instance of this Ambience module, which will be initialized and added to the module list upon registration.

Changes

File Path Change Summary
src/main/java/keystrokesmod/module/ModuleManager.java Added a public static instance Ambience and initialized it in the module list.
src/main/java/keystrokesmod/module/impl/render/Ambience.java Introduced Ambience class with settings for time, weather, and speed, along with related methods.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ModuleManager
    participant Ambience

    User->>ModuleManager: Start Application
    ModuleManager->>Ambience: Initialize and Register Ambience Module
    User->>Ambience: Adjust Time, Weather, Speed Settings
    Ambience-->>User: Apply Ambience Settings
Loading

Poem

In the world of code, where modules reside,
The Ambience now takes us on a ride.
Weather and time, now in our control,
With ModuleManager, it plays its role.
Amidst the bytes, a tranquil scene,
The game world breathes, serene and keen.
🌦️🕰️


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 41bf74e and 3a58560.

Files selected for processing (2)
  • src/main/java/keystrokesmod/module/ModuleManager.java (2 hunks)
  • src/main/java/keystrokesmod/module/impl/render/Ambience.java (1 hunks)
Additional comments not posted (9)
src/main/java/keystrokesmod/module/impl/render/Ambience.java (7)

14-14: Initialization of time

The time field is correctly initialized and registered.


15-15: Initialization of speed

The speed field is correctly initialized and registered.


16-16: Initialization of weather

The weather field is correctly initialized and registered.


19-26: Constructor Implementation

The constructor correctly initializes the module and registers the settings.


29-36: Method onDisable Implementation

The onDisable method correctly resets the weather settings.


39-41: Verify World Time Calculation in onRenderTick

The calculation of the world time might need clarification. Ensure that the formula correctly updates the world time based on the settings.


69-81: Method onReceivePacket Implementation

The onReceivePacket method correctly cancels the packet events based on their type and weather settings.

src/main/java/keystrokesmod/module/ModuleManager.java (2)

95-95: Addition of Ambience Module

The Ambience module has been correctly added as a public static instance.


218-218: Registration of Ambience Module

The Ambience module has been correctly registered in the register method.

Comment on lines +44 to +65
public void onPreMotion(PreMotionEvent event) {
if (mc.thePlayer.ticksExisted % 20 == 0) {

switch ((int) this.weather.getInput()) {
case 1: {
mc.theWorld.setRainStrength(0);
mc.theWorld.getWorldInfo().setCleanWeatherTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setRainTime(0);
mc.theWorld.getWorldInfo().setThunderTime(0);
mc.theWorld.getWorldInfo().setRaining(false);
mc.theWorld.getWorldInfo().setThundering(false);
break;
}
case 2:
mc.theWorld.setRainStrength(1);
mc.theWorld.getWorldInfo().setCleanWeatherTime(0);
mc.theWorld.getWorldInfo().setRainTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setThunderTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setRaining(true);
mc.theWorld.getWorldInfo().setThundering(false);
}
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refactor onPreMotion for Readability

The weather settings update logic can be refactored to improve readability.

-  switch ((int) this.weather.getInput()) {
-      case 1: {
-          mc.theWorld.setRainStrength(0);
-          mc.theWorld.getWorldInfo().setCleanWeatherTime(Integer.MAX_VALUE);
-          mc.theWorld.getWorldInfo().setRainTime(0);
-          mc.theWorld.getWorldInfo().setThunderTime(0);
-          mc.theWorld.getWorldInfo().setRaining(false);
-          mc.theWorld.getWorldInfo().setThundering(false);
-          break;
-      }
-      case 2:
-          mc.theWorld.setRainStrength(1);
-          mc.theWorld.getWorldInfo().setCleanWeatherTime(0);
-          mc.theWorld.getWorldInfo().setRainTime(Integer.MAX_VALUE);
-          mc.theWorld.getWorldInfo().setThunderTime(Integer.MAX_VALUE);
-          mc.theWorld.getWorldInfo().setRaining(true);
-          mc.theWorld.getWorldInfo().setThundering(false);
-  }
+  if (this.weather.getInput() == 1) {
+      setWeatherClear();
+  } else if (this.weather.getInput() == 2) {
+      setWeatherRain();
+  }
+
+  private void setWeatherClear() {
+      mc.theWorld.setRainStrength(0);
+      mc.theWorld.getWorldInfo().setCleanWeatherTime(Integer.MAX_VALUE);
+      mc.theWorld.getWorldInfo().setRainTime(0);
+      mc.theWorld.getWorldInfo().setThunderTime(0);
+      mc.theWorld.getWorldInfo().setRaining(false);
+      mc.theWorld.getWorldInfo().setThundering(false);
+  }
+
+  private void setWeatherRain() {
+      mc.theWorld.setRainStrength(1);
+      mc.theWorld.getWorldInfo().setCleanWeatherTime(0);
+      mc.theWorld.getWorldInfo().setRainTime(Integer.MAX_VALUE);
+      mc.theWorld.getWorldInfo().setThunderTime(Integer.MAX_VALUE);
+      mc.theWorld.getWorldInfo().setRaining(true);
+      mc.theWorld.getWorldInfo().setThundering(false);
+  }
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
public void onPreMotion(PreMotionEvent event) {
if (mc.thePlayer.ticksExisted % 20 == 0) {
switch ((int) this.weather.getInput()) {
case 1: {
mc.theWorld.setRainStrength(0);
mc.theWorld.getWorldInfo().setCleanWeatherTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setRainTime(0);
mc.theWorld.getWorldInfo().setThunderTime(0);
mc.theWorld.getWorldInfo().setRaining(false);
mc.theWorld.getWorldInfo().setThundering(false);
break;
}
case 2:
mc.theWorld.setRainStrength(1);
mc.theWorld.getWorldInfo().setCleanWeatherTime(0);
mc.theWorld.getWorldInfo().setRainTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setThunderTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setRaining(true);
mc.theWorld.getWorldInfo().setThundering(false);
}
}
public void onPreMotion(PreMotionEvent event) {
if (mc.thePlayer.ticksExisted % 20 == 0) {
if (this.weather.getInput() == 1) {
setWeatherClear();
} else if (this.weather.getInput() == 2) {
setWeatherRain();
}
}
}
private void setWeatherClear() {
mc.theWorld.setRainStrength(0);
mc.theWorld.getWorldInfo().setCleanWeatherTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setRainTime(0);
mc.theWorld.getWorldInfo().setThunderTime(0);
mc.theWorld.getWorldInfo().setRaining(false);
mc.theWorld.getWorldInfo().setThundering(false);
}
private void setWeatherRain() {
mc.theWorld.setRainStrength(1);
mc.theWorld.getWorldInfo().setCleanWeatherTime(0);
mc.theWorld.getWorldInfo().setRainTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setThunderTime(Integer.MAX_VALUE);
mc.theWorld.getWorldInfo().setRaining(true);
mc.theWorld.getWorldInfo().setThundering(false);
}

@xia-mc xia-mc merged commit 1745d2b into xia-mc:master Jul 12, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants