net.minecraftforge.fml.common.event

Class FMLInterModComms.IMCMessage

java.lang.Object

net.minecraftforge.fml.common.event.FMLInterModComms.IMCMessage

Enclosing class:

FMLInterModComms

public static final class FMLInterModComms.IMCMessage
extends java.lang.Object

You will receive an instance of this for each message sent

Author:

cpw

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isFunction
java.lang.String	key This field, and value are both at the mod's discretion
private java.lang.String	sender This is the modid of the mod that sent you the message
private java.lang.Object	value This field, and key are both at the mod's discretion

Constructor Summary

Constructors

Modifier	Constructor and Description
private	IMCMessage(java.lang.String key, java.lang.Object value)
private	IMCMessage(java.lang.String key, java.lang.String value, boolean isFunction)

Method Summary

Modifier and Type	Method and Description
<T,V> java.util.Optional<java.util.function.Function<T,V>>	getFunctionValue(java.lang.Class<T> functionFrom, java.lang.Class<V> functionTo) Get the Function value from this message.
ItemStack	getItemStackValue() Get the ItemStack value from this message
java.lang.Class<?>	getMessageType() Get the actual message class type
NBTTagCompound	getNBTValue() Get the NBTTagCompound value from this message
ResourceLocation	getResourceLocationValue() Get the ResourceLocation value from this message.
java.lang.String	getSender() Get the sending modId of this message.
java.lang.String	getStringValue() Get the string value from this message.
boolean	isFunctionMessage() Is this a Function type message
boolean	isItemStackMessage() Is this an ItemStack type message
boolean	isNBTMessage() Is this an NBTTagCompound type message
boolean	isResourceLocationMessage() Is this an ResourceLocation type message
boolean	isStringMessage() Is this a string type message
(package private) void	setSender(ModContainer activeModContainer)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

isFunction

private final boolean isFunction

sender

private java.lang.String sender

This is the modid of the mod that sent you the message

key

@Nonnull
public final java.lang.String key

This field, and value are both at the mod's discretion

value

@Nonnull
private final java.lang.Object value

This field, and key are both at the mod's discretion

Constructor Detail

IMCMessage

private IMCMessage(@Nonnull
                   java.lang.String key,
                   @Nonnull
                   java.lang.Object value)

IMCMessage

private IMCMessage(@Nonnull
                   java.lang.String key,
                   @Nonnull
                   java.lang.String value,
                   boolean isFunction)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSender

public java.lang.String getSender()

Get the sending modId of this message.

Returns:

The modId of the mod that originated the message

setSender

void setSender(ModContainer activeModContainer)

getStringValue

public java.lang.String getStringValue()

Get the string value from this message.

Returns:

The string value

Throws:

java.lang.ClassCastException - if this message doesn't contain a String value

getResourceLocationValue

public ResourceLocation getResourceLocationValue()

Get the ResourceLocation value from this message.

Returns:

The string value

Throws:

java.lang.ClassCastException - if this message doesn't contain a ResourceLocation value

getNBTValue

public NBTTagCompound getNBTValue()

Get the NBTTagCompound value from this message

Returns:

The NBT value

Throws:

java.lang.ClassCastException - if this message doesn't contain an NBT value

getItemStackValue

@Nonnull
public ItemStack getItemStackValue()

Get the ItemStack value from this message

Returns:

The Itemstack value

Throws:

java.lang.ClassCastException - if this message doesn't contain an Itemstack value

getFunctionValue

public <T,V> java.util.Optional<java.util.function.Function<T,V>> getFunctionValue(java.lang.Class<T> functionFrom,
                                                                                   java.lang.Class<V> functionTo)

Get the Function value from this message. This will attempt to classload the function supplied by the caller. The parameter classes are strictly to give a concrete generic function return value.

Type Parameters:

T - The argument type

V - The result type

Parameters:

functionFrom - The type of the argument to the function

functionTo - The type of the result of the function

Returns:

The function value or Optional.absent if it wasn't readable or isn't a function call

getMessageType

public java.lang.Class<?> getMessageType()

Get the actual message class type

Returns:

The type of the message

isStringMessage

public boolean isStringMessage()

Is this a string type message

Returns:

if this is a string type message

isItemStackMessage

public boolean isItemStackMessage()

Is this an ItemStack type message

Returns:

if this is an itemstack type message

isNBTMessage

public boolean isNBTMessage()

Is this an NBTTagCompound type message

Returns:

if this is an NBT type message

isResourceLocationMessage

public boolean isResourceLocationMessage()

Is this an ResourceLocation type message

Returns:

if this is an NBT type message

isFunctionMessage

public boolean isFunctionMessage()

Is this a Function type message

Returns:

if this is a function type message