show() メソッドは、画面切り替え開始時に1度だけ呼ばれます。 hide() メソッドは、画面切り替え終了時に1度だけ呼ばれます。 画面切り替え時とは、 Game#setScreen() メソッド呼び出した時のことです。

例えば現在「メニュー画面」を表示していた場合、「ゲーム画面」に切り替えたくなったら、 下記のようなコードを実行します。

game.setScreen(new GameScreen(this));

この setScreen() メソッドの中で、 現在表示中の「メニュー画面」の MainMenu#hide() メソッドが呼ばれ、 次に表示予定の「ゲーム画面」の GameScreen#show() メソッドが呼ばれます。

Game#setScreen() のソースコードです。短かいので全部載せておきます。

    public void setScreen (Screen screen) {
        if (this.screen != null) this.screen.hide();
        this.screen = screen;
        if (this.screen != null) {
            this.screen.show();
            this.screen.resize(Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
        }
    }

setScreen() した時は、hide,show,resizeが即実行されるということを 頭に叩きこんでおいたほうが良さそうですね。

1. 現在の画面の Screen#hide()
2. 次の画面の Screen#show()
3. 次の画面の Screen#resize()

以上から、 show() メソッドは初期化処理、 hide() メソッドは終了処理を実装すれば良いと思います。

ただし、 hide() メソッドには、リソース解放処理を記述してはいけません。 リソース解放処理とは、 Texture#dipose() や、 SpriteBatch#dispose() などのことです。 理由は後述します。

dispose() メソッドには、注意すべき重要なことがあります。 それは何かというと、 Screen#dispose() はシステムから自動的に呼びだされないということです。 ApplicationListener#dispose() とは扱いが違いますね。

APIマニュアルにも記述されています。

Screens are not disposed automatically. 
You must handle whether you want to keep 
screens around or dispose of them when another screen is set.

• https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/Game.html

ゲームによって、リソースの解放タイミングは様々なので、 このようにクライアントまかせになっているのかもしれません。 (そうすると、Screenインタフェイスを使わずに全部自分で作ったほうがいいんじゃないかという気もしてきますが。)

ということで、 dispose() は自分で呼びだす必要があります。

AplicationLisner 利用時は、特になにも考えずに ApplicationListener#dispose() にリソース解放処理を記述しておけばよかったのですが、 Screen を利用する場合は、 解放のタイミングを自分で制御しなくてはなりません。

例えば、下記のように Screen#render() メソッドから setScreen() メソッドを呼びだすとします。

public void render (float deltaTime) {
       : 
    game.setScreen(new MainMenuScreen(game));
       : 
    leftButton.draw(batch);
       : 
}

このとき、現在実行中の Screen インスタンスの hide() メソッドが呼ばれます。 hide() メソッドは下記のようにテクスチャの開放処理を実装していたとします。

public void hide() {
    img.dispose();
}

結論をいうとこの書き方ではうまくいきません。 なぜなら、 hide() でテクスチャを解放したにもかかわらず、 その後に、テクスチャの描画処理を呼んでしまっているからです。

hide() にリソースの解放処理を入れるならば、 redner() メソッドを下記のように 書かなければなりません。

public void render (float deltaTime) {
       : 
       : 
    leftButton.draw(batch);
       : 
    game.setScreen(new MainMenuScreen(game));
    // ここには何も処理を書かない。
}

つまり、 setScreen() を render() の一番最後に持ってこなければなりません。 しかしながら、最後に呼びだすなどのルールは忘れやすそうですし、 強制性がないので個人的にはお勧めしません。

扱うリソースが少ないシンプルなゲームの場合に利用できる方法です。

Game#create() でそのゲームの全リソースをロードし、 Game#dispose() で全リソースを解放します。 Screen クラスでは、リソース管理を一切しません。 (スクリーンからこれらのリソースにアクセスするには、 Game のインスンタンス経由でアクセスします)。

こうすれば、 Screen 毎にリソースの管理を気にせずにすむので楽ですね。

今回採用した方法です。その1の方法を改良しました。

Gameクラスを継承したクラスを少し改造します。

public class LibGdxSample extends Game {
    private Screen nextScreen;
        :
    @Override
    public void render() {
        super.render();
        if (nextScreen != null) {
            super.setScreen(nextScreen);
            nextScreen = null;
        }
    }
        :
    @Override
    public void setScreen (Screen screen) {
        Gdx.app.log(LOG_TAG, "setScreen");
        nextScreen = screen;
    }
        :
}

まず、 nextScreen というフィールドを新設します。 そして setScreen メソッドをオーバライドし、 nextScreen フィールドに screen をセットするだけの処理にします。 更に render() メソッドの最後で、 nextScreen フィールドがセットされたときのみ setScreen() を呼びだすようにします。

このような仕組みを持つことで、 game.setScreen() をいつでも呼びだすことが可能になります。 なぜなら、 Screen#hide() の呼びだされるタイミングが必ず render() の一番最後になるからです。

以上で、 Screen#hide() の実行されるタイミングに気を使うことなく、 dispose() 処理を実装できるようになりました。

後は次のように、 hide() から dispose() 処理を呼びだせば良いですね。

    @Override
    public void hide() {
        dispose();
    }

    @Override
    public void dispose() {
        music.dispose();
        seGet.dispose();
        seMiss.dispose();
        batch.dispose();
        font.dispose();
        img.dispose();
        bgImg.dispose();
        shapeRenderer.dispose();
    }

最後に注意というか知っていたほうが良い知識として、 Screen#hide() は、 Game#dispose() からも自動で呼びだされるということを述べておきます。

public abstract class Game implements ApplicationListener {
     :
	public void dispose () {
		if (screen != null) screen.hide();
	}
     :
}

なので、 Game#dispose() 内でわざわざ自分で Screen#dispose() を呼びだす必要はありません。

    public void dispose() {
        super.dispose();
        Screen screen = getScreen();
        if (screen != null) screen.dispose();
    }

今回は、ソースコードが4ファイルになってしまったため、githubに載せることにしました。

• https://github.com/zarudama/fishcatch

思いのほかコード量が多くなってしまったのが反省点です。 いろいろ工夫の余地はあると思うので、今後改善していきたいと思います。

今回実装したゲームのアセットファイルは数えるほどしかありませんので、 画像やサウンドの読み込みは、単純に読み込むだけでした。

ゲームの種類によっては、沢山のアセットを駆使しなければならない場合もあるでしょう。 そんなときは、libGDXの AssetManager クラスを使うのが良さそうです。

• https://libgdx.com/wiki/managing-your-assets

非同期読み込みや依存管理、キャッシュの管理など便利な機能を多く実装しているようですね。 Screen 利用時の解放処理の煩雑さも、このクラスを利用すれば解決するのかもしれません。