Part 10. ゲームシーンを読み込む間、ローディングシーンを表示する:

前の記事では、基本的なゲームプレイ用 scene の設定を準備しました。それでは、メニュー画面のプレイボタンを押した後にローディングsceneを表示するように制御します。クラス図の説明にあったように、ゲームリソースの事前読み込み・メニューテクスチャの読み込み解除・ゲームsceneの初期化をしている間にローディングsceneを表示します(ゲームsceneからメニューsceneに戻る時も、ローディングsceneを表示します)。

1. メニューテクスチャの読み込みと読み込み解除:

前述のように、メニューテクスチャの読み込みと読み込み解除を司るメソッドが必要です。それらメソッドを ResorucesManager クラス内に作成します:

public void unloadMenuTextures()
{
    menuTextureAtlas.unload();
}
    
public void loadMenuTextures()
{
    menuTextureAtlas.load();
}

テクスチャが必要ない間はそのメモリを解放したほうが良いというのは自明のことです。解放したテクスチャは後で一行で読み込むことができます (テクスチャ領域などを再作成する必要はありません。メモリからテクスチャの読み込みを解除し、再度テクスチャの読み込みを行うだけです)。

ゲームscene の初期化・そのリソースの読み込み・メニューテクスチャの読み込み解除をしている間にローディングsceneを表示するためのメソッドを、SceneManager内に作成します。

public void loadGameScene(final Engine mEngine)
{
    setScene(loadingScene);
    ResourcesManager.getInstance().unloadMenuTextures();
    mEngine.registerUpdateHandler(new TimerHandler(0.1f, new ITimerCallback() 
    {
        public void onTimePassed(final TimerHandler pTimerHandler) 
        {
            mEngine.unregisterUpdateHandler(pTimerHandler);
            ResourcesManager.getInstance().loadGameResources();
            gameScene = new GameScene();
            setScene(gameScene);
        }
    }));
}

MenuScene クラスを開いて、プレイボタンが押された後にloadGameScene()メソッドを実行します。

public boolean onMenuItemClicked(MenuScene pMenuScene, IMenuItem pMenuItem, float pMenuItemLocalX, float pMenuItemLocalY)
{
    switch(pMenuItem.getID())
    {
        case MENU_PLAY:
            //Load Game Scene!
            SceneManager.getInstance().loadGameScene(engine);
            return true;
        case MENU_OPTIONS:
            return true;
        default:
            return false;
    }
}

私のチュートリアルとコードに従って慎重にコーディングしたのでれば、プレイボタンを押した後にゲームscene を読み込むことができ、ゲームsceneを読み込んでいる間はローディングscene が表示されます。

Loading scene.

Game Scene.

1. Loading and unloading menu texture(s):

As mentioned we will need methods responsible for handling unloading and loading menu texture(s), create them inside our ResorucesManager class:

public void unloadMenuTextures()
{
    menuTextureAtlas.unload();
}
    
public void loadMenuTextures()
{
    menuTextureAtlas.load();
}

Its quite self-explanatory what it just help us to free some memory while texture is currently not needed, later we can load it again with one line (we do not have to recreate texture regions etc, we just unloaded texture from memory, we can load it again)

create method inside SceneManager responsible for displaying loading scene, while initializing game scene and loading its resources, and unloading menu texture.

public void loadGameScene(final Engine mEngine)
{
    setScene(loadingScene);
    ResourcesManager.getInstance().unloadMenuTextures();
    mEngine.registerUpdateHandler(new TimerHandler(0.1f, new ITimerCallback() 
    {
        public void onTimePassed(final TimerHandler pTimerHandler) 
        {
            mEngine.unregisterUpdateHandler(pTimerHandler);
            ResourcesManager.getInstance().loadGameResources();
            gameScene = new GameScene();
            setScene(gameScene);
        }
    }));
}

Open our MenuScene class to execute this method after pressing play button.

public boolean onMenuItemClicked(MenuScene pMenuScene, IMenuItem pMenuItem, float pMenuItemLocalX, float pMenuItemLocalY)
{
    switch(pMenuItem.getID())
    {
        case MENU_PLAY:
            //Load Game Scene!
            SceneManager.getInstance().loadGameScene(engine);
            return true;
        case MENU_OPTIONS:
            return true;
        default:
            return false;
    }
}

If you followed my tutorials and codes carefully, you should be able to load game scene after pressing play button, and while loading game scene, loading scene should be displayed.

Loading scene.

Game Scene.

2. ゲームシーンからメニューシーンに戻る:

さて、現在ゲームシーンが表示されているとしましょう。戻るボタンを押すと、メニューシーンに戻るはずです。メニューテクスチャーの読み込みを解除するため、いくつかの処理を実行する必要があります。ゲームテクスチャの読み解除、メニューテクスチャの読み込み、最終的に全てのゲームscene のエレメントを破棄/取り外してゲームscene の破壊・破棄を行います (メモリリークが一切起きないようにするためです)。そして再びメニューシーンを表示し、これら全てのタスクを実行する間はローディングscene を表示します。

ResourcesManager内に、ゲームテクスチャの読み込み解除を司るメソッドを新規に作成します。ゲームsceneのテクスチャは何も作成していないので、今のところは処理部分は空白にしておきます。後でゲームテクスチャの読み込み解除コードを追記します。
```
public void unloadGameTextures()
{
    // TODO (Since we did not create any textures for game scene yet)
}
```

メニューscene の読み込みと、前述の処理全てを実行している間にローディングscene を表示するためのメソッドを、SceneManager 内に作成します:
```
public void loadMenuScene(final Engine mEngine)
{
    setScene(loadingScene);
    gameScene.disposeScene();
    ResourcesManager.getInstance().unloadGameTextures();
    mEngine.registerUpdateHandler(new TimerHandler(0.1f, new ITimerCallback() 
    {
        public void onTimePassed(final TimerHandler pTimerHandler) 
        {
            mEngine.unregisterUpdateHandler(pTimerHandler);
            ResourcesManager.getInstance().loadMenuTextures();
            setScene(menuScene);
        }
    }));
}
```
上記はゲームテクスチャの読み込み解除とメニューテクスチャの再読み込みをしている間の、ローディングscene を制御しています。また、game sceneのdisposeScene()メソッドを実行しています。 game sceneをクリアするコードを記述しましょう。今のところは、GameSceneクラス内のdisposeScene()内にこれを記述します。
```
@Override
public void disposeScene()
{
    camera.setHUD(null);
    camera.setCenter(400, 240);

    // TODO code responsible for disposing scene
    // removing all game scene objects.
}
```
今のところは、カメラのHUDをクリアして、カメラの中心点を既定値に設定するだけです。後で、全てのエンティティの取り外し/破棄、物理オブジェクトの破棄を行うコードを追加します。.

onBackKeyPressed()メソッド内でloadMenuScene()メソッドを実行することで、 GameScene内でメニューシーンへの切り替えを実行します。
```
@Override
public void onBackKeyPressed()
{
    SceneManager.getInstance().loadMenuScene(engine);
}
```

この記事はこれで完了です。これまでの記事に記載された内容を全て実施することで、メニューシーンとゲームシーンを自由に切り替えることができるようになります。現時点はリソース(画像など)をそれほどしていないのでローディングscene は本当に短い時間だけしか表示されませんが、次第に時間がかかってうんざりするようになるでしょう。

2. Moving back from game to menu scene:

Okay, lets assume we are in game scene, we are pressing back button, so we supposed to be moved to the menu scene, since we unloaded menu texture we now have to perform some tasks. Unload game texture, load menu texture, eventually destroy/dispose game scene by destroying/detaching all game scene elements (to make sure there will not be any memory leaks) and display menu scene back, while performing all those tasks, our loading scene will be displayed.

inside our ResourcesManager, create new method responsible for unloading game texture(s) since we did not create any textures for game scene, we will leave it blank for now, and fill later with game textures unloading code.

public void unloadGameTextures()
{
    // TODO (Since we did not create any textures for game scene yet)
}

create method inside SceneManager responsible for loading menu scene and displaying loading scene while performing all mentioned tasks:

public void loadMenuScene(final Engine mEngine)
{
    setScene(loadingScene);
    gameScene.disposeScene();
    ResourcesManager.getInstance().unloadGameTextures();
    mEngine.registerUpdateHandler(new TimerHandler(0.1f, new ITimerCallback() 
    {
        public void onTimePassed(final TimerHandler pTimerHandler) 
        {
            mEngine.unregisterUpdateHandler(pTimerHandler);
            ResourcesManager.getInstance().loadMenuTextures();
            setScene(menuScene);
        }
    }));
}

It handles displaying loading scene while executing unloading game textures code, loading back menu texture and also we execute disposeScene(); method from our game scene, we will put there code responsible for cleaning our game scene, for now put this inside disposeScene() in our GameScene class.

@Override
public void disposeScene()
{
    camera.setHUD(null);
    camera.setCenter(400, 240);

    // TODO code responsible for disposing scene
    // removing all game scene objects.
}

For now we just clear camera`s HUD and set camera`s center position to its default value, later we will add code responsible for detaching/disposing all entities and destroying physical objects.

Execute method responsible for switching back to the menu scene inside your GameScene, by executing this method inside onBackKeyPressed() method.

@Override
public void onBackKeyPressed()
{
    SceneManager.getInstance().loadMenuScene(engine);
}

That`s all in this article, by doing all included in all articles till now, you should be able to switch between menu and game scenes freely. Loading scene will be displayed only for really small period of time, because currently we do not use many resources (graphics etc) but later it will surly takes bit longer.

AndEngineドキュメント日本語訳

Part 10. ゲームシーンを読み込む間、ローディングシーンを表示する:

Part 10. Displaying loading scene while loading game scene:

1. メニューテクスチャの読み込みと読み込み解除:

1. Loading and unloading menu texture(s):

2. ゲームシーンからメニューシーンに戻る:

2. Moving back from game to menu scene:

注意事項

AndEngineドキュメント 日本語訳

Part 10. ゲームシーンを読み込む間、ローディングシーンを表示する:

Part 10. Displaying loading scene while loading game scene:

1. メニューテクスチャの読み込みと読み込み解除:

1. Loading and unloading menu texture(s):

2. ゲームシーンからメニューシーンに戻る:

2. Moving back from game to menu scene:

注意事項

AndEngineドキュメント日本語訳