net.minecraftforge.fml.client

Class FMLConfigGuiFactory

java.lang.Object

net.minecraftforge.fml.client.FMLConfigGuiFactory

All Implemented Interfaces:

IModGuiFactory

public class FMLConfigGuiFactory
extends java.lang.Object
implements IModGuiFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FMLConfigGuiFactory.CustomArrayEntry
static class	FMLConfigGuiFactory.FMLConfigGuiScreen

Nested classes/interfaces inherited from interface net.minecraftforge.fml.client.IModGuiFactory

IModGuiFactory.RuntimeOptionCategoryElement, IModGuiFactory.RuntimeOptionGuiHandler

Constructor Summary

Constructors

Constructor and Description
FMLConfigGuiFactory()

Method Summary

Modifier and Type	Method and Description
GuiScreen	createConfigGui(GuiScreen parentScreen) Return an initialized GuiScreen.
IModGuiFactory.RuntimeOptionGuiHandler	getHandlerFor(IModGuiFactory.RuntimeOptionCategoryElement element) Return an instance of a IModGuiFactory.RuntimeOptionGuiHandler that handles painting the right hand side option screen for the specified IModGuiFactory.RuntimeOptionCategoryElement.
boolean	hasConfigGui() If this method returns false, the config button in the mod list will be disabled
void	initialize(Minecraft minecraftInstance) Called when instantiated to initialize with the active minecraft instance.
java.lang.Class<? extends GuiScreen>	mainConfigGuiClass() Return the name of a class extending GuiScreen.
java.util.Set<IModGuiFactory.RuntimeOptionCategoryElement>	runtimeGuiCategories() Return a list of the "runtime" categories this mod wishes to populate with GUI elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

FMLConfigGuiFactory

public FMLConfigGuiFactory()

Method Detail

hasConfigGui

public boolean hasConfigGui()

Description copied from interface: IModGuiFactory

If this method returns false, the config button in the mod list will be disabled

Specified by:

hasConfigGui in interface IModGuiFactory

Returns:

true if this object provides a config gui screen, false otherwise

initialize

public void initialize(Minecraft minecraftInstance)

Description copied from interface: IModGuiFactory

Called when instantiated to initialize with the active minecraft instance.

Specified by:

initialize in interface IModGuiFactory

Parameters:

minecraftInstance - the instance

createConfigGui

public GuiScreen createConfigGui(GuiScreen parentScreen)

Description copied from interface: IModGuiFactory

Return an initialized GuiScreen. This screen will be displayed when the "config" button is pressed in the mod list. It will have a single argument constructor - the "parent" screen, the same as all Minecraft GUIs. The expected behaviour is that this screen will replace the "mod list" screen completely, and will return to the mod list screen through the parent link, once the appropriate action is taken from the config screen. This config GUI is anticipated to provide configuration to the mod in a friendly visual way. It should not be abused to set internals such as IDs (they're gonna keep disappearing anyway), but rather, interesting behaviours. This config GUI is never run when a server game is running, and should be used to configure desired behaviours that affect server state. Costs, mod game modes, stuff like that can be changed here.

Specified by:

createConfigGui in interface IModGuiFactory

Parameters:

parentScreen - The screen to which must be returned when closing the returned screen.

Returns:

A class that will be instantiated on clicks on the config button or null if no GUI is desired.

mainConfigGuiClass

public java.lang.Class<? extends GuiScreen> mainConfigGuiClass()

Description copied from interface: IModGuiFactory

Return the name of a class extending GuiScreen. This class will be instantiated when the "config" button is pressed in the mod list. It will have a single argument constructor - the "parent" screen, the same as all Minecraft GUIs. The expected behaviour is that this screen will replace the "mod list" screen completely, and will return to the mod list screen through the parent link, once the appropriate action is taken from the config screen. A null from this method indicates that the mod does not provide a "config" button GUI screen, and the config button will be hidden/disabled. This config GUI is anticipated to provide configuration to the mod in a friendly visual way. It should not be abused to set internals such as IDs (they're gonna keep disappearing anyway), but rather, interesting behaviours. This config GUI is never run when a server game is running, and should be used to configure desired behaviours that affect server state. Costs, mod game modes, stuff like that can be changed here.

Specified by:

mainConfigGuiClass in interface IModGuiFactory

Returns:

A class that will be instantiated on clicks on the config button or null if no GUI is desired.

runtimeGuiCategories

public java.util.Set<IModGuiFactory.RuntimeOptionCategoryElement> runtimeGuiCategories()

Description copied from interface: IModGuiFactory

Return a list of the "runtime" categories this mod wishes to populate with GUI elements. Runtime categories are created on demand and organized in a 'lite' tree format. The parent represents the parent node in the tree. There is one special parent 'Help' that will always list first, and is generally meant to provide Help type content for mods. The remaining parents will sort alphabetically, though this may change if there is a lot of alphabetic abuse. "AAA" is probably never a valid category parent. Runtime configuration itself falls into two flavours: in-game help, which is generally non interactive except for the text it wishes to show, and client-only affecting behaviours. This would include things like toggling minimaps, or cheat modes or anything NOT affecting the behaviour of the server. Please don't abuse this to change the state of the server in any way, this is intended to behave identically when the server is local or remote.

Specified by:

runtimeGuiCategories in interface IModGuiFactory

Returns:

the set of options this mod wishes to have available, or empty if none

getHandlerFor

public IModGuiFactory.RuntimeOptionGuiHandler getHandlerFor(IModGuiFactory.RuntimeOptionCategoryElement element)

Description copied from interface: IModGuiFactory

Return an instance of a IModGuiFactory.RuntimeOptionGuiHandler that handles painting the right hand side option screen for the specified IModGuiFactory.RuntimeOptionCategoryElement.

Specified by:

getHandlerFor in interface IModGuiFactory

Parameters:

element - The element we wish to paint for

Returns:

The Handler for painting it