rbxts-chrono 2.0.0-experimental.4 → 2.0.0-experimental.5

package/package.json

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

package/src/index.d.ts

@@ -106,7 +106,7 @@ type EntityEventName =
 	| "ModelChanged"
 	| "LockChanged";
 
-// Entity interface
+// Entity interface (data only - methods are static on EntityConstructor)
 interface Entity {
 	/** Unique identifier for this entity */
 	readonly id: number;
@@ -131,102 +131,109 @@ interface Entity {
 
 	/** 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 this 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(entityConfig: string): void;
+	SetConfig(entity: Entity, entityConfig: string): void;
 
 	/** Sets the broad phase collision bounds */
-	SetBroadPhase(broadPhase?: Vector3): void;
+	SetBroadPhase(entity: Entity, broadPhase?: Vector3): void;
 
-	/** Gets custom data associated with this entity */
-	GetData<T = unknown>(): T;
+	/** Gets custom data associated with an entity */
+	GetData<T = unknown>(entity: Entity): T;
 
-	/** Gets the model associated with this entity */
-	GetModel(): Model | BasePart | undefined;
+	/** Gets the model associated with an entity */
+	GetModel(entity: Entity): Model | BasePart | undefined;
 
-	/** Sets custom data for this entity */
-	SetData(data: unknown): void;
+	/** Sets custom data for an entity */
+	SetData(entity: Entity, data: unknown): void;
 
 	/** Clears the mount relationship */
-	ClearMount(): void;
+	ClearMount(entity: Entity): void;
 
-	/** Mounts this entity to a parent entity with optional offset */
-	SetMount(parent?: Entity, offset?: CFrame): 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(player?: Player): void;
+	SetNetworkOwner(entity: Entity, player?: Player): void;
 
 	/** Clears the entity's snapshot buffer */
-	Clear(): void;
+	Clear(entity: Entity): void;
 
-	/** Pauses replication for this entity */
-	PauseReplication(): void;
+	/** Pauses replication for an entity */
+	PauseReplication(entity: Entity): void;
 
-	/** Resumes replication for this entity */
-	ResumeReplication(): void;
+	/** Resumes replication for an entity */
+	ResumeReplication(entity: Entity): void;
 
 	/** Pushes a new CFrame snapshot at the given time */
-	Push(time: number, value: CFrame): boolean;
+	Push(entity: Entity, time: number, value: CFrame): boolean;
 
 	/** Gets the interpolated CFrame at a specific time */
-	GetAt(time: number): CFrame | undefined;
+	GetAt(entity: Entity, time: number): CFrame | undefined;
 
 	/** Gets the target render time for interpolation */
-	GetTargetRenderTime(): number;
+	GetTargetRenderTime(entity: Entity): number;
 
 	/** Sets whether position updates automatically */
-	SetAutoUpdatePos(autoUpdate: boolean): void;
+	SetAutoUpdatePos(entity: Entity, autoUpdate: boolean): void;
 
 	/** Gets the current CFrame */
-	GetCFrame(): CFrame | undefined;
+	GetCFrame(entity: Entity): CFrame | undefined;
 
 	/** Sets the current CFrame */
-	SetCFrame(cframe: CFrame): void;
+	SetCFrame(entity: Entity, cframe: CFrame): void;
 
 	/** Gets the primary part of the model */
-	GetPrimaryPart(): BasePart | undefined;
+	GetPrimaryPart(entity: Entity): BasePart | undefined;
 
 	/** Locks native server CFrame replication */
-	LockNativeServerCFrameReplication(): void;
+	LockNativeServerCFrameReplication(entity: Entity): void;
 
 	/** Unlocks native server CFrame replication */
-	UnlockNativeServerCFrameReplication(): void;
+	UnlockNativeServerCFrameReplication(entity: Entity): void;
 
-	/** Destroys this entity */
-	Destroy(): void;
+	/** Destroys an entity */
+	Destroy(entity: Entity): void;
 
 	/** Gets an event by name */
-	GetEvent(name: "Destroying"): ChronoEvent<(entity: Entity) => void>;
+	GetEvent(entity: Entity, name: "Destroying"): ChronoEvent<(entity: Entity) => void>;
 	GetEvent(
+		entity: Entity,
 		name: "NetworkOwnerChanged",
 	): ChronoEvent<(entity: Entity, newOwner: Player | undefined, prevOwner: Player | undefined) => void>;
 	GetEvent(
+		entity: Entity,
 		name: "PushedSnapShot",
 	): ChronoEvent<(entity: Entity, time: number, value: CFrame, isNewest: boolean) => void>;
-	GetEvent(name: "TickChanged"): ChronoEvent<(entity: Entity, newTickType: "NONE" | "HALF" | "NORMAL") => void>;
-	GetEvent(name: "DataChanged"): ChronoEvent<(entity: Entity, data: unknown) => void>;
-	GetEvent(name: "Ticked"): ChronoEvent<(entity: Entity, dt: number) => void>;
 	GetEvent(
+		entity: Entity,
+		name: "TickChanged",
+	): ChronoEvent<(entity: Entity, newTickType: "NONE" | "HALF" | "NORMAL") => void>;
+	GetEvent(entity: Entity, name: "DataChanged"): ChronoEvent<(entity: Entity, data: unknown) => void>;
+	GetEvent(entity: Entity, name: "Ticked"): ChronoEvent<(entity: Entity, dt: number) => void>;
+	GetEvent(
+		entity: Entity,
 		name: "ModelChanged",
 	): ChronoEvent<(entity: Entity, newModel: Model | BasePart | undefined, oldModel: Model | BasePart | undefined) => void>;
-	GetEvent(name: "LockChanged"): ChronoEvent<(entity: Entity, isLocked: boolean) => void>;
-	GetEvent(name: EntityEventName): ChronoEvent;
-}
-
-interface EntityConstructor {
-	new (
-		entityConfig?: string,
-		model?: Model | BasePart | string,
-		modelReplicationMode?: ModelReplicationMode,
-		initCFrame?: CFrame,
-	): Entity;
+	GetEvent(entity: Entity, name: "LockChanged"): ChronoEvent<(entity: Entity, isLocked: boolean) => void>;
+	GetEvent(entity: Entity, name: EntityEventName): ChronoEvent;
 }
 
 // Replication rule types