src/main/java/com/hbm/handler/imc/package-info.java - master - Belyash5/Flu

src/main/java/com/hbm/handler/imc/package-info.java
66 строк3 KB
Bob
the new, the old, the mold
15 янв 2023, 22:23
15 янв 2023, 22:237f64b41
package com.hbm.handler.imc;

/*
	Howdy! This is the documentation for NTM's inter mod comms. This interface allows other mods to tell NTM to do all sorts of things.
	IMC messages are handled in the IMCEvent which is called between the mod's init and post-init phases. Make sure to send your IMC
	messages before they are processed!
	
	
	######################################## RECIPES ########################################
	
	####################### ACIDIZER #######################
	KEY: crystallizer
	VALUE: NBT
	
	[MANDATORY]
	To set the output, set a tag compound named "output" that holds the itemstack info (set via ItemStack.writeToNBT)
	
	[MANDATORY]
	To set the input, there are two choices:
	- Set another tag compound like the output called "output". This will make the input a fixed item.
	- Set a string called "oredict". This will make the input an ore dict entry and allow processing of genericized items.
	
	[OPTIONAL]
	The input has a few parameters that can be added:
	- Setting an integer "acid" will change the acid requirement to the fluid with that ID, in this case "amount" also has to be set to determine the fluid amount in mB. The default uses 500mB of hydrogen peroxide.
	- Setting an integer "duration" will change the base process time of this recipe in ticks, the default is 600 (30s).
	
	EXAMPLES:
	
	Recipe with fixed item, acidizing an alloy chestplate into 8 ingots, taking 500 ticks and using 50mB of steam:
		NBTTagCompound msg0 = new NBTTagCompound();
		NBTTagCompound ing0 = new NBTTagCompound();
		new ItemStack(ModItems.alloy_plate).writeToNBT(ing0);
		msg0.setTag("input", ing0);
		NBTTagCompound out0 = new NBTTagCompound();
		new ItemStack(ModItems.ingot_advanced_alloy, 8).writeToNBT(out0);
		msg0.setTag("output", out0);
		msg0.setInteger("acid", 2);
		msg0.setInteger("amount", 50);
		msg0.setInteger("duration", 500);
		FMLInterModComms.sendMessage("hbm", "crystallizer", msg0);

	Recipe with an ore dict item, acidizing all "plateSteel" into a steel ingot, with all optional values omitted:
		NBTTagCompound msg1 = new NBTTagCompound();
		msg1.setString("oredict", "plateSteel");
		NBTTagCompound out1 = new NBTTagCompound();
		new ItemStack(ModItems.ingot_steel, 1).writeToNBT(out1);
		msg1.setTag("output", out1);
		FMLInterModComms.sendMessage("hbm", "crystallizer", msg1);
	
	####################### CENTRIFUGE #######################
	KEY: centrifuge
	VALUE: NBT
	
	[MANDATORY]
	To set the output, set four tag compound named "output1" to "output4" that hold the itemstack info (set via ItemStack.writeToNBT)
	Note that the centrifuge will always output four items and does not (yet) support nulls.
	
	[MANDATORY]
	To set the input, there are two choices:
	- Set another tag compound like the output called "output". This will make the input a fixed item.
	- Set a string called "oredict". This will make the input an ore dict entry and allow processing of genericized items.
	
	EXAMPLES:
	Refer to the examples of the acidizer, the only difference is the fact that there are four mandatory outputs.
*/