Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Roll

Hierarchy

  • Roll

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Roll(dieCode?: undefined | string): Roll

  • Constructor

    Parameters

    • Optional dieCode: undefined | string

      string Regex matching a number of dices, their sides and a modifier

    Returns Roll

Properties

Readonly dice

dice: DiceInterface

Readonly diceNumber

diceNumber: number

Readonly diceSides

diceSides: number

Protected isFailure

isFailure: boolean = false

Protected isSuccess

isSuccess: boolean = false

Readonly modifier

modifier: number

Static CRITICAL_FAILURE

CRITICAL_FAILURE: number = 1

Static CRITICAL_SUCCESS

CRITICAL_SUCCESS: number = 6

Methods

Private createDice

  • createDice(): DiceInterface

  • Dice builder

    Returns DiceInterface

    DiceInterface

getResult

  • getResult(): number

  • Get roll reesult

    Returns number

    number

isCriticalFailure

  • isCriticalFailure(): boolean

  • Is a critical failure

    Returns boolean

    boolean

isCriticalSuccess

  • isCriticalSuccess(): boolean

  • Is a critical success

    Returns boolean

    boolean

resolve

  • resolve(target: number): boolean

  • Check if roll is greater or equal than target

    Parameters

    • target: number

    Returns boolean

    boolean

Private roll

  • roll(): number

  • Roll dices

    Returns number

    number

Generated using TypeDoc