rngine 0.3.1 → 0.4.0

package/src/Shared.ts

@@ -0,0 +1,83 @@
+import { Image } from 'react-native';
+import { gameAssets } from './GameAssets.nitro';
+import { gameMethods } from './GameMethods.nitro';
+import type {
+  Screen as NativeScreen,
+  Entity as NativeEntity,
+  EntityUpdate as NativeEntityUpdate,
+} from './nativeTypes';
+import type { Asset, Config, Entity, EntityUpdate } from './types';
+
+const assetCache = new WeakMap<object, number>();
+let nextId = -1;
+
+const registerAssetIfNotExist = (asset?: Asset) => {
+  switch (typeof asset) {
+    case 'object':
+      if (assetCache.has(asset)) {
+        return assetCache.get(asset);
+      }
+      const assetId = nextId--;
+      assetCache.set(asset, assetId);
+      gameAssets.registerLottie(assetId, JSON.stringify(asset));
+      return assetId;
+
+    case 'number':
+      if (gameAssets.isAssetRegistered(asset)) {
+        return asset;
+      }
+      const assetUri = Image.resolveAssetSource(asset)?.uri;
+      if (!assetUri) {
+        break;
+      }
+      gameAssets.registerSvg(asset, assetUri);
+      return asset;
+  }
+  return;
+};
+
+/** Sets up the game engine with the given configuration. Call this before anything else. */
+export const configure = ({
+  tickRate,
+  screen,
+  entities = [],
+  systems = [],
+  paused = true,
+}: Config) => {
+  screen.asset = registerAssetIfNotExist(screen.asset);
+  for (const entity of entities) {
+    entity.asset = registerAssetIfNotExist(entity.asset);
+  }
+
+  gameMethods.setTickRate(tickRate);
+  gameMethods.setScreen(screen as NativeScreen);
+  gameMethods.setEntities(entities as NativeEntity[]);
+  gameMethods.setSystems(systems);
+  if (paused) {
+    gameMethods.pause();
+  } else {
+    gameMethods.resume();
+  }
+};
+
+/** Spawns one or more entities into the world. Skips duplicates by id. */
+export const spawn = (entities: Entity | Entity[]) => {
+  const entityArray = Array.isArray(entities) ? entities : [entities];
+
+  for (const entity of entityArray) {
+    entity.asset = registerAssetIfNotExist(entity.asset);
+  }
+
+  gameMethods.spawn(entityArray as NativeEntity[]);
+};
+
+/** Updates one or more entities. Only the provided fields are changed. */
+export const update = (updates: EntityUpdate | EntityUpdate[]) => {
+  const entityUpdateArray = Array.isArray(updates) ? updates : [updates];
+
+  for (const entityUpdate of entityUpdateArray) {
+    entityUpdate.asset = registerAssetIfNotExist(entityUpdate.asset);
+  }
+
+  gameMethods.update(entityUpdateArray as NativeEntityUpdate[]);
+};

package/src/index.tsx

@@ -1,5 +1,7 @@
 import GameEngine from './GameEngine';
 
 export * from './GameMethods';
+export * from './Shared';
+export type { System } from './nativeTypes';
 export * from './types';
 export { GameEngine };

package/src/nativeTypes.ts

@@ -0,0 +1,83 @@
+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;
+  /** Asset to render, use `require` with the file path to get the id. */
+  asset?: number;
+  /** Animation progress between 0 and 1, automatically advanced each tick for Lottie assets. */
+  progress?: number;
+};
+
+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;
+  /** Asset to render, use `require` with the file path to get the id. */
+  asset?: number;
+  /** Animation progress between 0 and 1, automatically advanced each tick for Lottie assets. */
+  progress?: number;
+  /** 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 CollisionPair = {
+  /** Entity id or prefix of the first entity to watch. */
+  a: string;
+  /** Entity id or prefix of the second entity to watch. */
+  b: string;
+};
+
+export type Collision = {
+  /** Id of the first entity involved in the collision. */
+  a: string;
+  /** Id of the second entity involved in the collision. */
+  b: string;
+  /** Penetration depth of the collision. */
+  depth: number;
+};
+
+export type System = {
+  /** Entity ids or prefixes this system subscribes to. */
+  entities?: string[];
+  /** Collision pairs to watch for every tick. */
+  collisions?: CollisionPair[];
+  /** Called every tick with the resolved entities and collisions. */
+  onTick: (entities: Entity[], collisions: Collision[]) => void;
+};
+
+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;
+  /** Asset to render, use `require` with the file path to get the id. */
+  asset?: number;
+  /** Animation progress between 0 and 1, automatically advanced each tick for Lottie assets. */
+  progress?: number;
+  /** Velocity on the X axis in game units per second. */
+  vx?: number;
+  /** Velocity on the Y axis in game units per second. */
+  vy?: number;
+};

package/src/types.ts

@@ -1,62 +1,30 @@
-export type World = {
-  /** Width of the world in game units. */
-  width: number;
-  /** Height of the world in game units. */
-  height: number;
-  /** Background color of the world 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 = {
   /** Number of game logic updates per second. */
   tickRate: number;
-  /** World dimensions and background color. */
-  world: World;
+  /** Screen dimensions and background color. */
+  screen: Screen;
   /** Initial entities to spawn. */
   entities?: Entity[];
   /**