diff --git a/src/module/rolls/check.ts b/src/module/rolls/check.ts index e931f680..58cba71d 100644 --- a/src/module/rolls/check.ts +++ b/src/module/rolls/check.ts @@ -8,6 +8,19 @@ interface TermData { options: Record; } +/** + * Implements DS4 Checks as an emulated "dice throw". + * + * @notes + * Be aware that, even though this behaves like one roll, it actually throws several iones internally + * + * @example + * - Roll a check against a Check Target Number (CTV) of 18: `/r dsv18` + * - Roll a check with multiple dice against a CTN of 34: `/r dsv34` + * - Roll a check with a racial ability that makes `2` a coup and `19` a fumble: `/r dsv19c2,19` + * - Roll a check with a racial ability that makes `5` a coup and default fumble: `/r dsv19c5` + * - Roll a check with exploding dice: `/r dsv34x` + */ export class DS4Check extends DiceTerm { constructor(termData: Partial) { super({