@quenty/particles 5.9.0 → 5.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [5.9.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particles@5.9.0...@quenty/particles@5.9.1) (2025-03-21)
7
+
8
+ **Note:** Version bump only for package @quenty/particles
9
+
10
+
11
+
12
+
13
+
6
14
  # [5.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particles@5.8.0...@quenty/particles@5.9.0) (2025-02-18)
7
15
 
8
16
  **Note:** Version bump only for package @quenty/particles
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/particles",
3
- "version": "5.9.0",
3
+ "version": "5.9.1",
4
4
  "description": "Holds utilitity for playing back particles",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -27,10 +27,10 @@
27
27
  "dependencies": {
28
28
  "@quenty/loader": "^10.8.0",
29
29
  "@quenty/maid": "^3.4.0",
30
- "@quenty/numbersequenceutils": "^8.9.0"
30
+ "@quenty/numbersequenceutils": "^8.9.1"
31
31
  },
32
32
  "publishConfig": {
33
33
  "access": "public"
34
34
  },
35
- "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
35
+ "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
36
36
  }
@@ -1,4 +1,7 @@
1
1
  --[=[
2
+ Standard playback of particles using `EmitDelay` and `EmitCount` attributes that
3
+ most standard particle editors emit.
4
+
2
5
  @class ParticleEmitterUtils
3
6
  ]=]
4
7
 
@@ -9,7 +12,10 @@ local Maid = require("Maid")
9
12
 
10
13
  local ParticleEmitterUtils = {}
11
14
 
12
- function ParticleEmitterUtils.scaleSize(adornee, scale)
15
+ --[=[
16
+ Scales the size of the particle emitter to a specified size
17
+ ]=]
18
+ function ParticleEmitterUtils.scaleSize(adornee: Instance, scale: number)
13
19
  assert(typeof(adornee) == "Instance", "Bad adornee")
14
20
 
15
21
  for _, particleEmitter in pairs(ParticleEmitterUtils.getParticleEmitters(adornee)) do
@@ -17,7 +23,13 @@ function ParticleEmitterUtils.scaleSize(adornee, scale)
17
23
  end
18
24
  end
19
25
 
20
- function ParticleEmitterUtils.playFromTemplate(template, attachment)
26
+ --[=[
27
+ Playes a particle emitter from a template in the parent
28
+
29
+ @param template Instance
30
+ @return Maid
31
+ ]=]
32
+ function ParticleEmitterUtils.playFromTemplate(template: Instance, attachment: Attachment)
21
33
  local maid = Maid.new()
22
34
 
23
35
  for _, emitter in pairs(template:GetChildren()) do
@@ -38,10 +50,12 @@ function ParticleEmitterUtils.playFromTemplate(template, attachment)
38
50
  end
39
51
 
40
52
  return maid
41
-
42
53
  end
43
54
 
44
- function ParticleEmitterUtils.getParticleEmitters(adornee)
55
+ --[=[
56
+ Retrieves particle emitters for the given adornee
57
+ ]=]
58
+ function ParticleEmitterUtils.getParticleEmitters(adornee: Instance): { ParticleEmitter }
45
59
  assert(typeof(adornee) == "Instance", "Bad adornee")
46
60
 
47
61
  local emitters = {}
@@ -59,4 +73,4 @@ function ParticleEmitterUtils.getParticleEmitters(adornee)
59
73
  return emitters
60
74
  end
61
75
 
62
- return ParticleEmitterUtils
76
+ return ParticleEmitterUtils