[Docs] Add missing hits field to Scaling interface and clarify month/yearMonth in flags guide#108
Closed
Lyeeedar wants to merge 1 commit into
Closed
[Docs] Add missing hits field to Scaling interface and clarify month/yearMonth in flags guide#108Lyeeedar wants to merge 1 commit into
Lyeeedar wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two accuracy fixes in the Core Concepts documentation, covering the concepts and guides areas.
Changes
docs/concepts/scaling.md
Added the missing
hits?: Scalingfield to theScalinginterface definition and added a new Pattern 10: Multi-Hit Effects to document its usage ondamage,heal,barrier, andtemporaryHealtheffects. Thehitsfield allows these effects to apply multiple times per activation, with each hit applyingamountindependently. 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) andsrc/types/technique.ts(BuffSelfTechniqueEffect) which all definehits?: Scaling.docs/concepts/flags.md
Clarified the distinction between the
monthandyearMonthbuilt-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