External module "operations"

Index

Functions

Functions

assembleNumbers

assembleNumbers(numbers: Die[]): Die[]

- Defined in operations.ts:3
Parameters
- numbers: Die[]
Returns Die[]

dropHighest

dropHighest(numbers: Die[]): Die[]

- Defined in operations.ts:31
Drops the lowest die in the set

remarks

Works on any number of dice in a array, even of varying sides

Parameters
- numbers: Die[]
  
  A set of dice
Returns Die[]

The same set without the lowest result that was rolled

dropLowest

dropLowest(numbers: Die[]): Die[]

- Defined in operations.ts:19
Drops the highest die in the set

remarks

Works on any number of dice in a array, even of varying sides

Parameters
- numbers: Die[]
  
  A set of dice
Returns Die[]

The same set without the highest result that was rolled

rollMax

rollMax(dice: Die[]): number

- Defined in operations.ts:67
Rolls the dice and returns the maximum result

remarks

Works on any number of dice in a array, even of varying sides

Parameters
- dice: Die[]
Returns number

The highest possible result for the set of dice

rollMin

rollMin(dice: Die[]): number

- Defined in operations.ts:78
Rolls the dice and returns the minimum result

remarks

Works on any number of dice in a array, even of varying sides

Parameters
- dice: Die[]
Returns number

The lowest possible result for the set of dice

sum

sum(numbers: Die[]): number

- Defined in operations.ts:56
Rolls the dice and returns the actual result

remarks

Works on any number of dice in a array, even of varying sides

Parameters
- numbers: Die[]
  
  A set of dice
Returns number

The result for the set of dice

sumDice

sumDice(dice: Die[], getMax?: boolean): number

- Defined in operations.ts:37
Parameters
- dice: Die[]
- Default value getMax: boolean = false
Returns number

Generated using TypeDoc