@quenty/particleengine 4.0.0-canary.236.5597d0a.0 → 4.0.0

package/CHANGELOG.md

@@ -3,7 +3,55 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [4.0.0-canary.236.5597d0a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.2.0...@quenty/particleengine@4.0.0-canary.236.5597d0a.0) (2021-12-18)
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.6.0...@quenty/particleengine@4.0.0) (2022-03-06)
+
+**Note:** Version bump only for package @quenty/particleengine
+
+
+
+
+
+# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.5.1...@quenty/particleengine@3.6.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/particleengine
+
+
+
+
+
+## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.5.0...@quenty/particleengine@3.5.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/particleengine
+
+
+
+
+
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.4.0...@quenty/particleengine@3.5.0) (2022-01-07)
+
+**Note:** Version bump only for package @quenty/particleengine
+
+
+
+
+
+# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.3.1...@quenty/particleengine@3.4.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/particleengine
+
+
+
+
+
+## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.3.0...@quenty/particleengine@3.3.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/particleengine
+
+
+
+
+
+# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/particleengine@3.2.0...@quenty/particleengine@3.3.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/particleengine
 

package/README.md

@@ -1,21 +1,21 @@
 ## Particle Engine
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
   </a>
 </div>
 
-Adds GUI based particles to Roblox. This is legacy code and is not maintained to the same level of quality as other libraries might be. In general, favor Roblox's particle system instead of this one.
+Adds GUI based particles to Roblox. This is legacy code and is not maintained to the same level of quality as other libraries might be. In general, favor Roblox's particle system instead of this one. However, historically, this library was created before such particle systems were available for use.
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ParticleEngineClient">View docs →</a></div>
 
 ## Installation
 ```
 npm install @quenty/particleengine --save
-```
-
-However, historically, this library was created before such particle systems were available for use.
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/particleengine",
-  "version": "4.0.0-canary.236.5597d0a.0",
+  "version": "4.0.0",
   "description": "Adds GUI based particle engine to Roblox",
   "keywords": [
     "Roblox",
@@ -26,12 +26,12 @@
     "AxisAngles"
   ],
   "dependencies": {
-    "@quenty/loader": "3.1.1",
-    "@quenty/remoting": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/table": "2.1.0"
+    "@quenty/loader": "^4.0.0",
+    "@quenty/remoting": "^4.0.0",
+    "@quenty/table": "^2.1.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5597d0abdadd88f369f1401a558a8d6d1a1c5aab"
+  "gitHead": "dd428cab58282c975a4c082957dc8f58e3186905"
 }

package/src/Client/ParticleEngineClient.lua

@@ -1,5 +1,9 @@
---- Legacy code written by AxisAngles to simulate particles with Guis
--- @module ParticleEngine
+--[=[
+	Legacy code written by AxisAngles to simulate particles with Guis
+
+	@client
+	@class ParticleEngineClient
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -56,7 +60,7 @@ function ParticleEngineClient:Init(screen)
 	return self
 end
 
---- Removes a particle
+-- Removes a particle
 function ParticleEngineClient:Remove(p)
 	if self._particles[p] then
 		self._particles[p] = nil
@@ -151,7 +155,7 @@ function ParticleEngineClient:_updatePosVel(p, dt, t)
 	p.Velocity = p.Velocity + (p.Gravity + wind)*dt
 end
 
---- Handles both priority and regular particles
+-- Handles both priority and regular particles
 -- @return boolean alive, true if still fine
 function ParticleEngineClient:_updateParticle(particle, t, dt)
 	if particle.LifeTime - t <= 0 then
@@ -221,7 +225,7 @@ function ParticleEngineClient:_updateRender()
 	self:_updateScreenInfo(camera)
 
 	local cameraInverse = camera.CFrame:inverse()
-	local cameraPosition = camera.CFrame.p
+	local cameraPosition = camera.CFrame.Position
 
 	local frameIndex, frame = next(self._particleFrames)
 	for particle in pairs(self._particles) do

package/src/Server/ParticleEngineServer.lua

@@ -1,5 +1,9 @@
---- Handles replication on the server side
--- @module ParticleEngineServer
+--[=[
+	Handles replication on the server side
+
+	@server
+	@class ParticleEngineServer
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Shared/ParticleEngineConstants.lua

@@ -1,6 +1,6 @@
----
--- @module ParticleEngineConstants
--- @author Quenty
+--[=[
+	@class ParticleEngineConstants
+]=]
 
 local require = require(script.Parent.loader).load(script)