提供: Minecraft Modding Wiki
移動先: 案内、 検索
(→‎ソースコード: CoreとBlockを変更)
(ModIDとブロックID、TileEntityIDの変更)
 
(同じ利用者による、間の4版が非表示)
1行目: 1行目:
 +
[[ComputerCraft_API|ComputerCraft API]] >
 
{{前提MOD|reqmod="Minecraft Forge Universal 10.13.0.x～"及び"ComputerCraft 1.65～"}}
 
{{前提MOD|reqmod="Minecraft Forge Universal 10.13.0.x～"及び"ComputerCraft 1.65～"}}
  
 
== 周辺機器の追加 ==
 
== 周辺機器の追加 ==
−
何もしない周辺機器ブロックを追加する。
+
何もしない周辺機器ブロックを追加します。
  
−
このサンプルではレシピを登録していないのでクリエイティブ・インベントリから取り出す。
+
*IPeripheralの実装
 +
*IPeripheralProviderの実装
 +
*PeripheralProviderの登録
 +
 
 +
このサンプルでは周辺機器ブロックのレシピを登録していないので、適当なレシピを追加するか、クリエイティブ・インベントリから取り出してください。
  
 
=== ソースコード ===
 
=== ソースコード ===
20行目: 25行目:
 
import dan200.computercraft.api.ComputerCraftAPI;
 
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 {
  
−
@Mod(modid="SamplePeripheralMod", name="SamplePeripheralMod", version="1.0",
+
public static final String MOD_ID = "sampleperipheralmod";
−
dependencies = "required-after:ComputerCraft")
+
public static final String MOD_NAME = "Sample Peripheral Mod";
−
public class SamplePeripheralCore {
+
public static final String MOD_VERSION = "1.0";
 +
public static final String MOD_DEPENDENCIES = "after:ComputerCraft";
  
 
public static Block blockSamplePeripheral;
 
public static Block blockSamplePeripheral;
30行目: 41行目:
 
public void preInit(FMLPreInitializationEvent event) {
 
public void preInit(FMLPreInitializationEvent event) {
 
blockSamplePeripheral = new BlockSamplePeripheral()
 
blockSamplePeripheral = new BlockSamplePeripheral()
−
.setBlockName("blockSamplePeripheral")
+
GameRegistry.registerBlock(blockSamplePeripheral, "sample_peripheral");
−
.setCreativeTab(CreativeTabs.tabBlock);
 
−
GameRegistry.registerBlock(blockSamplePeripheral, "blockSamplePeripheral");
 
 
}
 
}
  
 
@EventHandler
 
@EventHandler
 
public void init(FMLInitializationEvent event) {
 
public void init(FMLInitializationEvent event) {
−
GameRegistry.registerTileEntity(TileSamplePeripheral.class, "tileSamplePeripheral");
+
GameRegistry.registerTileEntity(TileSamplePeripheral.class, "tile_sample_peripheral");
 
ComputerCraftAPI.registerPeripheralProvider(new PeripheralProvider());
 
ComputerCraftAPI.registerPeripheralProvider(new PeripheralProvider());
 
}
 
}
47行目: 56行目:
 
<source lang = "java">
 
<source lang = "java">
 
package mods.sample.peripheral;
 
package mods.sample.peripheral;
−
 
−
import java.util.Random;
 
  
 
import net.minecraft.block.BlockContainer;
 
import net.minecraft.block.BlockContainer;
59行目: 66行目:
 
public BlockSamplePeripheral() {
 
public BlockSamplePeripheral() {
 
super(Material.ground);
 
super(Material.ground);
−
}
 
  
−
@Override
+
setBlockName("sample_peripheral");
−
public int quantityDropped(int meta, int fortune, Random random){
+
setCreativeTab(CreativeTabs.tabBlock);
−
return quantityDroppedWithBonus(fortune, random);
 
−
}
 
−
 
 
−
@Override
 
−
public int quantityDropped(Random random){
 
−
return 1;
 
 
}
 
}
  
124行目: 124行目:
 
return other == this;
 
return other == this;
 
}
 
}
 +
 
return false;
 
return false;
 
}
 
}
145行目: 146行目:
 
TileEntity tile = world.getTileEntity(x, y, z);
 
TileEntity tile = world.getTileEntity(x, y, z);
 
if (tile != null && tile instanceof TileSamplePeripheral) {
 
if (tile != null && tile instanceof TileSamplePeripheral) {
−
return (TileSamplePeripheral)tile;
+
return (IPeripheral)tile;
 
}
 
}
 +
 
return null;
 
return null;
 
}
 
}
155行目: 157行目:
 
=== 解説 ===
 
=== 解説 ===
 
==== SamplePeripheralCore.java ====
 
==== SamplePeripheralCore.java ====
−
Modのコアとなるクラス。
+
Modのコアとなるクラス
 +
 
 +
*dependencies
 +
<source lang = "java">
 +
@Mod(
 +
dependencies = SamplePeripheralCore.MOD_DEPENDENCIES)
 +
public class SamplePeripheralCore {
 +
 +
public static final String MOD_DEPENDENCIES = "after:ComputerCraft";
 +
</source>
 +
@Modのdependenciesで、このmodがComputerCraftの後に読み込まれるように設定しています。
 +
 
 +
*周辺機器のブロックとTileEntityの登録
 
<source lang = "java">
 
<source lang = "java">
−
dependencies = "required-after:ComputerCraft"
+
blockSamplePeripheral = new BlockSamplePeripheral()
 +
GameRegistry.registerBlock(blockSamplePeripheral, "sample_peripheral");
 
</source>
 
</source>
−
↑このmodがComputerCraftを要求（未導入環境では警告メッセージが出る）し、なおかつComputerCraftの後に読み込まれるようにしている。
+
<source lang = "java">
 +
GameRegistry.registerTileEntity(TileSamplePeripheral.class, "tile_sample_peripheral");
 +
</source>
 +
 
 +
*PeripheralProviderの登録
 
<source lang = "java">
 
<source lang = "java">
 
ComputerCraftAPI.registerPeripheralProvider(new PeripheralProvider());
 
ComputerCraftAPI.registerPeripheralProvider(new PeripheralProvider());
 
</source>
 
</source>
−
↑接続したComputerから周辺機器実装クラスを要求されたときに提供するIPeripheralProviderの実装クラスをComputerCraftに登録する。'''自作周辺機器をComputerから使えるようにするために必須。'''
+
接続したComputerへ周辺機器のIPeripheral実装クラスを提供するためのIPeripheralProvider実装クラス（後述）を、ComputerCraftAPI.registerPeripheralProvider()でComputerCraftに登録します。
 +
これは、'''自作周辺機器をComputerから使えるようにするために必須'''です。
  
 
==== BlockSamplePeripheral.java ====
 
==== BlockSamplePeripheral.java ====
−
周辺機器のブロック。
+
周辺機器のブロック
 +
 
 +
*BlockContainerの継承
 +
<source lang = "java">
 +
public class BlockSamplePeripheral extends BlockContainer {
 +
 
 +
@Override
 +
public TileEntity createNewTileEntity(World world, int a) {
 +
return new TileSamplePeripheral();
 +
}
 +
</source>
 +
周辺機器はTileEntityを持つブロックとして実装するので、BlockContainerを継承し、createNewTileEntity()で周辺機器のTileEntityのインスタンスを生成して返しています。
 +
 
 
==== TileSamplePeripheral.java ====
 
==== TileSamplePeripheral.java ====
−
周辺機器のTileEntity。
+
周辺機器のTileEntity
 +
 
 +
*IPeripheralの実装
 
<source lang = "java">
 
<source lang = "java">
 
public class TileSamplePeripheral extends TileEntity implements IPeripheral {
 
public class TileSamplePeripheral extends TileEntity implements IPeripheral {
 
</source>
 
</source>
−
↑今回は周辺機器のTileEntityクラスでIPeripheralも実装する。<br>
+
今回は周辺機器のTileEntityクラスでIPeripheralも実装しています。
−
周辺機器は後述のPeripheralProviderでComputerCraftに登録されるため、別のクラスでIPeripheralを実装する事も出来る。
+
 
 +
ちなみに、周辺機器は後述のPeripheralProviderでComputerへ提供されるため、IPeripheralはTileEntity以外のクラスで実装する事もできます。
 +
 
 +
*getType()
 
<source lang = "java">
 
<source lang = "java">
 
@Override
 
@Override
180行目: 217行目:
 
}
 
}
 
</source>
 
</source>
−
↑Computer側からのperipheral.getType()に対する文字列を返す。他の種類の周辺機器とは被らないようにする。
+
周辺機器の種類を表す文字列を返します。ゲーム内のLuaプログラムではperipheral.getType()で取得したこの文字列によって周辺機器の種類を判別します。
 +
 
 +
*getMethodNames()
 
<source lang = "java">
 
<source lang = "java">
 
@Override
 
@Override
187行目: 226行目:
 
}
 
}
 
</source>
 
</source>
−
↑Computer側からのperipheral.getMethods()に対するメソッド名（文字列）の配列を返す。今回は実装しないので空の配列。
+
Computerから呼び出せる周辺機器のメソッド名を表す文字列の配列を返します。ゲーム内のLuaプログラムではperipheral.getMethods()の戻り値になります。<br>
 +
今回は実装しないので空の配列を返しています。
 +
 
 +
*callMethod()
 
<source lang = "java">
 
<source lang = "java">
 
@Override
 
@Override
196行目: 238行目:
 
}
 
}
 
</source>
 
</source>
−
↑Computer側からのperipheral.call()に対する処理とその結果を返す。今回は実装しないのでnull。
+
Computerからperipheral.call()で周辺機器のメソッドを呼び出したときの処理を実装します。<br>
 +
今回はメソッドを実装しないので何もしません。
 +
 
 +
*attach()とdetach()
 
<source lang = "java">
 
<source lang = "java">
 
@Override
 
@Override
208行目: 253行目:
 
}
 
}
 
</source>
 
</source>
−
↑周辺機器がComputerに取り付けられた時（attach）と取り外された時（detach）に、Computerから呼び出される。今回は何もしない。
+
周辺機器ブロックがComputerに接続されたとき（attach）と、取り外されたとき（detach）に呼び出されます。<br>
 +
今回は何もしません。
 +
 
 +
*equals()
 
<source lang = "java">
 
<source lang = "java">
 
@Override
 
@Override
215行目: 263行目:
 
return other == this;
 
return other == this;
 
}
 
}
 +
 
return false;
 
return false;
 
}
 
}
 
</source>
 
</source>
−
↑Computerに周辺機器が着脱された時に現在取り付けられている周辺機器（this）が、それまで取り付けられていた周辺機器（other）と同一かどうかを調べるために呼び出される。今回は周辺機器のTileEntityが同一かどうかを比較して返している。
+
Computerに周辺機器が着脱されたときに現在取り付けられている周辺機器（this）が、それまで取り付けられていた周辺機器（other）と同一かどうかを調べるために呼び出されます。<br>
 +
周辺機器のTileEntityインスタンスが同一かどうかを比較して返しています。
  
 
==== PeripheralProvider.java ====
 
==== PeripheralProvider.java ====
−
Computerへ周辺機器（IPeripheral実装クラス）を提供するためのクラス。<br>
+
Computerへ周辺機器（IPeripheralの実装クラス）を提供するためのクラス
−
前述の通り、ComputerCraftAPI.registerPeripheralProvider()でComputerCraftへ登録する。
+
 
 +
*IPeripheralProviderの実装
 +
<source lang = "java">
 +
public class PeripheralProvider implements IPeripheralProvider {
 +
</source>
 +
IPeripheralProviderを実装します。<br>
 +
前述の通り、このクラスのインスタンスをComputerCraftAPI.registerPeripheralProvider()でComputerCraftへ登録します。
 +
 
 +
*getPeripheral()
 
<source lang = "java">
 
<source lang = "java">
 
@Override
 
@Override
228行目: 286行目:
 
TileEntity tile = world.getTileEntity(x, y, z);
 
TileEntity tile = world.getTileEntity(x, y, z);
 
if (tile != null && tile instanceof TileSamplePeripheral) {
 
if (tile != null && tile instanceof TileSamplePeripheral) {
−
return (TileSamplePeripheral)tile;
+
return (IPeripheral)tile;
 
}
 
}
 +
 
return null;
 
return null;
 
}
 
}
 
</source>
 
</source>
−
↑周辺機器がComputerへ接続された時に呼び出される。x, y, zは周辺機器の座標。sideは周辺機器から見たComputerの方向。<br>
+
周辺機器がComputerへ接続されたときに呼び出されます。x, y, zは周辺機器の座標、sideは周辺機器から見た接続方向です。<br>
−
今回はTileEntityでIPeripheralを実装したため、座標のTileEntityを取得して自分自身の周辺機器と同一だったらそれを周辺機器のインスタンスとして返している。
+
今回は周辺機器のTileEntityでIPeripheralを実装したため、座標から周辺機器のTileEntityを取得し、IPeripheralのインスタンスとして返しています。

2015年12月28日 (月) 20:48時点における最新版

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のインスタンスとして返しています。

「https://mcmodding.jp/modding/index.php?title=ComputerCraft_API/1.65/周辺機器の追加&oldid=2944」から取得