net.minecraftforge.fml.common.event

Class FMLInterModComms

java.lang.Object

net.minecraftforge.fml.common.event.FMLInterModComms

public class FMLInterModComms
extends java.lang.Object

Simple intermod communications to receive simple messages directed at you from other mods

Author:

cpw

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FMLInterModComms.IMCEvent Subscribe to this event to receive your messages (they are sent between FMLInitializationEvent and FMLPostInitializationEvent)
static class	FMLInterModComms.IMCMessage You will receive an instance of this for each message sent

Field Summary

Fields

Modifier and Type	Field and Description
private static com.google.common.collect.ImmutableList<FMLInterModComms.IMCMessage>	emptyIMCList
private static com.google.common.collect.ArrayListMultimap<java.lang.String,FMLInterModComms.IMCMessage>	modMessages

Constructor Summary

Constructors

Constructor and Description
FMLInterModComms()

Method Summary

Modifier and Type	Method and Description
private static void	enqueueMessage(java.lang.Object sourceMod, java.lang.String modTarget, FMLInterModComms.IMCMessage message)
private static boolean	enqueueStartupMessage(java.lang.String modTarget, FMLInterModComms.IMCMessage message)
static com.google.common.collect.ImmutableList<FMLInterModComms.IMCMessage>	fetchRuntimeMessages(java.lang.Object forMod) Retrieve any pending runtime messages for the mod
static boolean	sendFunctionMessage(java.lang.String modId, java.lang.String key, java.lang.String functionClassName) Send a startup time function message
static boolean	sendMessage(java.lang.String modId, java.lang.String key, ItemStack value) Send a startup time message
static boolean	sendMessage(java.lang.String modId, java.lang.String key, NBTTagCompound value) Send a startup time message
static boolean	sendMessage(java.lang.String modId, java.lang.String key, ResourceLocation value) Send a startup time message
static boolean	sendMessage(java.lang.String modId, java.lang.String key, java.lang.String value) Send a startup time message
static void	sendRuntimeFunctionMessage(java.lang.Object sourceMod, java.lang.String modId, java.lang.String key, java.lang.String functionClassName) Send a post-startup function message.
static void	sendRuntimeMessage(java.lang.Object sourceMod, java.lang.String modId, java.lang.String key, ItemStack value) Send a post-startup message
static void	sendRuntimeMessage(java.lang.Object sourceMod, java.lang.String modId, java.lang.String key, NBTTagCompound value) Send a post-startup message
static void	sendRuntimeMessage(java.lang.Object sourceMod, java.lang.String modId, java.lang.String key, ResourceLocation value) Send a post-startup message
static void	sendRuntimeMessage(java.lang.Object sourceMod, java.lang.String modId, java.lang.String key, java.lang.String value) Send a post-startup message

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

emptyIMCList

private static final com.google.common.collect.ImmutableList<FMLInterModComms.IMCMessage> emptyIMCList

modMessages

private static com.google.common.collect.ArrayListMultimap<java.lang.String,FMLInterModComms.IMCMessage> modMessages

Constructor Detail

FMLInterModComms

public FMLInterModComms()

Method Detail

sendMessage

public static boolean sendMessage(java.lang.String modId,
                                  java.lang.String key,
                                  NBTTagCompound value)

Send a startup time message

Parameters:

modId - The modid to send it to

key - The mod specific key

value - An NBT type value

Returns:

if the message was enqueued successfully and will be processed during startup

sendMessage

public static boolean sendMessage(java.lang.String modId,
                                  java.lang.String key,
                                  ItemStack value)

Send a startup time message

Parameters:

modId - The modid to send it to

key - The mod specific key

value - An Itemstack value

Returns:

if the message was enqueued successfully and will be processed during startup

sendMessage

public static boolean sendMessage(java.lang.String modId,
                                  java.lang.String key,
                                  ResourceLocation value)

Send a startup time message

Parameters:

modId - The modid to send it to

key - The mod specific key

value - A ResourceLocation value

Returns:

if the message was enqueued successfully and will be processed during startup

sendMessage

public static boolean sendMessage(java.lang.String modId,
                                  java.lang.String key,
                                  java.lang.String value)

Send a startup time message

Parameters:

modId - The modid to send it to

key - The mod specific key

value - A String value

Returns:

if the message was enqueued successfully and will be processed during startup

sendFunctionMessage

public static boolean sendFunctionMessage(java.lang.String modId,
                                          java.lang.String key,
                                          java.lang.String functionClassName)

Send a startup time function message

Parameters:

modId - The modid to send it to

key - The mod specific key

functionClassName - The class name of a function that will be instantiated when the message is read. It must implement Function

Returns:

if the message was enqueued successfully and will be processed during startup

sendRuntimeMessage

public static void sendRuntimeMessage(java.lang.Object sourceMod,
                                      java.lang.String modId,
                                      java.lang.String key,
                                      NBTTagCompound value)

Send a post-startup message

Parameters:

sourceMod - The mod sending the message

modId - The modid to send it to

key - The mod specific key

value - An NBT type value

sendRuntimeMessage

public static void sendRuntimeMessage(java.lang.Object sourceMod,
                                      java.lang.String modId,
                                      java.lang.String key,
                                      ItemStack value)

Send a post-startup message

Parameters:

sourceMod - The mod sending the message

modId - The modid to send it to

key - The mod specific key

value - An Itemstack value

sendRuntimeMessage

public static void sendRuntimeMessage(java.lang.Object sourceMod,
                                      java.lang.String modId,
                                      java.lang.String key,
                                      java.lang.String value)

Send a post-startup message

Parameters:

sourceMod - The mod sending the message

modId - The modid to send it to

key - The mod specific key

value - A string value

sendRuntimeMessage

public static void sendRuntimeMessage(java.lang.Object sourceMod,
                                      java.lang.String modId,
                                      java.lang.String key,
                                      ResourceLocation value)

Send a post-startup message

Parameters:

sourceMod - The mod sending the message

modId - The modid to send it to

key - The mod specific key

value - A string value

sendRuntimeFunctionMessage

public static void sendRuntimeFunctionMessage(java.lang.Object sourceMod,
                                              java.lang.String modId,
                                              java.lang.String key,
                                              java.lang.String functionClassName)

Send a post-startup function message.

Parameters:

sourceMod - The mod originating this message

modId - The modid to send it to

key - The mod specific key

functionClassName - The name of a class to be loaded when the caller processes this message. The named class must extend Function

enqueueStartupMessage

private static boolean enqueueStartupMessage(java.lang.String modTarget,
                                             FMLInterModComms.IMCMessage message)

enqueueMessage

private static void enqueueMessage(java.lang.Object sourceMod,
                                   java.lang.String modTarget,
                                   FMLInterModComms.IMCMessage message)

fetchRuntimeMessages

public static com.google.common.collect.ImmutableList<FMLInterModComms.IMCMessage> fetchRuntimeMessages(java.lang.Object forMod)

Retrieve any pending runtime messages for the mod

Parameters:

forMod - The Mod.Instance of the Mod to fetch messages for

Returns:

any messages - the collection will never be null