@vttforge/types / RollConstructor

Interface: RollConstructor

The Roll class itself, as foundry.dice.Roll.

Constructors

Constructor

new RollConstructor(formula?, data?, options?): RollLike

Parameters

formula?

string

data?

Record<string, unknown>

options?

Record<string, unknown>

Returns

RollLike

Properties

defaultImplementation

readonly defaultImplementation: RollConstructor

Methods

_mapLegacyRollMode()

_mapLegacyRollMode(rollMode): string

Map a v13 rollMode onto a v14 messageMode.

Parameters

rollMode

string

Returns

string

---

create()

create(formula, data?, options?): RollLike

Parameters

formula

string

data?

Record<string, unknown>

options?

Record<string, unknown>

Returns

RollLike

---

fromJSON()

fromJSON(json): RollLike

Parameters

json

string

Returns

RollLike

---

fromTerms()

fromTerms(terms, options?): RollLike

Parameters

terms

readonly RollTermLike[]

options?

Record<string, unknown>

Returns

RollLike

---

getFormula()

getFormula(terms): string

Parameters

terms

readonly RollTermLike[]

Returns

string

---

parse()

parse(formula?, data?): RollTermLike[]

Parameters

formula?

string

data?

Record<string, unknown>

Returns

RollTermLike[]

---

replaceFormulaData()

replaceFormulaData(formula, data, options?): string

Parameters

formula

string

data

Record<string, unknown>

options?

missing?

string

warn?

boolean

Returns

string

---

safeEval()

safeEval(expression): number

Parameters

expression

string

Returns

number

---

simplifyTerms()

simplifyTerms(terms): RollTermLike[]

Parameters

terms

readonly RollTermLike[]

Returns

RollTermLike[]

---

simulate()

simulate(formula, n?): Promise<number[]>

Parameters

formula

string

n?

number

Returns

Promise<number[]>

---

validate()

validate(formula): boolean

Parameters

formula

string

Returns

boolean