Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@nativescript/canvas-phaser

1.0.0-alpha5 • Public • Published

@nativescript/canvas-phaser

Tools for using Phaser3 to build native 2D games in NativeScript 👾👾

Installation

npm i @nativescript/canvas-phaser

Usage

Import the library into your JavaScript file:

import TNSPhaser from "@nativescript/canvas-phaser";

Functions

TNSPhaser.game({ canvas, renderer: Phaser.WEBGL || Phaser.CANVAS, ...extras })

Given a canvas from a Canvas, return a Phaser.Game that draws into it.

Props

Property Type Description Default Value
canvas TNSCanvas Required: canvas that the Phaser.Game will render to null
renderer number? Optional: choose the renderer type e.g Phaser.CANVAS (1) , Phaser.WEBGL(2) 1
width number? Optional: height of the Phaser.Game canvas height
height number? Optional: width of the Phaser.Game canvas width
title string? Optional: title of the Phaser.Game "tns-phaser-game"

Returns

Property Type Description
game Phaser.Game The Phaser3 game used for rendering game logic

Example

const game = TNSPhaser.game({ canvas });

What does it do?

Under the hood, TNSPhaser is maintaining global instances of a few libraries.

window.Phaser = require("phaser");

Finally when a new instance of TNSPhaser.Game is created, we set the document.readyState to 'complete'

global.document.readyState = "complete";

License

Apache License Version 2.0, January 2004

Install

npm i @nativescript/canvas-phaser

DownloadsWeekly Downloads

12

Version

1.0.0-alpha5

License

Apache-2.0

Unpacked Size

20.2 kB

Total Files

15

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar