ConfigChangedEvent (Forge API)

From 877312184c472d9845e5ef1008bc538f4634059f Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:50:56 +0300 Subject: fix missing source folder --- .../mods/fml/client/event/ConfigChangedEvent.html | 376 --------------------- 1 file changed, 376 deletions(-) delete mode 100644 javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html (limited to 'javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html') diff --git a/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html b/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html deleted file mode 100644 index 9935f52..0000000 --- a/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - -ConfigChangedEvent (Forge API) - - - - - - - -

-

-

-

Prev Class
Next Class

-

Frames
No Frames

-

All Classes

-

- -

-

-

Summary:
Nested |
Field |
Constr |
Method

-

Detail:
Field |
Constr |
Method

-

- - - -

-

java.lang.Object
-
- cpw.mods.fml.common.eventhandler.Event
- -
  - cpw.mods.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.
-

-

-

-

- -

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 cpw.mods.fml.common.eventhandler.Event
-Event.HasResult, Event.Result

-

- -

Field Summary

- - - - - - - - - - - - - - - - - - - - - - -

Fields
Modifier and Type	Field and Description
`java.lang.String`	`configID` - A String identifier for this ConfigChangedEvent. -
`boolean`	`isWorldRunning` - Whether or not a world is currently running. -
`java.lang.String`	`modID` - The Mod ID of the mod whose configuration just changed. -
`boolean`	`requiresMcRestart` - Will be set to true if any elements were changed that require a restart of Minecraft. -

-

- -

Constructor Summary

- - - - - - - - -

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

-

- -

- - -
Method Summary
-
- - - -
  Methods inherited from class cpw.mods.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
    -
```
public final java.lang.String modID
```
    -
    The Mod ID of the mod whose configuration just changed.
    -
  - - - -
  - -
    isWorldRunning
    -
```
public final boolean isWorldRunning
```
    -
    Whether or not a world is currently running.
    -
  - - - -
  - -
    requiresMcRestart
    -
```
public final boolean requiresMcRestart
```
    -
    Will be set to true if any elements were changed that require a restart of Minecraft.
    -
  - - - -
  - -
    configID
    -
```
public final java.lang.String configID
```
    -
    A String identifier for this ConfigChangedEvent.
    -
  -
- -
- - - -
  Constructor Detail
  - - - -
  - -
    ConfigChangedEvent
    -
```
public ConfigChangedEvent(java.lang.String modID,
-                  java.lang.String configID,
-                  boolean isWorldRunning,
-                  boolean requiresMcRestart)
```
    -
  -
-

-

-

- - -

-

-

-

Prev Class
Next Class

-

Frames
No Frames

-

All Classes

-

- -

-

-

Summary:
Nested |
Field |
Constr |
Method

-

Detail:
Field |
Constr |
Method

-

- - - -- cgit v1.2.3