Annotation: OnSelectionChanged and GetSelectedUnits

[4z0t]

Description of the proposed changes

Add annotation about GetSelectedUnits being used within OnSelectionChanged.

Testing done on the proposed changes

No testing needed.

Additional context

Useful tip for modders, so they don't stumble as I did.

Checklist

• Changes are annotated, including comments where useful
• Changes are documented in a changelog snippet according to the guidelines.
• Request 2-3 reviewers from the list of reviewers and their areas of knowledge.

Summary by CodeRabbit

• Documentation
  • Added clarification notes to internal code comments regarding engine behavior.

Note: This release contains no user-visible changes.

[coderabbitai]

Walkthrough

A comment was added to the OnSelectionChanged function in gamemain.lua documenting that GetSelectedUnits returns nil when the function is invoked by the engine. No functional code changes were made.

Changes

Cohort / File(s)	Change Summary
Documentation & Comments lua/ui/game/gamemain.lua	Added informational comment in OnSelectionChanged documenting nil return behavior of GetSelectedUnits when engine-invoked

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A note in code, so clear and bright,
To guide the reader through the night—
When nil appears from engine's call,
This comment helps us understand it all! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Annotation: OnSelectionChanged and GetSelectedUnits' clearly identifies the main change as adding an annotation about these functions, which matches the actual changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check	✅ Passed	The PR description covers the main sections but omits the changelog snippet documentation, which is a required checklist item per the template guidelines.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

lua/ui/game/gamemain.lua (1)

608-608: Helpful tip for modders, consider minor wording clarification.

The annotation is valuable documentation that warns modders about a gotcha behavior. The current phrasing is slightly ambiguous—it could be clearer that it's the result of calling GetSelectedUnits within this function, not that the engine calls it.

Consider rephrasing to: "Within this function (called by the engine), GetSelectedUnits() will always return nil." This makes it explicit that calling GetSelectedUnits from within this callback won't work as expected.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5eddd6f and fd6668f.

📒 Files selected for processing (1)

• lua/ui/game/gamemain.lua (1 hunks)