「Forge式コンフィグファイルの利用」を編集中

{{前提MOD|reqmod="Minecraft Forge4.3x"}}

==Forge式コンフィグファイルの利用==
[[無機能アイテムの追加]]と[[無機能ブロックの追加]]ではアイテムIDとブロックIDは変更不可能だった. そこでModLoaderのMLPropよりも柔軟な(ただし複雑な)コンフィグファイルを利用する.
なお, 上記2つのコードで説明した箇所は説明を省いている.

ソースコード
*ConfigSampleCore.java
<source lang = "java">
package mods.configsample;

import java.util.logging.Level;

import net.minecraft.src.*;

import net.minecraftforge.common.Configuration;
import net.minecraftforge.common.Property;

import cpw.mods.fml.common.FMLLog;
import cpw.mods.fml.common.Mod;
import cpw.mods.fml.common.network.NetworkMod;

import cpw.mods.fml.common.event.FMLInitializationEvent;
import cpw.mods.fml.common.event.FMLPreInitializationEvent;

import cpw.mods.fml.common.registry.GameRegistry;
import cpw.mods.fml.common.registry.LanguageRegistry;

import mods.itemsample.ItemSample;
import mods.blocksample.BlockSample;

@Mod(
	modid = "ConfigSampleMod",
	name  = "Config Sample Mod",
	version = "1.0.0"
)
@NetworkMod(
	clientSideRequired = true,
	serverSideRequired = false
)
public class ConfigSampleCore
{
	public static Block blockSample;
	public static Item  itemSample;
	
	public int blockIdSample;
	public int itemIdSample;
	
	@Mod.PreInit
	public void preInit(FMLPreInitializationEvent event)
	{
		Configuration cfg = new Configuration(event.getSuggestedConfigurationFile());
		try
		{
			cfg.load();
			Property blockProp = cfg.getBlock("ConfigSampleBlock", 1301);
			Property itemProp  = cfg.getItem("ConfigSampleItem", 4001);
			blockProp.comment  = "This comment is Block Property";
			itemProp.comment   = "This comment is Item Property";
			blockIdSample = blockProp.getInt();
			itemIdSample  = itemProp.getInt();
		}
		catch (Exception e)
		{
			FMLLog.log(Level.SEVERE, e, "Error Message");
		}
		finally
		{
			cfg.save();
		}
	}
	
	@Mod.Init
	public void init(FMLInitializationEvent event)
	{
		blockSample = (new BlockSample(blockIdSample, 4)).setBlockName("configsampleblock").setCreativeTab(CreativeTabs.tabBlock);
		itemSample  = (new ItemSample(itemIdSample)).setIconCoord(10, 0).setItemName("configsampleitem").setCreativeTab(CreativeTabs.tabMaterials);
		
		GameRegistry.registerBlock(blockSample);
		
		LanguageRegistry.addName(blockSample, "Config Sample Block");
		LanguageRegistry.instance().addNameForObject(blockSample, "ja_JP", "コンフィグサンプルブロック");
		
		LanguageRegistry.addName(itemSample, "Config Sample Item");
		LanguageRegistry.instance().addNameForObject(itemSample, "ja_JP", "コンフィグサンプルアイテム");
		
		GameRegistry.addShapelessRecipe(
			new ItemStack(itemSample, 1),
				new Object[]
				{
					Block.dirt, Block.dirt, Block.dirt
				});
				
		GameRegistry.addShapelessRecipe(
			new ItemStack(blockSample, 1),
				new Object[]
				{
					Block.dirt, Block.dirt, Block.dirt, Block.dirt
				});
	}
}
</source>

==解説==
===package, import===
<source lang = "java">
import java.util.logging.Level;
</source>
:後述のFMLLogで利用するクラス.
<br/>

<source lang = "java">
import net.minecraftforge.common.Configuration;
import net.minecraftforge.common.Property;
</source>
:Forge式コンフィグファイルの機能を提供するAPI. コンフィグ自体はConfigurationクラスが行い, Propertyクラスは設定項目のコメントや実体を扱う.
<br/>

<source lang = "java">
import cpw.mods.fml.common.FMLLog;
</source>
:FML(ForgeModLoader)が提供するログ表示用API. 開発環境でのプロンプト画面に表示される他, 実行ログにも記録されるようになる.
<br/>

<source lang = "java">
import cpw.mods.fml.common.event.FMLPreInitializationEvent;
</source>
:ModLoaderにはなかった前処理(pre init)を行うためのイベント. 基本的な使い方はFMLInitializationEventと同じ.
<br/>

<source lang = "java">
import mods.itemsample.ItemSample;
import mods.blocksample.BlockSample;
</soruce>
:以前解説したItemSampleクラスとBlockSampleクラスを利用するため, インポートする. 同パッケージ内で作成している場合, このimport文は不要.
<br/>

===ConfigSampleCoreクラスのpreInitメソッド===
<source lang = "java">
@Mod.PreInit
public void preInit(FMLPreInitializationEvent event)
{
	Configuration cfg = new Configuration(event.getSuggestedConfigurationFile());
	try
	{
		cfg.load();
		Property blockProp = cfg.getBlock("ConfigSampleBlock", 1301);
		Property itemProp  = cfg.getItem("ConfigSampleItem", 4001);
		blockProp.comment  = "This comment is Block Property";
		itemProp.comment   = "This comment is Item Property";
		blockIdSample = blockProp.getInt();
		itemIdSample  = itemProp.getInt();
	}
	catch (Exception e)
	{
		FMLLog.log(Level.SEVERE, e, "Error Message");
	}
	finally
	{
		cfg.save();
	}
}
</source>
@Mod.Initと同様に, @Mod.PreInitアノテーションを付与し, 引数にFMLPreInitializationEventを指定すると前処理専用のメソッドとなる. 基本的にはコンフィグファイルの生成や, コンフィグファイルから値を持ってくる処理を行う.
<br/>

<source lang = "java">
Configuration cfg = new Configuration(event.getSuggestedConfigurationFile());
</source>
:Configurationのインスタンスを作成する. 引数のevent.getSuggestedConfigurationFile()は, @Modで指定した'''modid'''.cfgというファイルオブジェクトを返す.
<br/>

<source lang = "java">
cfg.load();
</source>
:Configurationの処理を開始させるメソッド. 必ずsave()と対になる.
<br/>

<source lang = "java">
Property blockProp = cfg.getBlock("ConfigSampleBlock", 1301);
Property itemProp  = cfg.getItem("ConfigSampleItem", 4001);
</source>
:コンフィグファイルに項目とデフォルト値を設定し, その要素をPropetryインスタンスに返す処理.
この時, このModよりも前に読み込まれたModのブロック, アイテムIDと重複していた場合, '''自動でIDの末尾からIDの再割り当てを行う.'''
<br/>

<source lang = "java">
blockProp.comment  = "This comment is Block Property";
itemProp.comment   = "This comment is Item Property";
</source>
:コンフィグファイルでの項目に対するコメント.
<br/>

<source lang = "java">
blockIdSample = blockProp.getInt();
itemIdSample  = itemProp.getInt();
</source>
:コンフィグファイルで設定した値をint型にして取得するメソッド.
:アイテムIDに関しては自動で-256してくれるようになった. これは4.1.4.281からの機能.

<source lang = "java">
catch (Exception e)
{
	FMLLog.log(Level.SEVERE, e, "Error Message");
}
</source>
:ファイルへの書き込み, 読み込みが失敗したときに呼ばれる, 例外. ログファイルにエラーメッセージを出力し, ゲームを強制終了させる.
<br/>

<source lang = "java">
finally
{
	cfg.save();
}
</source>
:tryで例外が発生しない場合呼ばれる. コンフィグファイルを保存する.

==実際の挙動==
実際の挙動自体は[[無機能アイテムの追加]], [[無機能ブロックの追加]]とほぼ同じである. ただしconfigフォルダに'''ConfigSampleCore.cfg'''というファイルが生成されている.