CriticalFailureModifier
ComparisonModifier
CriticalFailureModifier ⇐ A CriticalFailureModifier
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: CriticalSuccessModifier for the opposite of this modifier
- CriticalFailureModifier ⇐
ComparisonModifier
- new CriticalFailureModifier([comparePoint])
- .order :
number
- .name ⇒
string
- .notation ⇒
string
- .defaultComparePoint(_context) ⇒
array
- .run(results, _context) ⇒
RollResults
new CriticalFailureModifier([comparePoint])
Create a CriticalFailureModifier
instance.
Throws:
TypeError
comparePoint must be aComparePoint
object
Param | Type | Description |
---|---|---|
[comparePoint] | ComparePoint | The comparison object |
number
criticalFailureModifier.order : The default modifier execution order.
Kind: instance property of CriticalFailureModifier
string
criticalFailureModifier.name ⇒ The name of the modifier.
Kind: instance property of CriticalFailureModifier
Returns: string
- 'critical-failure'
string
criticalFailureModifier.notation ⇒ The modifier's notation.
Kind: instance property of CriticalFailureModifier
array
criticalFailureModifier.defaultComparePoint(_context) ⇒ The default compare point definition
Kind: instance method of CriticalFailureModifier
Param | Type | Description |
---|---|---|
_context | StandardDice | RollGroup | The object that the modifier is attached to |
RollResults
criticalFailureModifier.run(results, _context) ⇒ Run the modifier on the results.
Kind: instance method of CriticalFailureModifier
Returns: RollResults
- The modified results
Param | Type | Description |
---|---|---|
results | RollResults | The results to run the modifier against |
_context | StandardDice | RollGroup | The object that the modifier is attached to |