@rbxts/covenant 3.5.1 → 3.6.0

package/package.json

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

package/src/covenant.d.ts

@@ -4,8 +4,9 @@ import { Remove, Delete } from "./stringEnums";
 export * from "@rbxts/jecs";
 export type WorldChangesForReplication = Map<string, Delete | Map<string, defined | Remove>>;
 export type WorldChangesForPrediction = Map<string, Map<string, defined | Remove>>;
+export type LoggingOption = "FORCE_ON" | "FORCE_OFF" | "COMPONENT_CONTROLLED";
 export interface CovenantProps {
-    logging: boolean;
+    logging: LoggingOption;
     requestPayloadSend: () => void;
     requestPayloadConnect: (callback: (player: Player) => void) => void;
     replicationSend: (player: Player, worldChanges: WorldChangesForReplication) => void;
@@ -25,6 +26,7 @@ export declare class Covenant {
     private undefinedStringifiedComponents;
     private replicatedStringifiedComponents;
     private predictedStringifiedComponents;
+    private loggingStringfiedComponents;
     private stringfiedComponentsToNameMap;
     private started;
     private stringifiedComponentSubscribers;
@@ -41,9 +43,7 @@ export declare class Covenant {
     constructor({ logging, requestPayloadSend, requestPayloadConnect, replicationSend, replicationConnect, replicationSendAll, predictionSend, predictionConnect, }: CovenantProps);
     getClientEntity(entity: Entity): Entity | undefined;
     getServerEntity(entity: Entity): Entity | undefined;
-    private logging;
-    enableLogging(): void;
-    disableLogging(): void;
+    private loggingOption;
     private setupPredictionClient;
     private forEachComponentChanges;
     private setupPredictionServer;
@@ -63,14 +63,16 @@ export declare class Covenant {
     worldTag(): Entity<undefined>;
     private checkComponentDefined;
     private defineComponentNetworkBehavior;
-    defineComponent<T extends defined>({ component, queriedComponents, recipe, replicated, predictionValidator, }: {
+    defineComponent<T extends defined>({ logging, component, queriedComponents, recipe, replicated, predictionValidator, }: {
+        logging?: true;
         replicated: boolean;
         predictionValidator: ComponentPredictionValidator | false;
         component: Entity<T>;
         queriedComponents: Entity[][];
         recipe: (entity: Entity, lastState: T | undefined, updateId: number, hooks: CovenantHooks) => T | undefined;
     }): void;
-    defineIdentity<T extends defined>({ identityComponent, replicated, lifetime, factory, }: {
+    defineIdentity<T extends defined>({ logging, identityComponent, replicated, lifetime, factory, }: {
+        logging?: true;
         identityComponent: Entity<T>;
         replicated: boolean;
         lifetime: (entity: Entity, state: T, despawn: () => void) => (() => void) | undefined;

package/src/covenant.luau

@@ -46,13 +46,14 @@ do
 		self.undefinedStringifiedComponents = {}
 		self.replicatedStringifiedComponents = {}
 		self.predictedStringifiedComponents = {}
+		self.loggingStringfiedComponents = {}
 		self.stringfiedComponentsToNameMap = {}
 		self.started = false
 		self.stringifiedComponentSubscribers = {}
 		self.stringifiedComponentValidators = {}
 		self.clientToServerEntityMap = {}
 		self.serverToClientEntityMap = {}
-		self.logging = logging
+		self.loggingOption = logging
 		self.requestPayloadSend = requestPayloadSend
 		self.requestPayloadConnect = requestPayloadConnect
 		self.replicationSend = replicationSend
@@ -73,12 +74,6 @@ do
 		local _arg0 = tostring(entity)
 		return _clientToServerEntityMap[_arg0]
 	end
-	function Covenant:enableLogging()
-		self.logging = true
-	end
-	function Covenant:disableLogging()
-		self.logging = false
-	end
 	function Covenant:setupPredictionClient()
 		self:schedule(RunService.Heartbeat, function()
 			if next(self.worldChangesForPrediction) == nil then
@@ -378,7 +373,17 @@ do
 		else
 			self._world:set(entity, component, newState)
 		end
-		if self.logging and RunService:IsStudio() then
+		local _condition = RunService:IsStudio() and self.loggingOption ~= "FORCE_OFF"
+		if _condition then
+			local _condition_1 = self.loggingOption == "FORCE_ON"
+			if not _condition_1 then
+				local _loggingStringfiedComponents = self.loggingStringfiedComponents
+				local _arg0 = tostring(component)
+				_condition_1 = _loggingStringfiedComponents[_arg0] ~= nil
+			end
+			_condition = _condition_1
+		end
+		if _condition then
 			print(`{self:getComponentName(component)}.{entity}.[{if doNotReconcile then "remote" else "local"}]:{tableToString(lastState)}->{tableToString(newState)}`)
 		end
 		local _stringifiedComponentSubscribers = self.stringifiedComponentSubscribers
@@ -397,13 +402,13 @@ do
 		if doNotReconcile then
 			return nil
 		end
-		local _condition = RunService:IsServer()
-		if _condition then
+		local _condition_1 = RunService:IsServer()
+		if _condition_1 then
 			local _replicatedStringifiedComponents = self.replicatedStringifiedComponents
 			local _arg0_1 = tostring(component)
-			_condition = _replicatedStringifiedComponents[_arg0_1] ~= nil
+			_condition_1 = _replicatedStringifiedComponents[_arg0_1] ~= nil
 		end
-		if _condition then
+		if _condition_1 then
 			local _worldChangesForReplication = self.worldChangesForReplication
 			local _arg0_1 = tostring(entity)
 			local entityChanges = _worldChangesForReplication[_arg0_1]
@@ -421,13 +426,13 @@ do
 				_entityChanges[_arg0_2] = _arg1
 			end
 		end
-		local _condition_1 = RunService:IsClient()
-		if _condition_1 then
+		local _condition_2 = RunService:IsClient()
+		if _condition_2 then
 			local _predictedStringifiedComponents = self.predictedStringifiedComponents
 			local _arg0_1 = tostring(component)
-			_condition_1 = _predictedStringifiedComponents[_arg0_1] ~= nil
+			_condition_2 = _predictedStringifiedComponents[_arg0_1] ~= nil
 		end
-		if _condition_1 then
+		if _condition_2 then
 			local _worldChangesForPrediction = self.worldChangesForPrediction
 			local _arg0_1 = tostring(component)
 			local componentChanges = _worldChangesForPrediction[_arg0_1]
@@ -553,6 +558,7 @@ do
 		end
 	end
 	function Covenant:defineComponent(_param)
+		local logging = _param.logging
 		local component = _param.component
 		local queriedComponents = _param.queriedComponents
 		local recipe = _param.recipe
@@ -560,6 +566,11 @@ do
 		local predictionValidator = _param.predictionValidator
 		self:checkComponentDefined(component)
 		self:defineComponentNetworkBehavior(component, replicated, predictionValidator)
+		if logging then
+			local _loggingStringfiedComponents = self.loggingStringfiedComponents
+			local _arg0 = tostring(component)
+			_loggingStringfiedComponents[_arg0] = true
+		end
 		local queryThisComponent = self:worldQuery(component):cached()
 		local willUpdate = true
 		local function indicateUpdate()
@@ -681,11 +692,17 @@ do
 		end)
 	end
 	function Covenant:defineIdentity(_param)
+		local logging = _param.logging
 		local identityComponent = _param.identityComponent
 		local replicated = _param.replicated
 		local lifetime = _param.lifetime
 		local factory = _param.factory
 		self:checkComponentDefined(identityComponent)
+		if logging then
+			local _loggingStringfiedComponents = self.loggingStringfiedComponents
+			local _arg0 = tostring(identityComponent)
+			_loggingStringfiedComponents[_arg0] = true
+		end
 		self:defineComponentNetworkBehavior(identityComponent, replicated, false)
 		factory(function(state)
 			local entity = self:worldEntity()