@quenty/depthoffield 1.4.1-canary.8533eea.0 → 1.5.1

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.4.1-canary.8533eea.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/depthoffield@1.4.0...@quenty/depthoffield@1.4.1-canary.8533eea.0) (2021-12-18)
+## [1.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/depthoffield@1.5.0...@quenty/depthoffield@1.5.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/depthoffield
+
+
+
+
+
+# [1.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/depthoffield@1.4.0...@quenty/depthoffield@1.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/depthoffield
 

package/README.md

@@ -1,10 +1,10 @@
 # DepthOfField
 <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" />
@@ -13,6 +13,8 @@
 
 Depth of field service to allow multiple systems to write depth of field
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/DepthOfFieldService">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/depthoffield --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/depthoffield",
-  "version": "1.4.1-canary.8533eea.0",
+  "version": "1.5.1",
   "description": "Depth of field service to allow multiple systems to write depth of field",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "2.0.0",
-    "@quenty/baseobject": "3.2.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/signal": "2.0.0",
-    "@quenty/steputils": "3.0.0",
-    "@quenty/valueobject": "3.4.1-canary.8533eea.0"
+    "@quenty/acceltween": "^2.0.1",
+    "@quenty/baseobject": "^3.2.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/maid": "^2.0.2",
+    "@quenty/signal": "^2.0.1",
+    "@quenty/steputils": "^3.0.1",
+    "@quenty/valueobject": "^3.5.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8533eeade3bf6835c0295785c1c326b9abee3222"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Client/DepthOfFieldModifier.lua

@@ -1,6 +1,6 @@
----
--- @classmod DepthOfFieldModifier
--- @author Quenty
+--[=[
+	@class DepthOfFieldModifier
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -20,21 +20,41 @@ function DepthOfFieldModifier.new(distance, radius)
 	self._distance = distance
 	self._radius = radius
 
+--[=[
+	Fires when the modifier is removing.
+	@prop Removing Signal
+	@within DepthOfFieldModifier
+]=]
 	self.Removing = Signal.new()
 	self._maid:GiveTask(function()
 		self.Removing:Fire()
 		self.Removing:Destroy()
 	end)
 
+--[=[
+	Fires when the distance changes.
+	@prop DistanceChanged Signal
+	@within DepthOfFieldModifier
+]=]
 	self.DistanceChanged = Signal.new()
 	self._maid:GiveTask(self.DistanceChanged)
 
+--[=[
+	Fires when the radius changes.
+	@prop RadiusChanged Signal
+	@within DepthOfFieldModifier
+]=]
 	self.RadiusChanged = Signal.new()
 	self._maid:GiveTask(self.RadiusChanged)
 
 	return self
 end
 
+--[=[
+	Sets the target depth of field distance
+	@param distance number
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldModifier:SetDistance(distance, doNotAnimate)
 	assert(type(distance) == "number", "Bad distance")
 
@@ -46,6 +66,11 @@ function DepthOfFieldModifier:SetDistance(distance, doNotAnimate)
 	self.DistanceChanged:Fire(distance, doNotAnimate)
 end
 
+--[=[
+	Sets the target depth of field distance
+	@param radius number
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldModifier:SetRadius(radius, doNotAnimate)
 	assert(type(radius) == "number", "Bad radius")
 
@@ -57,14 +82,26 @@ function DepthOfFieldModifier:SetRadius(radius, doNotAnimate)
 	self.RadiusChanged:Fire(radius, doNotAnimate)
 end
 
+--[=[
+	Retrieves the distance
+	@return number
+]=]
 function DepthOfFieldModifier:GetDistance()
 	return self._distance
 end
 
+--[=[
+	Retrieves the radius
+	@return number
+]=]
 function DepthOfFieldModifier:GetRadius()
 	return self._radius
 end
 
+--[=[
+	Resets the radius
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldModifier:Reset(doNotAnimate)
 	self:SetDistance(self._originalDistance, doNotAnimate)
 	self:SetRadius(self._originalRadius, doNotAnimate)

package/src/Client/DepthOfFieldService.lua

@@ -1,6 +1,6 @@
----
--- @module DepthOfFieldService
--- @author Quenty
+--[=[
+	@class DepthOfFieldService
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -13,6 +13,10 @@ local ValueObject = require("ValueObject")
 
 local DepthOfFieldService = {}
 
+--[=[
+	Initializes the DepthOfFieldService. Should be done via [ServiceBag].
+	@param _serviceBag ServiceBag
+]=]
 function DepthOfFieldService:Init(_serviceBag)
 	self._maid = Maid.new()
 
@@ -48,6 +52,10 @@ function DepthOfFieldService:Init(_serviceBag)
 	self._modifierStack = {}
 end
 
+--[=[
+	Creates a new depth of field modifier
+	@return DepthOfFieldModifier
+]=]
 function DepthOfFieldService:CreateModifier()
 	local maid = Maid.new()
 

package/src/Client/DepthOfFieldTweener.lua

@@ -1,6 +1,7 @@
----
--- @classmod DepthOfFieldTweener
--- @author Quenty
+--[=[
+	Tweens DepthOfField. Prefer to use [DepthOfFieldService].
+	@class DepthOfFieldTweener
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -14,6 +15,12 @@ local DepthOfFieldTweener = setmetatable({}, BaseObject)
 DepthOfFieldTweener.ClassName = "DepthOfFieldTweener"
 DepthOfFieldTweener.__index = DepthOfFieldTweener
 
+--[=[
+	Create a new DepthOfFieldTweener.
+	@param depthOfField number
+	@param speed number?
+	@return DepthOfFieldTweener
+]=]
 function DepthOfFieldTweener.new(depthOfField, speed)
 	local self = setmetatable(BaseObject.new(), DepthOfFieldTweener)
 
@@ -42,6 +49,11 @@ function DepthOfFieldTweener.new(depthOfField, speed)
 	return self
 end
 
+--[=[
+	Sets the radius and starts any animation
+	@param radius number
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldTweener:SetRadius(radius, doNotAnimate)
 	local target = math.clamp(radius, 0, 500)
 	self._radius.t = target
@@ -53,14 +65,27 @@ function DepthOfFieldTweener:SetRadius(radius, doNotAnimate)
 	self:_startAnimation()
 end
 
+--[=[
+	Gets the current radius being rendered
+	@return number
+]=]
 function DepthOfFieldTweener:GetRadius()
 	return self._radius.p
 end
 
+--[=[
+	Gets the current distance being set
+	@return number
+]=]
 function DepthOfFieldTweener:GetDistance()
 	return self._distance.p
 end
 
+--[=[
+	Sets the distance to render
+	@param distance number
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldTweener:SetDistance(distance, doNotAnimate)
 	local target = math.clamp(distance, 0, 500)
 	self._distance.t = target
@@ -72,16 +97,28 @@ function DepthOfFieldTweener:SetDistance(distance, doNotAnimate)
 	self:_startAnimation()
 end
 
+--[=[
+	Resets the depth of field to the original distance
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldTweener:Reset(doNotAnimate)
 	self:ResetRadius(doNotAnimate)
 	self:ResetDistance(doNotAnimate)
 end
 
+--[=[
+	Resets the radius
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldTweener:ResetRadius(doNotAnimate)
 	self:SetRadius(self._originalDistance, doNotAnimate)
 	self:_startAnimation()
 end
 
+--[=[
+	Resets the distance
+	@param doNotAnimate boolean
+]=]
 function DepthOfFieldTweener:ResetDistance(doNotAnimate)
 	self:SetDistance(self._originalDistance, doNotAnimate)
 	self:_startAnimation()