@quenty/characterutils 12.17.0 → 12.17.1

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.
 
+## [12.17.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/characterutils@12.17.0...@quenty/characterutils@12.17.1) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/characterutils
+
+
+
+
+
 # [12.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/characterutils@12.16.0...@quenty/characterutils@12.17.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/characterutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/characterutils",
-  "version": "12.17.0",
+  "version": "12.17.1",
   "description": "CharacterUtils",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.16.0",
+    "@quenty/brio": "^14.16.1",
     "@quenty/deferred": "^2.2.0",
-    "@quenty/instanceutils": "^13.16.0",
+    "@quenty/instanceutils": "^13.16.1",
     "@quenty/loader": "^10.8.0",
     "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.0",
-    "@quenty/rx": "^13.16.0"
+    "@quenty/promise": "^10.10.1",
+    "@quenty/rx": "^13.16.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Shared/CharacterUtils.lua

@@ -12,7 +12,7 @@ local CharacterUtils = {}
 	@param player Player
 	@return Humanoid? -- Nil if not found
 ]=]
-function CharacterUtils.getPlayerHumanoid(player)
+function CharacterUtils.getPlayerHumanoid(player: Player): Humanoid?
 	local character = player.Character
 	if not character then
 		return nil
@@ -26,7 +26,7 @@ end
 	@param player Player
 	@return Humanoid? -- Nil if not found
 ]=]
-function CharacterUtils.getAlivePlayerHumanoid(player)
+function CharacterUtils.getAlivePlayerHumanoid(player: Player): Humanoid?
 	local humanoid = CharacterUtils.getPlayerHumanoid(player)
 	if not humanoid or humanoid.Health <= 0 then
 		return nil
@@ -41,7 +41,7 @@ end
 	@param player Player
 	@return BasePart? -- Nil if not found
 ]=]
-function CharacterUtils.getAlivePlayerRootPart(player)
+function CharacterUtils.getAlivePlayerRootPart(player: Player): BasePart?
 	local humanoid = CharacterUtils.getPlayerHumanoid(player)
 	if not humanoid or humanoid.Health <= 0 then
 		return nil
@@ -55,7 +55,7 @@ end
 	@param player Player
 	@return BasePart? -- Nil if not found
 ]=]
-function CharacterUtils.getPlayerRootPart(player)
+function CharacterUtils.getPlayerRootPart(player: Player): BasePart?
 	local humanoid = CharacterUtils.getPlayerHumanoid(player)
 	if not humanoid then
 		return nil
@@ -78,7 +78,7 @@ end
 
 	@param player Player
 ]=]
-function CharacterUtils.unequipTools(player)
+function CharacterUtils.unequipTools(player: Player)
 	local humanoid = CharacterUtils.getPlayerHumanoid(player)
 	if humanoid then
 		humanoid:UnequipTools()
@@ -106,7 +106,7 @@ end
 	@param descendant Instance -- A child of the potential character.
 	@return Player? -- Nil if not found
 ]=]
-function CharacterUtils.getPlayerFromCharacter(descendant)
+function CharacterUtils.getPlayerFromCharacter(descendant: Instance): Player?
 	local character = descendant
 	local player = Players:GetPlayerFromCharacter(character)
 
@@ -122,4 +122,4 @@ function CharacterUtils.getPlayerFromCharacter(descendant)
 	return player
 end
 
-return CharacterUtils
+return CharacterUtils

package/src/Shared/RootPartUtils.lua

@@ -24,7 +24,7 @@ local MAX_YIELD_TIME = 60
 	@param humanoid Humanoid
 	@return Promise<BasePart>
 ]=]
-function RootPartUtils.promiseRootPart(humanoid)
+function RootPartUtils.promiseRootPart(humanoid: Humanoid)
 	if humanoid.RootPart then
 		return Promise.resolved(humanoid.RootPart)
 	end
@@ -69,4 +69,4 @@ function RootPartUtils.promiseRootPart(humanoid)
 	return promise
 end
 
-return RootPartUtils
+return RootPartUtils

package/src/Shared/RxCharacterUtils.lua

@@ -36,17 +36,29 @@ end
 	@param player Player
 	@return Observable<Model>
 ]=]
-function RxCharacterUtils.observeCharacter(player)
+function RxCharacterUtils.observeCharacter(player: Player)
 	return RxInstanceUtils.observeProperty(player, "Character")
 end
 
-function RxCharacterUtils.observeCharacterBrio(player)
+--[=[
+	Observes a player's character property as a brio
+
+	@param player Player
+	@return Observable<Brio<Model>>
+]=]
+function RxCharacterUtils.observeCharacterBrio(player: Player)
 	return RxInstanceUtils.observePropertyBrio(player, "Character", function(character)
 		return character ~= nil
 	end)
 end
 
-function RxCharacterUtils.observeIsOfLocalCharacter(instance)
+--[=[
+	Observes whether the instance is part of the local player's character
+
+	@param instance Instance
+	@return Observable<boolean>
+]=]
+function RxCharacterUtils.observeIsOfLocalCharacter(instance: Instance)
 	assert(typeof(instance) == "Instance", "Bad instance")
 
 	local localPlayer = Players.LocalPlayer
@@ -56,8 +68,8 @@ function RxCharacterUtils.observeIsOfLocalCharacter(instance)
 	end
 
 	return Rx.combineLatest({
-		character = RxCharacterUtils.observeLocalPlayerCharacter();
-		_ancestry = RxInstanceUtils.observeAncestry(instance)
+		character = RxCharacterUtils.observeLocalPlayerCharacter(),
+		_ancestry = RxInstanceUtils.observeAncestry(instance),
 	}):Pipe({
 		Rx.map(function(state)
 			if state.character then
@@ -65,19 +77,30 @@ function RxCharacterUtils.observeIsOfLocalCharacter(instance)
 			else
 				return false
 			end
-		end);
-		Rx.distinct();
+		end),
+		Rx.distinct(),
 	})
 end
 
-function RxCharacterUtils.observeIsOfLocalCharacterBrio(instance)
+--[=[
+	Observes whether the instance is part of the local player's character as a brio
+
+	@param instance Instance
+	@return Observable<Brio<boolean>>
+]=]
+function RxCharacterUtils.observeIsOfLocalCharacterBrio(instance: Instance)
 	return RxCharacterUtils.observeIsOfLocalCharacter(instance):Pipe({
 		RxBrioUtils.switchToBrio(function(value)
 			return value
-		end)
+		end),
 	})
 end
 
+--[=[
+	Observes the local player's character
+
+	@return Observable<Model>
+]=]
 function RxCharacterUtils.observeLocalPlayerCharacter()
 	return RxInstanceUtils.observeProperty(Players, "LocalPlayer"):Pipe({
 		Rx.switchMap(function(player)
@@ -86,8 +109,8 @@ function RxCharacterUtils.observeLocalPlayerCharacter()
 			else
 				return Rx.of(nil)
 			end
-		end);
-		Rx.distinct();
+		end),
+		Rx.distinct(),
 	})
 end
 
@@ -100,7 +123,7 @@ function RxCharacterUtils.observeLastHumanoidBrio(player: Player)
 	return RxCharacterUtils.observeLastCharacterBrio(player):Pipe({
 		RxBrioUtils.switchMapBrio(function(character)
 			return RxInstanceUtils.observeLastNamedChildBrio(character, "Humanoid", "Humanoid")
-		end);
+		end),
 	})
 end
 
@@ -129,6 +152,7 @@ local function observeHumanoidLifetimeAsBrio(humanoid: Humanoid)
 			return maid
 		else
 			onDeath()
+			return nil
 		end
 	end)
 end
@@ -161,7 +185,7 @@ function RxCharacterUtils.observeLastAliveHumanoidBrio(player: Player)
 	return RxCharacterUtils.observeLastHumanoidBrio(player):Pipe({
 		RxBrioUtils.switchMapBrio(function(humanoid)
 			return observeHumanoidLifetimeAsBrio(humanoid)
-		end);
+		end),
 	})
 end
 

package/src/Shared/RxRootPartUtils.lua

@@ -15,7 +15,7 @@ local RxRootPartUtils = {}
 	@param character Model
 	@return Brio<BasePart>
 ]=]
-function RxRootPartUtils.observeHumanoidRootPartBrio(character)
+function RxRootPartUtils.observeHumanoidRootPartBrio(character: Model)
 	-- let's make a reasonable assumption here about name not changing
 	return RxInstanceUtils.observeChildrenBrio(character, function(part)
 		return part:IsA("BasePart") and part.Name == "HumanoidRootPart"
@@ -28,12 +28,12 @@ end
 	@param humanoid Humanoid
 	@return Brio<BasePart>
 ]=]
-function RxRootPartUtils.observeHumanoidRootPartBrioFromHumanoid(humanoid)
+function RxRootPartUtils.observeHumanoidRootPartBrioFromHumanoid(humanoid: Humanoid)
 	return RxInstanceUtils.observeParentBrio(humanoid):Pipe({
 		RxBrioUtils.switchMapBrio(function(character)
 			return RxRootPartUtils.observeHumanoidRootPartBrio(character)
-		end)
+		end),
 	})
 end
 
-return RxRootPartUtils
+return RxRootPartUtils