Skip to content

[Docs] Document buffTarget initialState and tooltipCondition in Scaling - #138

Open
Lyeeedar wants to merge 1 commit into
mainfrom
docs/update-20260814-004231
Open

[Docs] Document buffTarget initialState and tooltipCondition in Scaling#138
Lyeeedar wants to merge 1 commit into
mainfrom
docs/update-20260814-004231

Conversation

@Lyeeedar

Copy link
Copy Markdown
Owner

Summary

Two documentation gaps found during the 2026-08-14 rotating review of the concepts area:

1. buffTarget technique effect initialState (modapi.md)

Commit 0f16b6e7 (2026-08-11) added initialState?: Record<string, Scaling> to CreateBuffTargetEffect (src/types/buff.ts) and BuffTargetTechniqueEffect (src/types/technique.ts). This field seeds a buff's internalState at application time using expressions evaluated in the applier's context, enabling debuffs that capture apply-time data (e.g. absorbed damage). The feature mirrors initialState already available on buffSelf. The documentation did not mention this field at all.

Added a new "Technique Effect Reference" section with a buffTarget entry covering the field and an example use case.

2. Missing tooltipCondition field in Scaling interface (scaling.md)

src/types/stat.ts defines tooltipCondition?: string on the Scaling interface — it controls whether a scaling value is shown in buff tooltips. This field was absent from the documented interface.

Added the field with its description to the Scaling interface block in scaling.md.


🤖 Mod Documentation Updater — automated AI assistant

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