ComputerCraft API/1.65/周辺機器の追加

ComputerCraft API >

この記事は"Minecraft Forge Universal 10.13.0.x～"及び"ComputerCraft 1.65～"を前提MODとしています。

周辺機器の追加

何もしない周辺機器ブロックを追加します。

• IPeripheralの実装
• IPeripheralProviderの実装
• PeripheralProviderの登録

このサンプルでは周辺機器ブロックのレシピを登録していないので、適当なレシピを追加するか、クリエイティブ・インベントリから取り出してください。

ソースコード

• SamplePeripheralCore.java

package mods.sample.peripheral;

import net.minecraft.block.Block;
import net.minecraft.creativetab.CreativeTabs;
import cpw.mods.fml.common.Mod;
import cpw.mods.fml.common.Mod.EventHandler;
import cpw.mods.fml.common.event.FMLInitializationEvent;
import cpw.mods.fml.common.event.FMLPreInitializationEvent;
import cpw.mods.fml.common.registry.GameRegistry;
import dan200.computercraft.api.ComputerCraftAPI;

@Mod(modid=SamplePeripheralCore.MOD_ID,
name=SamplePeripheralCore.MOD_NAME,
version=SamplePeripheralCore.MOD_VERSION,
dependencies = SamplePeripheralCore.MOD_DEPENDENCIES)
public class SamplePeripheralCore {

	public static final String MOD_ID = "sampleperipheralmod";
	public static final String MOD_NAME = "Sample Peripheral Mod";
	public static final String MOD_VERSION = "1.0";
	public static final String MOD_DEPENDENCIES = "after:ComputerCraft";

	public static Block blockSamplePeripheral;

	@EventHandler
	public void preInit(FMLPreInitializationEvent event) {
		blockSamplePeripheral = new BlockSamplePeripheral()
		GameRegistry.registerBlock(blockSamplePeripheral, "sample_peripheral");
	}

	@EventHandler
	public void init(FMLInitializationEvent event) {
		GameRegistry.registerTileEntity(TileSamplePeripheral.class, "tile_sample_peripheral");
		ComputerCraftAPI.registerPeripheralProvider(new PeripheralProvider());
	}

}

• BlockSamplePeripheral.java

package mods.sample.peripheral;

import net.minecraft.block.BlockContainer;
import net.minecraft.block.material.Material;
import net.minecraft.tileentity.TileEntity;
import net.minecraft.world.World;

public class BlockSamplePeripheral extends BlockContainer {

	public BlockSamplePeripheral() {
		super(Material.ground);

		setBlockName("sample_peripheral");
		setCreativeTab(CreativeTabs.tabBlock);
	}

	@Override
	public TileEntity createNewTileEntity(World world, int a) {
		return new TileSamplePeripheral();
	}

}

• TileSamplePeripheral.java

package mods.sample.peripheral;

import net.minecraft.tileentity.TileEntity;
import dan200.computercraft.api.lua.ILuaContext;
import dan200.computercraft.api.lua.LuaException;
import dan200.computercraft.api.peripheral.IComputerAccess;
import dan200.computercraft.api.peripheral.IPeripheral;

public class TileSamplePeripheral extends TileEntity implements IPeripheral {

	@Override
	public String getType() {
		return "sample";
	}

	@Override
	public String[] getMethodNames() {
		return new String[] {};
	}

	@Override
	public Object[] callMethod(IComputerAccess computer, ILuaContext context,
			int method, Object[] arguments) throws LuaException,
			InterruptedException {
		return null;
	}

	@Override
	public void attach(IComputerAccess computer) {

	}

	@Override
	public void detach(IComputerAccess computer) {

	}

	@Override
	public boolean equals(IPeripheral other) {
		if ((other != null) && (other instanceof TileSamplePeripheral)) {
			return other == this;
		}

		return false;
	}

}

• PeripheralProvider.java

package mods.sample.peripheral;

import net.minecraft.tileentity.TileEntity;
import net.minecraft.world.World;
import dan200.computercraft.api.peripheral.IPeripheral;
import dan200.computercraft.api.peripheral.IPeripheralProvider;

public class PeripheralProvider implements IPeripheralProvider {

	@Override
	public IPeripheral getPeripheral(World world, int x, int y, int z, int side) {
		TileEntity tile = world.getTileEntity(x, y, z);
		if (tile != null && tile instanceof TileSamplePeripheral) {
			return (IPeripheral)tile;
		}

		return null;
	}

}

解説

SamplePeripheralCore.java

Modのコアとなるクラス

• dependencies

@Mod(
	dependencies = SamplePeripheralCore.MOD_DEPENDENCIES)
public class SamplePeripheralCore {
 
	public static final String MOD_DEPENDENCIES = "after:ComputerCraft";

@Modのdependenciesで、このmodがComputerCraftの後に読み込まれるように設定しています。

• 周辺機器のブロックとTileEntityの登録

blockSamplePeripheral = new BlockSamplePeripheral()
GameRegistry.registerBlock(blockSamplePeripheral, "sample_peripheral");

GameRegistry.registerTileEntity(TileSamplePeripheral.class, "tile_sample_peripheral");

• PeripheralProviderの登録

ComputerCraftAPI.registerPeripheralProvider(new PeripheralProvider());

接続したComputerへ周辺機器のIPeripheral実装クラスを提供するためのIPeripheralProvider実装クラス（後述）を、ComputerCraftAPI.registerPeripheralProvider()でComputerCraftに登録します。 これは、自作周辺機器をComputerから使えるようにするために必須です。

BlockSamplePeripheral.java

周辺機器のブロック

• BlockContainerの継承

public class BlockSamplePeripheral extends BlockContainer {

	@Override
	public TileEntity createNewTileEntity(World world, int a) {
		return new TileSamplePeripheral();
	}

周辺機器はTileEntityを持つブロックとして実装するので、BlockContainerを継承し、createNewTileEntity()で周辺機器のTileEntityのインスタンスを生成して返しています。

TileSamplePeripheral.java

周辺機器のTileEntity

• IPeripheralの実装

public class TileSamplePeripheral extends TileEntity implements IPeripheral {

今回は周辺機器のTileEntityクラスでIPeripheralも実装しています。

ちなみに、周辺機器は後述のPeripheralProviderでComputerへ提供されるため、IPeripheralはTileEntity以外のクラスで実装する事もできます。

• getType()

@Override
public String getType() {
	return "sample";
}

周辺機器の種類を表す文字列を返します。ゲーム内のLuaプログラムではperipheral.getType()で取得したこの文字列によって周辺機器の種類を判別します。

• getMethodNames()

@Override
public String[] getMethodNames() {
	return new String[] {};
}

Computerから呼び出せる周辺機器のメソッド名を表す文字列の配列を返します。ゲーム内のLuaプログラムではperipheral.getMethods()の戻り値になります。
今回は実装しないので空の配列を返しています。

• callMethod()

@Override
public Object[] callMethod(IComputerAccess computer, ILuaContext context,
		int method, Object[] arguments) throws LuaException,
		InterruptedException {
	return null;
}

Computerからperipheral.call()で周辺機器のメソッドを呼び出したときの処理を実装します。
今回はメソッドを実装しないので何もしません。

• attach()とdetach()

@Override
public void attach(IComputerAccess computer) {

}

@Override
public void detach(IComputerAccess computer) {

}

周辺機器ブロックがComputerに接続されたとき（attach）と、取り外されたとき（detach）に呼び出されます。
今回は何もしません。

• equals()

@Override
public boolean equals(IPeripheral other) {
	if ((other != null) && (other instanceof TileSamplePeripheral)) {
		return other == this;
	}

	return false;
}

Computerに周辺機器が着脱されたときに現在取り付けられている周辺機器（this）が、それまで取り付けられていた周辺機器（other）と同一かどうかを調べるために呼び出されます。
周辺機器のTileEntityインスタンスが同一かどうかを比較して返しています。

PeripheralProvider.java

Computerへ周辺機器（IPeripheralの実装クラス）を提供するためのクラス

• IPeripheralProviderの実装

public class PeripheralProvider implements IPeripheralProvider {

IPeripheralProviderを実装します。
前述の通り、このクラスのインスタンスをComputerCraftAPI.registerPeripheralProvider()でComputerCraftへ登録します。

• getPeripheral()

@Override
public IPeripheral getPeripheral(World world, int x, int y, int z, int side) {
	TileEntity tile = world.getTileEntity(x, y, z);
	if (tile != null && tile instanceof TileSamplePeripheral) {
		return (IPeripheral)tile;
	}

	return null;
}

周辺機器がComputerへ接続されたときに呼び出されます。x, y, zは周辺機器の座標、sideは周辺機器から見た接続方向です。
今回は周辺機器のTileEntityでIPeripheralを実装したため、座標から周辺機器のTileEntityを取得し、IPeripheralのインスタンスとして返しています。