@quenty/modeltransparencyeffect 11.8.4 → 11.8.5-canary.559.339cfa7.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [11.8.5-canary.559.339cfa7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/modeltransparencyeffect@11.8.4...@quenty/modeltransparencyeffect@11.8.5-canary.559.339cfa7.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+
+
+
 ## [11.8.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/modeltransparencyeffect@11.8.3...@quenty/modeltransparencyeffect@11.8.4) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/modeltransparencyeffect

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/modeltransparencyeffect",
-  "version": "11.8.4",
+  "version": "11.8.5-canary.559.339cfa7.0",
   "description": "Allows a model to have transparent set locally on the client",
   "keywords": [
     "Roblox",
@@ -25,14 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "^2.5.3",
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/steputils": "^3.5.5",
-    "@quenty/transparencyservice": "^11.8.4"
+    "@quenty/acceltween": "2.5.3",
+    "@quenty/baseobject": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/loader": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/steputils": "3.5.6-canary.559.339cfa7.0",
+    "@quenty/transparencyservice": "11.8.5-canary.559.339cfa7.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "339cfa778736f08768ed7305041f6221faa35bfc"
 }

package/src/Client/ModelTransparencyEffect.lua

@@ -9,6 +9,7 @@ local require = require(script.Parent.loader).load(script)
 
 local AccelTween = require("AccelTween")
 local BaseObject = require("BaseObject")
+local ServiceBag = require("ServiceBag")
 local StepUtils = require("StepUtils")
 local TransparencyService = require("TransparencyService")
 
@@ -17,14 +18,29 @@ ModelTransparencyEffect.ClassName = "ModelTransparencyEffect"
 ModelTransparencyEffect.__index = ModelTransparencyEffect
 
 export type TransparencyMode = "SetTransparency" | "SetLocalTransparencyModifier"
+
+export type ModelTransparencyEffect = typeof(setmetatable(
+	{} :: {
+		_transparency: AccelTween.AccelTween,
+		_transparencyService: TransparencyService.TransparencyService,
+		_transparencyServiceMethodName: TransparencyMode,
+		_parts: { [Instance]: boolean },
+	},
+	{} :: typeof({ __index = ModelTransparencyEffect })
+)) & BaseObject.BaseObject
+
 --[=[
 	@param serviceBag ServiceBag
 	@param adornee Instance
 	@param transparencyServiceMethodName "SetTransparency" | "SetLocalTransparencyModifier" | nil
 	@return ModelTransparencyEffect
 ]=]
-function ModelTransparencyEffect.new(serviceBag, adornee: Instance, transparencyServiceMethodName: TransparencyMode?)
-	local self = setmetatable(BaseObject.new(adornee), ModelTransparencyEffect)
+function ModelTransparencyEffect.new(
+	serviceBag: ServiceBag.ServiceBag,
+	adornee: Instance,
+	transparencyServiceMethodName: TransparencyMode?
+): ModelTransparencyEffect
+	local self: ModelTransparencyEffect = setmetatable(BaseObject.new(adornee) :: any, ModelTransparencyEffect)
 
 	assert(serviceBag, "Bad serviceBag")
 	assert(adornee, "Bad adornee")
@@ -47,7 +63,7 @@ end
 	Sets the acceleration
 	@param acceleration number
 ]=]
-function ModelTransparencyEffect:SetAcceleration(acceleration: number)
+function ModelTransparencyEffect.SetAcceleration(self: ModelTransparencyEffect, acceleration: number)
 	self._transparency.a = acceleration
 end
 
@@ -56,7 +72,11 @@ end
 	@param transparency number
 	@param doNotAnimate boolean?
 ]=]
-function ModelTransparencyEffect:SetTransparency(transparency: number, doNotAnimate: boolean?)
+function ModelTransparencyEffect.SetTransparency(
+	self: ModelTransparencyEffect,
+	transparency: number,
+	doNotAnimate: boolean?
+)
 	if self._transparency.t == transparency then
 		return
 	end
@@ -73,7 +93,7 @@ end
 	Returns true if animation is done
 	@return boolean
 ]=]
-function ModelTransparencyEffect:IsDoneAnimating(): boolean
+function ModelTransparencyEffect.IsDoneAnimating(self: ModelTransparencyEffect): boolean
 	return self._transparency.rtime == 0
 end
 
@@ -82,7 +102,7 @@ end
 	finish the animation.
 	@param callback function
 ]=]
-function ModelTransparencyEffect:FinishTransparencyAnimation(callback)
+function ModelTransparencyEffect.FinishTransparencyAnimation(self: ModelTransparencyEffect, callback)
 	self:SetTransparency(0)
 
 	if self._transparency.rtime == 0 then
@@ -94,14 +114,14 @@ function ModelTransparencyEffect:FinishTransparencyAnimation(callback)
 	end
 end
 
-function ModelTransparencyEffect:_update()
+function ModelTransparencyEffect._update(self: ModelTransparencyEffect)
 	if self._transparencyService:IsDead() then
 		return
 	end
 
 	local transparency = self._transparency.p
 
-	for part, _ in pairs(self:_getParts()) do
+	for part in self:_getPartsSet() do
 		self._transparencyService[self._transparencyServiceMethodName](
 			self._transparencyService,
 			self,
@@ -113,7 +133,7 @@ function ModelTransparencyEffect:_update()
 	return self._transparency.rtime > 0
 end
 
-function ModelTransparencyEffect:_getParts()
+function ModelTransparencyEffect._getPartsSet(self: ModelTransparencyEffect)
 	if self._parts then
 		return self._parts
 	end
@@ -123,8 +143,8 @@ function ModelTransparencyEffect:_getParts()
 	return self._parts
 end
 
-function ModelTransparencyEffect:_setupParts()
-	assert(not self._parts, "Already initialized")
+function ModelTransparencyEffect._setupParts(self: ModelTransparencyEffect)
+	assert(not (self :: any)._parts, "Already initialized")
 
 	self._parts = {}