feat(hooks): add useScene

src/helpers/index.ts

@@ -0,0 +1 @@
+export * from './scene';

src/helpers/scene.test.ts

@@ -0,0 +1,15 @@
+import { Scene } from 'phaser';
+
+import { getScene, setScene } from './scene';
+
+const scene = new Scene();
+
+afterEach(() => {
+  setScene(undefined as unknown as Scene);
+});
+
+it('sets and gets scene', () => {
+  expect(getScene()).toEqual(undefined);
+  expect(setScene(scene)).toEqual(undefined);
+  expect(getScene()).toEqual(scene);
+});

src/helpers/scene.ts

@@ -0,0 +1,11 @@
+import type { Scene } from 'phaser';
+
+let _scene: Scene;
+
+export function getScene() {
+  return _scene;
+}
+
+export function setScene(scene: Scene) {
+  _scene = scene;
+}

src/hooks/index.ts

@@ -0,0 +1 @@
+export * from './useScene';

src/hooks/useScene.test.ts

@@ -0,0 +1,17 @@
+import { Scene } from 'phaser';
+
+import { getScene } from '../helpers';
+import { useScene } from './useScene';
+
+jest.mock('../helpers/scene', () => ({
+  getScene: jest.fn(),
+}));
+
+const mockedGetScene = jest.mocked(getScene);
+
+it('returns scene', () => {
+  const scene = new Scene();
+  mockedGetScene.mockReturnValueOnce(scene);
+  expect(useScene()).toEqual(scene);
+  expect(mockedGetScene).toHaveBeenCalledTimes(1);
+});

src/hooks/useScene.ts

@@ -0,0 +1,5 @@
+import { getScene } from '../helpers';
+
+export function useScene() {
+  return getScene();
+}

src/index.test.mjs

@@ -10,12 +10,13 @@ import {
   Image,
   jsx,
   render,
+  useScene,
   Video,
 } from '../cjs/index.js';
 
-[createElement, Image, render, Video].forEach((func) => {
-  it(`exports ${func.name}`, () => {
-    assert.strictEqual(typeof func, 'function');
+[createElement, Image, render, Video, useScene].forEach((fun) => {
+  it(`exports ${fun.name}`, () => {
+    assert.strictEqual(typeof fun, 'function');
   });
 });
 

src/index.test.ts

@@ -1,9 +1,17 @@
-import { Container, createElement, jsx, Rectangle, render, Text } from '.';
+import {
+  Container,
+  createElement,
+  jsx,
+  Rectangle,
+  render,
+  Text,
+  useScene,
+} from '.';
 
-it.each([Container, Rectangle, Text, createElement, render])(
+it.each([Container, Rectangle, Text, createElement, render, useScene])(
   'exports %p',
-  (func) => {
-    expect(func).toBeInstanceOf(Function);
+  (fun) => {
+    expect(fun).toBeInstanceOf(Function);
   },
 );
 

src/index.ts

@@ -1,5 +1,6 @@
 export * from './components';
 export { createElement, jsx } from './element';
+export { useScene } from './hooks';
 export { createRef } from './ref';
 export { render } from './render';
 export type { GameObjectProps, Ref } from './types';

src/render/render.test.ts

@@ -1,6 +1,7 @@
 import Phaser from 'phaser';
 
 import { Container, createElement } from '..';
+import { setScene } from '../helpers';
 import { render } from './render';
 
 jest.mock('phaser', () => {
@@ -19,19 +20,24 @@ jest.mock('phaser', () => {
   };
 });
 
+jest.mock('../helpers/scene', () => ({
+  setScene: jest.fn(),
+}));
+
 it('does not render element into the scene', () => {
   const spy = jest.spyOn(console, 'warn').mockImplementation();
   const element = {} as JSX.Element;
   const scene = new Phaser.Scene();
   expect(render(element, scene)).toBe(undefined);
-  expect(scene.add.existing).not.toBeCalled();
-  expect(spy).toBeCalledTimes(1);
+  expect(scene.add.existing).not.toHaveBeenCalled();
+  expect(spy).toHaveBeenCalledTimes(1);
   spy.mockRestore();
 });
 
 it('renders element into the scene', () => {
   const element = createElement(Container);
   const scene = new Phaser.Scene();
   expect(render(element, scene)).toBe(undefined);
-  expect(scene.add.existing).toBeCalledTimes(1);
+  expect(scene.add.existing).toHaveBeenCalledTimes(1);
+  expect(setScene).toHaveBeenCalledWith(scene);
 });

src/render/render.ts

@@ -1,6 +1,7 @@
 import Phaser from 'phaser';
 import type { JSX } from 'react';
 
+import { setScene } from '../helpers';
 import { createGameObject } from './gameobject';
 
 /**
@@ -10,6 +11,8 @@ import { createGameObject } from './gameobject';
  * @param scene - Phaser scene.
  */
 export function render(element: JSX.Element, scene: Phaser.Scene) {
+  setScene(scene);
+
   const gameObject = createGameObject(element, scene);
 
   if (gameObject) {