@quenty/modeltransparencyeffect 11.13.0 → 11.14.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.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/modeltransparencyeffect@11.13.0...@quenty/modeltransparencyeffect@11.14.0) (2026-04-14)
+
+
+### Features
+
+* Expand LocalTransparencyModifier support ([1d2bc4d](https://github.com/Quenty/NevermoreEngine/commit/1d2bc4d75a954486c0b8a9c160d06476ca47e2e6))
+
+
+
+
+
 # [11.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/modeltransparencyeffect@11.12.0...@quenty/modeltransparencyeffect@11.13.0) (2026-02-20)
 
 **Note:** Version bump only for package @quenty/modeltransparencyeffect

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/modeltransparencyeffect",
-  "version": "11.13.0",
+  "version": "11.14.0",
   "description": "Allows a model to have transparent set locally on the client",
   "keywords": [
     "Roblox",
@@ -30,6 +30,9 @@
   "dependencies": {
     "@quenty/acceltween": "2.7.0",
     "@quenty/baseobject": "10.12.0",
+    "@quenty/enums": "1.2.0",
+    "@quenty/hide": "11.35.0",
+    "@quenty/instanceutils": "13.28.0",
     "@quenty/loader": "10.10.0",
     "@quenty/servicebag": "11.16.0",
     "@quenty/steputils": "3.6.3",
@@ -38,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "305e70aba3395b2f94f500c731327760984aeb4f"
+  "gitHead": "f8273b1b201921976953174e30958440e44e64cb"
 }

package/src/Client/ModelTransparencyEffect.lua

@@ -1,6 +1,6 @@
 --!nonstrict
 --[=[
-	Allows a model to have transparent set locally on the client
+	Allows a model to have transparency set locally on the client
 
 	@client
 	@class ModelTransparencyEffect
@@ -10,6 +10,9 @@ local require = require(script.Parent.loader).load(script)
 
 local AccelTween = require("AccelTween")
 local BaseObject = require("BaseObject")
+local HideUtils = require("HideUtils")
+local ModelTransparencyMode = require("ModelTransparencyMode")
+local RxInstanceUtils = require("RxInstanceUtils")
 local ServiceBag = require("ServiceBag")
 local StepUtils = require("StepUtils")
 local TransparencyService = require("TransparencyService")
@@ -18,15 +21,13 @@ local ModelTransparencyEffect = setmetatable({}, BaseObject)
 ModelTransparencyEffect.ClassName = "ModelTransparencyEffect"
 ModelTransparencyEffect.__index = ModelTransparencyEffect
 
-export type TransparencyMode = "SetTransparency" | "SetLocalTransparencyModifier"
-
 export type ModelTransparencyEffect =
 	typeof(setmetatable(
 		{} :: {
 			_serviceBag: ServiceBag.ServiceBag,
 			_transparency: AccelTween.AccelTween,
 			_transparencyService: TransparencyService.TransparencyService,
-			_transparencyServiceMethodName: TransparencyMode,
+			_transparencyServiceMethodName: ModelTransparencyMode.ModelTransparencyMode,
 			_parts: { [Instance]: boolean },
 			_startAnimation: (self: ModelTransparencyEffect) -> (),
 		},
@@ -43,7 +44,7 @@ export type ModelTransparencyEffect =
 function ModelTransparencyEffect.new(
 	serviceBag: ServiceBag.ServiceBag,
 	adornee: Instance,
-	transparencyServiceMethodName: TransparencyMode?
+	transparencyServiceMethodName: ModelTransparencyMode.ModelTransparencyMode?
 ): ModelTransparencyEffect
 	assert(adornee, "Bad adornee")
 
@@ -52,14 +53,14 @@ function ModelTransparencyEffect.new(
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
 	assert(
-		type(transparencyServiceMethodName) == "string" or transparencyServiceMethodName == nil,
+		ModelTransparencyMode:IsValue(transparencyServiceMethodName) or transparencyServiceMethodName == nil,
 		"Bad transparencyServiceMethodName"
 	)
 
 	self._transparencyService = self._serviceBag:GetService(TransparencyService :: any)
 
 	self._transparency = AccelTween.new(20)
-	self._transparencyServiceMethodName = transparencyServiceMethodName or "SetTransparency"
+	self._transparencyServiceMethodName = transparencyServiceMethodName or ModelTransparencyMode.TRANSPARENCY
 
 	self._startAnimation, self._maid._stop = StepUtils.bindToRenderStep(self._update)
 
@@ -155,32 +156,36 @@ function ModelTransparencyEffect._setupParts(self: ModelTransparencyEffect)
 
 	self._parts = {}
 
-	if self._obj:IsA("BasePart") or self._obj:IsA("Decal") then
-		self._parts[self._obj] = true
-	end
+	local transparencyServiceMethod = self._transparencyService[self._transparencyServiceMethodName]
 
-	for _, part in self._obj:GetDescendants() do
-		if part:IsA("BasePart") or part:IsA("Decal") then
-			self._parts[part] = true
-		end
+	local function canHide(part: Instance): boolean
+		return if (self._transparencyServiceMethodName == ModelTransparencyMode.LOCAL_TRANSPARENCY)
+			then HideUtils.hasLocalTransparencyModifier(part)
+			else (part:IsA("BasePart") or part:IsA("Decal"))
 	end
 
-	self._maid:GiveTask(self._obj.DescendantAdded:Connect(function(child)
-		if child:IsA("BasePart") or child:IsA("Decal") then
-			self._parts[child] = true
-			self:_startAnimation()
-		end
-	end))
+	if canHide(self._obj) then
+		self._parts[self._obj] = true
+	end
 
-	self._maid:GiveTask(self._obj.DescendantRemoving:Connect(function(child)
-		if self._transparencyService:IsDead() then
+	self._maid:GiveTask(RxInstanceUtils.observeDescendantsBrio(self._obj, canHide):Subscribe(function(brio)
+		if brio:IsDead() then
 			return
 		end
 
-		if self._parts[child] then
-			self._parts[child] = nil
-			self._transparencyService[self._transparencyServiceMethodName](self._transparencyService, self, child, nil)
-		end
+		local maid, part = brio:ToMaidAndValue()
+
+		self._parts[part] = true
+		self:_startAnimation()
+
+		maid:GiveTask(function()
+			if self._transparencyService:IsDead() or not self._parts[part] then
+				return
+			end
+
+			self._parts[part] = nil
+			transparencyServiceMethod(self._transparencyService, self, part, nil)
+		end)
 	end))
 
 	self._maid:GiveTask(function()
@@ -188,8 +193,8 @@ function ModelTransparencyEffect._setupParts(self: ModelTransparencyEffect)
 			return
 		end
 
-		for part, _ in self._parts do
-			self._transparencyService[self._transparencyServiceMethodName](self._transparencyService, self, part, nil)
+		for part in self._parts do
+			transparencyServiceMethod(self._transparencyService, self, part, nil)
 		end
 	end)
 end

package/src/Shared/ModelTransparencyMode.lua

@@ -0,0 +1,15 @@
+--!strict
+--[=[
+	@class ModelTransparencyMode
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local SimpleEnum = require("SimpleEnum")
+
+export type ModelTransparencyMode = "SetTransparency" | "SetLocalTransparencyModifier"
+
+return SimpleEnum.new({
+	TRANSPARENCY = "SetTransparency" :: "SetTransparency",
+	LOCAL_TRANSPARENCY = "SetLocalTransparencyModifier" :: "SetLocalTransparencyModifier",
+})