feat: add the ability to adjust the lifetime of particles in weather …

…effects
ghost-fvtt · Jan 9, 2022 · edc7972 · edc7972
1 parent 6974d31
commit edc7972
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -93,23 +93,23 @@ You can get a complete list by typing `CONFIG.fxmaster.filters` in your web cons
 
 #### Available Weather Effects With Supported Options
 
-| Type         | `scale` | `direction` | `speed` | `density` | `tint` |
-| ------------ | :-----: | :---------: | :-----: | :-------: | :----: |
-| `snowstorm`  |    ✓    |      ✓      |    ✓    |     ✓     |   ✓    |
-| `bubbles`    |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `clouds`     |    ✓    |      ✓      |    ✓    |           |   ✓    |
-| `embers`     |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `rainsimple` |    ✓    |      ✓      |    ✓    |     ✓     |   ✓    |
-| `stars`      |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `crows`      |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `bats`       |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `spiders`    |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `fog`        |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `raintop`    |    ✓    |      ✓      |    ✓    |     ✓     |   ✓    |
-| `birds`      |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `leaves`     |    ✓    |             |    ✓    |     ✓     |   ✓    |
-| `rain`       |    ✓    |      ✓      |    ✓    |     ✓     |   ✓    |
-| `snow`       |    ✓    |      ✓      |    ✓    |     ✓     |   ✓    |
+| Type         | `scale` | `direction` | `speed` | `lifetime` | `density` | `tint` |
+| ------------ | :-----: | :---------: | :-----: | :--------: | :-------: | :----: |
+| `snowstorm`  |    ✓    |      ✓      |    ✓    |     ✓      |     ✓     |   ✓    |
+| `bubbles`    |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `clouds`     |    ✓    |      ✓      |    ✓    |     ✓      |           |   ✓    |
+| `embers`     |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `rainsimple` |    ✓    |      ✓      |    ✓    |     ✓      |     ✓     |   ✓    |
+| `stars`      |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `crows`      |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `bats`       |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `spiders`    |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `fog`        |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `raintop`    |    ✓    |      ✓      |    ✓    |     ✓      |     ✓     |   ✓    |
+| `birds`      |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `leaves`     |    ✓    |             |    ✓    |     ✓      |     ✓     |   ✓    |
+| `rain`       |    ✓    |      ✓      |    ✓    |     ✓      |     ✓     |   ✓    |
+| `snow`       |    ✓    |      ✓      |    ✓    |     ✓      |     ✓     |   ✓    |
 
 #### Weather Effect Options
 
@@ -118,6 +118,7 @@ You can get a complete list by typing `CONFIG.fxmaster.filters` in your web cons
 | `scale`     | `number`                          | A factor that scales the effect relative to its base size.                                        |
 | `direction` | `number`                          | The direction of the effect in degrees.                                                           |
 | `speed`     | `number`                          | A factor that adjusts the speed of the effect relative to its base speed.                         |
+| `lieftime`  | `number`                          | A factor that adjusts the lifetime of the individual particles.                                   |
 | `density`   | `number`                          | The density of the effect. For most effects, it represents the number of particles per grid unit. |
 | `tint`      | `{value: string, apply: boolean}` | Tint the effect with this color.                                                                  |
 

diff --git a/src/lang/en.json b/src/lang/en.json
@@ -27,6 +27,7 @@
   "FXMASTER.Scale": "Scale",
   "FXMASTER.ScaleHint": "Video scaling",
   "FXMASTER.Speed": "Speed",
+  "FXMASTER.Lifetime": "Lifetime",
   "FXMASTER.Blur": "Blur",
   "FXMASTER.Bloom": "Bloom",
   "FXMASTER.Sepia": "Sepia",

diff --git a/src/module/weatherEffects/effects/AbstractWeatherEffect.js b/src/module/weatherEffects/effects/AbstractWeatherEffect.js
@@ -30,6 +30,15 @@ export class AbstractWeatherEffect extends SpecialEffect {
         step: 0.1,
         decimals: 1,
       },
+      lifetime: {
+        label: "FXMASTER.Lifetime",
+        type: "range",
+        min: 0.1,
+        value: 1,
+        max: 5,
+        step: 0.1,
+        decimals: 1,
+      },
       density: {
         label: "FXMASTER.Density",
         type: "range",
@@ -75,6 +84,7 @@ export class AbstractWeatherEffect extends SpecialEffect {
     this._applyScaleToConfig(config);
     this._applySpeedToConfig(config);
     this._applyDirectionToConfig(config);
+    this._applyLifetimeToConfig(config);
     this._applyTintToConfig(config);
   }
 
@@ -129,6 +139,14 @@ export class AbstractWeatherEffect extends SpecialEffect {
     }
   }
 
+  /** @protected */
+  _applyLifetimeToConfig(config) {
+    const lifetime = config.lifetime ?? {};
+    const factor = this.options.lifetime?.value ?? 1;
+    this._applyFactorToBasicTweenableOrValueListOrRandNumber(lifetime, factor);
+    config.frequency *= factor;
+  }
+
   /** @protected */
   _applyTintToConfig(config) {
     if (this.options.tint?.value.apply) {