Skip to content

[Docs] Add missing hits field to Scaling interface and clarify month/yearMonth in flags guide#108

Closed
Lyeeedar wants to merge 1 commit into
mainfrom
docs/update-20260709-004107
Closed

[Docs] Add missing hits field to Scaling interface and clarify month/yearMonth in flags guide#108
Lyeeedar wants to merge 1 commit into
mainfrom
docs/update-20260709-004107

Conversation

@Lyeeedar

@Lyeeedar Lyeeedar commented Jul 9, 2026

Copy link
Copy Markdown
Owner

Summary

Two accuracy fixes in the Core Concepts documentation, covering the concepts and guides areas.


Changes

docs/concepts/scaling.md

Added the missing hits?: Scaling field to the Scaling interface definition and added a new Pattern 10: Multi-Hit Effects to document its usage on damage, heal, barrier, and temporaryHealth effects. The hits field allows these effects to apply multiple times per activation, with each hit applying amount independently. The hits scaling value itself can also be dynamic (e.g. one hit per stack of a given buff).

Cross-referenced against src/types/buff.ts (DamageEffect, HealEffect, BarrierEffect, GiveTemporaryHealthEffect interfaces) and src/types/technique.ts (BuffSelfTechniqueEffect) which all define hits?: Scaling.

docs/concepts/flags.md

Clarified the distinction between the month and yearMonth built-in flags, which was a persistent source of confusion for modders. The guide previously described both identically as "current month" without explaining their different semantics and appropriate use cases.

  • month: Total months elapsed since game start (e.g. month 15). Use for absolute elapsed-time tracking and duration calculations via subtraction.
  • yearMonth: Current month within the year, 1-12. Use for season checks and time-of-year branching. Does not represent absolute time.

Added a "Choosing Between month and yearMonth" section at the end of the Flags guide and corrected the existing "Time-Based Logic" examples to demonstrate both correct usage patterns.


Review Area

This run reviewed the concepts area (flags, scaling, modapi).


Triggered By

No reactive documentation updates this run. All recent commits in the past 24 hours were internal performance optimizations or non-API changes (combat buffering, UI rerender reductions, item description typo fixes, formatNumber changes). No mod-API-affecting changes were found.


🤖 Mod Documentation Updater - automated AI assistant

@Lyeeedar Lyeeedar closed this Jul 9, 2026
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