@quenty/characterutils 12.4.0 → 12.5.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.
 
+# [12.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/characterutils@12.4.0...@quenty/characterutils@12.5.0) (2024-09-12)
+
+
+### Features
+
+* Add RxCharacterUtil helper methods ([7b0b7a9](https://github.com/Quenty/NevermoreEngine/commit/7b0b7a94b4c8c7c76b030b48ecdab1f1c8a7ff53))
+
+
+
+
+
 # [12.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/characterutils@12.3.0...@quenty/characterutils@12.4.0) (2024-08-09)
 
 **Note:** Version bump only for package @quenty/characterutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/characterutils",
-  "version": "12.4.0",
+  "version": "12.5.0",
   "description": "CharacterUtils",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.4.0",
+    "@quenty/brio": "^14.5.0",
     "@quenty/deferred": "^2.2.0",
-    "@quenty/instanceutils": "^13.4.0",
-    "@quenty/loader": "^10.3.0",
-    "@quenty/maid": "^3.2.0",
-    "@quenty/promise": "^10.3.0",
-    "@quenty/rx": "^13.4.0"
+    "@quenty/instanceutils": "^13.5.0",
+    "@quenty/loader": "^10.4.0",
+    "@quenty/maid": "^3.3.0",
+    "@quenty/promise": "^10.4.0",
+    "@quenty/rx": "^13.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ba466bdbc05c42fb607cf5e228c16339201d21d7"
+  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
 }

package/src/Shared/RxCharacterUtils.lua

@@ -5,11 +5,14 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local Players = game:GetService("Players")
+
 local Brio = require("Brio")
 local Maid = require("Maid")
 local Observable = require("Observable")
 local RxBrioUtils = require("RxBrioUtils")
 local RxInstanceUtils = require("RxInstanceUtils")
+local Rx = require("Rx")
 
 local RxCharacterUtils = {}
 
@@ -37,6 +40,57 @@ function RxCharacterUtils.observeCharacter(player)
 	return RxInstanceUtils.observeProperty(player, "Character")
 end
 
+function RxCharacterUtils.observeCharacterBrio(player)
+	return RxInstanceUtils.observePropertyBrio(player, "Character", function(character)
+		return character ~= nil
+	end)
+end
+
+function RxCharacterUtils.observeIsOfLocalCharacter(instance)
+	assert(typeof(instance) == "Instance", "Bad instance")
+
+	local localPlayer = Players.LocalPlayer
+	if not localPlayer then
+		warn("[RxCharacterUtils] - No localPlayer")
+		return Rx.EMPTY
+	end
+
+	return Rx.combineLatest({
+		character = RxCharacterUtils.observeLocalPlayerCharacter();
+		_ancestry = RxInstanceUtils.observeAncestry(instance)
+	}):Pipe({
+		Rx.map(function(state)
+			if state.character then
+				return instance == state.character or instance:IsDescendantOf(state.character)
+			else
+				return false
+			end
+		end);
+		Rx.distinct();
+	})
+end
+
+function RxCharacterUtils.observeIsOfLocalCharacterBrio(instance)
+	return RxCharacterUtils.observeIsOfLocalCharacter(instance):Pipe({
+		RxBrioUtils.switchToBrio(function(value)
+			return value
+		end)
+	})
+end
+
+function RxCharacterUtils.observeLocalPlayerCharacter()
+	return RxInstanceUtils.observeProperty(Players, "LocalPlayer"):Pipe({
+		Rx.switchMap(function(player)
+			if player then
+				return RxCharacterUtils.observeCharacter(player)
+			else
+				return Rx.of(nil)
+			end
+		end);
+		Rx.distinct();
+	})
+end
+
 --[=[
 	Observe a player's last humanoid. Note that it may not be alive!
 	@param player Player