Auto API update from github workflow

Author: GreenImp

docs/api/config.js

@@ -31,6 +31,8 @@ A `ComparisonModifier` is the base modifier class for comparing values.
     * *[.comparePoint](#ComparisonModifier+comparePoint)*
     * *[.name](#ComparisonModifier+name) ⇒ <code>string</code>*
     * *[.notation](#ComparisonModifier+notation) ⇒ <code>string</code>*
+    * *[.defaultComparePoint(_context)](#ComparisonModifier+defaultComparePoint) ⇒ <code>null</code>*
+    * *[.defaults(_context)](#ComparisonModifier+defaults) ⇒ <code>object</code>*
     * *[.isComparePoint(value)](#ComparisonModifier+isComparePoint) ⇒ <code>boolean</code>*
     * *[.toJSON()](#ComparisonModifier+toJSON) ⇒ <code>Object</code>*
 
@@ -82,6 +84,28 @@ The name of the modifier.
 The modifier's notation.
 
 **Kind**: instance property of [<code>ComparisonModifier</code>](#ComparisonModifier)  
+<a name="ComparisonModifier+defaultComparePoint"></a>
+
+### *comparisonModifier.defaultComparePoint(_context) ⇒ <code>null</code>*
+Empty default compare point definition
+
+**Kind**: instance method of [<code>ComparisonModifier</code>](#ComparisonModifier)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _context | <code>StandardDice</code> \| <code>RollGroup</code> | The object that the modifier is attached to |
+
+<a name="ComparisonModifier+defaults"></a>
+
+### *comparisonModifier.defaults(_context) ⇒ <code>object</code>*
+Eases processing of simple "compare point only" defaults
+
+**Kind**: instance method of [<code>ComparisonModifier</code>](#ComparisonModifier)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _context | <code>StandardDice</code> \| <code>RollGroup</code> | The object that the modifier is attached to |
+
 <a name="ComparisonModifier+isComparePoint"></a>
 
 ### *comparisonModifier.isComparePoint(value) ⇒ <code>boolean</code>*

docs/api/modifiers/ComparisonModifier.md

@@ -20,6 +20,7 @@ Unlike most other modifiers, it doesn't affect the roll value, it simply "flags"
     * [.order](#CriticalFailureModifier+order) : <code>number</code>
     * [.name](#CriticalFailureModifier+name) ⇒ <code>string</code>
     * [.notation](#CriticalFailureModifier+notation) ⇒ <code>string</code>
+    * [.defaultComparePoint(_context)](#CriticalFailureModifier+defaultComparePoint) ⇒ <code>array</code>
     * [.run(results, _context)](#CriticalFailureModifier+run) ⇒ <code>RollResults</code>
 
 <a name="new_CriticalFailureModifier_new"></a>
@@ -55,6 +56,17 @@ The name of the modifier.
 The modifier's notation.
 
 **Kind**: instance property of [<code>CriticalFailureModifier</code>](#CriticalFailureModifier)  
+<a name="CriticalFailureModifier+defaultComparePoint"></a>
+
+### criticalFailureModifier.defaultComparePoint(_context) ⇒ <code>array</code>
+The default compare point definition
+
+**Kind**: instance method of [<code>CriticalFailureModifier</code>](#CriticalFailureModifier)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _context | <code>StandardDice</code> \| <code>RollGroup</code> | The object that the modifier is attached to |
+
 <a name="CriticalFailureModifier+run"></a>
 
 ### criticalFailureModifier.run(results, _context) ⇒ <code>RollResults</code>

docs/api/modifiers/CriticalFailureModifier.md

@@ -20,6 +20,7 @@ Unlike most other modifiers, it doesn't affect the roll value, it simply "flags"
     * [.order](#CriticalSuccessModifier+order) : <code>number</code>
     * [.name](#CriticalSuccessModifier+name) ⇒ <code>string</code>
     * [.notation](#CriticalSuccessModifier+notation) ⇒ <code>string</code>
+    * [.defaultComparePoint(_context)](#CriticalSuccessModifier+defaultComparePoint) ⇒ <code>array</code>
     * [.run(results, _context)](#CriticalSuccessModifier+run) ⇒ <code>RollResults</code>
 
 <a name="new_CriticalSuccessModifier_new"></a>
@@ -55,6 +56,17 @@ The name of the modifier.
 The modifier's notation.
 
 **Kind**: instance property of [<code>CriticalSuccessModifier</code>](#CriticalSuccessModifier)  
+<a name="CriticalSuccessModifier+defaultComparePoint"></a>
+
+### criticalSuccessModifier.defaultComparePoint(_context) ⇒ <code>array</code>
+The default compare point definition
+
+**Kind**: instance method of [<code>CriticalSuccessModifier</code>](#CriticalSuccessModifier)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _context | <code>StandardDice</code> \| <code>RollGroup</code> | The object that the modifier is attached to |
+
 <a name="CriticalSuccessModifier+run"></a>
 
 ### criticalSuccessModifier.run(results, _context) ⇒ <code>RollResults</code>

docs/api/modifiers/CriticalSuccessModifier.md

@@ -20,6 +20,7 @@ An `ExplodeModifier` re-rolls dice that match a given test, and adds them to the
     * [.name](#ExplodeModifier+name) ⇒ <code>string</code>
     * [.notation](#ExplodeModifier+notation) ⇒ <code>string</code>
     * [.penetrate](#ExplodeModifier+penetrate) ⇒ <code>boolean</code>
+    * [.defaultComparePoint(_context)](#ExplodeModifier+defaultComparePoint) ⇒ <code>array</code>
     * [.run(results, _context)](#ExplodeModifier+run) ⇒ <code>RollResults</code>
     * [.toJSON()](#ExplodeModifier+toJSON) ⇒ <code>Object</code>
 
@@ -72,6 +73,17 @@ Whether the modifier should penetrate the results or not.
 
 **Kind**: instance property of [<code>ExplodeModifier</code>](#ExplodeModifier)  
 **Returns**: <code>boolean</code> - `true` if it should penetrate, `false` otherwise  
+<a name="ExplodeModifier+defaultComparePoint"></a>
+
+### explodeModifier.defaultComparePoint(_context) ⇒ <code>array</code>
+The default compare point definition
+
+**Kind**: instance method of [<code>ExplodeModifier</code>](#ExplodeModifier)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _context | <code>StandardDice</code> \| <code>RollGroup</code> | The object that the modifier is attached to |
+
 <a name="ExplodeModifier+run"></a>
 
 ### explodeModifier.run(results, _context) ⇒ <code>RollResults</code>

docs/api/modifiers/ExplodeModifier.md

@@ -22,6 +22,8 @@ A `Modifier` is the base modifier class that all others extend from.
     * *[.name](#Modifier+name) ⇒ <code>string</code>*
     * *[.notation](#Modifier+notation) ⇒ <code>string</code>*
     * *[.maxIterations](#Modifier+maxIterations) ⇒ <code>number</code>*
+    * *[.defaults(_context)](#Modifier+defaults) ⇒ <code>object</code>*
+    * *[.useDefaultsIfNeeded(_context)](#Modifier+useDefaultsIfNeeded) ⇒ <code>void</code>*
     * *[.run(results, _context)](#Modifier+run) ⇒ <code>RollResults</code>*
     * *[.toJSON()](#Modifier+toJSON) ⇒ <code>Object</code>*
     * *[.toString()](#Modifier+toString) ⇒ <code>string</code>*
@@ -57,6 +59,28 @@ The maximum number of iterations that the modifier can apply to a single die rol
 
 **Kind**: instance property of [<code>Modifier</code>](#Modifier)  
 **Returns**: <code>number</code> - `1000`  
+<a name="Modifier+defaults"></a>
+
+### *modifier.defaults(_context) ⇒ <code>object</code>*
+No default values present
+
+**Kind**: instance method of [<code>Modifier</code>](#Modifier)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _context | <code>StandardDice</code> \| <code>RollGroup</code> | The object that the modifier is attached to |
+
+<a name="Modifier+useDefaultsIfNeeded"></a>
+
+### *modifier.useDefaultsIfNeeded(_context) ⇒ <code>void</code>*
+Processing default values definitions
+
+**Kind**: instance method of [<code>Modifier</code>](#Modifier)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _context | <code>StandardDice</code> \| <code>RollGroup</code> | The object that the modifier is attached to |
+
 <a name="Modifier+run"></a>
 
 ### *modifier.run(results, _context) ⇒ <code>RollResults</code>*