rbxts-chrono 2.0.0-experimental.6 → 2.0.0-experimental.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rbxts-chrono",
-  "version": "2.0.0-experimental.6",
+  "version": "2.0.0-experimental.8",
   "description": "TypeScript types for Chrono - Custom Character Replication for Roblox",
   "main": "src/init.lua",
   "types": "src/index.d.ts",

package/src/index.d.ts

@@ -4,252 +4,257 @@
  * @see https://github.com/Parihsz/Chrono
  */
 
-// Model replication modes
-type ModelReplicationMode = "NATIVE" | "NATIVE_WITH_LOCK" | "CUSTOM";
-
-// Player replication modes
-type PlayerReplicationMode = "AUTOMATIC" | "CUSTOM";
-
-// Replication filter modes (used for REPLICATE_DEATHS and REPLICATE_CFRAME_SETTERS)
-type ReplicationFilterMode = "NONE" | "PLAYER_ENTITIES" | "PLAYER_CHARACTERS";
-
-// Configuration option names
-type ConfigName =
-	| "MIN_BUFFER"
-	| "MAX_BUFFER"
-	| "SHOW_WARNINGS"
-	| "MAX_SNAPSHOT_COUNT"
-	| "CHECK_NEW_VERSION"
-	| "DEFAULT_NORMAL_TICK_DISTANCE"
-	| "DEFAULT_HALF_TICK_DISTANCE"
-	| "DEFAULT_MODEL_REPLICATION_MODE"
-	| "PLAYER_REPLICATION"
-	| "REPLICATE_DEATHS"
-	| "REPLICATE_CFRAME_SETTERS"
-	| "MAX_TOTAL_BYTES_PER_FRAME_PER_PLAYER"
-	| "SEND_FULL_ROTATION";
-
-// Event system types
-interface Connection {
-	Disconnect(): void;
-	Connected: boolean;
-}
-
-interface ChronoEvent<T extends Callback = Callback> {
-	Connect(callback: T, defer?: boolean): Connection;
-	Once(callback: T, defer?: boolean): Connection;
-	Wait(defer?: boolean): LuaTuple<Parameters<T>>;
-}
-
-// Snapshot types
-interface SnapshotData<Value, Velocity> {
-	t: number;
-	value: Value;
-	velocity: Velocity;
-}
-
-interface Snapshot<Value, Velocity> {
-	Push(timeStamp: number, value: Value, velocity: Velocity): void;
-	GetLatest(): SnapshotData<Value, Velocity> | undefined;
-	GetAt(at: number, bypassLock?: boolean): Value | undefined;
-	Clear(): void;
-}
-
-// Entity configuration input
-interface EntityConfigInput {
-	BUFFER: number;
-	TICK_RATE: number;
-	FULL_ROTATION?: boolean;
-	AUTO_UPDATE_POSITION?: boolean;
-	STORE_SNAPSHOTS?: boolean;
-	MODEL_REPLICATION_MODE?: ModelReplicationMode;
-	NORMAL_TICK_DISTANCE?: number;
-	HALF_TICK_DISTANCE?: number;
-	CUSTOM_INTERPOLATION?: boolean;
-}
-
-// Stats interfaces
-interface ClientStats {
-	TOTAL_ENTITIES_CULLED: number;
-	ENTITIES_MOVED_THIS_FRAME: number;
-	TOTAL_CLIENT_ENTITIES_CHECKED_THIS_FRAME: number;
-	TOTAL_CLIENT_ENTITIES: number;
-	AVG_INTERPOLATION_TIME_MS: number;
-	BYTES_RECEIVED_PER_SEC: number;
-	NEW_ENTITIES_PER_SEC: number;
-	ENTITY_CHANGES_PER_SEC: number;
-	ENTITY_REMOVALS_PER_SEC: number;
-}
-
-interface ServerStats {
-	AVG_TICKER_TIME_MS: number;
-	ENTITY_GRID_UPDATE_TIME_MS: number;
-	GRID_UPDATE_SECTIONS: number;
-	NUMBER_OF_ENTITIES: number;
-	NON_TICKED: number;
-	ENTITIES_FULL_TICKED: number;
-	ENTITIES_HALF_TICKED: number;
-	REPLICATE_PLAYER_TIME_MS: number;
-	BYTES_RECEIVED_PER_SEC: number;
-	BYTES_SENT_PER_SEC: number;
-	PACKETS_SENT_PER_SEC: number;
-}
-
-// Entity event names
-type EntityEventName =
-	| "Destroying"
-	| "NetworkOwnerChanged"
-	| "PushedSnapShot"
-	| "TickChanged"
-	| "DataChanged"
-	| "Ticked"
-	| "ModelChanged"
-	| "LockChanged";
-
-// Entity interface (data only - methods are static on EntityConstructor)
-interface Entity {
-	/** Unique identifier for this entity */
-	readonly id: number;
-
-	/** Whether this entity is registered with the system */
-	readonly registered: boolean;
-
-	/** Whether this entity has been destroyed */
-	readonly destroyed: boolean;
-
-	/** The player who owns this entity (controls its movement) */
-	readonly networkOwner: Player | undefined;
-
-	/** Whether the current context (client/server) is the network owner */
-	readonly isContextOwner: boolean;
-
-	/** The model associated with this entity */
-	readonly model: Model | BasePart | undefined;
-
-	/** Whether replication is paused for this entity */
-	readonly paused: boolean;
-
-	/** The most recent CFrame value */
-	readonly latestCFrame: CFrame | undefined;
-}
-
-interface EntityConstructor {
-	new (
-		entityConfig?: string,
-		model?: Model | BasePart | string,
-		modelReplicationMode?: ModelReplicationMode,
-		initCFrame?: CFrame,
-	): Entity;
-
-	/** Sets or changes the model for an entity */
-	SetModel: (
-		entity: Entity,
-		model?: Model | BasePart | string,
-		modelReplicationMode?: ModelReplicationMode,
-		noDestroy?: boolean,
-	) => void;
-
-	/** Sets the entity configuration type */
-	SetConfig: (entity: Entity, entityConfig: string) => void;
-
-	/** Sets the broad phase collision bounds */
-	SetBroadPhase: (entity: Entity, broadPhase?: Vector3) => void;
-
-	/** Gets custom data associated with an entity */
-	GetData: <T = unknown>(entity: Entity) => T;
-
-	/** Gets the model associated with an entity */
-	GetModel: (entity: Entity) => Model | BasePart | undefined;
-
-	/** Sets custom data for an entity */
-	SetData: (entity: Entity, data: unknown) => void;
+declare namespace Chrono {
+	// ===== Type Aliases =====
+	export type ModelReplicationMode = "NATIVE" | "NATIVE_WITH_LOCK" | "CUSTOM";
+	export type PlayerReplicationMode = "AUTOMATIC" | "CUSTOM";
+	export type ReplicationFilterMode = "NONE" | "PLAYER_ENTITIES" | "PLAYER_CHARACTERS";
+
+	export type ConfigName =
+		| "MIN_BUFFER"
+		| "MAX_BUFFER"
+		| "SHOW_WARNINGS"
+		| "MAX_SNAPSHOT_COUNT"
+		| "CHECK_NEW_VERSION"
+		| "DEFAULT_NORMAL_TICK_DISTANCE"
+		| "DEFAULT_HALF_TICK_DISTANCE"
+		| "DEFAULT_MODEL_REPLICATION_MODE"
+		| "PLAYER_REPLICATION"
+		| "REPLICATE_DEATHS"
+		| "REPLICATE_CFRAME_SETTERS"
+		| "MAX_TOTAL_BYTES_PER_FRAME_PER_PLAYER"
+		| "SEND_FULL_ROTATION";
+
+	export type EntityEventName =
+		| "Destroying"
+		| "NetworkOwnerChanged"
+		| "PushedSnapShot"
+		| "TickChanged"
+		| "DataChanged"
+		| "Ticked"
+		| "ModelChanged"
+		| "LockChanged";
+
+	export type RuleFn = (entity: Entity, viewer: Player, viewerEntityId?: number) => boolean;
+	export type MiddleManFn = (player: Player, entity: Entity, cframe: CFrame, arriveTime: number) => boolean;
+
+	// ===== Interfaces =====
+	export interface ConfigValueMap {
+		MIN_BUFFER: number;
+		MAX_BUFFER: number;
+		SHOW_WARNINGS: boolean;
+		MAX_SNAPSHOT_COUNT: number;
+		CHECK_NEW_VERSION: boolean;
+		DEFAULT_NORMAL_TICK_DISTANCE: number;
+		DEFAULT_HALF_TICK_DISTANCE: number;
+		DEFAULT_MODEL_REPLICATION_MODE: ModelReplicationMode;
+		PLAYER_REPLICATION: PlayerReplicationMode;
+		REPLICATE_DEATHS: ReplicationFilterMode;
+		REPLICATE_CFRAME_SETTERS: ReplicationFilterMode;
+		MAX_TOTAL_BYTES_PER_FRAME_PER_PLAYER: number;
+		SEND_FULL_ROTATION: boolean;
+	}
 
-	/** Clears the mount relationship */
-	ClearMount: (entity: Entity) => void;
+	export interface Connection {
+		Disconnect(): void;
+		Connected: boolean;
+	}
 
-	/** Mounts an entity to a parent entity with optional offset */
-	SetMount: (entity: Entity, parent?: Entity, offset?: CFrame) => void;
+	export interface ChronoEvent<T extends Callback = Callback> {
+		Connect(callback: T, defer?: boolean): Connection;
+		Once(callback: T, defer?: boolean): Connection;
+		Wait(defer?: boolean): LuaTuple<Parameters<T>>;
+	}
 
-	/** Sets the network owner (player who controls this entity) */
-	SetNetworkOwner: (entity: Entity, player?: Player) => void;
+	export interface SnapshotData<Value, Velocity> {
+		t: number;
+		value: Value;
+		velocity: Velocity;
+	}
 
-	/** Clears the entity's snapshot buffer */
-	Clear: (entity: Entity) => void;
+	export interface Snapshot<Value, Velocity> {
+		Push(timeStamp: number, value: Value, velocity: Velocity): void;
+		GetLatest(): SnapshotData<Value, Velocity> | undefined;
+		GetAt(at: number, bypassLock?: boolean): Value | undefined;
+		Clear(): void;
+	}
 
-	/** Pauses replication for an entity */
-	PauseReplication: (entity: Entity) => void;
+	export interface EntityConfigInput {
+		BUFFER: number;
+		TICK_RATE: number;
+		FULL_ROTATION?: boolean;
+		AUTO_UPDATE_POSITION?: boolean;
+		STORE_SNAPSHOTS?: boolean;
+		MODEL_REPLICATION_MODE?: ModelReplicationMode;
+		NORMAL_TICK_DISTANCE?: number;
+		HALF_TICK_DISTANCE?: number;
+		CUSTOM_INTERPOLATION?: boolean;
+	}
 
-	/** Resumes replication for an entity */
-	ResumeReplication: (entity: Entity) => void;
+	export interface ClientStats {
+		TOTAL_ENTITIES_CULLED: number;
+		ENTITIES_MOVED_THIS_FRAME: number;
+		TOTAL_CLIENT_ENTITIES_CHECKED_THIS_FRAME: number;
+		TOTAL_CLIENT_ENTITIES: number;
+		AVG_INTERPOLATION_TIME_MS: number;
+		BYTES_RECEIVED_PER_SEC: number;
+		NEW_ENTITIES_PER_SEC: number;
+		ENTITY_CHANGES_PER_SEC: number;
+		ENTITY_REMOVALS_PER_SEC: number;
+	}
 
-	/** Pushes a new CFrame snapshot at the given time */
-	Push: (entity: Entity, time: number, value: CFrame) => boolean;
+	export interface ServerStats {
+		AVG_TICKER_TIME_MS: number;
+		ENTITY_GRID_UPDATE_TIME_MS: number;
+		GRID_UPDATE_SECTIONS: number;
+		NUMBER_OF_ENTITIES: number;
+		NON_TICKED: number;
+		ENTITIES_FULL_TICKED: number;
+		ENTITIES_HALF_TICKED: number;
+		REPLICATE_PLAYER_TIME_MS: number;
+		BYTES_RECEIVED_PER_SEC: number;
+		BYTES_SENT_PER_SEC: number;
+		PACKETS_SENT_PER_SEC: number;
+	}
 
-	/** Gets the interpolated CFrame at a specific time */
-	GetAt: (entity: Entity, time: number) => CFrame | undefined;
+	export interface Entity {
+		/** Unique identifier for this entity */
+		readonly id: number;
 
-	/** Gets the target render time for interpolation */
-	GetTargetRenderTime: (entity: Entity) => number;
+		/** Whether this entity is registered with the system */
+		readonly registered: boolean;
 
-	/** Sets whether position updates automatically */
-	SetAutoUpdatePos: (entity: Entity, autoUpdate: boolean) => void;
+		/** Whether this entity has been destroyed */
+		readonly destroyed: boolean;
 
-	/** Gets the current CFrame */
-	GetCFrame: (entity: Entity) => CFrame | undefined;
+		/** The player who owns this entity (controls its movement) */
+		readonly networkOwner: Player | undefined;
 
-	/** Sets the current CFrame */
-	SetCFrame: (entity: Entity, cframe: CFrame) => void;
+		/** Whether the current context (client/server) is the network owner */
+		readonly isContextOwner: boolean;
 
-	/** Gets the primary part of the model */
-	GetPrimaryPart: (entity: Entity) => BasePart | undefined;
+		/** The model associated with this entity */
+		readonly model: Model | BasePart | undefined;
 
-	/** Locks native server CFrame replication */
-	LockNativeServerCFrameReplication: (entity: Entity) => void;
+		/** Whether replication is paused for this entity */
+		readonly paused: boolean;
 
-	/** Unlocks native server CFrame replication */
-	UnlockNativeServerCFrameReplication: (entity: Entity) => void;
+		/** The most recent CFrame value */
+		readonly latestCFrame: CFrame | undefined;
+	}
 
-	/** Destroys an entity */
-	Destroy: (entity: Entity) => void;
+	export interface EntityConstructor {
+		new (
+			entityConfig?: string,
+			model?: Model | BasePart | string,
+			modelReplicationMode?: ModelReplicationMode,
+			initCFrame?: CFrame,
+		): Entity;
 
-	/** Gets an event by name */
-	GetEvent: ((entity: Entity, name: "Destroying") => ChronoEvent<(entity: Entity) => void>) &
-		((
-			entity: Entity,
-			name: "NetworkOwnerChanged",
-		) => ChronoEvent<(entity: Entity, newOwner: Player | undefined, prevOwner: Player | undefined) => void>) &
-		((
-			entity: Entity,
-			name: "PushedSnapShot",
-		) => ChronoEvent<(entity: Entity, time: number, value: CFrame, isNewest: boolean) => void>) &
-		((
-			entity: Entity,
-			name: "TickChanged",
-		) => ChronoEvent<(entity: Entity, newTickType: "NONE" | "HALF" | "NORMAL") => void>) &
-		((entity: Entity, name: "DataChanged") => ChronoEvent<(entity: Entity, data: unknown) => void>) &
-		((entity: Entity, name: "Ticked") => ChronoEvent<(entity: Entity, dt: number) => void>) &
-		((
+		/** Sets or changes the model for an entity */
+		SetModel: (
 			entity: Entity,
-			name: "ModelChanged",
-		) => ChronoEvent<
-			(entity: Entity, newModel: Model | BasePart | undefined, oldModel: Model | BasePart | undefined) => void
-		>) &
-		((entity: Entity, name: "LockChanged") => ChronoEvent<(entity: Entity, isLocked: boolean) => void>) &
-		((entity: Entity, name: EntityEventName) => ChronoEvent);
-}
-
-// Replication rule types
-type RuleFn = (entity: Entity, viewer: Player, viewerEntityId?: number) => boolean;
+			model?: Model | BasePart | string,
+			modelReplicationMode?: ModelReplicationMode,
+			noDestroy?: boolean,
+		) => void;
+
+		/** Sets the entity configuration type */
+		SetConfig: (entity: Entity, entityConfig: string) => void;
+
+		/** Sets the broad phase collision bounds */
+		SetBroadPhase: (entity: Entity, broadPhase?: Vector3) => void;
+
+		/** Gets custom data associated with an entity */
+		GetData: <T = unknown>(entity: Entity) => T;
+
+		/** Gets the model associated with an entity */
+		GetModel: (entity: Entity) => Model | BasePart | undefined;
+
+		/** Sets custom data for an entity */
+		SetData: (entity: Entity, data: unknown) => void;
+
+		/** Clears the mount relationship */
+		ClearMount: (entity: Entity) => void;
+
+		/** Mounts an entity to a parent entity with optional offset */
+		SetMount: (entity: Entity, parent?: Entity, offset?: CFrame) => void;
+
+		/** Sets the network owner (player who controls this entity) */
+		SetNetworkOwner: (entity: Entity, player?: Player) => void;
+
+		/** Clears the entity's snapshot buffer */
+		Clear: (entity: Entity) => void;
+
+		/** Pauses replication for an entity */
+		PauseReplication: (entity: Entity) => void;
+
+		/** Resumes replication for an entity */
+		ResumeReplication: (entity: Entity) => void;
+
+		/** Pushes a new CFrame snapshot at the given time */
+		Push: (entity: Entity, time: number, value: CFrame) => boolean;
+
+		/** Gets the interpolated CFrame at a specific time */
+		GetAt: (entity: Entity, time: number) => CFrame | undefined;
+
+		/** Gets the target render time for interpolation */
+		GetTargetRenderTime: (entity: Entity) => number;
+
+		/** Sets whether position updates automatically */
+		SetAutoUpdatePos: (entity: Entity, autoUpdate: boolean) => void;
+
+		/** Gets the current CFrame */
+		GetCFrame: (entity: Entity) => CFrame | undefined;
+
+		/** Sets the current CFrame */
+		SetCFrame: (entity: Entity, cframe: CFrame) => void;
+
+		/** Gets the primary part of the model */
+		GetPrimaryPart: (entity: Entity) => BasePart | undefined;
+
+		/** Locks native server CFrame replication */
+		LockNativeServerCFrameReplication: (entity: Entity) => void;
+
+		/** Unlocks native server CFrame replication */
+		UnlockNativeServerCFrameReplication: (entity: Entity) => void;
+
+		/** Destroys an entity */
+		Destroy: (entity: Entity) => void;
+
+		/** Gets an event by name */
+		GetEvent: ((entity: Entity, name: "Destroying") => ChronoEvent<(entity: Entity) => void>) &
+			((
+				entity: Entity,
+				name: "NetworkOwnerChanged",
+			) => ChronoEvent<(entity: Entity, newOwner: Player | undefined, prevOwner: Player | undefined) => void>) &
+			((
+				entity: Entity,
+				name: "PushedSnapShot",
+			) => ChronoEvent<(entity: Entity, time: number, value: CFrame, isNewest: boolean) => void>) &
+			((
+				entity: Entity,
+				name: "TickChanged",
+			) => ChronoEvent<(entity: Entity, newTickType: "NONE" | "HALF" | "NORMAL") => void>) &
+			((entity: Entity, name: "DataChanged") => ChronoEvent<(entity: Entity, data: unknown) => void>) &
+			((entity: Entity, name: "Ticked") => ChronoEvent<(entity: Entity, dt: number) => void>) &
+			((
+				entity: Entity,
+				name: "ModelChanged",
+			) => ChronoEvent<
+				(entity: Entity, newModel: Model | BasePart | undefined, oldModel: Model | BasePart | undefined) => void
+			>) &
+			((entity: Entity, name: "LockChanged") => ChronoEvent<(entity: Entity, isLocked: boolean) => void>) &
+			((entity: Entity, name: EntityEventName) => ChronoEvent);
+	}
 
-interface ReplicationRule {
-	filterType: "include" | "exclude";
-	filterPlayers?: Player[];
-}
+	export interface ReplicationRule {
+		filterType: "include" | "exclude";
+		filterPlayers?: Player[];
+	}
 
-// Middleware function type for Receiver
-type MiddleManFn = (player: Player, entity: Entity, cframe: CFrame, arriveTime: number) => boolean;
+	// ===== Functions and Values =====
 
-declare namespace Chrono {
 	/** Starts the Chrono system */
 	function Start(config?: ModuleScript): void;
 
@@ -310,20 +315,7 @@ declare namespace Chrono {
 	/** Configuration functions */
 	namespace Config {
 		/** Sets a configuration value (must be called before Start) */
-		function SetConfig(name: "MIN_BUFFER", value: number): void;
-		function SetConfig(name: "MAX_BUFFER", value: number): void;
-		function SetConfig(name: "SHOW_WARNINGS", value: boolean): void;
-		function SetConfig(name: "MAX_SNAPSHOT_COUNT", value: number): void;
-		function SetConfig(name: "CHECK_NEW_VERSION", value: boolean): void;
-		function SetConfig(name: "DEFAULT_NORMAL_TICK_DISTANCE", value: number): void;
-		function SetConfig(name: "DEFAULT_HALF_TICK_DISTANCE", value: number): void;
-		function SetConfig(name: "DEFAULT_MODEL_REPLICATION_MODE", value: ModelReplicationMode): void;
-		function SetConfig(name: "PLAYER_REPLICATION", value: PlayerReplicationMode): void;
-		function SetConfig(name: "REPLICATE_DEATHS", value: ReplicationFilterMode): void;
-		function SetConfig(name: "REPLICATE_CFRAME_SETTERS", value: ReplicationFilterMode): void;
-		function SetConfig(name: "MAX_TOTAL_BYTES_PER_FRAME_PER_PLAYER", value: number): void;
-		function SetConfig(name: "SEND_FULL_ROTATION", value: boolean): void;
-		function SetConfig(name: ConfigName, value: unknown): void;
+		function SetConfig<K extends ConfigName>(name: K, value: ConfigValueMap[K]): void;
 
 		/** Registers a custom entity type configuration */
 		function RegisterEntityType(name: string, config: EntityConfigInput): void;