CriticalSuccessModifier

CriticalSuccessModifier ⇐ ComparisonModifier

A CriticalSuccessModifier modifier flags values that match a comparison.

Unlike most other modifiers, it doesn't affect the roll value, it simply "flags" matching rolls.

Kind: global class
Extends: ComparisonModifier
See: CriticalFailureModifier for the opposite of this modifier

• CriticalSuccessModifier ⇐ ComparisonModifier
  • new CriticalSuccessModifier(comparePoint)
  • .order : number
  • .name ⇒ string
  • .notation ⇒ string
  • .defaultComparePoint(_context) ⇒ array
  • .run(results, _context) ⇒ RollResults

new CriticalSuccessModifier(comparePoint)

Create a CriticalSuccessModifier instance.

Throws:

• TypeError comparePoint must be a ComparePoint object

Param	Type	Description
comparePoint	ComparePoint	The comparison object

criticalSuccessModifier.order : number

The default modifier execution order.

Kind: instance property of CriticalSuccessModifier

criticalSuccessModifier.name ⇒ string

The name of the modifier.

Kind: instance property of CriticalSuccessModifier
Returns: string - 'critical-success'

criticalSuccessModifier.notation ⇒ string

The modifier's notation.

Kind: instance property of CriticalSuccessModifier

criticalSuccessModifier.defaultComparePoint(_context) ⇒ array

The default compare point definition

Kind: instance method of CriticalSuccessModifier

Param	Type	Description
_context	StandardDice | RollGroup	The object that the modifier is attached to

criticalSuccessModifier.run(results, _context) ⇒ RollResults

Runs the modifier on the rolls.

Kind: instance method of CriticalSuccessModifier

Param	Type	Description
results	RollResults	The results to run the modifier against
_context	StandardDice | RollGroup	The object that the modifier is attached to