Skip to content

[Docs] Add initialState and hideBuff to buffTarget effect docs #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lyeeedar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Docs] Add initialState and hideBuff to buffTarget effect docs #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/combat/effects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,14 @@ Gives a buff to the enemy.
{
kind: 'buffTarget',
amount: { value: 3, stat: undefined },
buff: debuffBuff
buff: debuffBuff,
hideBuff?: true, // Don't show buff in tooltips
initialState?: Record<string, Scaling> // Seeds the created buff's internalState (evaluated in this effect's context)
}
```

**New in recent update:** `initialState` seeds the created buff's `internalState` at application time, with each value resolved in the effect's scaling scope. This mirrors the `initialState` field already available on `buffSelf`. It is useful for debuffs that track a value derived from the technique's context — for example, a debuff that stores how much damage was absorbed during the application and exposes it via `stateTooltip`.

### `consumeTarget`

Removes a buff from the enemy.
Expand Down