RPGツクールMVのプラグインでアイテム情報を取得する方法

この記事では、RPGツクールMVのプラグインからアイテム（武器・防具）の情報を取得する方法を紹介します。

RPGツクールMVのアイテムの情報は、グローバル変数に配列として格納されています。

配列の中身は、アイテム・武器・防具それぞれのオブジェクトになっています。

オブジェクトは特定のものについて情報と処理を集めたものです。

アイテムオブジェクトだったら、アイテム名や価格などの情報があつまっています。

オブジェクトの情報はプロパティに格納されており、オブジェクト.プロパティ名で取得することができます。

    var item = $dataItems[1];   // データベースから1番のアイテムを取得
    var itemName = item.name;   // nameプロパティからアイテム名を取得

アイテムの情報を取得するには、オブジェクトにどんなプロパティがあるかを知っておかなければいけません。

そこで、アイテムオブジェクト、武器オブジェクト、防具オブジェクトにどんなプロパティがあるかをまとめました。

プロパティのほとんどがデータベース→アイテム（武器・防具）から設定できる項目と対応しているので、わりとわかりやすいんじゃないでしょうか。

ちなみに、オブジェクトのプロパティに別のオブジェクトが入っている場合もあります。

アイテムオブジェクトのdamageプロパティにはダメージオブジェクト、effectsプロパティは配列にエフェクトオブジェクトが入っています。

プロパティ名をピリオドでつなげることで、入れ子になっているオブジェクトのプロパティを取得できます。

アイテムオブジェクトにのdamegeプロパティに入っているダメージオブジェクトから属性IDを取得するには、 item.damage.elementId となります。

アイテム関連のオブジェクト

アイテムオブジェクトのプロパティ

ダメージオブジェクトのプロパティ

アイテムオブジェクトのdamageプロパティに代入されているオブジェクトです。

エフェクトオブジェクトのプロパティ

アイテムオブジェクトのeffectsプロパティに代入されているオブジェクトです。

武器・防具関連のオブジェクト

武器オブジェクトのプロパティ

防具オブジェクトのプロパティ

特徴オブジェクトのプロパティ

武器・防具のtraitsプロパティに代入されているオブジェクトです。

各種IDまとめ

ノートタグ(metaプロパティ)を使って独自の項目を設定する

アイテムや武器、防具は設定できる項目が決まっていますが、ゲームによってはオリジナルの項目を設定したいこともあるかと思います。

アイテムに独自の項目を設定するには、アイテム（武器、防具）のメモ欄にノートタグを書きます。

<タグ名:値>

ノートタグの値は文字列でも、クォーテーションで囲む必要はありません。

設定したノートタグの値は、アイテム（武器、防具）オブジェクトのmetaプロパティから取得できます。

metaプロパティの値はオブジェクトで、ノートタグと同じ名前のプロパティを持っています。

アイテムID1番のメモ欄に<MyItemProp:テスト> と書くと、metaプロパティのオブジェクトにMyItemPropというプロパティができ、値にテストという文字が入っているということです。

あとは変数に取得するなりして使えばよいです。

    var content = $dataItems[1].meta['MyItemProp'];

ノートタグを使う時の注意点

ほかのプラグインとかぶらない名前をつける

プラグインは全体を関数化することで変数をローカル化することができましたが、ノートタグはローカル化できません。

そのため、ノートタグ名にプラグインの頭文字をつけるなどして、ほかのプラグインとノートタグ名がかぶらないようにする必要があります。

<MyPluginContent:テスト>

<content:テスト>

値が数値の場合は、数値に変換する

ノートタグの値は文字列として代入されています。

ノートタグの値に数値を入れて計算をする場合は、ノートタグの値をNumberオブジェクトで数値に変換する必要があります。

（例）アイテムID1番のメモ欄に

<MyItemProp:1>

と入れ、MyItemPropの値に1を足す場合：

    var content = Number($dataItems[1].meta['MyItemProp']) + 1;  // -> 2

数値変換をしないでそのまま1を足してしまうと、数値の足し算ではなく、文字列の連結として扱われてしまいます。

そのため1という文字と1という文字をつなげて「11」という文字ができてしまいます。

    var content = $dataItems[1].meta['MyItemProp'] + 1;        // -> 11