@rbxts/covenant 3.0.2 → 3.1.1

package/package.json

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

package/src/covenant.d.ts

@@ -66,10 +66,11 @@ export declare class Covenant {
         queriedComponents: Entity[][];
         recipe: (entity: Entity, lastState: T | undefined, updateId: number, hooks: CovenantHooks) => T | undefined;
     }): void;
-    defineIdentity<T extends defined>({ identityComponent, replicated, factory, }: {
+    defineIdentity<T extends defined>({ identityComponent, replicated, lifetime, factory, }: {
         identityComponent: Entity<T>;
         replicated: boolean;
-        factory: (spawnEntity: (state: T) => Entity, despawnEntity: (entity: Entity) => void) => void;
+        lifetime: (entity: Entity, state: T, despawn: () => void) => (() => void) | undefined;
+        factory: (spawnEntity: (state: T) => void) => void;
     }): void;
     private worldEntity;
     worldQuery<T extends Id[]>(...components: T): import("@rbxts/jecs").Query<T>;

package/src/covenant.luau

@@ -671,18 +671,20 @@ do
 	function Covenant:defineIdentity(_param)
 		local identityComponent = _param.identityComponent
 		local replicated = _param.replicated
+		local lifetime = _param.lifetime
 		local factory = _param.factory
 		self:checkComponentDefined(identityComponent)
 		self:defineComponentNetworkBehavior(identityComponent, replicated, false)
 		factory(function(state)
 			local entity = self:worldEntity()
 			self:worldSet(entity, identityComponent, state)
-			return entity
-		end, function(entity)
-			if not self:worldHas(entity, identityComponent) then
-				return nil
-			end
-			self:worldDelete(entity)
+			local cleanup = function() end
+			cleanup = lifetime(entity, state, function()
+				self:worldDelete(entity)
+				if cleanup ~= nil then
+					cleanup()
+				end
+			end)
 		end)
 	end
 	function Covenant:worldEntity()