Skip to content

MakeType for Static and Constant - #305

Merged
AngeloTadeucci merged 16 commits into
MS2Community:masterfrom
Zintixx:attribute-rolls
Feb 9, 2025
Merged

MakeType for Static and Constant#305
AngeloTadeucci merged 16 commits into
MS2Community:masterfrom
Zintixx:attribute-rolls

Conversation

@Zintixx

@Zintixx Zintixx commented Feb 8, 2025

Copy link
Copy Markdown
Collaborator

Tiny change that should just optimize the use of lua or not.

Summary by CodeRabbit

  • New Features
    • Introduced support for a new option type based on Lua functions, expanding item configuration capabilities.
  • Refactor
    • Enhanced consistency in processing item options, resulting in more reliable item stat calculations and refined evaluation logic.
    • Updated item option types for better type safety and clarity.

@coderabbitai

coderabbitai Bot commented Feb 8, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This PR updates how item option types are managed across various modules by replacing the previous RandomMakeType and related int fields with a unified ItemOptionMakeType. The changes include explicit type casting in the mapper, an updated enum with a new Lua member, modifications to the metadata record fields, and adjustments in the game’s stats calculation logic to correctly process these options.

Changes

File(s) Change Summary
Maple2.File.Ingest/Mapper/ItemMapper.cs
Maple2.Model/Metadata/ItemMetadata.cs
Updated type casting and field types for item option properties, converting from int/RandomMakeType to ItemOptionMakeType.
Maple2.Model/Enum/ItemOptionMakeType.cs Renamed enum from RandomMakeType to ItemOptionMakeType and added a new member, Lua, with a value of 2.
Maple2.Server/Game/Util/ItemStatsCalculator.cs Adjusted control flow in the GetValue method and its helpers to check against ItemOptionMakeType (including Lua) and refined return checks for option retrieval.

Sequence Diagram(s)

sequenceDiagram
    participant I as Item
    participant M as ItemStatsCalculator
    participant MD as ItemMetadata
    Note over I, M: Calculate item stats based on option type
    I->>MD: Retrieve ItemMetadataOption
    MD-->>M: Provide option details (ItemOptionMakeType)
    M->>M: Switch on ItemOptionMakeType value
    alt When type is Lua
        M->>M: Process Lua option logic
    else Other types
        M->>M: Process random/static/constant option logic
    end
    M-->>I: Return calculated stat value
Loading

Possibly related PRs

Suggested labels

enhancement

Poem

Hopping through code under moonlit skies,
I changed old types with clever, swift tries.
From random to structured, each field now sings,
With Lua whispers, new option magic springs.
I'm a bunny coder, celebrating these lines—
Leaping happily where clean code shines!


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
Maple2.Model/Enum/ItemOptionMakeType.cs (1)

3-7: LGTM! Consider adding XML documentation.

The enum rename and new member addition look good. The rename from RandomMakeType to ItemOptionMakeType better represents its purpose for all item option types.

Consider adding XML documentation to describe the enum's purpose and each member's behavior:

+/// <summary>
+/// Defines how item options are calculated.
+/// </summary>
 public enum ItemOptionMakeType {
+    /// <summary>
+    /// Uses itemoptionvariation table for calculations.
+    /// </summary>
     Base = 0, // uses itemoptionvariation table
+    /// <summary>
+    /// Uses itemoptionvariation_* tables for calculations.
+    /// </summary>
     Range = 1, // uses itemoptionvariation_* tables
+    /// <summary>
+    /// Uses Lua functions for calculations.
+    /// </summary>
     Lua = 2, // uses lua  functions
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c66d72a and f19388e.

📒 Files selected for processing (4)
  • Maple2.File.Ingest/Mapper/ItemMapper.cs (2 hunks)
  • Maple2.Model/Enum/ItemOptionMakeType.cs (1 hunks)
  • Maple2.Model/Metadata/ItemMetadata.cs (2 hunks)
  • Maple2.Server.Game/Util/ItemStatsCalculator.cs (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: format
  • GitHub Check: build
🔇 Additional comments (5)
Maple2.Model/Metadata/ItemMetadata.cs (1)

92-96: LGTM! Type safety improvements.

The changes improve type safety by:

  1. Using ItemOptionMakeType enum instead of raw integers
  2. Renaming RandomType to ItemOptionType for better clarity
Maple2.File.Ingest/Mapper/ItemMapper.cs (1)

124-128: LGTM! Type casting updates.

The type casting changes align with the field type changes in ItemMetadata.cs.

Maple2.Server.Game/Util/ItemStatsCalculator.cs (3)

195-196: LGTM! Switch statement update.

The switch statement now uses ItemOptionType instead of RandomType, aligning with the field rename in ItemMetadata.cs.


295-308: LGTM! Lua option type handling in GetConstantOption.

The method correctly handles the new ItemOptionMakeType.Lua option type by:

  1. Checking for Lua type
  2. Creating a new option if needed
  3. Applying constant values using Lua functions

323-338: LGTM! Lua option type handling in GetStaticOption.

The method correctly handles the new ItemOptionMakeType.Lua option type by:

  1. Checking for Lua type
  2. Creating a new option if needed
  3. Applying static values using Lua functions
  4. Using a clearer return statement with option != null

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
Maple2.Server.Game/Util/ItemStatsCalculator.cs (1)

327-327: Remove unnecessary empty line.

This empty line doesn't add to readability and can be removed.

-
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f19388e and a1d3bec.

📒 Files selected for processing (4)
  • Maple2.File.Ingest/Mapper/ItemMapper.cs (1 hunks)
  • Maple2.Model/Enum/ItemOptionMakeType.cs (1 hunks)
  • Maple2.Model/Metadata/ItemMetadata.cs (1 hunks)
  • Maple2.Server.Game/Util/ItemStatsCalculator.cs (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • Maple2.Model/Enum/ItemOptionMakeType.cs
  • Maple2.File.Ingest/Mapper/ItemMapper.cs
  • Maple2.Model/Metadata/ItemMetadata.cs
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (3)
Maple2.Server.Game/Util/ItemStatsCalculator.cs (3)

195-196: LGTM! The switch statement refactor improves clarity.

The change from RandomMakeType to ItemOptionMakeType with cases Range and Base better reflects the purpose of each option type.

Also applies to: 260-260


295-295: LGTM! The condition is more explicit.

The change to check for ItemOptionMakeType.Lua and returning option != null improves code clarity and maintainability.

Also applies to: 308-308


323-323: LGTM! The condition is more explicit.

The change to check for ItemOptionMakeType.Lua and returning option != null improves code clarity and maintainability.

Also applies to: 337-337

@AngeloTadeucci
AngeloTadeucci merged commit 012e070 into MS2Community:master Feb 9, 2025
@Zintixx
Zintixx deleted the attribute-rolls branch February 9, 2025 23:36
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