@rbxts/planck 0.2.5 → 0.3.0-alpha.2

package/{out → src}/utils.luau

@@ -1,161 +1,197 @@
-type Phase = any
-type Pipeline = any
-
-type SystemFn<U...> = ((U...) -> any) | ((U...) -> ())
-
-type SystemTable<U...> = {
-	system: SystemFn<U...>,
-	phase: Phase?,
-	[any]: any,
-}
-
-type System<U...> = SystemFn<U...> | SystemTable<U...>
-
-local function getSystem<U...>(system: any): SystemTable<U...>?
-	if type(system) == "function" then
-		return system
-	elseif type(system) == "table" and system.system then
-		return system.system
-	else
-		return nil
-	end
-end
-
-local function getSystemName(system: any): string
-	local name = debug.info(system, "n")
-	if not name or string.len(name) == 0 then
-		local source, line = debug.info(system, "sl")
-		name = `{source}:{line}`
-	end
-
-	return name
-end
-
-local function isPhase(phase: any): Phase?
-	if type(phase) == "table" and phase._type == "phase" then
-		return phase
-	else
-		return nil
-	end
-end
-
-local function isPipeline(pipeline: any): Pipeline?
-	if type(pipeline) == "table" and pipeline._type == "pipeline" then
-		return pipeline
-	else
-		return nil
-	end
-end
-
-local function getEventIdentifier(instance, event)
-	return `{instance}{event and `@{event}` or ""}`
-end
-
-local EVENT_CONNECT_METHODS = { "Connect", "On", "on", "connect" }
-
-export type EventLike = RBXScriptSignal | {
-	connect: (self: EventLike, ...any) -> any,
-	[any]: any,
-} | {
-	Connect: (self: EventLike, ...any) -> any,
-	[any]: any,
-} | {
-	on: (self: EventLike, ...any) -> any,
-	[any]: any,
-}
-
-export type EventInstance = Instance | {
-	[any]: EventLike,
-}
-
-export type ConnectionLike = RBXScriptConnection | {
-	disconnect: (self: ConnectionLike, ...any) -> any,
-	[any]: any,
-} | {
-	Disconnect: (self: ConnectionLike, ...any) -> any,
-	[any]: any,
-} | {
-	destroy: (self: ConnectionLike, ...any) -> any,
-	[any]: any,
-} | {
-	Destroy: (self: ConnectionLike, ...any) -> any,
-	[any]: any,
-} | (...any) -> any
-
-export type ConnectFn<U...> = (callback: (U...) -> ()) -> ConnectionLike
-
-local EVENT_DISCONNECT_METHODS =
-	{ "disconnect", "Disconnect", "destroy", "Destroy" }
-
-local function disconnectEvent(connection: ConnectionLike)
-	if type(connection) == "function" then
-		connection()
-		return
-	elseif typeof(connection) == "RBXScriptConnection" then
-		connection:Disconnect()
-		return
-	elseif type(connection) == "table" then
-		for _, method in EVENT_DISCONNECT_METHODS do
-			if
-				connection[method]
-				and type(connection[method]) == "function"
-			then
-				connection[method](connection)
-				return
-			end
-		end
-	end
-end
-
--- This function is inspired by useEvent in Matter, a library by evaera (https://github.com/evaera)
--- License: Copyright (c) 2021 Eryn L. K., MIT License
--- Source: https://github.com/matter-ecs/matter/blob/main/lib/hooks/useEvent.luau
-local function getConnectFunction<U...>(
-	instance: EventInstance | EventLike,
-	event: string | EventLike
-): ConnectFn<U...>?
-	local eventInstance = instance
-
-	if typeof(event) == "RBXScriptSignal" or type(event) == "table" then
-		eventInstance = event
-	elseif type(event) == "string" then
-		eventInstance = (instance :: any)[event]
-	end
-
-	if type(eventInstance) == "function" then
-		return eventInstance
-	elseif typeof(eventInstance) == "RBXScriptSignal" then
-		return function(callback)
-			return eventInstance:Connect(callback)
-		end
-	end
-
-	if type(eventInstance) == "table" then
-		for _, method in EVENT_CONNECT_METHODS do
-			if type(eventInstance[method]) ~= "function" then
-				continue
-			end
-
-			return function(callback)
-				return eventInstance[method](eventInstance, callback)
-			end
-		end
-	end
-
-	return nil
-end
-
-local function isValidEvent(instance, event)
-	return getConnectFunction(instance, event) ~= nil
-end
-
-return {
-	getSystem = getSystem,
-	getSystemName = getSystemName,
-	isPhase = isPhase,
-	isPipeline = isPipeline,
-	getEventIdentifier = getEventIdentifier,
-	isValidEvent = isValidEvent,
-	getConnectFunction = getConnectFunction,
-	disconnectEvent = disconnectEvent,
-}
+type Phase = any
+type Pipeline = any
+
+type SystemFn<U...> = (U...) -> ()
+type SystemInitializerFn<U...> = (U...) -> SystemFn<U...>
+
+type SystemTable<U...> = {
+	system: SystemFn<U...> | SystemInitializerFn<U...>,
+	phase: Phase?,
+	[any]: any,
+}
+
+type System<U...> = SystemFn<U...> | SystemInitializerFn<U...> | SystemTable<U...>
+
+local function getSystem<U...>(system: any): SystemTable<U...>?
+	if type(system) == "function" then
+		return system
+	elseif type(system) == "table" and system.system then
+		return system.system
+	else
+		return nil
+	end
+end
+
+local function getSystemName(system: any): string
+	if type(system) == "table" and system.name then
+		return system.name
+	end
+
+	local fn = type(system) == "table" and system.system or system
+
+	local name = debug.info(fn, "n")
+	if not name or string.len(name) == 0 then
+		local source, line = debug.info(fn, "sl")
+		name = `{source}:{line}`
+	end
+
+	return name
+end
+
+local function isPhase(phase: any): Phase?
+	if type(phase) == "table" and phase._type == "phase" then
+		return phase
+	else
+		return nil
+	end
+end
+
+local function isPipeline(pipeline: any): Pipeline?
+	if type(pipeline) == "table" and pipeline._type == "pipeline" then
+		return pipeline
+	else
+		return nil
+	end
+end
+
+local function getEventIdentifier(instance, event)
+	return `{instance}{event and `@{event}` or ""}`
+end
+
+local EVENT_CONNECT_METHODS = { "Connect", "On", "on", "connect" }
+
+export type ConnectionLike = RBXScriptConnection | {
+	disconnect: (self: ConnectionLike, ...any) -> any,
+	[any]: any,
+} | {
+	Disconnect: (self: ConnectionLike, ...any) -> any,
+	[any]: any,
+} | {
+	destroy: (self: ConnectionLike, ...any) -> any,
+	[any]: any,
+} | {
+	Destroy: (self: ConnectionLike, ...any) -> any,
+	[any]: any,
+} | (...any) -> any
+
+local EVENT_DISCONNECT_METHODS =
+	{ "disconnect", "Disconnect", "destroy", "Destroy" }
+
+local function disconnectEvent(connection: ConnectionLike)
+	if type(connection) == "function" then
+		connection()
+		return
+	elseif typeof(connection) == "RBXScriptConnection" then
+		connection:Disconnect()
+		return
+	elseif type(connection) == "table" then
+		for _, method in EVENT_DISCONNECT_METHODS do
+			if
+				connection[method]
+				and type(connection[method]) == "function"
+			then
+				connection[method](connection)
+				return
+			end
+		end
+	end
+end
+
+export type Callback<U...> = (U...) -> ...any
+export type ConnectFn<T, U...> = (callback: (U...) -> ...any) -> T
+export type GenericTable = { [any]: any }
+
+export type SignalLike<U...> =
+	{
+		connect: (self: SignalLike<U...>, Callback<U...>, ...any?) -> any,
+		[any]: any,
+	}
+	| {
+		Connect: (self: SignalLike<U...>, Callback<U...>, ...any?) -> any,
+		[any]: any,
+	}
+	| {
+		on: (self: SignalLike<U...>, Callback<U...>, ...any?) -> any,
+		[any]: any,
+	}
+	| {
+		On: (self: SignalLike<U...>, Callback<U...>, ...any?) -> any,
+		[any]: any,
+	}
+
+type GetConnectFn<U...> =
+	-- RBXScriptSignal & nil
+	((RBXScriptSignal<U...>) -> ConnectFn<RBXScriptConnection, U...>)
+	-- Instance & RBXScriptSignal
+	-- Instance & string
+	& ((
+		Instance,
+		RBXScriptSignal<U...> | string
+	) -> ConnectFn<RBXScriptConnection, U...>)
+	-- SignalLike & nil
+	& ((SignalLike<U...>) -> ConnectFn<any, U...>)
+	-- table & string
+	& ((GenericTable, string) -> ConnectFn<any, U...>)
+	-- table & connectable method
+	& (<T>(
+		GenericTable,
+		(GenericTable, Callback<U...>, ...any) -> T
+	) -> ConnectFn<T, U...>)
+	-- connectable function
+	& (<T>((Callback<U...>, ...any) -> T) -> ConnectFn<T, U...>)
+
+-- This function is inspired by useEvent in Matter, a library by evaera (https://github.com/evaera)
+-- License: Copyright (c) 2021 Eryn L. K., MIT License
+-- Source: https://github.com/matter-ecs/matter/blob/main/lib/hooks/useEvent.luau
+local function getConnectFunction(instance, event)
+	local eventInstance = instance
+
+	if typeof(event) == "RBXScriptSignal" or type(event) == "table" then
+		eventInstance = event
+	elseif type(event) == "string" then
+		eventInstance = (instance :: any)[event]
+	end
+
+	if type(eventInstance) == "function" then
+		return eventInstance
+	elseif typeof(eventInstance) == "RBXScriptSignal" then
+		return function(callback)
+			return eventInstance:Connect(callback)
+		end
+	end
+
+	if type(eventInstance) == "table" then
+		if type(event) == "function" then
+			return function(callback)
+				return event(eventInstance, callback)
+			end
+		end
+
+		for _, method in EVENT_CONNECT_METHODS do
+			if type(eventInstance[method]) ~= "function" then
+				continue
+			end
+
+			return function(callback)
+				return eventInstance[method](eventInstance, callback)
+			end
+		end
+	end
+
+	return nil
+end
+
+local function isValidEvent(instance, event)
+	return getConnectFunction(instance, event) ~= nil
+end
+
+return {
+	getSystem = getSystem,
+	getSystemName = getSystemName,
+	isPhase = isPhase,
+	isPipeline = isPipeline,
+	getEventIdentifier = getEventIdentifier,
+	isValidEvent = isValidEvent,
+	getConnectFunction = getConnectFunction :: GetConnectFn<...any>,
+	disconnectEvent = disconnectEvent,
+}

package/out/Phase.d.ts

@@ -1,8 +0,0 @@
-declare class Phase {
-    constructor(debugName?: string)
-    static readonly PreStartup: Phase
-    static readonly Startup: Phase
-    static readonly PostStartup: Phase
-}
-
-export = Phase;

package/out/Pipeline.d.ts

@@ -1,11 +0,0 @@
-import Phase from "./Phase";
-
-declare class Pipeline {
-    constructor(debugName?: string)
-    insert(phase: Phase) : Pipeline
-    insertAfter(phase: Phase, after: Phase): Pipeline
-    insertBefore(phase: Phase, before: Phase): Pipeline
-    static readonly Startup: Pipeline
-}
-
-export = Pipeline;

package/out/Scheduler.d.ts

@@ -1,31 +0,0 @@
-import Phase from "./Phase";
-import Pipeline from "./Pipeline";
-import { Hooks, EventInstance, EventLike, System, Plugin, HookFunctionMap, HookFunctionArgs } from "./types";
-
-declare class Scheduler<T extends unknown[]> {
-    /** @hidden */
-    _orderedPhases: Phase[]
-    Hooks: Hooks["Hooks"]
-    cleanup(): void
-    addRunCondition(dependent: System<T>, fn: (...args: T) => boolean): Scheduler<T>
-    replaceSystem(oldSystem: System<T>, newSystem: System<T>): Scheduler<T>
-    removeSystem(system: System<T>): Scheduler<T>
-    editSystem(system: System<T>, phase: Phase): Scheduler<T>
-    addSystem(system: System<T>, phase?: Phase): Scheduler<T>
-    addSystems(systems: System<T>[], phase?: Phase): Scheduler<T>
-    insertBefore(dependent: Phase, before: Phase): Scheduler<T>
-    insertBefore(dependent: Pipeline, before: Phase): Scheduler<T>
-    insertAfter(phase: Phase, after: Phase | Pipeline): Scheduler<T>
-    insertAfter(pipeline: Pipeline, after: Phase | Pipeline): Scheduler<T>
-    insert(dependent: Phase | Pipeline, instance: EventInstance, event?: string): Scheduler<T>
-    insert(dependent: Phase | Pipeline): Scheduler<T>
-    runAll(): Scheduler<T>
-    run(dependent: System<T> | Phase | Pipeline): Scheduler<T>
-    getDeltaTime(): number
-    addPlugin(plugin: Plugin): Scheduler<T>
-    /** @hidden */
-    _addHook<K extends keyof HookFunctionMap>(hook: K, fn: (info: HookFunctionArgs<K, T>) => void): void
-    constructor(...args: T)
-}
-
-export = Scheduler;

package/out/conditions.d.ts

@@ -1,14 +0,0 @@
-import { EventInstance, EventLike } from "./types";
-
-type Condition = () => boolean;
-
-declare const timePassed: (time: number) => Condition;
-
-declare const exported: {
-    timePassed: (time: number) => Condition;
-    runOnce: () => Condition;
-    onEvent: <T extends unknown[]>(instance: EventInstance<T>, event?: string) => LuaTuple<[Condition, () => IterableFunction<LuaTuple<[number, ...T]>>, () => void]>;
-    isNot: (condition: Condition) => Condition;
-    cleanupCondition: (condition: Condition) => void
-}
-export = exported

package/out/hooks.d.ts

@@ -1,4 +0,0 @@
-import { Hooks } from "./types";
-
-declare const hooks : Hooks;
-export = hooks;

package/out/index.d.ts

@@ -1,18 +0,0 @@
-import phase from "./Phase";
-import pipeline from "./Pipeline";
-import schedular from "./Scheduler";
-import condition from "./conditions"
-
-interface Planck {
-    Phase: typeof phase;
-    Pipeline: typeof pipeline; 
-    Scheduler: typeof schedular;
-
-    isNot: typeof condition.isNot;
-    timePassed: typeof condition.timePassed;
-    runOnce: typeof condition.runOnce;
-    onEvent: typeof condition.onEvent;
-}
-
-declare const planck: Planck;
-export = planck;

package/out/init.luau

@@ -1,143 +0,0 @@
-local Phase = require(script:FindFirstChild("Phase")) :: any
-local Pipeline = require(script:FindFirstChild("Pipeline")) :: any
-local Scheduler = require(script:FindFirstChild("Scheduler")) :: any
-
-local conditions = require(script:FindFirstChild("conditions"))
-local utils = require(script:FindFirstChild("utils"))
-
-type EventLike = utils.EventLike
-type EventInstance = utils.EventInstance
-
-export type SystemFn<U...> = ((U...) -> any) | ((U...) -> ())
-
-export type SystemTable<U...> = {
-	system: SystemFn<U...>,
-	phase: Phase?,
-	name: string?,
-	runConditions: { (U...) -> boolean }?,
-	[any]: any,
-}
-
-export type System<U...> = SystemFn<U...> | SystemTable<U...>
-
-export type Phase = {
-	PreStartup: Phase,
-	Startup: Phase,
-	PostStartup: Phase,
-
-	new: (debugName: string?) -> Phase,
-}
-
-export type Pipeline = {
-	Startup: Pipeline,
-
-	insert: (self: Pipeline, phase: Phase) -> Pipeline,
-	insertAfter: (self: Pipeline, phase: Phase, after: Phase) -> Pipeline,
-	new: (debugName: string?) -> Pipeline,
-}
-
-type Plugin<U...> = {
-	build: (self: Plugin<U...>, scheduler: Scheduler<U...>) -> (),
-	cleanup: ((self: Plugin<U...>) -> ())?,
-	[any]: any,
-}
-
-export type Scheduler<U...> = {
-	addPlugin: (self: Scheduler<U...>, plugin: Plugin<U...>) -> Scheduler<U...>,
-
-	addSystem: (
-		self: Scheduler<U...>,
-		system: System<U...>,
-		phase: Phase?
-	) -> Scheduler<U...>,
-
-	addSystems: (
-		self: Scheduler<U...>,
-		systems: { System<U...> },
-		phase: Phase?
-	) -> Scheduler<U...>,
-
-	editSystem: (
-		self: Scheduler<U...>,
-		system: System<U...>,
-		new: Phase
-	) -> Scheduler<U...>,
-
-	replaceSystem: (
-		self: Scheduler<U...>,
-		system: System<U...>,
-		new: System<U...>
-	) -> Scheduler<U...>,
-
-	removeSystem: (
-		self: Scheduler<U...>,
-		system: System<U...>
-	) -> Scheduler<U...>,
-
-	addRunCondition: ((
-		self: Scheduler<U...>,
-		system: System<U...>,
-		fn: (U...) -> boolean,
-		...any
-	) -> Scheduler<U...>) & ((
-		self: Scheduler<U...>,
-		phase: Phase,
-		fn: (U...) -> boolean,
-		...any
-	) -> Scheduler<U...>) & ((
-		self: Scheduler<U...>,
-		pipeline: Pipeline,
-		fn: (U...) -> boolean,
-		...any
-	) -> Scheduler<U...>),
-
-	run: ((self: Scheduler<U...>, system: System<U...>) -> Scheduler<U...>)
-		& ((self: Scheduler<U...>, phase: Phase) -> Scheduler<U...>)
-		& ((self: Scheduler<U...>, pipeline: Pipeline) -> Scheduler<U...>),
-
-	runAll: (self: Scheduler<U...>) -> Scheduler<U...>,
-
-	getDeltaTime: (self: Scheduler<U...>) -> number,
-
-	insert: ((self: Scheduler<U...>, phase: Phase) -> Scheduler<U...>) & ((
-		self: Scheduler<U...>,
-		pipeline: Pipeline
-	) -> Scheduler<U...>) & ((
-		self: Scheduler<U...>,
-		phase: Phase,
-		instance: EventInstance | EventLike,
-		event: string | EventLike
-	) -> Scheduler<U...>) & ((
-		self: Scheduler<U...>,
-		Pipeline: Pipeline,
-		instance: EventInstance | EventLike,
-		event: string | EventLike
-	) -> Scheduler<U...>),
-
-	insertAfter: ((
-		self: Scheduler<U...>,
-		phase: Phase,
-		after: Phase | Pipeline
-	) -> Scheduler<U...>) & ((
-		self: Scheduler<U...>,
-		pipeline: Pipeline,
-		after: Phase | Pipeline
-	) -> Scheduler<U...>),
-
-	cleanup: (self: Scheduler<U...>) -> (),
-
-	new: (U...) -> Scheduler<U...>,
-}
-
-return {
-	Phase = Phase :: Phase,
-	Pipeline = Pipeline :: Pipeline,
-	Scheduler = Scheduler :: {
-		new: <U...>(U...) -> Scheduler<U...>,
-	},
-
-	isNot = conditions.isNot,
-	runOnce = conditions.runOnce,
-	timePassed = conditions.timePassed,
-	onEvent = conditions.onEvent,
-}