net.minecraftforge.fml.client.config

Class GuiConfig

java.lang.Object

net.minecraft.client.gui.Gui

net.minecraft.client.gui.GuiScreen

net.minecraftforge.fml.client.config.GuiConfig

All Implemented Interfaces:

GuiYesNoCallback

Direct Known Subclasses:

FMLConfigGuiFactory.FMLConfigGuiScreen, ForgeGuiFactory.ForgeConfigGui

public class GuiConfig
extends GuiScreen

This class is the base GuiScreen for all config GUI screens. It can be extended by mods to provide the top-level config screen that will be called when the Config button is clicked from the Main Menu Mods list.

Author:

bspkrs

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allRequireMcRestart
boolean	allRequireWorldRestart
protected GuiButtonExt	btnDefaultAll
protected GuiButtonExt	btnUndoAll
protected HoverChecker	checkBoxHoverChecker
protected GuiCheckBox	chkApplyGlobally
java.util.List<IConfigElement>	configElements
java.lang.String	configID When set to a non-null value the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed if any configElements were changed (includes child screens).
GuiConfigEntries	entryList
java.util.List<GuiConfigEntries.IConfigEntry>	initEntries
boolean	isWorldRunning
java.lang.String	modID
boolean	needsRefresh
GuiScreen	parentScreen A reference to the screen object that created this.
protected HoverChecker	resetHoverChecker
java.lang.String	title
java.lang.String	titleLine2
protected HoverChecker	undoHoverChecker

Fields inherited from class net.minecraft.client.gui.GuiScreen

allowUserInput, buttonList, fontRenderer, height, itemRender, keyHandled, labelList, mc, mouseHandled, selectedButton, width

Fields inherited from class net.minecraft.client.gui.Gui

ICONS, OPTIONS_BACKGROUND, STAT_ICONS, zLevel

Constructor Summary

Constructors

Constructor and Description
GuiConfig(GuiScreen parentScreen, java.util.List<IConfigElement> configElements, java.lang.String modID, boolean allRequireWorldRestart, boolean allRequireMcRestart, java.lang.String title) GuiConfig constructor that will use ConfigChangedEvent when editing is concluded.
GuiConfig(GuiScreen parentScreen, java.util.List<IConfigElement> configElements, java.lang.String modID, boolean allRequireWorldRestart, boolean allRequireMcRestart, java.lang.String title, java.lang.String titleLine2) GuiConfig constructor that will use ConfigChangedEvent when editing is concluded.
GuiConfig(GuiScreen parentScreen, java.util.List<IConfigElement> configElements, java.lang.String modID, java.lang.String configID, boolean allRequireWorldRestart, boolean allRequireMcRestart, java.lang.String title) GuiConfig constructor that will use ConfigChangedEvent when editing is concluded.
GuiConfig(GuiScreen parentScreen, java.util.List<IConfigElement> configElements, java.lang.String modID, java.lang.String configID, boolean allRequireWorldRestart, boolean allRequireMcRestart, java.lang.String title, java.lang.String titleLine2) GuiConfig constructor that will use ConfigChangedEvent when editing is concluded.
GuiConfig(GuiScreen parentScreen, java.lang.String modID, boolean allRequireWorldRestart, boolean allRequireMcRestart, java.lang.String title, java.lang.Class<?>... configClasses)
GuiConfig(GuiScreen parentScreen, java.lang.String modid, java.lang.String title) This constructor handles the @Config configuration classes

Method Summary

Modifier and Type	Method and Description
protected void	actionPerformed(GuiButton button)
private static java.util.List<IConfigElement>	collectConfigElements(java.lang.Class<?>[] configClasses)
void	drawScreen(int mouseX, int mouseY, float partialTicks)
void	drawToolTip(java.util.List<java.lang.String> stringList, int x, int y)
static java.lang.String	getAbridgedConfigPath(java.lang.String path)
void	handleMouseInput()
void	initGui()
protected void	keyTyped(char eventChar, int eventKey)
protected void	mouseClicked(int x, int y, int mouseEvent)
protected void	mouseReleased(int x, int y, int mouseEvent)
void	onGuiClosed()
void	updateScreen()

Methods inherited from class net.minecraft.client.gui.GuiScreen

addButton, confirmClicked, doesGuiPauseGame, drawBackground, drawDefaultBackground, drawHoveringText, drawHoveringText, drawHoveringText, drawWorldBackground, getClipboardString, getItemToolTip, handleComponentClick, handleComponentHover, handleInput, handleKeyboardInput, isAltKeyDown, isCtrlKeyDown, isFocused, isKeyComboCtrlA, isKeyComboCtrlC, isKeyComboCtrlV, isKeyComboCtrlX, isShiftKeyDown, mouseClickMove, onResize, renderToolTip, sendChatMessage, sendChatMessage, setClipboardString, setFocused, setGuiSize, setText, setWorldAndResolution

Methods inherited from class net.minecraft.client.gui.Gui

drawCenteredString, drawGradientRect, drawHorizontalLine, drawModalRectWithCustomSizedTexture, drawRect, drawScaledCustomSizeModalRect, drawString, drawTexturedModalRect, drawTexturedModalRect, drawTexturedModalRect, drawVerticalLine

Methods inherited from class java.lang.Object

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

Field Detail

parentScreen

public final GuiScreen parentScreen

A reference to the screen object that created this. Used for navigating between screens.

title

public java.lang.String title

titleLine2

@Nullable
public java.lang.String titleLine2

configElements

public final java.util.List<IConfigElement> configElements

initEntries

public final java.util.List<GuiConfigEntries.IConfigEntry> initEntries

entryList

public GuiConfigEntries entryList

btnDefaultAll

protected GuiButtonExt btnDefaultAll

btnUndoAll

protected GuiButtonExt btnUndoAll

chkApplyGlobally

protected GuiCheckBox chkApplyGlobally

modID

public final java.lang.String modID

configID

@Nullable
public final java.lang.String configID

When set to a non-null value the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed if any configElements were changed (includes child screens). If not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.

isWorldRunning

public final boolean isWorldRunning

allRequireWorldRestart

public final boolean allRequireWorldRestart

allRequireMcRestart

public final boolean allRequireMcRestart

needsRefresh

public boolean needsRefresh

undoHoverChecker

protected HoverChecker undoHoverChecker

resetHoverChecker

protected HoverChecker resetHoverChecker

checkBoxHoverChecker

protected HoverChecker checkBoxHoverChecker

Constructor Detail

GuiConfig

public GuiConfig(GuiScreen parentScreen,
                 java.lang.String modid,
                 java.lang.String title)

This constructor handles the @Config configuration classes

Parameters:

parentScreen - the parent GuiScreen object

modid - the mod for which to create a screen

GuiConfig

public GuiConfig(GuiScreen parentScreen,
                 java.lang.String modID,
                 boolean allRequireWorldRestart,
                 boolean allRequireMcRestart,
                 java.lang.String title,
                 java.lang.Class<?>... configClasses)

Parameters:

parentScreen - the parrent GuiScreen object

modID - the mod ID for the mod whose config settings will be editted

allRequireWorldRestart - whether all config elements on this screen require a world restart

allRequireMcRestart - whether all config elements on this screen require a game restart

title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being edited.

configClasses - an array of classes annotated with @Config providing the configuration

GuiConfig

public GuiConfig(GuiScreen parentScreen,
                 java.util.List<IConfigElement> configElements,
                 java.lang.String modID,
                 java.lang.String configID,
                 boolean allRequireWorldRestart,
                 boolean allRequireMcRestart,
                 java.lang.String title)

GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. If a non-null value is passed for configID, the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed if any configElements were changed (includes child screens). If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.

Parameters:

parentScreen - the parent GuiScreen object

configElements - a List of IConfigElement objects

modID - the mod ID for the mod whose config settings will be edited

configID - an identifier that will be passed to the OnConfigChanged and PostConfigChanged events. Setting this value will force the save action to be called when the Done button is pressed on this screen if any configElements were changed.

allRequireWorldRestart - send true if all configElements on this screen require a world restart

allRequireMcRestart - send true if all configElements on this screen require MC to be restarted

title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being edited.

GuiConfig

public GuiConfig(GuiScreen parentScreen,
                 java.util.List<IConfigElement> configElements,
                 java.lang.String modID,
                 boolean allRequireWorldRestart,
                 boolean allRequireMcRestart,
                 java.lang.String title)

GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. This constructor passes null for configID. If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.

Parameters:

parentScreen - the parent GuiScreen object

configElements - a List of IConfigElement objects

modID - the mod ID for the mod whose config settings will be edited

allRequireWorldRestart - send true if all configElements on this screen require a world restart

allRequireMcRestart - send true if all configElements on this screen require MC to be restarted

title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being edited.

GuiConfig

public GuiConfig(GuiScreen parentScreen,
                 java.util.List<IConfigElement> configElements,
                 java.lang.String modID,
                 boolean allRequireWorldRestart,
                 boolean allRequireMcRestart,
                 java.lang.String title,
                 java.lang.String titleLine2)

GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. This constructor passes null for configID. If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.

Parameters:

parentScreen - the parent GuiScreen object

configElements - a List of IConfigElement objects

modID - the mod ID for the mod whose config settings will be edited

allRequireWorldRestart - send true if all configElements on this screen require a world restart

allRequireMcRestart - send true if all configElements on this screen require MC to be restarted

title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being edited.

titleLine2 - the desired title second line for this screen. Typically this is used to send the category name of the category currently being edited.

GuiConfig

public GuiConfig(GuiScreen parentScreen,
                 java.util.List<IConfigElement> configElements,
                 java.lang.String modID,
                 @Nullable
                 java.lang.String configID,
                 boolean allRequireWorldRestart,
                 boolean allRequireMcRestart,
                 java.lang.String title,
                 @Nullable
                 java.lang.String titleLine2)

GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. titleLine2 is specified in this constructor. If a non-null value is passed for configID, the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed if any configElements were changed (includes child screens). If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.

Parameters:

parentScreen - the parent GuiScreen object

configElements - a List of IConfigElement objects

modID - the mod ID for the mod whose config settings will be edited

configID - an identifier that will be passed to the OnConfigChanged and PostConfigChanged events

allRequireWorldRestart - send true if all configElements on this screen require a world restart

allRequireMcRestart - send true if all configElements on this screen require MC to be restarted

title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being edited.

titleLine2 - the desired title second line for this screen. Typically this is used to send the category name of the category currently being edited.

Method Detail

collectConfigElements

private static java.util.List<IConfigElement> collectConfigElements(java.lang.Class<?>[] configClasses)

getAbridgedConfigPath

public static java.lang.String getAbridgedConfigPath(java.lang.String path)

initGui

public void initGui()

Overrides:

initGui in class GuiScreen

onGuiClosed

public void onGuiClosed()

Overrides:

onGuiClosed in class GuiScreen

actionPerformed

protected void actionPerformed(GuiButton button)

Overrides:

actionPerformed in class GuiScreen

handleMouseInput

public void handleMouseInput()
                      throws java.io.IOException

Overrides:

handleMouseInput in class GuiScreen

Throws:

java.io.IOException

mouseClicked

protected void mouseClicked(int x,
                            int y,
                            int mouseEvent)
                     throws java.io.IOException

Overrides:

mouseClicked in class GuiScreen

Throws:

java.io.IOException

mouseReleased

protected void mouseReleased(int x,
                             int y,
                             int mouseEvent)

Overrides:

mouseReleased in class GuiScreen

keyTyped

protected void keyTyped(char eventChar,
                        int eventKey)

Overrides:

keyTyped in class GuiScreen

updateScreen

public void updateScreen()

Overrides:

updateScreen in class GuiScreen

drawScreen

public void drawScreen(int mouseX,
                       int mouseY,
                       float partialTicks)

Overrides:

drawScreen in class GuiScreen

drawToolTip

public void drawToolTip(java.util.List<java.lang.String> stringList,
                        int x,
                        int y)