rngine 0.3.2 → 0.4.0

package/src/types.ts

@@ -1,55 +1,23 @@
-export type Screen = {
-  /** Width of the screen in game units. */
-  width: number;
-  /** Height of the screen in game units. */
-  height: number;
-  /** Background color of the screen as a hex string e.g. `'#1a1a1a'`. */
-  color: string;
-};
+import type {
+  Screen as NativeScreen,
+  Entity as NativeEntity,
+  EntityUpdate as NativeEntityUpdate,
+  System,
+} from './nativeTypes';
 
-export type Entity = {
-  /** Unique identifier. Use `_` as a separator for group queries e.g. `'enemy_1'`. */
-  id: string;
-  /** X position in game units. */
-  px: number;
-  /** Y position in game units. */
-  py: number;
-  /** Width in game units. */
-  width: number;
-  /** Height in game units. */
-  height: number;
-  /** Fill color as a hex string e.g. `'#00ff00'`. */
-  color: string;
-  /** Velocity on the X axis in game units per second. */
-  vx?: number;
-  /** Velocity on the Y axis in game units per second. */
-  vy?: number;
-};
+export type Asset = number | object;
 
-export type System = {
-  /** Entity ids or prefixes this system subscribes to. */
-  ids: string[];
-  /** Called every tick with the resolved entities. */
-  onTick: (entities: Entity[]) => void;
+export type Screen = Omit<NativeScreen, 'asset'> & {
+  /** Asset to render, use `require` with the file path to get the id. */
+  asset?: Asset;
 };
-
-export type EntityUpdate = {
-  /** Unique identifier or prefix of the entities to update. */
-  id: string;
-  /** X position in game units. */
-  px?: number;
-  /** Y position in game units. */
-  py?: number;
-  /** Width in game units. */
-  width?: number;
-  /** Height in game units. */
-  height?: number;
-  /** Fill color as a hex string e.g. `'#00ff00'`. */
-  color?: string;
-  /** Velocity on the X axis in game units per second. */
-  vx?: number;
-  /** Velocity on the Y axis in game units per second. */
-  vy?: number;
+export type Entity = Omit<NativeEntity, 'asset'> & {
+  /** Asset to render, use `require` with the file path to get the id. */
+  asset?: Asset;
+};
+export type EntityUpdate = Omit<NativeEntityUpdate, 'asset'> & {
+  /** Asset to render, use `require` with the file path to get the id. */
+  asset?: Asset;
 };
 
 export type Config = {