Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example splash screen and preloader progress bar #6

Merged
merged 2 commits into from
Oct 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions v3/_starter-v3-vsc-ts-node/src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1" />
<title>Starter Project for Phaser with TypeScript</title>
<title>Starter Project for Phaser 3 with TypeScript</title>
<link rel="shortcut icon" href="favicon.ico" />
<link rel="stylesheet" href="app.css" type="text/css" />
<script src="lib/phaser.min.js"></script>
</head>
<body>
<!--Update the heading below, and title above, as needed.-->
<h1>Starter Project for Phaser with TypeScript</h1>
<h1>Starter Project for Phaser 3 with TypeScript</h1>

<div id="content"></div>
<!--If using the project the TypeScript files will automatically be combined into the following file. Update as needed.-->
Expand Down
2 changes: 2 additions & 0 deletions v3/_starter-v3-vsc-ts-node/src/ts/Game.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import * as phaser from "phaser";
import Boot from "./Scenes/Boot";
import Preloader from "./Scenes/Preloader";
import MainMenu from "./Scenes/MainMenu";
import SplashScreen from "./Scenes/SplashScreen";
import Utilities from "./Utilities";

const gameConfig: GameConfig = {
Expand All @@ -20,6 +21,7 @@ export default class Game extends Phaser.Game {

this.scene.add(Boot.Name, Boot);
this.scene.add(Preloader.Name, Preloader);
this.scene.add(SplashScreen.Name, SplashScreen);
this.scene.add(MainMenu.Name, MainMenu);
this.scene.start(Boot.Name);
}
Expand Down
4 changes: 2 additions & 2 deletions v3/_starter-v3-vsc-ts-node/src/ts/Scenes/MainMenu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ export default class MainMenu extends Phaser.Scene {
public static Name: string = "MainMenu";

public preload(): void {
this.load.path = "assets/";
this.load.image("Phaser-Logo-Small");
// Preload as needed.
}

public create(): void {
Expand All @@ -18,5 +17,6 @@ export default class MainMenu extends Phaser.Scene {
}

public update(): void {
// Update logic, as needed.
}
}
79 changes: 77 additions & 2 deletions v3/_starter-v3-vsc-ts-node/src/ts/Scenes/Preloader.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MainMenu from "./MainMenu";
import SplashScreen from "./SplashScreen";
import Utilities from "../Utilities";

export default class Preloader extends Phaser.Scene {
Expand All @@ -8,15 +8,90 @@ export default class Preloader extends Phaser.Scene {
public static Name: string = "Preloader";

public preload(): void {
this.addProgressBar();

this.load.path = "assets/";
this.load.image("phaser_pixel_medium_flat");
this.load.image("Phaser-Logo-Small");

// You should remove this logic; this is only included here to show off the progress bar.
for (let i = 0; i < 100; i++) {
this.load.image("Phaser-Logo-Small" + i, "Phaser-Logo-Small.png");
}
}

public create(): void {
Utilities.LogSceneMethodEntry("Preloader", "create");

this.scene.start(MainMenu.Name);
this.scene.start(SplashScreen.Name);
}

public update(): void {
}

/**
* Adds a progress bar to the display, showing the percentage of assets loaded and their name.
*/
private addProgressBar(): void {
const width = this.cameras.main.width;
const height = this.cameras.main.height;

const progressBar = this.add.graphics();
const progressBox = this.add.graphics();
progressBox.fillStyle(0x222222, 0.8);
progressBox.fillRect(width / 4, height / 2 - 30, width / 2, 50);

const loadingText = this.make.text({
x: width / 2,
y: height / 2 - 50,
text: "Loading...",
style: {
font: "20px monospace",
fill: "#ffffff"
}
});
loadingText.setOrigin(0.5, 0.5);

const percentText = this.make.text({
x: width / 2,
y: height / 2 - 5,
text: "0%",
style: {
font: "18px monospace",
fill: "#ffffff"
}
});
percentText.setOrigin(0.5, 0.5);

const assetText = this.make.text({
x: width / 2,
y: height / 2 + 50,
text: "",
style: {
font: "18px monospace",
fill: "#ffffff"
}
});

assetText.setOrigin(0.5, 0.5);

this.load.on("progress", (value) => {
percentText.setText(parseInt(value * 100 + "", 10) + "%");
progressBar.clear();
progressBar.fillStyle(0xffffff, 1);
progressBar.fillRect((width / 4) + 10, (height / 2) - 30 + 10, (width / 2 - 10 - 10) * value, 30);
});

this.load.on("fileprogress", (file) => {
assetText.setText("Loading asset: " + file.key);
});

this.load.on("complete", () => {
progressBar.destroy();
progressBox.destroy();
loadingText.destroy();
percentText.destroy();
assetText.destroy();
});
}
}
44 changes: 44 additions & 0 deletions v3/_starter-v3-vsc-ts-node/src/ts/Scenes/SplashScreen.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import Utilities from "../Utilities";
import MainMenu from "./MainMenu";

export default class SplashScreen extends Phaser.Scene {
/**
* Unique name of the scene.
*/
public static Name: string = "SplashScreen";

public preload(): void {
this.load.path = "assets/";
}

public create(): void {
Utilities.LogSceneMethodEntry("SplashScreen", "create");

const titleText = this.add.text(this.cameras.main.centerX, this.cameras.main.centerY * 0.5, "Starter Project for Phaser 3 with TypeScript")
.setOrigin(0.5, 0)
.setFontFamily("monospace").setFontSize(26).setFill("#fff");

const poweredByText = this.add.text(this.cameras.main.centerX, this.cameras.main.centerY - 25, "Powered By");
poweredByText.setOrigin(0.5, 0.5);
poweredByText.setFontFamily("monospace").setFontSize(20).setFill("#fff");
this.add.image(this.cameras.main.centerX, this.cameras.main.centerY, "phaser_pixel_medium_flat");

this.input.setDefaultCursor("pointer");
this.input.on("pointerdown", this.loadMainMenu, this);

this.time.addEvent({
// Run after three seconds.
delay: 3000,
callback: this.loadMainMenu,
callbackScope: this,
loop: false
});
}

/**
* Load the next scene, the main menu.
*/
private loadMainMenu(): void {
this.scene.start(MainMenu.Name);
}
}