net.minecraftforge.common.config

Interface IFieldWrapper

All Known Implementing Classes:

FieldWrapper, FieldWrapper.EnumWrapper, FieldWrapper.MapWrapper, FieldWrapper.PrimitiveWrapper, FieldWrapper.SingleValueFieldWrapper

public interface IFieldWrapper

The objects are expected to get their wrapped field, the owning class, instance and category string on initialization. In general: The key is the fully qualified property name, where each subcategory is appended with a dot. i.e: general.map.isPresent

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory() i.e.
java.lang.String[]	getKeys()
ITypeAdapter	getTypeAdapter()
java.lang.Object	getValue(java.lang.String key)
boolean	handlesKey(java.lang.String key)
boolean	hasKey(java.lang.String key)
void	setupConfiguration(Configuration cfg, java.lang.String desc, java.lang.String langKey, boolean reqMCRestart, boolean reqWorldRestart) Deprecated.
default void	setupConfiguration(Configuration cfg, java.lang.String desc, java.lang.String langKey, boolean reqMCRestart, boolean reqWorldRestart, boolean hasSlidingControl)
void	setValue(java.lang.String key, java.lang.Object value)

Method Detail

getTypeAdapter

ITypeAdapter getTypeAdapter()

Returns:

The type adapter to serialize the values returned by getValue. Null if non-primitive.

getKeys

java.lang.String[] getKeys()

Returns:

a list of fully qualified property keys handled by this field

getValue

java.lang.Object getValue(java.lang.String key)

Parameters:

key - the fully qualified property key

Returns:

the value the wrapped field associates with the given key

setValue

void setValue(java.lang.String key,
              java.lang.Object value)

Parameters:

key - the fully qualified property key

value - the target value of the property associated with the key

hasKey

boolean hasKey(java.lang.String key)

Parameters:

key - a fully qualified property key

Returns:

true if the wrapped field contains a property associated with the given key

handlesKey

boolean handlesKey(java.lang.String key)

Parameters:

key - a fully qualified property key

Returns:

true if the wrapped field can save information associated with the given key, false otherwise

setupConfiguration

@Deprecated
void setupConfiguration(Configuration cfg,
                                    java.lang.String desc,
                                    java.lang.String langKey,
                                    boolean reqMCRestart,
                                    boolean reqWorldRestart)

Deprecated.

See Also:

setupConfiguration(Configuration, String, String, boolean, boolean, boolean)

setupConfiguration

default void setupConfiguration(Configuration cfg,
                                java.lang.String desc,
                                java.lang.String langKey,
                                boolean reqMCRestart,
                                boolean reqWorldRestart,
                                boolean hasSlidingControl)

Parameters:

cfg - The configuration object holding the properties

desc - The properties description

langKey - The languageKey of the property, used in GUI

reqMCRestart - True, if a change in this property requires a restart of Minecraft

reqWorldRestart - True, if the world needs to be reloaded after changes to this property

hasSlidingControl - true if the property is going to have a slider control attached in the configuration UI; works in conjunction with Config.RangeInt and Config.RangeDouble

getCategory

java.lang.String getCategory()

i.e. general.map in the example above

Returns:

the category name in which the entries should be saved. This includes the parent categories