@quenty/teamutils 2.1.0 → 2.2.1-canary.276.672e37b.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.2.1-canary.276.672e37b.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/teamutils@2.2.0...@quenty/teamutils@2.2.1-canary.276.672e37b.0) (2022-07-31)
+
+
+### Features
+
+* Add RxTeamUtils.observeEnemyTeamColorPlayersBrio(teamColor) and documentation ([25690cb](https://github.com/Quenty/NevermoreEngine/commit/25690cb306dc2c6a140e3c12bacc9cec945a5b11))
+
+
+
+
+
+# [2.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/teamutils@2.1.0...@quenty/teamutils@2.2.0) (2022-06-21)
+
+
+### Features
+
+* Add RxTeamUtils ([437b7c6](https://github.com/Quenty/NevermoreEngine/commit/437b7c6b146709852e7f99c4d999af845915a15d))
+
+
+
+
+
 # [2.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/teamutils@2.0.1...@quenty/teamutils@2.1.0) (2022-03-27)
 
 **Note:** Version bump only for package @quenty/teamutils

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2021 Quenty
+Copyright (c) 2014-2022 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/teamutils",
-  "version": "2.1.0",
+  "version": "2.2.1-canary.276.672e37b.0",
   "description": "Team utility methods",
   "keywords": [
     "Roblox",
@@ -27,5 +27,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "501844bd6c3d3f765fd3032b997d8030bc963a1f"
+  "dependencies": {
+    "@quenty/brio": "6.1.1-canary.276.672e37b.0",
+    "@quenty/instanceutils": "5.1.1-canary.276.672e37b.0",
+    "@quenty/loader": "5.0.0",
+    "@quenty/maid": "2.3.1-canary.276.672e37b.0",
+    "@quenty/rx": "5.1.1-canary.276.672e37b.0"
+  },
+  "gitHead": "672e37b9bbb8b2d4c4c6c69ed2647335be0bc469"
 }

package/src/Shared/RxTeamUtils.lua

@@ -0,0 +1,184 @@
+--[=[
+	Helper methods involving teams on Roblox.
+	@class RxTeamUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Teams = game:GetService("Teams")
+local Players = game:GetService("Players")
+
+local Observable = require("Observable")
+local Maid = require("Maid")
+local Brio = require("Brio")
+local RxBrioUtils = require("RxBrioUtils")
+
+local RxTeamUtils = {}
+
+--[=[
+	Observes all players on a taem.
+
+	@param team Team
+	@return Observable<Brio<Player>>
+]=]
+function RxTeamUtils.observePlayersForTeamBrio(team)
+	assert(typeof(team) == "Instance" and team:IsA("Team"), "Bad team")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local function handlePlayer(player)
+			local brio = Brio.new(player)
+			maid[player] = brio
+
+			sub:Fire(brio)
+		end
+
+		maid:GiveTask(team.PlayerAdded:Connect(handlePlayer))
+		maid:GiveTask(team.PlayerRemoved:Connect(function(player)
+			maid[player] = nil
+		end))
+
+		for _, player in pairs(team:GetPlayers()) do
+			handlePlayer(player)
+		end
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes all enemy players for a team color
+
+	@param teamColor BrickColor
+	@return Observable<Brio<Player>>
+]=]
+function RxTeamUtils.observeEnemyTeamColorPlayersBrio(teamColor)
+	assert(typeof(teamColor) == "BrickColor", "Bad teamColor")
+
+	return Observable.new(function(sub)
+		local topMaid = Maid.new()
+
+		local function handlePlayerTeamChanged(playerMaid, player)
+			if player.Team and player.Team.TeamColor.Number == teamColor.Number then
+				playerMaid[player] = nil
+			else
+				local brio = Brio.new(player)
+				playerMaid[player] = brio
+				sub:Fire(brio)
+			end
+		end
+
+		local function handlePlayer(player)
+			local maid = Maid.new()
+
+			handlePlayerTeamChanged(maid, player)
+			maid:GiveTask(player:GetPropertyChangedSignal("Team"):Connect(function()
+				handlePlayerTeamChanged(maid, player)
+			end))
+
+			topMaid[player] = maid
+		end
+
+		topMaid:GiveTask(Players.PlayerAdded:Connect(handlePlayer))
+		topMaid:GiveTask(Players.PlayerRemoving:Connect(function(player)
+			topMaid[player] = nil
+		end))
+
+		for _, player in pairs(Players:GetPlayers()) do
+			handlePlayer(player)
+		end
+
+		return topMaid
+	end)
+end
+
+
+--[=[
+	Observes all players for a team color (given they have a team)
+
+	@param teamColor BrickColor
+	@return Observable<Brio<Player>>
+]=]
+function RxTeamUtils.observePlayersForTeamColorBrio(teamColor)
+	assert(typeof(teamColor) == "BrickColor", "Bad teamColor")
+
+	return RxTeamUtils.observeTeamsForColorBrio(teamColor):Pipe({
+		-- NOTE: Switch map here means we get a subtle bug, but alternative is duplicate players if there's 2 teams
+		-- with the same color so no great solution here.
+		RxBrioUtils.switchMapBrio(function(team)
+			return RxTeamUtils.observePlayersForTeamBrio(team)
+		end)
+	})
+end
+
+--[=[
+	Observes all teams for a given color
+
+	@param teamColor BrickColor
+	@return Observable<Brio<Team>>
+]=]
+function RxTeamUtils.observeTeamsForColorBrio(teamColor)
+	assert(typeof(teamColor) == "BrickColor", "Bad teamColor")
+
+	return Observable.new(function(sub)
+		local topMaid = Maid.new()
+
+		topMaid:GiveTask(RxTeamUtils.observeTeamsBrio():Subscribe(function(brio)
+			if brio:IsDead() then
+				return
+			end
+
+			local maid = brio:ToMaid()
+			local team = brio:GetValue()
+
+			local function update()
+				if team.TeamColor.Number == teamColor.Number then
+					local result = Brio.new(team)
+					maid._current = result
+
+					sub:Fire(result)
+				else
+					maid._current = nil
+				end
+			end
+			team:GetPropertyChangedSignal("TeamColor"):Connect(update)
+			update()
+		end))
+
+		return topMaid
+	end)
+end
+
+--[=[
+	Observes all teams in the game (In Teams service)
+
+	@return Observable<Brio<Team>>
+]=]
+function RxTeamUtils.observeTeamsBrio()
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local function handleTeam(team)
+			if team:IsA("Team") then
+				local brio = Brio.new(team)
+				maid[team] = brio
+
+				sub:Fire(brio)
+			end
+		end
+
+		maid:GiveTask(Teams.ChildAdded:Connect(handleTeam))
+		maid:GiveTask(Teams.ChildRemoved:Connect(function(inst)
+			maid[inst] = nil
+		end))
+
+		for _, team in pairs(Teams:GetTeams()) do
+			handleTeam(team)
+		end
+
+		return maid
+	end)
+end
+
+return RxTeamUtils

package/src/node_modules.project.json

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