feat: Add UGCSanitize to FirstPersonTransparency

Author: Quenty

readme.md

@@ -55,7 +55,7 @@ Many of these packages represent not just useful code, but useful patterns, or w
 ### All packages
 <!--package-list-generated-start-->
 
-There are 267 packages in Nevermore.
+There are 268 packages in Nevermore.
 
 | Package | Description | Install | docs | source | changelog | npm |
 | ------- | ----------- | ------- | ---- | ------ | --------- | --- |
@@ -134,7 +134,7 @@ There are 267 packages in Nevermore.
 | [EquippedTracker](https://quenty.github.io/NevermoreEngine/api/EquippedTracker) | Tracks the equipped player of a tool | `npm i @quenty/equippedtracker` | [docs](https://quenty.github.io/NevermoreEngine/api/EquippedTracker) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/equippedtracker) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/equippedtracker/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/equippedtracker) |
 | [ExperienceCalculator](https://quenty.github.io/NevermoreEngine/api/ExperienceUtils) | Calculate experience on an exponential curve and perform relevant calculations Uses formulas from stackoverflow.com/questions/6954874/php-game-formula-to-calculate-a-level-based-on-exp | `npm i @quenty/experiencecalculator` | [docs](https://quenty.github.io/NevermoreEngine/api/ExperienceUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/experiencecalculator) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/experiencecalculator/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/experiencecalculator) |
 | [FakeSkybox](https://quenty.github.io/NevermoreEngine/api/FakeSkybox) | Allow transitions between skyboxes | `npm i @quenty/fakeskybox` | [docs](https://quenty.github.io/NevermoreEngine/api/FakeSkybox) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/fakeskybox) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/fakeskybox/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/fakeskybox) |
-| [FirstPersonCharacterTransparency](https://quenty.github.io/NevermoreEngine/api/DisableHatParticles) | Allows transparency to manually be controlled for a character in first-person mode | `npm i @quenty/firstpersoncharactertransparency` | [docs](https://quenty.github.io/NevermoreEngine/api/DisableHatParticles) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/firstpersoncharactertransparency) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/firstpersoncharactertransparency/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/firstpersoncharactertransparency) |
+| [FirstPersonCharacterTransparency](https://quenty.github.io/NevermoreEngine/api/ShowBody) | Allows transparency to manually be controlled for a character in first-person mode | `npm i @quenty/firstpersoncharactertransparency` | [docs](https://quenty.github.io/NevermoreEngine/api/ShowBody) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/firstpersoncharactertransparency) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/firstpersoncharactertransparency/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/firstpersoncharactertransparency) |
 | [Flipbook](https://quenty.github.io/NevermoreEngine/api/Flipbook) | Handles playing back animated spritesheets | `npm i @quenty/flipbook` | [docs](https://quenty.github.io/NevermoreEngine/api/Flipbook) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/flipbook) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/flipbook/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/flipbook) |
 | [FriendUtils](https://quenty.github.io/NevermoreEngine/api/FriendUtils) | Utlity functions to help find friends of a user. Also contains utility to make testing in studio easier. | `npm i @quenty/friendutils` | [docs](https://quenty.github.io/NevermoreEngine/api/FriendUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/friendutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/friendutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/friendutils) |
 | [FunctionUtils](https://quenty.github.io/NevermoreEngine/api/FunctionUtils) | Utility functions involving functions | `npm i @quenty/functionutils` | [docs](https://quenty.github.io/NevermoreEngine/api/FunctionUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/functionutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/functionutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/functionutils) |
@@ -314,6 +314,7 @@ There are 267 packages in Nevermore.
 | [TransitionModel](https://quenty.github.io/NevermoreEngine/api/TransitionModelUtils) | Helps with Gui visiblity showing and hiding | `npm i @quenty/transitionmodel` | [docs](https://quenty.github.io/NevermoreEngine/api/TransitionModelUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/transitionmodel) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/transitionmodel/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/transitionmodel) |
 | [TransparencyService](https://quenty.github.io/NevermoreEngine/api/TransparencyService) | Service that orchistrates transparency setting from multiple colliding sources and handle the transparency appropriately. This means that 2 systems can work with transparency without knowing about each other. | `npm i @quenty/transparencyservice` | [docs](https://quenty.github.io/NevermoreEngine/api/TransparencyService) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/transparencyservice) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/transparencyservice/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/transparencyservice) |
 | [Tuple](https://quenty.github.io/NevermoreEngine/api/TupleUtils) | Tuple utility package | `npm i @quenty/tuple` | [docs](https://quenty.github.io/NevermoreEngine/api/TupleUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/tuple) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/tuple/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/tuple) |
+| [UGCSanitize](https://quenty.github.io/NevermoreEngine/api/UGCSanitizeUtils) | Sanitizes UGC hats and other items | `npm i @quenty/ugcsanitize` | [docs](https://quenty.github.io/NevermoreEngine/api/UGCSanitizeUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/ugcsanitize) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/ugcsanitize/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/ugcsanitize) |
 | [UIObjectUtils](https://quenty.github.io/NevermoreEngine/api/PlayerGuiUtils) | UI object utils library for Roblox | `npm i @quenty/uiobjectutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerGuiUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/uiobjectutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/uiobjectutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/uiobjectutils) |
 | [UltrawideContainerUtils](https://quenty.github.io/NevermoreEngine/api/UltrawideContainerUtils) | Creates a 1920x1080 scaling container to handle ultrawide monitors and screens in a reasonable way. This helps keep UI centered and available for ultrawide screens. | `npm i @quenty/ultrawidecontainerutils` | [docs](https://quenty.github.io/NevermoreEngine/api/UltrawideContainerUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/ultrawidecontainerutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/ultrawidecontainerutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/ultrawidecontainerutils) |
 | [UndoStack](https://quenty.github.io/NevermoreEngine/api/UndoStack) | Generalized undo stack for Roblox | `npm i @quenty/undostack` | [docs](https://quenty.github.io/NevermoreEngine/api/UndoStack) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/undostack) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/undostack/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/undostack) |

src/firstpersoncharactertransparency/README.md

@@ -13,7 +13,7 @@
 
 Allows transparency to manually be controlled for a character in first-person mode
 
-<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/DisableHatParticles">View docs →</a></div>
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ShowBody">View docs →</a></div>
 
 ## Installation
 ```

src/firstpersoncharactertransparency/package.json

@@ -35,7 +35,8 @@
     "@quenty/r15utils": "file:../r15utils",
     "@quenty/rx": "file:../rx",
     "@quenty/statestack": "file:../statestack",
-    "@quenty/transparencyservice": "file:../transparencyservice"
+    "@quenty/transparencyservice": "file:../transparencyservice",
+    "@quenty/ugcsanitize": "file:../ugcsanitize"
   },
   "publishConfig": {
     "access": "public"

src/firstpersoncharactertransparency/src/Client/DisableHatParticles.lua

@@ -0,0 +1,23 @@
+## UGCSanitize
+
+<div align="center">
+  <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/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" />
+  </a>
+</div>
+
+Sanitizes UGC hats and other items
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/UGCSanitizeUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/ugcsanitize --save
+```

src/ugcsanitize/README.md

@@ -0,0 +1,7 @@
+{
+  "name": "ugcsanitize",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": "src"
+  }
+}

src/ugcsanitize/default.project.json

@@ -0,0 +1,37 @@
+{
+  "name": "@quenty/ugcsanitize",
+  "version": "1.0.0",
+  "description": "Sanitizes UGC hats and other items",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "ugcsanitize"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/ugcsanitize/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "file:../baseobject",
+    "@quenty/instanceutils": "file:../instanceutils",
+    "@quenty/loader": "file:../loader",
+    "@quenty/maid": "file:../maid",
+    "@quenty/string": "file:../string"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

src/ugcsanitize/package.json

@@ -0,0 +1,101 @@
+--[=[
+	@class DisableHatParticles
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local RxInstanceUtils = require("RxInstanceUtils")
+local String = require("String")
+
+local DisableHatParticles = setmetatable({}, BaseObject)
+DisableHatParticles.ClassName = "DisableHatParticles"
+DisableHatParticles.__index = DisableHatParticles
+
+function DisableHatParticles.new(character)
+	local self = setmetatable(BaseObject.new(character), DisableHatParticles)
+
+	self._maid:GiveTask(RxInstanceUtils.observeChildrenOfClassBrio(self._obj, "Accessory"):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid, accessory = brio:ToMaidAndValue()
+		self:_handleAccessory(maid, accessory)
+	end))
+
+	return self
+end
+
+function DisableHatParticles:_handleAccessory(maid, accessory)
+	maid:GiveTask(accessory.DescendantAdded:Connect(function(descendant)
+		self:_handleAccessoryDescendant(maid, descendant)
+	end))
+	maid:GiveTask(accessory.DescendantRemoving:Connect(function(descendant)
+		maid[descendant] = nil
+	end))
+
+	for _, descendant in pairs(accessory:GetDescendants()) do
+		self:_handleAccessoryDescendant(maid, descendant)
+	end
+end
+
+function DisableHatParticles:_handleAccessoryDescendant(maid, descendant)
+	if descendant:IsA("Fire")
+		or descendant:IsA("Sparkles")
+		or descendant:IsA("Smoke")
+		or descendant:IsA("ParticleEmitter") then
+		if descendant.Enabled then
+			maid[descendant] = function()
+				descendant.Enabled = true
+			end
+
+			descendant.Enabled = false
+		end
+	end
+
+	-- TODO: This code is unsafe? Use a sound group?
+	if self:_isASoundScript(descendant) then
+		maid[descendant] = function()
+			descendant.Enabled = true
+		end
+
+		descendant.Enabled = false
+	end
+
+	if self:_isSound(descendant) then
+		local originalVolume = descendant.Volume
+		maid[descendant] = function()
+			descendant.Volume = originalVolume
+		end
+
+		descendant.Volume = 0
+	end
+end
+
+function DisableHatParticles:_isASoundScript(descendant)
+	if not descendant:IsA("LocalScript") then
+		return false
+	end
+
+	if String.endsWith(descendant.Name, "Sounds") then
+		return true
+	end
+
+	if String.endsWith(descendant.Name, "Sound") then
+		return true
+	end
+
+	if String.startsWith(descendant.Name, "Sound") then
+		return true
+	end
+
+	return false
+end
+
+function DisableHatParticles:_isSound(descendant)
+	-- Sound group check is paranoid but likely to be valid as to identify hat-sounds
+	return descendant:IsA("Sound") and descendant.SoundGroup == nil
+end
+
+return DisableHatParticles

src/ugcsanitize/src/Shared/DisableHatParticles.lua

@@ -0,0 +1,9 @@
+--[=[
+	@class UGCSanitizeUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local UGCSanitizeUtils = {}
+
+return UGCSanitizeUtils

src/ugcsanitize/src/Shared/UGCSanitizeUtils.lua

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

src/ugcsanitize/src/node_modules.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "UGCSanitizeTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "ugcsanitize": {
+        "$path": ".."
+      }
+    }
+  }
+}