@rbxts/planck 0.1.0-rc.2

package/out/Phase.d.ts

@@ -0,0 +1,3 @@
+import { Phase } from "./types";
+
+export = Phase;

package/out/Phase.luau

@@ -0,0 +1,89 @@
+--- @class Phase
+---
+--- Phases represent tags that tell the scheduler when to
+--- schedule a set of systems.
+local Phase = {}
+Phase.__index = Phase
+
+function Phase:__tostring()
+	return self._name
+end
+
+--- @within Phase
+---
+--- Creates a new Phase, with an optional name to use for debugging.
+--- When no name is provided, the script and line number will be used.
+function Phase.new(name: string?)
+	name = name or debug.info(2, "sl")
+	return setmetatable({
+		_name = name,
+		_type = "phase",
+	}, Phase)
+end
+
+--- @prop PreStartup Phase
+--- @within Phase
+--- Runs before the `Startup` Phase.
+
+--- @prop Startup Phase
+--- @within Phase
+--- This Phase will run once, the first time the Scheduler is ran,
+--- before any other Phases are ran.
+
+--- @prop PostStartup Phase
+--- @within Phase
+--- Runs after the `Startup` phase.
+
+Phase.PreStartup = Phase.new("PreStartup")
+Phase.Startup = Phase.new("Startup")
+Phase.PostStartup = Phase.new("PostStartup")
+
+--- @prop PreRender Phase
+--- @within Phase
+--- Runs on the `RunService.PreRender` Event.
+
+--- @prop PreAnimation Phase
+--- @within Phase
+--- Runs on the `RunService.PreAnimation` Event.
+
+--- @prop PreSimulation Phase
+--- @within Phase
+--- Runs on the `RunService.PreSimulation` Event.
+
+--- @prop PostSimulation Phase
+--- @within Phase
+--- Runs on the `RunService.PostSimulation` Event.
+
+Phase.PreRender = Phase.new("PreRender")
+Phase.PreAnimation = Phase.new("PreAnimation")
+Phase.PreSimulation = Phase.new("PreSimulation")
+Phase.PostSimulation = Phase.new("PostSimulation")
+
+--- @prop First Phase
+--- @within Phase
+--- Will always run first on the `RunService.Heartbeat` Event.
+
+--- @prop PreUpdate Phase
+--- @within Phase
+--- Runs before the `Update` Phase.
+
+--- @prop Update Phase
+--- @within Phase
+--- Runs on the `RunService.Heartbeat` Event.
+--- This is the default Phase systems will run on.
+
+--- @prop PostUpdate Phase
+--- @within Phase
+--- Runs after the `Update` Phase.
+
+--- @prop Last Phase
+--- @within Phase
+--- Will always run last on the `RunService.Heartbeat` Event.
+
+Phase.First = Phase.new("First")
+Phase.PreUpdate = Phase.new("PreUpdate")
+Phase.Update = Phase.new("Update")
+Phase.PostUpdate = Phase.new("PostUpdate")
+Phase.Last = Phase.new("Last")
+
+return Phase

package/out/Pipeline.d.ts

@@ -0,0 +1,4 @@
+import { Pipeline } from "./types";
+
+
+export = Pipeline;

package/out/Pipeline.luau

@@ -0,0 +1,74 @@
+local Phase = require(script.Parent:WaitForChild('Phase'))
+--- @class Pipeline
+---
+--- Pipelines represent a set of ordered Phases. Systems cannot be
+--- assigned to Pipelines themselves, but rather to Phases within
+--- those Pipelines.
+
+local Pipeline = {}
+Pipeline.__index = Pipeline
+
+function Pipeline:__tostring()
+	return self._name
+end
+
+--- @method insert
+--- @within Pipeline
+--- @param phase Phase
+--- @return Pipeline
+---
+--- Adds a Phase to the Pipeline, ordering it implicitly.
+function Pipeline:insert(phase)
+	table.insert(self._phases, phase)
+	return self
+end
+
+--- @method insert
+--- @within Pipeline
+--- @param phase Phase
+--- @param after Phase
+--- @return Pipeline
+---
+--- Adds a Phase to the Pipeline after another Phase, ordering it explicitly.
+function Pipeline:insertAfter(phase, otherPhase)
+	local i = table.find(self._phases, phase)
+	assert(i, "Phase not initialized in Pipeline")
+
+	table.insert(self._phases, i + 1, otherPhase)
+	return self
+end
+
+--- @within Pipeline
+---
+--- Creates a new Pipeline, with an optional name to use for debugging.
+--- When no name is provided, the script and line number will be used.
+function Pipeline.new(name: string?)
+	name = name or debug.info(2, "sl")
+	return setmetatable({
+		_name = name,
+		_type = "pipeline",
+		_phases = {},
+	}, Pipeline)
+end
+
+--- @prop Startup Pipeline
+--- @within Pipeline
+---
+--- A Pipeline containing the `PreStartup`, `Startup`, and `PostStartup` phases.
+Pipeline.Startup = Pipeline.new()
+	:insert(Phase.PreStartup)
+	:insert(Phase.Startup)
+	:insert(Phase.PostStartup)
+
+--- @prop Main Pipeline
+--- @within Pipeline
+---
+--- A Pipeline containing the `First`, `PreUpdate`, `Update`, `PostUpdate`, and `Last` phases.
+Pipeline.Main = Pipeline.new()
+	:insert(Phase.First)
+	:insert(Phase.PreUpdate)
+	:insert(Phase.Update)
+	:insert(Phase.PostUpdate)
+	:insert(Phase.Last)
+
+return Pipeline

package/out/Scheduler.d.ts

@@ -0,0 +1,3 @@
+import { Scheduler } from "./types";
+
+export = Scheduler;