マイクラ(＆Forge#1180)の個人的な解析メモ

# マイクラがWorld内のブロックのデータをどのように取り扱っているかのメモ
## ブロックは、1種類につきゲーム内で1つしか存在しない

- 独自追加したものも含めて、Block（を継承したクラス）はゲーム開始時に1種類1個ずつインスタンスが作成される。
- マイクラ世界の個々のブロックはBlockクラスのインスタンスではなく、マッピングデータ。（そりゃそうだ、万単位のブロックが個別のインスタンスだとPCがチヌ）
    - (イメージ)　座標(1,1,1)と(1,1,2)　にはBlockID3のブロック（1つのインスタンスを指す）が設置されているよ。
    - ```world.getBlock(x,y,z)```、　ワールドの座標をキーにBlockインスタンスを取り出す。取り出したオブジェクトは、同じ種類のブロックなら常に同一のもの。
    - だから、独自ブロックを追加したときに、クラス変数どころか、インスタンス変数も全ブロックで共有されることになる。（要調査：違うワールドではどうなる？）

##上記の内容を検証したサンプルコード

- （基本知識）独自ブロックを追加するためには、Modの初期化メソッド中で最低限、以下を実行する
    1. Blockクラスを継承(extends)した新しいクラスを作成。
    2. new して、そのインスタンスオブジェクトを、一意な名前とともにGameRegistryに登録
- 元とするMaterial(例：rock)を指定することでその性質をそのまま引き継いだブロックができる
    - 独自機能をつけたいなら@Overrride
- 以下のコードでは、説明簡略化のためにテクスチャ関係は省略

```
// このコードだけでは動きません
// 初期化作業として以下が最低でも必要
//  Block blockSample = new BlockSample();  //インスタンス生成
//  GameRegistry.registerBlock(blockSample, "block_sample"); //それをゲームに登録

// import は省略

public class BlockSample extends Block {
    public static Integer varC=0; // クラス変数
    public Integer varI=0; // インスタンス変数

    public BlockSample() {
        super(Material.rock); // 基本的な性質は rockのものを使う
        this.setCreativeTab(CreativeTabs.tabBlock);  //Creativeモードでブロックを取り出すとき、ブロックタブから取り出せるように
    }

    /**
     * Blockクラスにもとからあるメソッドを上書き @Override
     * このメソッドはブロックを右クリックすると呼び出される
     * 本プログラムは右クリックでカウンタの値が増える。ポイントは、ワールド中に設置した全てのブロックでカウンタ（2種類）が共有されていること。
     * なぜならば、どれも同じ BlockSampleインスタンスを参照しているからである。
     * ついでに、サーバー／クライアントでそれぞれ実行されるので、1クリックで2回呼び出されていること、
     * そしてさらに、サーバー／クライアント間でも共通のインスタンスを参照していることがわかる。（←シングルだからです。マルチなら違うはず）
     */
    @Override
    public boolean onBlockActivated(World world, int blockX, int blockY, int blockZ, EntityPlayer player, int hitSide, float par7, float par8, float par9) {
        BlockSample.varC++;
        this.varI++;
        System.out.println("BlockSample.onBlockActivated"+world);
        System.out.println(this.toString());  // 参照しているオブジェクトの情報表示
        System.out.println("Class var: "+BlockSample.varG);  // こちらが共通なのは当然といえば当然の結果
        System.out.println("Instance var: "+this.varI); // 問題はこちら
        return super.onBlockActivated(world, blockX, blockY, blockZ, player, hitSide, par7, par8, par9);
    }
}
```

## （補足）　サーバー/クライアントごとのコードの書き分けについて

- 基本的な考え方は以下を参照。
    - http://minecraftjp.info/modding/index.php/%E6%96%B0%E3%81%97%E3%81%84%E3%82%B3%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E8%A8%98%E6%B3%95%E3%81%A8Universal_Modding
- なお、@SideOnly(Sides.CLIENT)アノテーションは、シングル環境ではうまく働かない模様。
    - ```if (!world.isRemote){}```による書き分けが必要？
        - 情報源。　http://forum.minecraftuser.jp/viewtopic.php?f=39&t=18801
    -  サーバークライアント間での同期、通信方法については要調査。

# ブロックごとに個別の情報を格納したいときにどうするか
## 小さなデータはMetaDataで

- 小さなデータならMetaData（メタ値）、複雑なデータはTileEntityを使う。
- 小さなデータなら、メタ値として情報を格納できる。たぶん容量は4bit（10進数で0-15）。
    - ```world.getBlockMetadata(x,y,z)```　、座標をキーにメタ値取り出し。「ブロックをキー」にではないところに注意。
- メタ値によって表示するテクスチャを変えることで、違うブロックのように見せかけることが可能。羊毛とかね。あとは原木の向きとか
    - ブロックが返すテクスチャ切り替えるには、Blockを継承したクラスで、以下のメソッドを@Override　すればいいのかな？（要調査）
        - ```public IIcon getIcon(){};```

## より大きなデータはTileEntityで

TileEntity　はゲーム内でどのように取り扱われているか

- たとえば個別にインベントリを持つブロックなどは、各ブロックごとに大量のデータを保持しなくてはならない。
- あるBlockがTileEntityを持つとあらかじめ宣言（手順は後述）しておくことで、ワールドにブロックを設置するごとに、新しいTileEntityインスタンス生成＆保存
- イメージとしては、個別ブロックとTileEntityが直接結び付けられているようだが、実装としては、World座標ベースで保存＆管理されている。以下は根拠。
    - ```world.getTileEntity(x,y,z)``` : 座標をキーに個別のEntityを取り出し。「ブロックをキー」にではないところに注意。

#　TileEntityをブロックと結びつける方法
## 最低限の手順

- TileEntityの用意
    1. TileEntityクラスを継承した独自のTileEntityクラスを作っておく
        - ```public class TileEntitySample extends TileEntity{}```
        - この中で独自機能や独自変数を定義しておく
    2. GameRegistoryに一意な名前と一緒に追加して、これはTileEntityなんだよということをシステムに知らせる
        - ```GameRegistry.registerTileEntity(TileEntitySample.class, "TileEntitySample");```
        - ブロックの追加とは異なり```TileEntitySample.class```というクラスそのものを追加していることに注意。
- Block側の用意
    1. Blockクラスではなくそれを拡張したBlockContainerクラスを使って、新しいBlockを定義
    2. BlockContainerクラスの中で、createnewTileEntityメソッドを@Overrideする。その中で結び付けたいTileEntityをnewして返すようにする。
        - ```public TileEntity createNewTileEntity(World world, int param) { return new TileEntitySample() }```

これらの手順を踏むことで、システムは、ワールドにブロックが設置されるたびにそのBlockのcreateNewTileEntity()メソッドを呼び出し、
新しいTileEntityオブジェクトを得て、それをワールドデータに（位置座標をキーに）保存する。

- （要検討事項）
    - createNewTileEntity()の2番目のint paramは何が入ってくるのか謎。
    - たぶんこの値によって、呼び出すTileEntityを変えるよう実装できるのかな？

## 以下、知らなくても別にいいけれど、知っておくと得した気分になれる情報
- マイクラソースコード中では、BlockContainerは以下のように定義されている
    - ```public abstract class BlockContainer extends Block implements ITileEntityProvider{}```
- ITileEntityProvider インタフェースは、```TileEntity createNewTileEntity(World world, int param)```だけが定義されている
- つまり、TileEntityを取り扱うブロックは、原則としてBlockContainerクラスを使わなくてはならない（もちろんこのProviderインタフェースを独自実装したなら話は別）。

# 今回のまとめ

- ブロックの実体そのものは、ゲーム内で1種類あたり1個しか存在しない
    - ゲーム内で特定の座標に設置されたブロックが何であるかという情報は、Worldごとに、座標をキーとしたマッピングデータで保存されている
    - ```world.getBlock(x,y,z)``` でそのブロックの実体を参照できる。
- ブロックの実体は1種類あたり1個しか存在しないので、座標が違っても種類が同じなら、結局指すものは同じもの。
- そのため、ワールドに設置したブロック1つずつに独自情報を保存するためには別の手段が必要


- 手段１：　MetaData（メタ値）によって小さなデータ保存(4bitかな？10進数で言う0-15)
    - 原木の向きや羊毛の色などはこの値によって管理されている
    - 独自データは、ブロックではなく、座標に結び付けられて保存されていることに注意。
    - ```world.getBlockMetaData(x,y,z)```　でその「座標」のメタデータを入手できる。
    - もし、ブロックマッピングデータとMetaDataマッピングデータに齟齬がでたら・・・ガクブル
- 手段２:　EntityDataによって様々なデータを保存
    - 内部インベントリを持つブロックなど、大量のデータを保存するときはこちらの手段を使う。
    - ``world.getTileEntity(x,y,z)``` 「座標」をキーに個別のEntityオブジェクトを入手できる。
    - もし、ブロックマッピングデータと(略

# 感想（というか妄想みたいなもの）

きっと、最初期のマイクラはデータ保存の方法としてBlockマッピングデータとMetaDataマッピングデータしか用意していなかったんじゃないかな？

そしてバージョンアップするうちに、これじゃ領域が足りん！ということで、後付でTileEntityという保存手段を実装したんじゃないかな？

# 次に何を調べるかまとめるか

- マイクラ世界に存在するブロックとは別のオブジェクトであるEntity。それがどのようにデータ管理されているのか、そしてどうやってEntityを追加するのか。
- マルチプレイヤー環境に対応できるMOD作成のために、
    - サーバー・クライアントでどのように処理を分けるのか。ロジック面と実装面の両方について。
    - もちろん具体的な実装方法も。サーバークライアント間の同期をどのように行うのかについても調べる。
- 直方体のブロックにテクスチャを貼るだけではなく、独自レンダリングをどうやって行うのか。噂に聞くと、内容理解は相当ハードらしい。