Add very simple docs.

This commit is contained in:
Oliver Rümpelein 2021-01-08 23:41:23 +01:00
parent a5e240ab75
commit 25119fd9e3

View file

@ -8,6 +8,19 @@ interface TermData {
options: Record<string, unknown>; options: Record<string, unknown>;
} }
/**
* 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 { export class DS4Check extends DiceTerm {
constructor(termData: Partial<TermData>) { constructor(termData: Partial<TermData>) {
super({ super({