@quenty/modeltransparencyeffect 3.1.3-canary.c50dead.0 → 3.2.1

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.1.3-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/modeltransparencyeffect@3.1.2...@quenty/modeltransparencyeffect@3.1.3-canary.c50dead.0) (2021-11-20)
+## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/modeltransparencyeffect@3.2.0...@quenty/modeltransparencyeffect@3.2.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/modeltransparencyeffect
+
+
+
+
+
+# [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/modeltransparencyeffect@3.1.2...@quenty/modeltransparencyeffect@3.2.0) (2021-11-20)
 
 
 ### Bug Fixes
 
-* Support MacOS syncing ([c50dead](https://github.com/Quenty/NevermoreEngine/commit/c50deadbe5ebe479aded04e1619441a08ff0e9a8))
+* Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
 
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## ModelTransparencyEffect
 <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,21 +13,9 @@
 
 Allows a model to have transparent set locally on the client
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ModelTransparencyEffect">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/modeltransparencyeffect --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `ModelTransparencyEffect.new(adornee, transparencyServiceMethodName)`
-
-### `ModelTransparencyEffect:SetAcceleration(acceleration)`
-
-### `ModelTransparencyEffect:SetTransparency(transparency, doNotAnimate)`
-
-### `ModelTransparencyEffect:IsDoneAnimating()`
-
-### `ModelTransparencyEffect:FinishTransparencyAnimation(callback)`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/modeltransparencyeffect",
-  "version": "3.1.3-canary.c50dead.0",
+  "version": "3.2.1",
   "description": "Allows a model to have transparent set locally on the client",
   "keywords": [
     "Roblox",
@@ -25,14 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "2.0.0",
-    "@quenty/baseobject": "3.1.3-canary.c50dead.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/steputils": "3.0.0",
-    "@quenty/transparencyservice": "3.1.2-canary.c50dead.0"
+    "@quenty/acceltween": "^2.0.1",
+    "@quenty/baseobject": "^3.2.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/steputils": "^3.0.1",
+    "@quenty/transparencyservice": "^3.2.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Client/ModelTransparencyEffect.lua

@@ -1,6 +1,9 @@
---- Allows a model to have transparent set locally on the client
--- @classmod ModelTransparencyEffect
--- @author Quenty
+--[=[
+	Allows a model to have transparent set locally on the client
+
+	@client
+	@class ModelTransparencyEffect
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -13,6 +16,12 @@ local ModelTransparencyEffect = setmetatable({}, BaseObject)
 ModelTransparencyEffect.ClassName = "ModelTransparencyEffect"
 ModelTransparencyEffect.__index = ModelTransparencyEffect
 
+--[=[
+	@param serviceBag ServiceBag
+	@param adornee Instance
+	@param transparencyServiceMethodName "SetTransparency" | "SetLocalTransparencyModifier" | nil
+	@return ModelTransparencyEffect
+]=]
 function ModelTransparencyEffect.new(serviceBag, adornee, transparencyServiceMethodName)
 	local self = setmetatable(BaseObject.new(adornee), ModelTransparencyEffect)
 
@@ -31,10 +40,19 @@ function ModelTransparencyEffect.new(serviceBag, adornee, transparencyServiceMet
 	return self
 end
 
+--[=[
+	Sets the acceleration
+	@param acceleration number
+]=]
 function ModelTransparencyEffect:SetAcceleration(acceleration)
 	self._transparency.a = acceleration
 end
 
+--[=[
+	Sets the transparency
+	@param transparency number
+	@param doNotAnimate boolean
+]=]
 function ModelTransparencyEffect:SetTransparency(transparency, doNotAnimate)
 	if self._transparency.t == transparency then
 		return
@@ -48,16 +66,29 @@ function ModelTransparencyEffect:SetTransparency(transparency, doNotAnimate)
 	self:_startAnimation()
 end
 
+--[=[
+	Returns true if animation is done
+	@return boolean
+]=]
 function ModelTransparencyEffect:IsDoneAnimating()
 	return self._transparency.rtime == 0
 end
 
+--[=[
+	Finishes the transparency animation, and then calls the callback to
+	finish the animation.
+	@param callback function
+]=]
 function ModelTransparencyEffect:FinishTransparencyAnimation(callback)
 	self:SetTransparency(0)
 
-	delay(self._transparency.rtime, function()
+	if self._transparency.rtime == 0 then
 		callback()
-	end)
+	else
+		task.delay(self._transparency.rtime, function()
+			callback()
+		end)
+	end
 end