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

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

周辺機器の追加

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

このサンプルではレシピを登録していないのでクリエイティブ・インベントリから取り出す。

ソースコード

• 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="SamplePeripheralMod", name="SamplePeripheralMod", version="1.0",
	dependencies = "required-after:ComputerCraft")
public class SamplePeripheralCore {

	public static Block blockSamplePeripheral;

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

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

}

• BlockSamplePeripheral.java

package mods.sample.peripheral;

import java.util.Random;

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);
	}

	@Override
	public int quantityDropped(int meta, int fortune, Random random){
		return quantityDroppedWithBonus(fortune, random);
	}

	@Override
	public int quantityDropped(Random random){
		return 1;
	}

	@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 (TileSamplePeripheral)tile;
		}
		return null;
	}

}

解説

SamplePeripheralCore.java

Modのコアとなるクラス。

dependencies = "required-after:ComputerCraft"

↑このmodがComputerCraftを要求（未導入環境では警告メッセージが出る）し、なおかつComputerCraftの後に読み込まれるようにしている。

ComputerCraftAPI.registerPeripheralProvider(new PeripheralProvider());

↑接続したComputerから周辺機器実装クラスを要求されたときに提供するIPeripheralProviderの実装クラスをComputerCraftに登録する。自作周辺機器をComputerから使えるようにするために必須。

BlockSamplePeripheral.java

周辺機器のブロック。

TileSamplePeripheral.java

周辺機器のTileEntity。

public class TileSamplePeripheral extends TileEntity implements IPeripheral {

↑今回は周辺機器のTileEntityクラスでIPeripheralも実装する。
周辺機器は後述のPeripheralProviderでComputerCraftに登録されるため、別のクラスでIPeripheralを実装する事も出来る。

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

↑Computer側からのperipheral.getType()に対する文字列を返す。他の種類の周辺機器とは被らないようにする。

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

↑Computer側からのperipheral.getMethods()に対するメソッド名（文字列）の配列を返す。今回は実装しないので空の配列。

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

↑Computer側からのperipheral.call()に対する処理とその結果を返す。今回は実装しないのでnull。

@Override
public void attach(IComputerAccess computer) {

}

@Override
public void detach(IComputerAccess computer) {

}

↑周辺機器がComputerに取り付けられた時（attach）と取り外された時（detach）に、Computerから呼び出される。今回は何もしない。

@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実装クラス）を提供するためのクラス。
前述の通り、ComputerCraftAPI.registerPeripheralProvider()でComputerCraftへ登録する。

@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 (TileSamplePeripheral)tile;
	}
	return null;
}

↑周辺機器がComputerへ接続された時に呼び出される。x, y, zは周辺機器の座標。sideは周辺機器から見たComputerの方向。
今回はTileEntityでIPeripheralを実装したため、座標のTileEntityを取得して自分自身の周辺機器と同一だったらそれを周辺機器のインスタンスとして返している。