@quenty/firstpersoncharactertransparency 7.1.0 → 8.0.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/firstpersoncharactertransparency@7.1.0...@quenty/firstpersoncharactertransparency@8.0.0) (2022-10-12)
+
+**Note:** Version bump only for package @quenty/firstpersoncharactertransparency
+
+
+
+
+
 # [7.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/firstpersoncharactertransparency@7.0.0...@quenty/firstpersoncharactertransparency@7.1.0) (2022-10-11)
 
 **Note:** Version bump only for package @quenty/firstpersoncharactertransparency

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/firstpersoncharactertransparency",
-  "version": "7.1.0",
+  "version": "8.0.0",
   "description": "Allows transparency to manually be controlled for a character in first-person mode",
   "keywords": [
     "Roblox",
@@ -27,13 +27,18 @@
   ],
   "dependencies": {
     "@quenty/baseobject": "^6.0.0",
+    "@quenty/brio": "^8.1.0",
     "@quenty/humanoidtracker": "^7.1.0",
+    "@quenty/instanceutils": "^7.1.0",
     "@quenty/loader": "^6.0.0",
     "@quenty/maid": "^2.4.0",
+    "@quenty/r15utils": "^7.1.0",
+    "@quenty/rx": "^7.1.0",
+    "@quenty/statestack": "^8.1.0",
     "@quenty/transparencyservice": "^7.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "69c2153865684748d0a8d6806f1ff999685c2e55"
+  "gitHead": "6e40fe4f0e364f7f4e37a31fb8b19d975f4f377d"
 }

package/src/Client/DisableHatParticles.lua

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

package/src/Client/HideHead.lua

@@ -0,0 +1,82 @@
+--[=[
+	@class HideHead
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local RxBrioUtils = require("RxBrioUtils")
+local RxInstanceUtils = require("RxInstanceUtils")
+local TransparencyService = require("TransparencyService")
+local RxR15Utils = require("RxR15Utils")
+
+local HideHead = setmetatable({}, BaseObject)
+HideHead.ClassName = "HideHead"
+HideHead.__index = HideHead
+
+function HideHead.new(character, serviceBag)
+	local self = setmetatable(BaseObject.new(character), HideHead)
+
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._transparencyService = self._serviceBag:GetService(TransparencyService)
+
+
+	self._maid:GiveTask(self:_observeHeadAndFaceAccessoryPartsBrio():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local part = brio:GetValue()
+		local maid = brio:ToMaid()
+
+		self._transparencyService:SetTransparency(maid, part, 1)
+		maid:GiveTask(function()
+			self._transparencyService:ResetTransparency(maid, part)
+		end)
+	end))
+
+	self._maid:GiveTask(self:_observeHeadBrio():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local part = brio:GetValue()
+		local maid = brio:ToMaid()
+
+		self._transparencyService:SetTransparency(maid, part, 1)
+		maid:GiveTask(function()
+			self._transparencyService:ResetTransparency(maid, part)
+		end)
+	end))
+
+	return self
+end
+
+function HideHead:_observeHeadBrio()
+	return RxR15Utils.observeCharacterPartBrio(self._obj, "Head")
+end
+
+function HideHead:_observeHeadAndFaceAccessoryPartsBrio()
+	return self:_observeAccessoriesBrio():Pipe({
+		RxBrioUtils.flatMapBrio(function(accessory)
+			return RxInstanceUtils.observePropertyBrio(accessory, "AccessoryType", function(accessoryType)
+				return accessoryType == Enum.AccessoryType.Hat or accessoryType == Enum.AccessoryType.Face
+			end):Pipe({
+				RxBrioUtils.onlyLastBrioSurvives();
+				RxBrioUtils.switchMapBrio(function()
+					return RxInstanceUtils.observeDescendantsBrio(accessory, function(child)
+						return child:IsA("BasePart")
+					end)
+				end);
+			})
+		end)
+	})
+end
+
+function HideHead:_observeAccessoriesBrio()
+	return RxInstanceUtils.observeDescendantsBrio(self._obj, function(inst)
+		return inst:IsA("Accessory")
+	end)
+end
+
+return HideHead

package/src/Client/ShowBody.lua

@@ -0,0 +1,85 @@
+--[=[
+	@class ShowBody
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local RxBrioUtils = require("RxBrioUtils")
+local RxInstanceUtils = require("RxInstanceUtils")
+local TransparencyService = require("TransparencyService")
+
+local ShowBody = setmetatable({}, BaseObject)
+ShowBody.ClassName = "ShowBody"
+ShowBody.__index = ShowBody
+
+function ShowBody.new(character, serviceBag)
+	local self = setmetatable(BaseObject.new(character), ShowBody)
+
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._transparencyService = self._serviceBag:GetService(TransparencyService)
+
+	self._maid:GiveTask(self:_observeNonHeadAndFaceAccessoryPartsBrio():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local part = brio:GetValue()
+		local maid = brio:ToMaid()
+
+		-- Force visibility
+		maid:GiveTask(part:GetPropertyChangedSignal("LocalTransparencyModifier"):Connect(function()
+			part.LocalTransparencyModifier = 0
+		end))
+		part.LocalTransparencyModifier = 0
+	end))
+
+	self._maid:GiveTask(self:_observeNonHeadParts():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local part = brio:GetValue()
+		local maid = brio:ToMaid()
+
+		-- Force visibility
+		maid:GiveTask(part:GetPropertyChangedSignal("LocalTransparencyModifier"):Connect(function()
+			part.LocalTransparencyModifier = 0
+		end))
+		part.LocalTransparencyModifier = 0
+	end))
+
+	return self
+end
+
+function ShowBody:_observeNonHeadParts()
+	return RxInstanceUtils.observeChildrenBrio(self._obj, function(child)
+		return child:IsA("BasePart") and child.Name ~= "Head" -- make some assumptions
+	end)
+end
+
+
+function ShowBody:_observeNonHeadAndFaceAccessoryPartsBrio()
+	return self:_observeAccessoriesBrio():Pipe({
+		RxBrioUtils.flatMapBrio(function(accessory)
+			return RxInstanceUtils.observePropertyBrio(accessory, "AccessoryType", function(accessoryType)
+				return accessoryType ~= Enum.AccessoryType.Hat and accessoryType ~= Enum.AccessoryType.Face
+			end):Pipe({
+				RxBrioUtils.onlyLastBrioSurvives();
+				RxBrioUtils.switchMapBrio(function()
+					return RxInstanceUtils.observeDescendantsBrio(accessory, function(child)
+						return child:IsA("BasePart")
+					end)
+				end);
+			})
+		end)
+	})
+end
+
+function ShowBody:_observeAccessoriesBrio()
+	return RxInstanceUtils.observeDescendantsBrio(self._obj, function(inst)
+		return inst:IsA("Accessory")
+	end)
+end
+
+return ShowBody

package/src/Client/CharacterTransparency.lua

@@ -1,72 +0,0 @@
----
--- @classmod CharacterTransparency
--- @author Quenty
-
-local require = require(script.Parent.loader).load(script)
-
-local RunService = game:GetService("RunService")
-
-local BaseObject = require("BaseObject")
-local ModelTransparencyEffect = require("ModelTransparencyEffect")
-local DisableHatParticles = require("DisableHatParticles")
-
-local CharacterTransparency = setmetatable({}, BaseObject)
-CharacterTransparency.ClassName = "CharacterTransparency"
-CharacterTransparency.__index = CharacterTransparency
-
-function CharacterTransparency.new(serviceBag, character, tweener)
-	local self = setmetatable(BaseObject.new(character), CharacterTransparency)
-
-	self._character = assert(character, "Bad character")
-	self._tweener = assert(tweener, "Bad tweener")
-
-	self._modelTransparency = ModelTransparencyEffect.new(serviceBag, self._character)
-	self._modelTransparency:SetAcceleration(40)
-	self._maid:GiveTask(self._modelTransparency)
-
-	self._enabled = Instance.new("BoolValue")
-	self._enabled.Value = false
-	self._maid:GiveTask(self._enabled)
-
-	self._maid:GiveTask(self._enabled.Changed:Connect(function()
-		self:_onEnabledChanged()
-	end))
-
-	self._maid:GiveTask(RunService.RenderStepped:Connect(function()
-		self:_update()
-	end))
-
-	self:_update()
-
-	return self
-end
-
-function CharacterTransparency:_update()
-	self._enabled.Value = self:_getShouldBeVisible()
-end
-
-function CharacterTransparency:_getShouldBeVisible()
-	if self._tweener:GetPercentVisible() <= 0.5 then
-		return false
-	end
-
-	-- hope this isn't slow
-	local desiredPosition = self._tweener:GetCameraEffect().CameraState.CFrame.p
-	local position = workspace.CurrentCamera.CFrame.p
-	return (position - desiredPosition).magnitude <= 2
-end
-
-function CharacterTransparency:_onEnabledChanged()
-	if self._enabled.Value then
-		if not self._maid._disableHatParticles then
-			self._maid._disableHatParticles = DisableHatParticles.new(self._character)
-		end
-
-		self._modelTransparency:SetTransparency(1)
-	else
-		self._modelTransparency:SetTransparency(0)
-		self._maid._disableHatParticles = nil
-	end
-end
-
-return CharacterTransparency

package/src/Client/FirstPersonCharacterTransparency.lua

@@ -1,182 +0,0 @@
---[=[
-	Allows transparency to manually be controlled for a character in first-person mode.
-
-	:::tip
-	Make sure to initialize [TransparencyService] in the [ServiceBag] before using this.
-	:::
-
-	@class FirstPersonCharacterTransparency
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local BaseObject = require("BaseObject")
-local TransparencyService = require("TransparencyService")
-local Maid = require("Maid")
-
-local FirstPersonCharacterTransparency = setmetatable({}, BaseObject)
-FirstPersonCharacterTransparency.ClassName = "FirstPersonCharacterTransparency"
-FirstPersonCharacterTransparency.__index = FirstPersonCharacterTransparency
-
---[=[
-	Creates a new FirstPersonCharacterTransparency
-	@param humanoid Humanoid
-	@param serviceBag ServiceBag
-	@return FirstPersonCharacterTransparency
-]=]
-function FirstPersonCharacterTransparency.new(humanoid, serviceBag)
-	local self = setmetatable(BaseObject.new(humanoid), FirstPersonCharacterTransparency)
-
-	self._serviceBag = assert(serviceBag, "No serviceBag")
-
-	self._humanoid = humanoid or error("No humanoid")
-	self._character = self._humanoid.Parent or error("No character")
-	self._transparencyService = self._serviceBag:GetService(TransparencyService)
-
-	self._otherParts = {}
-	self._shownBodyParts = {}
-	self._transparency = 0
-
-	self._shouldShowArms = Instance.new("BoolValue")
-	self._shouldShowArms.Value = true
-	self._maid:GiveTask(self._shouldShowArms)
-
-	-- Listen to parts
-	for _, part in pairs(self._character:GetDescendants()) do
-		self:_handlePartAdded(part)
-	end
-
-	-- Listen to children
-	self._maid:GiveTask(self._character.DescendantAdded:Connect(function(part)
-		self:_handlePartAdded(part)
-	end))
-	self._maid:GiveTask(self._character.DescendantRemoving:Connect(function(part)
-		self:_handlePartRemoving(part)
-	end))
-
-	self._maid:GiveTask(function()
-		self:_reset()
-		self._otherParts = nil
-		self._shownBodyParts = nil
-	end)
-
-	return self
-end
-
---[=[
-	Sets whether body parts should be shown.
-	@param shouldShowArms boolean
-]=]
-function FirstPersonCharacterTransparency:SetShowArms(shouldShowArms)
-	assert(type(shouldShowArms) == "boolean", "Bad shouldShowArms")
-
-	self._shouldShowArms.Value = shouldShowArms
-	self:_updateRender()
-end
-
---[=[
-	Sets the transparency
-	@param transparency number
-]=]
-function FirstPersonCharacterTransparency:SetTransparency(transparency)
-	assert(type(transparency) == "number", "Bad transparency")
-
-	if transparency >= 0.999 then
-		transparency = 1
-	elseif transparency <= 0.001 then
-		transparency = 0
-	end
-
-	if self._transparency == transparency then
-		return
-	end
-
-	self._transparency = transparency
-
-	self:_updateRender()
-end
-
-function FirstPersonCharacterTransparency:_getBodyTransparency()
-	if self._shouldShowArms.Value then
-		return 0
-	else
-		return self._transparency
-	end
-end
-
-function FirstPersonCharacterTransparency:_reset()
-	for part, _ in pairs(self._otherParts) do
-		self:_resetPart(part)
-	end
-
-	for part, _ in pairs(self._shownBodyParts) do
-		self:_resetPart(part)
-	end
-end
-
-function FirstPersonCharacterTransparency:_resetPart(part)
-	self._transparencyService:ResetTransparency(self, part)
-	self._transparencyService:ResetLocalTransparencyModifier(self, part)
-end
-
-function FirstPersonCharacterTransparency:_isShowableBodyPart(part)
-	return not part:FindFirstAncestorWhichIsA("Accessory")
-		and (part.Name:find("Arm")
-			or part.Name:find("Hand")
-			or part.Name == "UpperTorso")
-end
-
-function FirstPersonCharacterTransparency:_handlePartAdded(part)
-	if not part:IsA("BasePart") then
-		return
-	end
-
-	if self:_isShowableBodyPart(part) then
-		self._shownBodyParts[part] = true
-		self:_updateBodyPart(part, self:_getBodyTransparency())
-
-		local maid = Maid.new()
-
-		-- Ensure sanity
-		maid:GiveTask(part:GetPropertyChangedSignal("LocalTransparencyModifier"):Connect(function()
-			self:_updateBodyPart(part, self:_getBodyTransparency())
-		end))
-
-		self._maid[part] = maid
-	else
-		self._otherParts[part] = true
-
-		self:_updatePart(part)
-	end
-end
-
-function FirstPersonCharacterTransparency:_handlePartRemoving(part)
-	if part:IsA("BasePart") then
-		self._otherParts[part] = nil
-		self._shownBodyParts[part] = nil
-		self._maid[part] = nil
-		self:_resetPart(part)
-	end
-end
-
-function FirstPersonCharacterTransparency:_updatePart(part)
-	self._transparencyService:SetTransparency(self, part, self._transparency)
-end
-
-function FirstPersonCharacterTransparency:_updateBodyPart(part, bodyTransparency)
-	self._transparencyService:SetTransparency(self, part, bodyTransparency)
-	part.LocalTransparencyModifier = 0
-end
-
-function FirstPersonCharacterTransparency:_updateRender()
-	for part, _ in pairs(self._otherParts) do
-		self:_updatePart(part)
-	end
-
-	local bodyTransparency = self:_getBodyTransparency()
-	for part, _ in pairs(self._shownBodyParts) do
-		self:_updateBodyPart(part, bodyTransparency)
-	end
-end
-
-return FirstPersonCharacterTransparency

package/src/Client/FirstPersonCharacterTransparencyServiceClient.lua

@@ -1,52 +0,0 @@
---[=[
-	@class FirstPersonCharacterTransparencyServiceClient
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Maid = require("Maid")
-local FirstPersonCharacterTransparency = require("FirstPersonCharacterTransparency")
-
-local FirstPersonCharacterTransparencyServiceClient = {}
-FirstPersonCharacterTransparencyServiceClient.ServiceName = "FirstPersonCharacterTransparencyServiceClient"
-
-function FirstPersonCharacterTransparencyServiceClient:Init(serviceBag)
-	assert(not self._serviceBag, "Already initialized")
-	self._serviceBag = assert(serviceBag, "No serviceBag")
-
-	self._serviceBag:GetService(require("TransparencyService"))
-	self._humanoidTrackerService = self._serviceBag:GetService(require("HumanoidTrackerService"))
-
-	self._maid = Maid.new()
-
-	self._shouldShowArms = Instance.new("BoolValue")
-	self._shouldShowArms.Value = true
-	self._maid:GiveTask(self._shouldShowArms)
-
-	self._humanoidTracker = self._humanoidTrackerService:GetHumanoidTracker()
-	self._maid:GiveTask(self._humanoidTracker.Humanoid:Observe():Subscribe(function(humanoid)
-		local maid = Maid.new()
-
-		if humanoid then
-			local firstPersonCharacterTransparency = FirstPersonCharacterTransparency.new(humanoid, serviceBag)
-			firstPersonCharacterTransparency:SetShowArms(self._shouldShowArms.Value)
-
-			maid:GiveTask(self._shouldShowArms.Changed:Connect(function()
-				firstPersonCharacterTransparency:SetShowArms(self._shouldShowArms.Value)
-			end))
-
-			maid:GiveTask(firstPersonCharacterTransparency)
-		end
-		self._maid._current = maid
-	end))
-end
-
-function FirstPersonCharacterTransparencyServiceClient:SetShowArms(shouldShowArms)
-	self._shouldShowArms.Value = shouldShowArms
-end
-
-function FirstPersonCharacterTransparencyServiceClient:Destroy()
-	self._maid:DoCleaning()
-end
-
-return FirstPersonCharacterTransparencyServiceClient