@quenty/spawning 1.1.0-canary.252.9753dcc.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.1.0-canary.252.9753dcc.0 (2022-03-10)
+
+
+### Features
+
+* Add spawning package for centralized performance tracked spawning ([dc21714](https://github.com/Quenty/NevermoreEngine/commit/dc21714f03bfe510670d65072dfcdbdb3392d3ce))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+## SoundPromiseUtils
+<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>
+
+Centralized spawning service
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/SpawnService">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/spawning --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "spawning",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@quenty/spawning",
+  "version": "1.1.0-canary.252.9753dcc.0",
+  "description": "Centralized spawning system",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/spawning/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/binder": "5.1.0-canary.252.9753dcc.0",
+    "@quenty/cmdrservice": "4.1.0-canary.252.9753dcc.0",
+    "@quenty/loader": "4.0.0",
+    "@quenty/maid": "2.2.0-canary.252.9753dcc.0",
+    "@quenty/randomutils": "2.1.1",
+    "@quenty/servicebag": "4.1.0-canary.252.9753dcc.0",
+    "@quentystudios/t": "^1.2.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "9753dcc02d4600d2706d8003cebb325ccfcde523"
+}

package/src/Client/SpawnServiceClient.lua

@@ -0,0 +1,16 @@
+--[=[
+	@class SpawnServiceClient
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local SpawnServiceClient = {}
+
+function SpawnServiceClient:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._serviceBag:GetService(require("CmdrServiceClient"))
+end
+
+return SpawnServiceClient

package/src/Server/SpawnBinderGroupsServer.lua

@@ -0,0 +1,30 @@
+--[=[
+	@class SpawnBinderGroupsServer
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BinderGroup = require("BinderGroup")
+local t = require("t")
+
+return require("BinderGroupProvider").new(function(self, _serviceBag)
+
+	-- SpawnProvider
+	-- self:Add("SpawnProviders", BinderGroup.new(
+	-- 	{
+	-- 	},
+	-- 	t.interface({
+	-- 		GetSpawnPosition = t.callback;
+	-- 	})
+	-- ))
+
+	-- Item / asset spawning
+	self:Add("Spawners", BinderGroup.new(
+		{
+		},
+		t.interface({
+			SpawnUpdate = t.callback;
+			Regenerate = t.callback;
+		})
+	))
+end)

package/src/Server/SpawnCmdrService.lua

@@ -0,0 +1,29 @@
+--[=[
+	@class SpawnCmdrService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local SpawnCmdrService = {}
+
+function SpawnCmdrService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._spawnService = self._serviceBag:GetService(require("SpawnService"))
+	self._cmdrService = self._serviceBag:GetService(require("CmdrService"))
+
+	self._cmdrService:RegisterCommand({
+		Name = "regen";
+		Aliases = {};
+		Description = "Forces all spawners to regenerate.";
+		Group = "Spawn";
+		Args = {};
+	}, function(_context)
+		self._spawnService:Regenerate()
+
+		return "Regenerated every spawner in the game."
+	end)
+end
+
+return SpawnCmdrService

package/src/Server/SpawnService.lua

@@ -0,0 +1,101 @@
+--[=[
+	Handles spawning stuff in the game
+	@class SpawnService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RunService = game:GetService("RunService")
+
+local RandomUtils = require("RandomUtils")
+local Maid = require("Maid")
+
+local UPDATE_PERIOD_SEC = 5
+local SPAWN_AFTER_GAME_START = 1
+local MAX_BUDGET_PER_CLASS = 0.05
+local WARN_ON_CLASS_BUDGET_EXHAUST = false
+local TOTAL_BUDGET_BEFORE_WARN = 0.1
+
+local SpawnService = {}
+
+function SpawnService:Init(serviceBag)
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	-- External
+	self._serviceBag:GetService(require("CmdrService"))
+
+	-- Internal
+	self._spawnBinderGroupsServer = self._serviceBag:GetService(require("SpawnBinderGroupsServer"))
+	self._serviceBag:GetService(require("SpawnCmdrService"))
+end
+
+function SpawnService:Start()
+	local lastUpdateTime = (tick() - UPDATE_PERIOD_SEC + SPAWN_AFTER_GAME_START)
+
+	-- TODO: Smear across update pipeline
+	self._maid:GiveTask(RunService.Stepped:Connect(function()
+		if (lastUpdateTime + UPDATE_PERIOD_SEC) <= tick() then
+			lastUpdateTime = tick()
+			self:Update()
+		end
+	end))
+end
+
+function SpawnService:AddSpawnerBinder(spawnerBinder)
+	self._spawnBinderGroupsServer.Spawners:Add(spawnerBinder)
+end
+
+function SpawnService:Regenerate()
+	local startTime = tick()
+
+	for _, binder in pairs(self._spawnBinderGroupsServer.Spawners:GetBinders()) do
+		for _, spawner in pairs(binder:GetAll()) do
+			spawner:Regenerate()
+		end
+	end
+
+	if (tick() - startTime) >= 0.05 then
+		warn(("SpawnService regenerate time: %0.4f ms"):format((tick() - startTime)*1000))
+	end
+end
+
+function SpawnService:Update()
+	debug.profilebegin("spawnService")
+
+	local startTime = tick()
+	local spawnerCount = 0
+
+	for _, binder in pairs(self._spawnBinderGroupsServer.Spawners:GetBinders()) do
+		local classStartTime = tick()
+		local classes = RandomUtils.shuffledCopy(binder:GetAll())
+
+		for _, spawner in pairs(classes) do
+			spawnerCount = spawnerCount + 1
+			spawner:SpawnUpdate(false)
+
+			if (tick() - classStartTime) >= MAX_BUDGET_PER_CLASS then
+				if WARN_ON_CLASS_BUDGET_EXHAUST then
+					warn(("[SpawnService.Update] - Class %q ran out of execution budget at %0.4f ms")
+						:format(binder:GetTag(), (tick() - classStartTime)*1000))
+				end
+				break
+			end
+		end
+	end
+
+	-- watch dog
+	if (tick() - startTime) >= TOTAL_BUDGET_BEFORE_WARN then
+		warn(("[SpawnService.Update] - Update time: %0.4f ms for %d spawners")
+			:format((tick() - startTime)*1000, spawnerCount))
+	end
+
+	debug.profileend()
+end
+
+function SpawnService:Destroy()
+	self._maid:DoCleaning()
+	self._maid = nil
+end
+
+return SpawnService

package/src/Shared/SpawnerUtils.lua

@@ -0,0 +1,26 @@
+--[=[
+	@class SpawnerUtils
+]=]
+
+local SpawnerUtils = {}
+
+function SpawnerUtils.getSpawnLocation(spawnPart, raycaster)
+	local size = spawnPart.Size
+	local sy = size.y
+
+	local ox = (math.random() - 0.5)*size.x
+	local oz = (math.random() - 0.5)*size.z
+
+	local point = spawnPart.CFrame:pointToWorldSpace(Vector3.new(ox, sy/2, oz))
+
+	local ray = Ray.new(point, Vector3.new(0, -sy*2, 0))
+
+	local data = raycaster:FindPartOnRay(ray)
+	if not data then
+		return point
+	end
+
+	return data.Position, data
+end
+
+return SpawnerUtils

package/src/node_modules.project.json

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