@rbxts/covenant 3.3.7 → 3.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rbxts/covenant",
-    "version": "3.3.7",
+    "version": "3.5.0",
     "main": "src/init.luau",
     "scripts": {
         "build": "rbxtsc",

package/src/covenant.d.ts

@@ -14,6 +14,7 @@ export interface CovenantProps {
     predictionSend: (worldChanges: WorldChangesForPrediction) => void;
     predictionConnect: (callback: (player: Player, worldChanges: WorldChangesForPrediction) => void) => void;
 }
+type ComponentSubscriber<T extends defined = defined> = (entity: Entity, state: T | undefined, previousState: T | undefined, isDeleting: boolean) => void;
 type ComponentPredictionValidator = (player: Player, entity: Entity, newState: unknown, lastState: unknown) => boolean;
 export declare class Covenant {
     private _world;
@@ -55,7 +56,7 @@ export declare class Covenant {
     private preventPostStartCall;
     private schedule;
     private worldSet;
-    subscribeComponent<T>(component: Entity<T>, subscriber: (entity: Entity, state: T | undefined, previousState: T | undefined) => void): () => void;
+    subscribeComponent<T extends defined>(component: Entity<T>, subscriber: ComponentSubscriber<T>): () => void;
     private worldDelete;
     worldComponent<T extends defined>(name: string): Entity<T>;
     getComponentName(component: Entity): string;

package/src/covenant.luau

@@ -387,7 +387,7 @@ do
 		if _result ~= nil then
 			-- ▼ ReadonlySet.forEach ▼
 			local _callback = function(subscriber)
-				subscriber(entity, newState, lastState)
+				subscriber(entity, newState, lastState, false)
 			end
 			for _v in _result do
 				_callback(_v, _v, _result)
@@ -482,7 +482,7 @@ do
 				if _result ~= nil then
 					-- ▼ ReadonlySet.forEach ▼
 					local _callback_1 = function(subscriber)
-						subscriber(entity, nil, lastState)
+						subscriber(entity, nil, lastState, false)
 					end
 					for _v in _result do
 						_callback_1(_v, _v, _result)
@@ -570,6 +570,18 @@ do
 			subscribeComponent = function(component, subscriber)
 				self:subscribeComponent(component, subscriber)
 			end,
+			getPayloadQueue = function(component)
+				local queue = {}
+				for entity, state in self:worldQuery(component) do
+					local _arg0 = {
+						entity = entity,
+						state = state,
+						previousState = nil,
+					}
+					table.insert(queue, _arg0)
+				end
+				return queue
+			end,
 		})
 		-- ▼ ReadonlyArray.map ▼
 		local _newValue = table.create(#queriedComponents)

package/src/hooks.d.ts

@@ -8,7 +8,7 @@ export type Discriminator = Exclude<defined, number>;
 export interface CovenantHooks {
     useEvent: <T extends Array<unknown>>(updateId: number, instance: Instance, event: RBXScriptSignal<(...args: T) => void>) => T[];
     useEventImmediately: <T extends Array<unknown>, TReturn extends defined>(updateId: number, instance: Instance, event: RBXScriptSignal<(...args: T) => void>, callback: (...args: T) => TReturn) => TReturn[];
-    useComponentChange: <T extends defined>(updateId: number, component: Entity<T>) => {
+    useComponentChange: <T extends defined>(updateId: number, component: Entity<T>, payload: boolean) => {
         entity: Entity;
         state: T | undefined;
         previousState: T | undefined;
@@ -24,6 +24,11 @@ export interface CovenantHooks {
 interface CovenantHooksProps {
     indicateUpdate: () => void;
     subscribeComponent: <T extends defined>(component: Entity<T>, subscriber: (entity: Entity, state: T | undefined, previousState: T | undefined) => void) => void;
+    getPayloadQueue: <T extends defined>(component: Entity<T>) => {
+        entity: Entity;
+        state: T | undefined;
+        previousState: T | undefined;
+    }[];
 }
 export declare function createHooks(props: CovenantHooksProps): CovenantHooks;
 export {};

package/src/hooks.luau

@@ -78,12 +78,16 @@ local function createUseEventImmediately(_param)
 end
 local function createUseComponentChange(_param)
 	local subscribeComponent = _param.subscribeComponent
-	local update = _param.indicateUpdate
+	local indicateUpdate = _param.indicateUpdate
+	local getPayloadQueue = _param.getPayloadQueue
 	local queues = {}
 	local watchedStringifiedComponents = {}
 	local caches = {}
 	local lastUpdateId = -1
-	return function(updateId, component)
+	return function(updateId, component, payload)
+		if payload == nil then
+			payload = false
+		end
 		if lastUpdateId ~= updateId then
 			table.clear(caches)
 			lastUpdateId = updateId
@@ -104,10 +108,14 @@ local function createUseComponentChange(_param)
 					previousState = previousState,
 				}
 				table.insert(_exp, _arg0)
-				update()
+				indicateUpdate()
 			end)
 			caches[stringifiedComponent] = {}
-			return {}
+			if not payload then
+				return {}
+			else
+				return getPayloadQueue(component)
+			end
 		end
 		local queue = queues[stringifiedComponent]
 		if not (#queue == 0) then