Feat: Implement simpleUiObjects

[AngeloTadeucci]

This pr covers interactables like extractors in fields

Summary by CodeRabbit

• New Features

  • Added support for multiplying a Vector3B by a float, returning a scaled Vector3.

• Refactor

  • Improved performance and clarity in map entity processing by caching enumerables and enhancing mapping logic.
  • Streamlined NPC removal checks for better code readability.
  • Renamed variables for clarity in the file ingestion process.

• Style

  • Enhanced coordinate command output to display player position, Vector3B representation, and block center on separate lines for improved readability.

[coderabbitai]

Walkthrough

The changes introduce a refactor to entity mapping in MapEntityMapper.cs, enhance vector operations in Vector3B, update coordinate output in CoordCommand.cs, adjust NPC existence checks in FieldManager.State.cs, and rename a parser variable in Program.cs. No public API signatures are altered.

Changes

File(s)	Change Summary
Maple2.File.Ingest/Mapper/MapEntityMapper.cs	Refactored ParseMap to cache entities, replaced loops, and added a missing yield for IMS2SimpleUiObject.
Maple2.File.Ingest/Program.cs	Renamed parser variable to xBlockParser and updated references accordingly.
Maple2.Model/Common/Vector.cs	Added multiplication operator overload for Vector3B with float, returning a Vector3.
Maple2.Server.Game/Commands/CoordCommand.cs	Enhanced coordinate output: added Vector3B and block center calculations in output.
Maple2.Server.Game/Manager/Field/FieldManager/FieldManager.State.cs	Modified RemoveNpc to perform existence checks using discard variables instead of storing NPC instance.

Sequence Diagram(s)

sequenceDiagram
    participant Player
    participant CoordCommand
    participant Vector3B
    participant Console

    Player->>CoordCommand: Invoke Handle (no coordinates)
    CoordCommand->>Vector3B: Convert position to Vector3B
    CoordCommand->>Vector3B: Multiply by block size (compute center)
    CoordCommand->>Console: Output position, Vector3B, center

Loading

Possibly related PRs

• AngeloTadeucci/Maple2#434: Also modifies ParseMap in MapEntityMapper.cs, focusing on waypoint flags; both change entity handling logic.
• AngeloTadeucci/Maple2#521: Alters the RemoveNpc method, changing parameter types and scheduling logic; both touch the same method.
• AngeloTadeucci/Maple2#359: Removes handling of a specific entity type in ParseMap; both modify entity handling logic in the same method.

Poem

A rabbit hopped through code anew,
Refactoring loops as rabbits do.
Vectors scaled and outputs clear,
NPCs checked with less to fear.
With every hop, the code refined—
A carrot earned for all aligned!
🥕

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6874acd and 72e7e12.

📒 Files selected for processing (5)

• Maple2.File.Ingest/Mapper/MapEntityMapper.cs (3 hunks)
• Maple2.File.Ingest/Program.cs (1 hunks)
• Maple2.Model/Common/Vector.cs (1 hunks)
• Maple2.Server.Game/Commands/CoordCommand.cs (1 hunks)
• Maple2.Server.Game/Manager/Field/FieldManager/FieldManager.State.cs (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

Maple2.Model/Common/Vector.cs (2)

Learnt from: mettaursp
PR: AngeloTadeucci/Maple2#270
File: Maple2.Tools/VectorMath/Transform.cs:92-94
Timestamp: 2024-10-09T04:13:28.776Z
Learning: In the `Transform.Scale` setter in `Maple2.Tools/VectorMath/Transform.cs`, the axes are normalized and directly scaled without considering the original scale, as it's no longer a factor after normalization.

Learnt from: mettaursp
PR: AngeloTadeucci/Maple2#270
File: Maple2.Tools/VectorMath/Transform.cs:92-94
Timestamp: 2024-09-30T04:20:44.252Z
Learning: In the `Transform.Scale` setter in `Maple2.Tools/VectorMath/Transform.cs`, the axes are normalized and directly scaled without considering the original scale, as it's no longer a factor after normalization.

🧬 Code Graph Analysis (1)

Maple2.Model/Common/Vector.cs (2)

Maple2.Model/Game/User/Home.cs (1)

• Vector3 (129-149)

Maple2.Server.Game/Model/Field/Entity/FieldMobSpawn.cs (1)

• Vector3 (180-184)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: build
• GitHub Check: build
• GitHub Check: format

🔇 Additional comments (6)

Maple2.Model/Common/Vector.cs (1)

43-44: LGTM! Well-implemented multiplication operator.

The operator correctly scales each component of the Vector3B by the float multiplier and returns a Vector3. This enhances the coordinate handling capabilities as demonstrated in the CoordCommand usage.

Maple2.File.Ingest/Program.cs (1)

225-229: Good naming improvement for clarity.

The variable renaming from parser to xBlockParser makes the code more readable and self-documenting. All references have been consistently updated.

Maple2.File.Ingest/Mapper/MapEntityMapper.cs (2)

28-29: Good performance optimization to prevent multiple enumeration.

Caching the entities enumerable to an array prevents multiple enumeration issues and improves performance. The cached array is correctly used in subsequent loops.

---

60-62: Critical fix: Added missing yield return for SimpleUiObject.

The missing yield return statement for IMS2SimpleUiObject has been properly added, ensuring these entities are correctly returned from the method. This aligns with the PR objective of implementing interactable objects.

Maple2.Server.Game/Commands/CoordCommand.cs (1)

39-42: Enhanced coordinate output with improved formatting.

The addition of Vector3B conversion and block center calculation using the new multiplication operator provides more comprehensive coordinate information. The multi-line output format improves readability and debugging capability.

Maple2.Server.Game/Manager/Field/FieldManager/FieldManager.State.cs (1)

753-753: Good use of discard variables for existence check.

The change from capturing NPC instances to using discard variables (_) makes the code intent clearer - this check only verifies existence rather than needing the actual NPC object. The removal logic later in the method properly handles NPC retrieval and disposal.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.