メインコンテンツまでスキップ

lesson-1_ボスキャラを作成して攻撃のロジックを実装しよう

😈 ボスを作る​

これから、ゲーム内のボス作成していきます。

このゲームのゴールは、ボスを攻撃して、ボスの HP を 0 にすることです。

  • ボスのHPは多く、ボスを攻撃するたびに反撃されるので、NFTキャラクターのHPは減ってしまいます。

  • NFTキャラクターのHPが0になると、ボスを攻撃できなくなり、ゲームオーバーとなります。

  • したがって、ボスを攻撃するためにはほかのプレイヤーが必要です。

  • まず、ボスのデータを格納するための構造体を作り、キャラクターと同じようにデータを初期化しましょう。

  • ボスは、名前、画像、攻撃力、HPを持っています。

ボスは NFT ではありません。

ボスのデータはスマートコントラクトに保存されるだけです。

次のコードをMyEpicGame.solのstruct CharacterAttributesコードブロックの直下に追加しましょう。

struct BigBoss {
  string name;
  string imageURI;
  uint hp;
  uint maxHp;
  uint attackDamage;
}
BigBoss public bigBoss;

ここでは、ボスのデータを整理して保持するための構造体と、ボスを保持するための変数bigBossを作成しています。

次に、ボスを初期化するために、下記のようにMyEpicGame.solを更新していきましょう。

  • constructorの中身を下記のように編集していきます。
constructor(
    string[] memory characterNames,
    string[] memory characterImageURIs,
    uint[] memory characterHp,
    uint[] memory characterAttackDmg,
    // これらの新しい変数は、run.js や deploy.js を介して渡されます。
    string memory bossName,
    string memory bossImageURI,
    uint bossHp,
    uint bossAttackDamage
  ) ERC721('OnePiece', 'ONEPIECE') {
    // ゲームで扱う全てのキャラクターをループ処理で呼び出し、それぞれのキャラクターに付与されるデフォルト値をコントラクトに保存します。
    // 後でNFTを作成する際に使用します。
    for (uint i = 0; i < characterNames.length; i += 1) {
      defaultCharacters.push(
        CharacterAttributes({
          characterIndex: i,
          name: characterNames[i],
          imageURI: characterImageURIs[i],
          hp: characterHp[i],
          maxHp: characterHp[i],
          attackDamage: characterAttackDmg[i]
        })
      );

      CharacterAttributes memory character = defaultCharacters[i];

      //  ハードハットのconsole.log()では、任意の順番で最大4つのパラメータを指定できます。
      // 使用できるパラメータの種類: uint, string, bool, address
      console.log(
        'Done initializing %s w/ HP %s, img %s',
        character.name,
        character.hp,
        character.imageURI
      );
    }

    // 次の NFT が Mint されるときのカウンターをインクリメントします。
    _tokenIds.increment();
    // ボスを初期化します。ボスの情報をグローバル状態変数 "bigBoss"に保存します。
    bigBoss = BigBoss({
      name: bossName,
      imageURI: bossImageURI,
      hp: bossHp,
      maxHp: bossHp,
      attackDamage: bossAttackDamage
    });
    console.log(
      'Done initializing boss %s w/ HP %s, img %s',
      bigBoss.name,
      bigBoss.hp,
      bigBoss.imageURI
    );
  }

最後に、run.jsとdeploy.jsのdeploy部分を以下のように変更して、ボスに渡すパラメータを変更しましょう。

const gameContract = await gameContractFactory.deploy(
  ["ZORO", "NAMI", "USOPP"], // キャラクターの名前
  [
    "https://i.imgur.com/TZEhCTX.png", // キャラクターの画像
    "https://i.imgur.com/WVAaMPA.png",
    "https://i.imgur.com/pCMZeiM.png",
  ],
  [100, 200, 300],
  [100, 50, 25],
  "CROCODILE", // Bossの名前
  "https://i.imgur.com/BehawOh.png", // Bossの画像
  10000, // Bossのhp
  50 // Bossの攻撃力
);

ボスには、クロコダイルの画像を設定しました。

今回のゲームでは、ワンピースのサンプル画像を使用していますが、ぜひオリジナルキャラクターを選んであなただけのゲームを作成してみてください ✨

Imgur を使用して、あなたのボスをセットアップしてください!

あなただけのオリジナルゲームを作りましょう ✨

👾 プレイヤーの NFT キャラクターの属性を取得する。​

これからattackBossという関数を作成して、MyEpicGame.solに追加していきましょう。

  • mintCharacterNFT関数のコードブロック直下に下記を追加してください。
function attackBoss() public {
	// 1. プレイヤーのNFTの状態を取得します。
	uint256 nftTokenIdOfPlayer = nftHolders[msg.sender];
	CharacterAttributes storage player = nftHolderAttributes[nftTokenIdOfPlayer];
	console.log("\nPlayer w/ character %s about to attack. Has %s HP and %s AD", player.name, player.hp, player.attackDamage);
	console.log("Boss %s has %s HP and %s AD", bigBoss.name, bigBoss.hp, bigBoss.attackDamage);

	// 2. プレイヤーのHPが0以上であることを確認する。
	require (
		player.hp > 0,
		"Error: character must have HP to attack boss."
	);
	// 3. ボスのHPが0以上であることを確認する。
	require (
		bigBoss.hp > 0,
		"Error: boss must have HP to attack characters."
	);

	// 4. プレイヤーがボスを攻撃できるようにする。
	if (bigBoss.hp < player.attackDamage) {
		bigBoss.hp = 0;
	} else {
		bigBoss.hp = bigBoss.hp - player.attackDamage;
	}
	// 5. ボスがプレイヤーを攻撃できるようにする。
	if (player.hp < bigBoss.attackDamage) {
		player.hp = 0;
	} else {
		player.hp = player.hp - bigBoss.attackDamage;
	}

	// プレイヤーの攻撃をターミナルに出力する。
	console.log("Player attacked boss. New boss hp: %s", bigBoss.hp);
	// ボスの攻撃をターミナルに出力する。
	console.log("Boss attacked player. New player hp: %s\n", player.hp);
}

追加したコードを、5つの段階に分けて見ていきましょう。

1️⃣ . プレイヤーの NFT の状態を取得する

まず、プレイヤーの NFT キャラクターの状態を取得していきます。

プレイヤーのNFTキャラクターの状態に関するデータはnftHolderAttributesに格納されています。

以前記述した下記のコードを覚えているでしょうか？

// ユーザーのアドレスと NFT の tokenId を紐づける mapping を作成しています。
mapping(address => uint256) public nftHolders;

// ユーザーの tokenId を取得します。
uint256 newItemId = _tokenIds.current();

// NFTの所有者を簡単に確認できるようにします。
nftHolders[msg.sender] = newItemId;

これらの処理により、nftHoldersからユーザーのtokenIdを取得できるようになりました。

下記のコードブロックでは、nftHoldersを使用しています。詳しく見ていきましょう。

function attackBoss() public {
  // 1. プレイヤーのNFTの状態を取得します。
  uint256 nftTokenIdOfPlayer = nftHolders[msg.sender];
  CharacterAttributes storage player = nftHolderAttributes[nftTokenIdOfPlayer];
  console.log("\nPlayer w/ character %s about to attack. Has %s HP and %s AD", player.name, player.hp, player.attackDamage);
  console.log("Boss %s has %s HP and %s AD", bigBoss.name, bigBoss.hp, bigBoss.attackDamage);
}

まず、下記のコードに注目してください。

uint256 nftTokenIdOfPlayer = nftHolders[msg.sender];

ここでは、nftHolders[msg.sender]を使って、プレイヤーが所有するNFTのtokenIdを取得し、nftTokenIdOfPlayerに格納しています。

たとえば、コレクションの3番目のNFTをMintした場合、nftHolders[msg.sender]は3となります!

次に、下記のコードを見ていきましょう。

CharacterAttributes storage player = nftHolderAttributes[nftTokenIdOfPlayer];

ここでは、nftHolderAttributes[nftTokenIdOfPlayer]を使ってプレイヤーの属性を取得しています。

✍️: storageとmemoryについて ここではstorageというデータを保存する際に使用するキーワードを使っています。

一般的に、storageはブロックチェーンにデータを保存するときに使用されるキーワードです。

一方、memoryはコントラクト実行時に一時的にデータを保持するときに使用されます。

例えば、storageと記載してから、player.hp = 0とすると、ブロックチェーン上で NFT キャラクターの HP 値 を0に変更することになります。

これに対して、もしstorageの代わりにmemoryを使用すると、関数のスコープ内に変数のローカルコピーが作成されます。

memoryを使用すれば、player.hp = 0とした場合でも、それは関数の中だけのことであり、ブロックチェーン上のデータが更新されることはありません。

storageとmemoryに関する詳しい説明は、こちら を参照してください。

最後に、下記のコードを見ていきましょう。

console.log(
  "\nPlayer w/ character %s about to attack. Has %s HP and %s AD",
  player.name,
  player.hp,
  player.attackDamage
);
console.log(
  "Boss %s has %s HP and %s AD",
  bigBoss.name,
  bigBoss.hp,
  bigBoss.attackDamage
);

ここでは、下記をターミナルに出力しています。

  • 攻撃を開始するNFTキャラクターの名前(player.name)、HP値(player.hp)、攻撃力(player.attackDamage)をターミナルに出力しています。
  • ボスの名前(bigBoss.name)、HP値(bigBoss.hp)、攻撃力(bigBoss.attackDamage)をターミナルに出力しています。

2️⃣ . プレイヤーの HP が 0 以上であることを確認する

次に、プレイヤーの HP が 0 以上であることを確認していきます。

// 2. プレイヤーのHPが0以上であることを確認する。
require(player.hp > 0, "Error: character must have HP to attack boss.");

ここでは、require関数を使用して、player.hp > 0であることを確認しています。

NFTキャラクターのHPが0である場合は、攻撃できません。

requireはif文のような役割を果たします。ロジックは、下記のようになります。

require(
	player.hp > 0 であれば（true）、コードを進める,
	player.hp > 0 でなければ Error を出力し(false)
	、処理実行前のコントラクトの状態に戻す
);

3️⃣ . ボスの HP が 0 以上であることを確認する

ステップ2と同じように、ボスの HP も 0 以上であることを確認していきます。

// 3. ボスのHPが0以上であることを確認する。
require(bigBoss.hp > 0, "Error: boss must have HP to attack boss.");

ボスのHPが0の場合、NFTキャラクターはボスをこれ以上攻撃することはできません。

⚠️: 注意

VS Code を使用している場合、"Function state mutability can be restricted to view"というwarningが表示されることがあります。

ここでのwarningは基本的に無視して大丈夫です 😊

4️⃣ . プレイヤーがボスを攻撃できるようにする

次に、プレイヤーがボスを攻撃するターンを実装していきます。

// 4. プレイヤーがボスを攻撃できるようにする。
if (bigBoss.hp < player.attackDamage) {
  bigBoss.hp = 0;
} else {
  bigBoss.hp = bigBoss.hp - player.attackDamage;
}

if / else文のロジックは、下記のようになります。

  • if : もし、ボスのHP(bigBoss.hp)がNFTキャラクターの攻撃力(player.attackDamage)を下回っていたら、ボスのHPを0に設定します。

  • else : もし、ボスのHP(bigBoss.hp)が、NFTキャラクターの攻撃力(player.attackDamage)を上回っていたら、ボスのHPを「現在のボスのHP」から「NFTキャラクターの攻撃力」を差し引いた値に更新します。

✍️: uintについて ここで使用されている変数（bigBoss.hpとplayer.attackDamage）は、constructorの中でuintとして定義されています。

uintとは、符号なし整数を意味しており、負の値をとることはできません。

なので、ボスの HP（ bigBoss.hp ）が NFT キャラクターの攻撃力 （ player.attackDamage ）を下回っている場合、bigBoss.hp = 0と直接値を更新しています。

変数を定義する際に、負の数をとることができるintを使用すると、エラーが発生することがあるので、注意しましょう。

OpenZeppelin や Hardhat は、ライブラリの中でintをサポートしていません。 例えば、MyEpicGame.solの中でStrings.toStringを使用していますが、これはuintで定義されている変数にのみ動作します。

また、console.logもintに対応していません。

5️⃣ . ボスがプレイヤーを攻撃できるようにする

// 5. ボスがプレイヤーを攻撃できるようにする。
if (player.hp < bigBoss.attackDamage) {
  player.hp = 0;
} else {
  player.hp = player.hp - bigBoss.attackDamage;
}

ここでは、ステップ4と同じ容量で、ボスがプレイヤーを攻撃する際のロジックを実装しています。

最後に、下記のコードを見ていきましょう。

// プレイヤーの攻撃をターミナルに出力する。
console.log("Player attacked boss. New boss hp: %s", bigBoss.hp);
// ボスの攻撃をターミナルに出力する。
console.log("Boss attacked player. New player hp: %s\n", player.hp);

ここでは、プレイヤーとボスの攻撃をターミナルに出力し、それぞれの現在のHPを表示しています。

🦖 テストを実行する​

run.jsに下記を追加して、attackBoss関数のテストをしてみましょう。

  • attackBoss関数のコードブロックを2回txn = await gameContract.mintCharacterNFT(2)の直下に追加します。
let txn;
txn = await gameContract.mintCharacterNFT(2);
await txn.wait();

// 1回目の攻撃: attackBoss 関数を追加
txn = await gameContract.attackBoss();
await txn.wait();

// 2回目の攻撃: attackBoss 関数を追加
txn = await gameContract.attackBoss();
await txn.wait();

コードを詳しく見ていきましょう。

txn = await gameContract.mintCharacterNFT(2);
await txn.wait();

ここではまず、インデックス2のキャラクターを作成しています。

これはconstructorに渡される配列の3番目のキャラクターです。

  • 私のゲームの場合、3番目のキャラクターは「ウソップ」です。

  • ゲーム内で「ウソップ」が「クロコダイル」を攻撃します。

  • 「ウソップ」はrun.jsを起動した際に、最初にMintされるキャラクターですので、NFTのID ( tokenId ) は、自動的に1になります。

    ⚠️: 通常_tokenIdsは 0 で始まりますが、constructor内で1にインクリメントされるため、tokenIdは1から始まります。

次に、下記のコードを見ていきましょう。

// 1回目の攻撃: attackBoss 関数を追加
txn = await gameContract.attackBoss();
await txn.wait();

// 2回目の攻撃: attackBoss 関数を追加
txn = await gameContract.attackBoss();
await txn.wait();

ここでは、attackBoss()を2回実行しています。

それではターミナル上で下記を実行し、テストを行いましょう。

yarn contract run:script

下記のような結果が出力されていれば、テストは成功です。

Done initializing boss CROCODILE w/ HP 10000, img https://i.imgur.com/BehawOh.png
Done initializing ZORO w/ HP 100, img https://i.imgur.com/TZEhCTX.png
Done initializing NAMI w/ HP 200, img https://i.imgur.com/WVAaMPA.png
Done initializing USOPP w/ HP 300, img https://i.imgur.com/pCMZeiM.png
Contract deployed to: 0x5FbDB2315678afecb367f032d93F642f64180aa3
Minted NFT w/ tokenId 1 and characterIndex 2

Player w/ character USOPP about to attack. Has 300 HP and 25 AD
Boss CROCODILE has 10000 HP and 50 AD
Player attacked boss. New boss hp: 9975
Boss attacked player. New player hp: 250


Player w/ character USOPP about to attack. Has 250 HP and 25 AD
Boss CROCODILE has 9975 HP and 50 AD
Player attacked boss. New boss hp: 9950
Boss attacked player. New player hp: 200

Token URI: data:application/json;base64,eyJuYW1lIjogIlpFTklHQU1FIC0tIE5GVCAjOiAxIiwgImRlc2NyaXB0aW9uIjogIlRoaXMgaXMgYW4gTkZUIHRoYXQgbGV0cyBwZW9wbGUgcGxheSBpbiB0aGUgZ2FtZSBNZXRhdmVyc2UgU2xheWVyISIsICJpbWFnZSI6ICJodHRwczovL2kuaW1ndXIuY29tL2tXMmROQ3MucG5nIiwgImF0dHJpYnV0ZXMiOiBbIHsgInRyYWl0X3R5cGUiOiAiSGVhbHRoIFBvaW50cyIsICJ2YWx1ZSI6IDIwMCwgIm1heF92YWx1ZSI6MzAwfSwgeyAidHJhaXRfdHlwZSI6ICJBdHRhY2sgRGFtYWdlIiwgInZhbHVlIjogMjV9IF19

1回目の攻撃の結果を詳しく見ていきましょう。

Player w/ character USOPP about to attack. Has 300 HP and 25 AD
Boss CROCODILE has 10000 HP and 50 AD
Player attacked boss. New boss hp: 9975
Boss attacked player. New player hp: 250

ここでは、ウソップがクロコダイルを25の攻撃力(AD)で攻撃して、クロコダイルのHPが10000から9975になりました。

そして、クロコダイルはウソップに50の攻撃力(AD)で攻撃し、ウソップのHPは「300」から「250」に減少しました。

次に、2回目の攻撃の結果を確認しましょう。

Player w/ character USOPP about to attack. Has 250 HP and 25 AD
Boss CROCODILE has 9975 HP and 50 AD
Player attacked boss. New boss hp: 9950
Boss attacked player. New player hp: 200

2回目の攻撃では、キャラクターとボスの両方に更新されたHP値が使用されているのがわかります。

これで、attackBoss関数は完成です ✨

ゲームのロジックが完全にブロックチェーンに保存されました。

🙋‍♂️ 質問する​

ここまでの作業で何かわからないことがある場合は、Discordの#ethereumで質問してください。

ヘルプをするときのフローが円滑になるので、エラーレポートには下記の3点を記載してください ✨

1. 質問が関連しているセクション番号とレッスン番号
2. 何をしようとしていたか
3. エラー文をコピー&ペースト
4. エラー画面のスクリーンショット

次のレッスンに進んで、テストネットに更新したコントラクトをデプロイしましょう 🎉