Merge pull request #50 from gibsonsmog/feature/beforeCollide

add onCollideStart and onEnterStart

Author: achtaitaipai

apps/examples/src/hello-world/index.ts

@@ -30,6 +30,12 @@ const game = createGame({
         ...66...
 			`,
 			dialog: 'Hello adventurer!',
+			onCollide() {
+				console.log('You have collided with the cell!')
+			},
+			onCollideStart() {
+				console.log('You have previously collided with the cell!')
+			},
 		},
 	},
 	map: `

packages/odyc/src/gameLoop.ts

@@ -44,17 +44,21 @@ class GameLoop<T extends string> {
 		if (this.#isCellOnworld(to.value)) {
 			const cell = this.#gameState.cells.getCellAt(...to.value)
 
-			if (!cell.solid) {
+			if (cell.solid) {
+				await this.#gameState.cells.getEvent(...to.value, 'onCollideStart')?.()
+			} else {
 				await this.#gameState.cells.getEvent(...from.value, 'onLeave')?.()
 				this.#gameState.player.position = to.value
+				await this.#gameState.cells.getEvent(...to.value, 'onEnterStart')?.()
 			}
 
 			this.#playSound(cell)
 			await this.#openDialog(cell)
 
-			if (cell.solid)
-				await this.#gameState.cells.getEvent(...to.value, 'onCollide')?.()
-			else await this.#gameState.cells.getEvent(...to.value, 'onEnter')?.()
+			await this.#gameState.cells.getEvent(
+				...to.value,
+				cell.solid ? 'onCollide' : 'onEnter',
+			)?.()
 		}
 
 		for (const cell of this.#gameState.cells.get()) {

packages/odyc/src/gameState/cells.ts

@@ -163,7 +163,9 @@ export class Cells<T extends string> {
 		y: number,
 		eventKey:
 			| 'onCollide'
+			| 'onCollideStart'
 			| 'onEnter'
+            | 'onEnterStart'
 			| 'onLeave'
 			| 'onScreenLeave'
 			| 'onScreenEnter'
@@ -247,6 +249,8 @@ export class Cells<T extends string> {
 			visible: template.visible !== false,
 			foreground: template.foreground === true,
 			onCollide: template.onCollide,
+			onCollideStart: template.onCollideStart,
+            onEnterStart: template.onEnterStart,
 			onEnter: template.onEnter,
 			onLeave: template.onLeave,
 			onScreenEnter: template.onScreenEnter,

packages/odyc/src/gameState/types.ts

@@ -45,6 +45,10 @@ export type CellState<T extends string> = {
 	position: [number, number]
 	/** Called when player tries to move into this cell's position */
 	onCollide?: (target: CellFacade<T>) => any
+	/** Called after player collides with this cell */
+	onCollideStart?: (target: CellFacade<T>) => any
+    /** Call when a player begins to enter a cell, before dialog and sounds */
+    onEnterStart?: (target: CellFacade<T>) => any
 	/** Called when player moves into this cell's position */
 	onEnter?: (target: CellFacade<T>) => any
 	/** Called when player leaves this cell's position */
@@ -70,6 +74,8 @@ export type CellParams = Partial<
 		| 'symbol'
 		| 'position'
 		| 'onCollide'
+		| 'onCollideStart'
+        | 'onEnterStart'
 		| 'onEnter'
 		| 'onLeave'
 		| 'onScreenEnter'

tests/odyc-e2e/functional/move-cell/index.ts

@@ -5,13 +5,14 @@ const state = {
 	turnSpy: null as any,
 	enterSpy: null as any,
 	collideSpy: null as any,
+    onCollideStartSpy: null as any,
 }
 
 export const init = () => {
 	state.turnSpy = vi.fn()
 	state.enterSpy = vi.fn()
 	state.collideSpy = vi.fn()
-
+    state.onCollideStartSpy = vi.fn()
 	const game = createGame({
 		templates: {
 			x: {
@@ -21,6 +22,7 @@ export const init = () => {
 				onTurn: state.turnSpy,
 				onEnter: state.enterSpy,
 				onCollide: state.collideSpy,
+                onCollideStart: state.onCollideStartSpy,
 			},
 			y: {
 				sprite: 2,

tests/odyc-e2e/functional/on-collide/index.test.ts

@@ -0,0 +1,48 @@
+import { expect, test, describe, vi } from 'vitest'
+import { createGame } from 'odyc'
+import { userEvent } from '@vitest/browser/context'
+
+describe('onCollide and onCollideStart events', () => {
+    test('should call onCollide when player collides with a cell', async () => {
+        const collideSpy = vi.fn()
+        const game = createGame({
+            player: {
+                position: [0, 1],
+            },
+            templates: {
+                x: {
+                    onCollide: collideSpy,
+                },
+            },
+            map: 
+            `
+                x.
+                ..
+            `,
+        })
+        expect(collideSpy).not.toHaveBeenCalled()
+        await userEvent.keyboard('[ArrowUp]')
+        expect(collideSpy).toHaveBeenCalled()
+    })
+    test('should call onCollideStart when player collides with a cell for the first time', async () => {
+        const collideStartSpy = vi.fn()
+        const game = createGame({
+            templates: {
+                x: {
+                    onCollideStart: collideStartSpy,
+                },
+            },
+            map: 
+            `
+                x.
+                ..
+            `,
+        })
+        expect(collideStartSpy).not.toHaveBeenCalled()
+        // slightly more complex route for funsies
+        await userEvent.keyboard('[ArrowRight]')
+        await userEvent.keyboard('[ArrowUp]')
+        await userEvent.keyboard('[ArrowLeft]')
+        expect(collideStartSpy).toHaveBeenCalled()
+    }) 
+})