net.minecraftforge.fml.client.event

Class ConfigChangedEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.client.event.ConfigChangedEvent

Direct Known Subclasses:

ConfigChangedEvent.OnConfigChangedEvent, ConfigChangedEvent.PostConfigChangedEvent

public class ConfigChangedEvent
extends Event

These events are posted from the GuiConfig screen when the done button is pressed. The events are only posted if the parent screen is not an instance of GuiConfig or if the configID field has been set for the GuiConfig screen. Listeners for this event should use OnConfigChanged or PostConfigChanged and check for a specific mod ID. For best results the listener should refresh any objects/fields that are set based on the mod's config and should serialize the modified config.

Author:

bspkrs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigChangedEvent.OnConfigChangedEvent This event is intended to be consumed by the mod whose config has been changed.
static class	ConfigChangedEvent.PostConfigChangedEvent This event is provided for mods to consume if they want to be able to check if other mods' configs have been changed.

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	configID
private boolean	isWorldRunning
private java.lang.String	modID
private boolean	requiresMcRestart

Constructor Summary

Constructors

Constructor and Description
ConfigChangedEvent(java.lang.String modID, java.lang.String configID, boolean isWorldRunning, boolean requiresMcRestart)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigID() A String identifier for this ConfigChangedEvent.
java.lang.String	getModID() The Mod ID of the mod whose configuration just changed.
boolean	isRequiresMcRestart() Will be set to true if any elements were changed that require a restart of Minecraft.
boolean	isWorldRunning() Whether or not a world is currently running.

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Field Detail

modID

private final java.lang.String modID

isWorldRunning

private final boolean isWorldRunning

requiresMcRestart

private final boolean requiresMcRestart

configID

@Nullable
private final java.lang.String configID

Constructor Detail

ConfigChangedEvent

public ConfigChangedEvent(java.lang.String modID,
                          @Nullable
                          java.lang.String configID,
                          boolean isWorldRunning,
                          boolean requiresMcRestart)

Method Detail

getModID

public java.lang.String getModID()

The Mod ID of the mod whose configuration just changed.

isWorldRunning

public boolean isWorldRunning()

Whether or not a world is currently running.

isRequiresMcRestart

public boolean isRequiresMcRestart()

Will be set to true if any elements were changed that require a restart of Minecraft.

getConfigID

@Nullable
public java.lang.String getConfigID()

A String identifier for this ConfigChangedEvent.