キャラクターの移動 - DXライブラリ

#準備
　下準備に関してはここでは触れる予定はないので***[DXライブラリ置き場](http://dxlib.o.oo7.jp/use/dxuse_vscom2017.html)***を参考にDXライブラリの導入とプロジェクトの設定までは行っておいてください。

#開発内容
　今回はウィンドウ上でキャラクターを動かすプログラムを紹介したいと思います。大まかな流れとしては

　　　①ウィンドウの生成
　　　　　↓
　　　②キャラクターの描画
　　　　　↓
　　　③キー入力判定の作成
　　　　　↓
　　　④キー入力に従ったキャラクターの移動
　　　　　↓
　　　⑤画面端の処理（今回は壁として判定）

　　　⑥ちょっとした小技の紹介

　といった流れになります。

#①ウィンドウの生成
　ウィンドウの生成はDXライブラリがほぼ自動で行ってくれます。自力でするとウィンドウプロシージャとか面倒なんですけどね...。

```c++
#include "DxLib.h"

int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
{
    if (DxLib_Init() == -1)     // DxLibの初期化
        return 0;

    DxLib_End();                // DxLibの終了
    return 0;
}

```
　普段の開発では`int main(void)`ですがウィンドウを作るとき(GUI)は`int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)`となります。たったこれだけでウィンドウが表示されます。
　ここでまだ説明していない`if (DxLib_Init() == -1)`と`DxLib_End()`というのが出てきました。説明はしませんがDXライブラリを使うときの***お約束***と覚えておきましょう。

###ちょっとオリジナリティを出してみよう
　このままでも使えるのですが画面のサイズとか背景色くらいは自分で設定したいですよね。ということで少しコードを追加してみます。

```C++
#include "DxLib.h"

int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
{
    ChangeWindowMode(TRUE);                 // ウィンドウモードで起動
    SetWindowSize(640, 480);                // ウィンドウサイズ設定
    SetBackgroundColor(255, 255, 255);      // 背景色設定

    if (DxLib_Init() == -1)     // DxLibの初期化
        return 0;

    DxLib_End();
    return 0;
}
```
　これらの処理をDXライブラリの初期化前に行うことで設定の反映されたウィンドウが生成されます。初期化後に行った場合、デフォルト設定のウィンドウが生成されてから設定が変更されるため、画面にちらつきが発生してしまいます。
※関数によっては初期化前だと実行できないものや正しく動作しないものがあるので、確認した上で設計しましょう。

#②キャラクターの描画
　今回は頑張って？作ったこのイラストを使っていきたいと思います。サイズは32×32です。
![charcter.png](https://qiita-image-store.s3.amazonaws.com/0/312202/48e30314-dfe3-2977-9b0d-8e7d7c7b500d.png)
背景はすでに透過してあるのでたぶん大丈夫だと思います。丸も満足にかけなくて情けない...。

```
    int charcterImage = LoadGraph("charcter.png");	// 画像の読み込み
	DrawGraph(0, 0, charcterImage, TRUE);			// 画像の描画

	WaitKey();		// キーを押すまで処理待ち
```
　これを`if (DxLib_Init() == -1)`から`DxLib_End()`の間に記述してください。実行して下の画像のようになっていれば成功です。
![image.png](https://qiita-image-store.s3.amazonaws.com/0/312202/bd978859-896e-192b-97a0-2270ea8c55c3.png)

#③キー入力判定の作成
　キー入力も本来ならイベントハンドラやあれやこれやと面倒なのですがそこはDXライブラリがしっかりとサポートしてくれています。
　`int GetHitKeyStateAll(char* KeyStateArray)`という関数が用意されています。

| キー       | キーコード      |
|:-----------|:---------------|
|ESC　　　　　|KEY_INPUT_ESCAPE|
|十字キー右   |KEY_INPUT_RIGHT |
|十字キー左   |KEY_INPUT_LEFT  |
|十字キー上   |KEY_INPUT_UP    |
|十字キー下   |KEY_INPUT_DOWN  |

　キーコードは上表のようにDXライブラリ内で定義されています。表には今回使うコードしか載せていませんので興味がある方はDXライブラリの[リファレンスページ](http://dxlib.o.oo7.jp/dxfunc.html)で検索してみてください。

　では実際にコードを書く前にまたしても注意事項があります。DXライブラリで無限ループを作る際は`int ProcessMessage()`という関数を定期的に呼び出す必要があります。エラーが起きなければ戻り値は０なので一般的に

```C
while (!ProcessMessage()) {
    // ここに処理を記述
}
```
このように無限ループを作ります。正常時は０が戻ってきますので`while (!0)`と同じとなり、`while (1)`と同義になります。
　これに関しても詳しい説明は省くのでとりあえず***無限ループのお約束***と覚えておきましょう。

#④キー入力に従ったキャラクターの移動
　処理の流れは単純で「貼る→隠す→貼る」をひたすら繰り返すだけです。
　では実際にコードを記述していきます（今回は同時押しはできないことにします）。

```C
    char keyState[256];								// キー情報格納用変数
	GetHitKeyStateAll(keyState);					// キー入力情報取得

	while (!ProcessMessage() && !keyState[KEY_INPUT_ESCAPE]) {
		GetHitKeyStateAll(keyState);
        drawX = x, drawY = y;
		if (keyState[KEY_INPUT_RIGHT])
			x += 2;	// 塗りつぶしX座標, 塗りつぶしY座標, 移動量
		else if (keyState[KEY_INPUT_LEFT])
			x -= 2;
		else if (keyState[KEY_INPUT_DOWN])
			y += 2;
		else if (keyState[KEY_INPUT_UP])
			y -= 2;

		if (CheckHitKeyAll()) {
			DrawBox(drawX, drawY, drawX + 32, drawY + 32, GetColor(0, 0, 0), TRUE); // 周辺の塗りつぶし
			DrawGraph(x, y, charcterImage, TRUE);
			Sleep(20);								// 移動のスピード調整
		}
	}
```
　`GetHitKeyStateAll(keyState);`ではchar型配列keyStateに全キーの入力状態を格納しています。keyStateは256個の要素を持つ配列でなくてはなりません。

| 値 | 状態 |
|:--:|:----:|
| ０ |未入力|
| １ |入力の瞬間|
| ２ |入力している|
　例えばESCキーの状態にアクセスするなら`keyState[KEY_INPUT_ESCAPE]`にアクセスすれば上表のいずれかの値が格納されています。あとは入力されているかどうかは`if (keyState[KEY_INPUT_ESCAPE])`で、入力の瞬間は`if (keyState[KEY_INPUT_ESCAPE] == 1)`で、未入力なら`if (!keyState[KEY_INPUT_ESCAPE])`で確認できます。


　`DrawBox(drawX, drawY, drawX + 32, drawY + 32, GetColor(0, 0, 0), TRUE);`は四角を描画する関数です。画像を移動して再描画する際に前の画像を消さないと再描画した画像と重なってしまいます。
（例）
1. 画用紙にシールを貼る
2. 貼ったシールをはがすか上から新しい紙を貼って隠す
3. 新しいシールを貼る

この3ステップでキャラクターを動かしています。DrawBox関数は2のステップの「新しい紙を貼って隠す」処理を行っています。はがす処理なら`ClearDrawScreen();`の鶴の一声で終わるのですがアニメーションとして見せるには時間がかかりすぎてしまいます。ほんの1割に満たない範囲を処理するのにすべてを対象にするのは無駄が多いので今回はDrawBox関数を使用しています。ちなみにマップチップを使ってマップを描画した際はこれの応用でマップチップのIDを割り出してその部分のチップを再描画することで対処します。

　`Sleep(20);`はただの処理待ちです。これを付けずに実行すると一瞬キーを押しただけで画面から消えてしまうのでそれを避けるため少し待っても押されているようならユーザーが連続の処理を望んでいるとして再度処理を行うといった流れになってます。

#⑤画面端の処理
　画面端を壁と同義であるとした場合の処理について学んでいきます。その処理の仕方には大きく2種類あります。（実際にはもう少しありますが）

1. 座標を操作してエラーチェックを行い、エラー値なら元に戻す
2. 仮座標に現座標をコピーして仮座標で計算して正常値なら現座標にコピーする

　まぁどっちもどっちなんですが現座標がエラー値になることがない2番の方法で実装していきます。それに伴って処理の順番等を入れ替えているのでコード全体を載せておきたいと思います。

```C
#include "DxLib.h"

int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
{
	ChangeWindowMode(TRUE);                 // ウィンドウモードで起動
	SetWindowSize(640, 480);                // ウィンドウサイズ設定
	SetBackgroundColor(0, 0, 0);			// 背景色設定（DxLibはデフォルトで黒だがあえて）

	if (DxLib_Init() == -1)					// DxLibの初期化
		return 0;

	int charcterImage = LoadGraph("charcter.png");	// 画像の読み込み

	int x = 0, y = 0;								// 画像の現座標
	int virtualX = x, virtualY = y;					// 画像の仮座標
	int drawX = x, drawY = y;						// 塗りつぶし用座標

	DrawGraph(x, y, charcterImage, TRUE);			// 画像の描画

	char keyState[256];								// キー情報格納用変数
	GetHitKeyStateAll(keyState);					// キー入力情報取得

	while (!ProcessMessage() && !keyState[KEY_INPUT_ESCAPE]) {
		GetHitKeyStateAll(keyState);
		if (keyState[KEY_INPUT_RIGHT])
			virtualX += 2;	// 移動量
		else if (keyState[KEY_INPUT_LEFT])
			virtualX -= 2;
		else if (keyState[KEY_INPUT_DOWN])
			virtualY += 2;
		else if (keyState[KEY_INPUT_UP])
			virtualY -= 2;

		if (!((virtualX <= (640 - 32)) && (virtualX >= 0) && (virtualY <= (480 - 32)) && (virtualY >= 0))) {
			virtualX = x;
			virtualY = y;
			continue;
		}

		drawX = x, drawY = y;
		x = virtualX, y = virtualY;

		if (CheckHitKeyAll()) {
			DrawBox(drawX, drawY, drawX + 32, drawY + 32, GetColor(0, 0, 0), TRUE); // 周辺の塗りつぶし
			DrawGraph(x, y, charcterImage, TRUE);
			Sleep(20);								// 移動のスピード調整
		}
	}

	DxLib_End();
	return 0;
}
```
　`if (!((virtualX <= (640 - 32)) && (virtualX >= 0) &&.....))`は4つの条件のうち1つでも満たされていなければ仮計算に使用した変数をリセットしてループの最初に戻っているだけです。範囲指定はシューティングの当たり判定と同じ方法で行っているので気になる人は調べてみてくださいね。

#ちょっとした小技の紹介
　先ほどのプログラムでも動作としては問題ないのですが描画に時間がかかりいわゆる「ちらつき」が発生してしまいます。このままでは見た目が悪いので修正したいと思います。
　今は1枚の画用紙で「貼る→隠す→貼る」という処理をしているのでユーザーには間の隠す処理がちらつきとして違和感を与えています。そこで先に「隠す→貼る」の処理を行った透明のフィルムを作り、それを画用紙に重ねることで一度の処理で「隠して貼る」となり画面が更新されたように見せることができます。

```c
    if (DxLib_Init() == -1)
        return 0;

    SetDrawScreen(DX_SCREEN_BACK);
```
　DXライブラリを初期化したあと`SetDrawScreen()`を呼び出すことで描画先を裏画面とよばれる先の透明なフィルムに変更することができます。しかし、フィルムに書いてもユーザーに見えなくては意味がありません。そこで`ScreenFlip()`を呼び出します。これがフィルムを画用紙に重ねる処理にあたります。使い方としてはScreenFlip()からScreenFlip()の間の描画内容を表示します。

```c
    if (DxLib_Init() == -1)
        return 0;

    int x = 0, y = 0;
    
    SetDrawScreen(DX_SCREEN_BACK);
    while (!ProcessMessage && !CheckHitKey(KEY_INPUT_ESCAPE)) {
        DrawBox(x, y, x + 32, y + 32, GetColor(0,0,0), TRUE);
        ScreenFlip();
        x += 64, y += 64;
        //Sleep(20);
    }
```
　32×32の黒い箱を斜めに描き続けるプログラムですね。もし変化がわかりにくければ一番下のコメントアウトを外すとわかりやすくなるので試してみてください。

#最後に
　今回はキー判定とアニメーションを組み合わせてキャラクターが移動するプログラムを作成しました。もしゲーム等で使用する際はSleep関数を無作為に使うのではなくFPSを計算したうえで誤差修正で使うにとどめるようにしましょう。
　最後までお読みいただきありがとうございました。