RobotlegsJS Pixi Palidor Extension
Palidor is an extension of RobotlegsJS for Pixi, designed to help the management of the Main Container, taking the responsibility to add, remove and switch the views. Perfect for game development.
You can get the latest release and the type definitions using NPM:
npm install @robotlegsjs/pixi-palidor
Or using Yarn:
yarn add @robotlegsjs/pixi-palidor
0.2.0 of this package, the PixiJS dependencies were moved to peerDependencies,
allowing the final user to choose the desired version of the
pixi.js library on each project.
@robotlegsjs/pixi-palidor package is compatible with versions between the
>=4.2.1 <5 version range of
Since each version of
pixi.js library defines which version of
eventemitter3 library is being used, remember to also install the proper version of
eventemitter3 in your project.
As example, when you would like to use the version
pixi.js library, you can run:
npm install firstname.lastname@example.org eventemitter3@^2.0.0 reflect-metadata --save
yarn add email@example.com eventemitter3@^2.0.0 reflect-metadata --save
Then follow the installation instructions of RobotlegsJS library to complete the setup of your project.
Palidor was designed to be simple and, practical. You just need to follow three steps to start to use.
Step 1 - Install/Configure
Firstly, you need to instantiate your RobotlegsJS's context, and then install and configure the PalidorPixiExtension:
- MVCSBundle: Installs a number of extensions and configurations for developers who are comfortable with the typical RobotlegsJS setup.
- PixiBundle: Installs a view / mediator layer provided by RobotlegsJS-Pixi.
- PalidorPixiExtension: It is the extension itself.
- MyPalidorConfig: The Class that implements the Robotlegs's IConfig and will be responsible for map all your Views and FloatingViews.
Step 2 - Mapping the Views/FloatingViews
In the Second step, you must map all views that you need. Palidor works with two types of views (FloatingViews and Views) and the main difference between them is the way that Palidor will add it on the Stage.
Palidor splits the Main Container into two distinct Layers, one to each type of View. The FloatingView always will be in a layer above the others Views.
- View: A View is a screen added into the Static Layer which is behind all FloatingViews. Palidor allows only one View per time and will remove the current view before to add a new View.
- FloatingView: A FloatingView is a screen added into the Dynamic Layer and always will be above the view and also others FloatingViews. Palidor allows any number of FloatingView that you want. FloatingViews is the best choice to create temporary views such as AlertsScreen, PauseScreen, GameOverScreen and Popups.
The FlowManager will be the responsible to tells to Palidor each event mapped to each View.
Step 3 - Adding a View
The last part it is the way that Palidor will add the views on the stage, you just need to dispatch an event using the IEventDispatcher which is available for Injection like any other Robotlegs Command.
There are some predefined events on the Palidor to help to remove a view or floating view from the stage.