@swrpg-online/dice/dist/types.d.ts

A TypeScript library that creates dice rolls using the narrative dice system for the Star Wars Roleplaying Game by Fantasy Flight Games and Edge Studio.

export type DicePool = {
    boostDice?: number;
    abilityDice?: number;
    proficiencyDice?: number;
    setBackDice?: number;
    difficultyDice?: number;
    challengeDice?: number;
    forceDice?: number;
};
export type DiceResult = {
    successes: number;
    failures: number;
    advantages: number;
    threats: number;
    triumphs: number;
    despair: number;
    lightSide: number;
    darkSide: number;
    hints?: string[];
};
export type DieType = "boost" | "ability" | "proficiency" | "setback" | "difficulty" | "challenge" | "force";
export type DetailedDieResult = {
    type: DieType;
    roll: number;
    result: DiceResult;
};
export type RollResult = {
    results: DetailedDieResult[];
    summary: DiceResult;
};
export declare const SYMBOLS: {
    readonly SUCCESS: "SUCCESS";
    readonly FAILURE: "FAILURE";
    readonly ADVANTAGE: "ADVANTAGE";
    readonly THREAT: "THREAT";
    readonly TRIUMPH: "TRIUMPH";
    readonly DESPAIR: "DESPAIR";
    readonly LIGHT: "LIGHT";
    readonly DARK: "DARK";
};
export type Symbol = keyof typeof SYMBOLS;
export type RollOptions = {
    hints?: boolean;
};