@quenty/playerutils 8.16.0 → 8.16.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.
 
+## [8.16.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerutils@8.16.0...@quenty/playerutils@8.16.1) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/playerutils
+
+
+
+
+
 # [8.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerutils@8.15.0...@quenty/playerutils@8.16.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/playerutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/playerutils",
-  "version": "8.16.0",
+  "version": "8.16.1",
   "description": "Player utility functions",
   "keywords": [
     "Roblox",
@@ -28,12 +28,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/brio": "^14.16.0",
-    "@quenty/instanceutils": "^13.16.0",
+    "@quenty/brio": "^14.16.1",
+    "@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"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Shared/PlayerUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class PlayerUtils
 ]=]
@@ -20,7 +21,7 @@ local PlayerUtils = {}
 	@param player Player
 	@return string -- Formatted name
 ]=]
-function PlayerUtils.formatName(player)
+function PlayerUtils.formatName(player: Player): string
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	local name = player.Name
@@ -50,12 +51,18 @@ function PlayerUtils.formatDisplayName(name: string, displayName: string): strin
 	end
 end
 
+export type UserInfo = {
+	Username: string,
+	DisplayName: string,
+	HasVerifiedBadge: boolean,
+}
+
 --[=[
 	Formats the display name from the user info
 	@param userInfo UserInfo
 	@return string
 ]=]
-function PlayerUtils.formatDisplayNameFromUserInfo(userInfo): string
+function PlayerUtils.formatDisplayNameFromUserInfo(userInfo: UserInfo): string
 	assert(type(userInfo) == "table", "Bad userInfo")
 	assert(type(userInfo.Username) == "string", "Bad userInfo.Username")
 	assert(type(userInfo.DisplayName) == "string", "Bad userInfo.DisplayName")
@@ -80,9 +87,9 @@ function PlayerUtils.addVerifiedBadgeToName(name: string): string
 end
 
 local NAME_COLORS = {
-	BrickColor.new("Bright red").Color;
-	BrickColor.new("Bright blue").Color;
-	BrickColor.new("Earth green").Color;
+	BrickColor.new("Bright red").Color,
+	BrickColor.new("Bright blue").Color,
+	BrickColor.new("Earth green").Color,
 	BrickColor.new("Bright violet").Color,
 	BrickColor.new("Bright orange").Color,
 	BrickColor.new("Bright yellow").Color,
@@ -90,15 +97,15 @@ local NAME_COLORS = {
 	BrickColor.new("Brick yellow").Color,
 }
 
-local function hashName(pName)
+local function hashName(playerName: string): number
 	local value = 0
-	for index = 1, #pName do
-		local cValue = string.byte(string.sub(pName, index, index))
-		local reverseIndex = #pName - index + 1
-		if #pName%2 == 1 then
+	for index = 1, #playerName do
+		local cValue = string.byte(string.sub(playerName, index, index))
+		local reverseIndex = #playerName - index + 1
+		if #playerName % 2 == 1 then
 			reverseIndex = reverseIndex - 1
 		end
-		if reverseIndex%4 >= 2 then
+		if reverseIndex % 4 >= 2 then
 			cValue = -cValue
 		end
 		value = value + cValue
@@ -112,7 +119,7 @@ end
 	@param displayName string
 	@return Color3
 ]=]
-function PlayerUtils.getDefaultNameColor(displayName)
+function PlayerUtils.getDefaultNameColor(displayName: string): Color3
 	return NAME_COLORS[(hashName(displayName) % #NAME_COLORS) + 1]
 end
 
@@ -122,7 +129,7 @@ end
 	@param player Player
 	@return Promise<Model>
 ]=]
-function PlayerUtils.promiseLoadCharacter(player)
+function PlayerUtils.promiseLoadCharacter(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return Promise.spawn(function(resolve, reject)
@@ -144,9 +151,15 @@ end
 	@param humanoidDescription HumanoidDescription
 	@return Promise<Model>
 ]=]
-function PlayerUtils.promiseLoadCharacterWithHumanoidDescription(player, humanoidDescription)
+function PlayerUtils.promiseLoadCharacterWithHumanoidDescription(
+	player: Player,
+	humanoidDescription: HumanoidDescription
+)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
-	assert(typeof(humanoidDescription) == "Instance" and humanoidDescription:IsA("HumanoidDescription"), "Bad humanoidDescription")
+	assert(
+		typeof(humanoidDescription) == "Instance" and humanoidDescription:IsA("HumanoidDescription"),
+		"Bad humanoidDescription"
+	)
 
 	return Promise.spawn(function(resolve, reject)
 		local ok, err = pcall(function()
@@ -160,4 +173,4 @@ function PlayerUtils.promiseLoadCharacterWithHumanoidDescription(player, humanoi
 	end)
 end
 
-return PlayerUtils
+return PlayerUtils