Fix: npc animations

[AngeloTadeucci]

Fix npcs switching between idle and playing a constant animation
Fix npcs stuck in animation when they should be playing death animation

Summary by CodeRabbit

• Bug Fixes
  • Prevented control updates from being broadcast for NPCs that are dead.
  • Improved emote state handling to optionally skip transitioning to idle after certain actions, resulting in more accurate character behavior.

[coderabbitai]

Walkthrough

This update introduces a new private flag, dontIdleOnStateEnd, to the MovementState class, allowing conditional skipping of the idle transition after an emote ends. The flag is also set in the standby logic based on the isIdle parameter. Additionally, the NPC update logic now prevents broadcasting control updates for dead NPCs.

Changes

File(s)	Change Summary
.../MovementStateStates/MovementState.Emote.cs	Added dontIdleOnStateEnd flag and conditional logic to skip idle transition after emote.
.../MovementStateTasks/MovementState.StandbyTask.cs	Sets dontIdleOnStateEnd based on isIdle parameter in Standby method.
.../FieldNpc.cs	Update method now prevents broadcasting control for dead NPCs.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant MovementState
    participant EmoteActionTask

    Client->>MovementState: Trigger Emote
    MovementState->>EmoteActionTask: Start Emote
    EmoteActionTask-->>MovementState: Emote Completed
    alt dontIdleOnStateEnd is true
        MovementState-->>MovementState: Return (skip Idle)
    else dontIdleOnStateEnd is false
        MovementState->>MovementState: Idle()
    end

Loading

Estimated code review effort

2 (~15 minutes)

Possibly related PRs

• AngeloTadeucci/Maple2#382: Modifies emote and idle state transitions in MovementState, directly related to this PR's emote/idle control flow changes.
• AngeloTadeucci/Maple2#473: Changes dontIdleOnStateEnd handling and modifies related logic in MovementState.StandbyTask.cs, overlapping with this PR's updates to the same field and class.

Suggested reviewers

• Zintixx

Poem

A bunny hops, a flag is set,
Emotes may end, but idle’s not met.
NPCs now rest when gone from the fray,
Control broadcasts quietly hop away.
With careful tweaks and thoughtful code,
The server’s garden smoothly flowed! 🐇

---

📜 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 fdc2037 and e04bdf3.

📒 Files selected for processing (3)

• Maple2.Server.Game/Model/Field/Actor/ActorStateComponent/MovementStateStates/MovementState.Emote.cs (2 hunks)
• Maple2.Server.Game/Model/Field/Actor/ActorStateComponent/MovementStateTasks/MovementState.StandbyTask.cs (1 hunks)
• Maple2.Server.Game/Model/Field/Actor/FieldNpc.cs (1 hunks)

🔇 Additional comments (4)

Maple2.Server.Game/Model/Field/Actor/ActorStateComponent/MovementStateTasks/MovementState.StandbyTask.cs (1)

28-28: LGTM! Correctly sets the idle transition control flag.

This change properly sets the dontIdleOnStateEnd flag based on the isIdle parameter, which will prevent unnecessary idle transitions when NPCs are already in an idle state. This aligns with the PR objective of fixing improper animation switching.

Maple2.Server.Game/Model/Field/Actor/FieldNpc.cs (1)

184-184: LGTM! Prevents control broadcasting for dead NPCs.

This change correctly prevents broadcasting NPC control updates when the NPC is dead, ensuring that death animations can play properly without interference from ongoing control updates. This directly addresses the PR objective of fixing NPCs getting stuck in animations when they should be playing death animations.

Maple2.Server.Game/Model/Field/Actor/ActorStateComponent/MovementStateStates/MovementState.Emote.cs (2)

7-7: LGTM! Well-named flag for controlling idle transitions.

The dontIdleOnStateEnd field clearly communicates its purpose and provides the necessary control mechanism for preventing unwanted idle transitions after emotes end.

---

27-29: LGTM! Correctly implements conditional idle transition logic.

This conditional check properly prevents the transition to idle state when dontIdleOnStateEnd is true, allowing for more precise control over NPC animation states. The early return maintains the existing flow while adding the new behavior needed to fix the animation switching issues.

✨ 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.