Skip to content

📝 Scribe: Add XML documentation for Housing Remote Agents#99

Open
nt153133 wants to merge 1 commit into
mainfrom
scribe/housing-agent-docs-17268433237527074644
Open

📝 Scribe: Add XML documentation for Housing Remote Agents#99
nt153133 wants to merge 1 commit into
mainfrom
scribe/housing-agent-docs-17268433237527074644

Conversation

@nt153133

Copy link
Copy Markdown
Owner

This PR illuminates the housing-related remote agents by adding detailed XML documentation.

What

  • AgentHousingSignboard: Documented plot metadata including ward, plot, sale status, and size. Added specific <remarks> explaining that WinningLotteryNumber and LotteryEntryCount currently use swapped offsets from the underlying memory mappings.
  • AgentHousingSelectBlock: Documented ward selection logic and plot status reading, clarifying that the ward index is zero-based in this context.
  • AgentHousing: Added high-level summary for the base housing agent.

Why

These agents interface directly with game memory and contain non-obvious domain logic, such as the 1-based indexing for plots/wards and the intentional offset swap in the lottery properties. Providing this clarity ensures future maintainers understand the "what" and "why" behind the implementation.

Examples

/// <summary>
/// Gets the 1-based ward number of the plot.
/// </summary>
public byte Ward => (byte)(Core.Memory.Read<byte>(Pointer + AgentHousingSignBoardOffsets.Ward) + 1);

/// <summary>
/// Gets the number of the winning ticket for the most recent lottery on this plot.
/// </summary>
/// <remarks>
/// Note: This property currently utilizes the offset named <c>LotteryEntryCount</c> (with an adjustment) from the offset manager.
/// </remarks>
public ushort WinningLotteryNumber => Core.Memory.Read<ushort>(Pointer + AgentHousingSignBoardOffsets.LotteryEntryCount + 0xC);

PR created automatically by Jules for task 17268433237527074644 started by @nt153133

- Added comprehensive XML documentation for AgentHousing, AgentHousingSelectBlock, and AgentHousingSignboard.
- Documented 1-based indexing for Ward and Plot in AgentHousingSignboard.
- Added remarks to AgentHousingSignboard properties explaining the offset swap for lottery data.
- Clarified zero-based ward indexing and plot status reading in AgentHousingSelectBlock.
- Updated scribe journal with domain-specific lottery offset findings.

Co-authored-by: nt153133 <[email protected]>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

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.

1 participant