npm package: @robotlegsjs/pixi-palidor
Description: A RobotlegsJS View Manager Extension for PixiJS
Author: RobotlegsJS
Latest version: 4.0.0

# RobotlegsJS Pixi Palidor Extension

[![GitHub license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/pixi-palidor/LICENSE)
[![Gitter chat](https://badges.gitter.im/RobotlegsJS/RobotlegsJS.svg)](https://gitter.im/RobotlegsJS/RobotlegsJS)
[![npm version](https://badge.fury.io/js/%40robotlegsjs%2Fpixi-palidor.svg)](https://badge.fury.io/js/%40robotlegsjs%2Fpixi-palidor)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

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.

## Installation

### Get `@robotlegsjs/pixi-palidor`

You can get the latest release and the type definitions using [NPM](https://www.npmjs.com/):

```bash
npm install @robotlegsjs/pixi-palidor --save
```

Or using [Yarn](https://yarnpkg.com/en/):

```bash
yarn add @robotlegsjs/pixi-palidor
```

From version `0.2.0` of this package, the [PixiJS](https://github.com/pixijs/pixi.js) dependencies were moved to **peerDependencies**,
allowing the final user to choose the desired version of the `pixi.js` library on each project.

#### For `pixi.js` version 6

The `@robotlegsjs/pixi-palidor` package version `^4.0.0` is compatible with versions `>=6.0.0 <7` version range of `pixi.js` library.

You can setup your project for version 6 of `pixi.js` using:

```bash
npm install @robotlegsjs/pixi-palidor@^4.0.0 pixi.js@^6.0.0 --save
```

or

```bash
yarn add @robotlegsjs/pixi-palidor@^4.0.0 pixi.js@^6.0.0
```

#### For `pixi.js` version 5

The `@robotlegsjs/pixi-palidor` package versions `^2.0.0` and `^3.0.0` are compatible with versions between the `>=5.0.0 <6` version range of `pixi.js` library.

Since version `5.0.0` of `pixi.js`, the `eventemitter3` library was removed and is not necessary anymore.

You can setup your project for version 5 of `pixi.js` using:

```bash
npm install @robotlegsjs/pixi-palidor@^3.0.0 pixi.js@^5.0.0 reflect-metadata --save
```

or

```bash
yarn add @robotlegsjs/pixi-palidor@^3.0.0 pixi.js@^5.0.0 reflect-metadata
```

#### For `pixi.js` version 4

The `@robotlegsjs/pixi-palidor` package version `^1.0.0` is compatible with versions between the `>=4.2.1 <5` version range of `pixi.js` library.

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 `4.2.1` of `pixi.js` library, you can run:

```bash
npm install @robotlegsjs/pixi-palidor@^1.0.0 pixi.js@4.2.1 eventemitter3@^2.0.0 reflect-metadata --save
```

or

```bash
yarn add @robotlegsjs/pixi-palidor@^1.0.0 pixi.js@4.2.1 eventemitter3@^2.0.0 reflect-metadata
```

Then follow the [installation instructions](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/core#installation) of **RobotlegsJS** library to complete the setup of your project.

**Dependencies**

+ [RobotlegsJS](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/core)
+ [RobotlegsJS-EventEmitter3](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/eventemitter3)
+ [RobotlegsJS-Pixi](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/pixi)
+ [tslib](https://github.com/Microsoft/tslib)

**Peer Dependencies**

+ [PixiJS](https://github.com/pixijs/pixi.js)
+ [reflect-metadata](https://github.com/rbuckton/reflect-metadata)

## Usage

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:

```typescript
let stage = new Container();
let context = new Context()
    .install(MVCSBundle)
    .install(PixiBundle)
    .install(PalidorPixiExtension)
    .configure(new ContextView(this.stage))
    .configure(MyPalidorConfig)
    .initialize();
```

+ **MVCSBundle:** Installs a number of extensions and configurations for developers who are comfortable with the typical [RobotlegsJS](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/core) setup.
+ **PixiBundle:** Installs a view / mediator layer provided by [RobotlegsJS-Pixi](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/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.

<img src="https://raw.githubusercontent.com/RobotlegsJS/RobotlegsJS-Framework/master/packages/pixi-palidor/media/layers.png" />

+ **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.

```typescript
import { IFlowManager } from "@robotlegsjs/pixi-palidor";
import { IConfig, injectable, inject } from "@robotlegsjs/core";

@injectable()
export class MyPalidorConfig implements IConfig {
    @inject(IFlowManager)
    public flowManager: IFlowManager;

    public configure(): void {
        this.flowManager.map( CustomEvent.SHOW_FIRST_VIEW ).toView( FirstView );
        this.flowManager.map( CustomEvent.SHOW_FIRST_FLOATING_VIEW ).toFloatingView( FirstFloatingView );
    }
}
```

### 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.

```typescript
this.eventDispatcher.dispatchEvent(new CustomEvent(CustomEvent.SHOW_FIRST_VIEW));
```

#### Events

There are some predefined events on the  Palidor to help to remove a view or floating view from the stage.

+ PalidorEvent.REMOVE_CURRENT_VIEW:
+ PalidorEvent.REMOVE_ALL_FLOATING_VIEWS:
+ PalidorEvent.REMOVE_LAST_FLOATING_VIEW_ADDED:

## Running the example

Run the following commands to run the example:

```bash
npm start
```

or:

```bash
yarn start
```

[See full example here](example/index.ts)

## Examples

+ [Game - Battleship](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/games/battleship)
+ [Game - Match3](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/games/match3)
+ [Game - Minesweeper](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/games/minesweeper)
+ [Game - Scratchcard](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/games/scratchcard)
+ [Game - Space Invaders](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/games/space-invaders)
+ [Game - Tetris](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/games/tetris)

## RobotlegsJS Pixi Palidor for enterprise

Available as part of the Tidelift Subscription

The maintainers of [@robotlegsjs/pixi-palidor](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/pixi-palidor) and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-robotlegsjs-pixi-palidor?utm_source=npm-robotlegsjs-pixi-palidor&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)

## License

[MIT](LICENSE)