net.minecraftforge.common.Configuration Class Reference

Classes
class	UnicodeInputStreamReader

Public Member Functions
	Configuration ()
	Configuration (File file)
	Configuration (File file, boolean caseSensitiveCustomCategories)
Property	getBlock (String key, int defaultID)
Property	getBlock (String key, int defaultID, String comment)
Property	getBlock (String category, String key, int defaultID)
Property	getBlock (String category, String key, int defaultID, String comment)
Property	getTerrainBlock (String category, String key, int defaultID, String comment)
Property	getItem (String key, int defaultID)
Property	getItem (String key, int defaultID, String comment)
Property	getItem (String category, String key, int defaultID)
Property	getItem (String category, String key, int defaultID, String comment)
Property	get (String category, String key, int defaultValue)
Property	get (String category, String key, int defaultValue, String comment)
Property	get (String category, String key, boolean defaultValue)
Property	get (String category, String key, boolean defaultValue, String comment)
Property	get (String category, String key, double defaultValue)
Property	get (String category, String key, double defaultValue, String comment)
Property	get (String category, String key, String defaultValue)
Property	get (String category, String key, String defaultValue, String comment)
Property	get (String category, String key, String[] defaultValue)
Property	get (String category, String key, String[] defaultValue, String comment)
Property	get (String category, String key, int[] defaultValue)
Property	get (String category, String key, int[] defaultValue, String comment)
Property	get (String category, String key, double[] defaultValue)
Property	get (String category, String key, double[] defaultValue, String comment)
Property	get (String category, String key, boolean[] defaultValue)
Property	get (String category, String key, boolean[] defaultValue, String comment)
Property	get (String category, String key, String defaultValue, String comment, Property.Type type)
Property	get (String category, String key, String[] defaultValue, String comment, Property.Type type)
boolean	hasCategory (String category)
boolean	hasKey (String category, String key)
void	load ()
void	save ()
ConfigCategory	getCategory (String category)
void	removeCategory (ConfigCategory category)
void	addCustomCategoryComment (String category, String comment)
boolean	hasChanged ()
Set< String >	getCategoryNames ()

Static Public Member Functions
static void	enableGlobalConfig ()

Public Attributes
String	defaultEncoding = DEFAULT_ENCODING
boolean	isChild = false

Static Public Attributes
static final String	CATEGORY_GENERAL = "general"
static final String	CATEGORY_BLOCK = "block"
static final String	CATEGORY_ITEM = "item"
static final String	ALLOWED_CHARS = "._-"
static final String	DEFAULT_ENCODING = "UTF-8"
static final String	CATEGORY_SPLITTER = "."
static final String	NEW_LINE
static final CharMatcher	allowedProperties = CharMatcher.JAVA_LETTER_OR_DIGIT.or(CharMatcher.anyOf(ALLOWED_CHARS))

Detailed Description

This class offers advanced configurations capabilities, allowing to provide various categories for configuration variables.

Constructor & Destructor Documentation

net.minecraftforge.common.Configuration.Configuration

(

)

net.minecraftforge.common.Configuration.Configuration

(

File

file)

Create a configuration file for the file given in parameter.

net.minecraftforge.common.Configuration.Configuration	(	File	file,
		boolean	caseSensitiveCustomCategories
	)

Member Function Documentation

void net.minecraftforge.common.Configuration.addCustomCategoryComment	(	String	category,
		String	comment
	)

static void net.minecraftforge.common.Configuration.enableGlobalConfig ( )

static

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		int	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		int	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		boolean	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		boolean	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		double	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		double	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		String	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		String	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		String[]	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		String[]	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		int[]	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		int[]	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		double[]	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		double[]	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		boolean[]	defaultValue
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		boolean[]	defaultValue,
		String	comment
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		String	defaultValue,
		String	comment,
		Property.Type	type
	)

Property net.minecraftforge.common.Configuration.get	(	String	category,
		String	key,
		String[]	defaultValue,
		String	comment,
		Property.Type	type
	)

Property net.minecraftforge.common.Configuration.getBlock	(	String	key,
		int	defaultID
	)

Gets or create a block id property. If the block id property key is already in the configuration, then it will be used. Otherwise, defaultId will be used, except if already taken, in which case this will try to determine a free default id.

Property net.minecraftforge.common.Configuration.getBlock	(	String	key,
		int	defaultID,
		String	comment
	)

Property net.minecraftforge.common.Configuration.getBlock	(	String	category,
		String	key,
		int	defaultID
	)

Property net.minecraftforge.common.Configuration.getBlock	(	String	category,
		String	key,
		int	defaultID,
		String	comment
	)

ConfigCategory net.minecraftforge.common.Configuration.getCategory

(

String

category)

Set<String> net.minecraftforge.common.Configuration.getCategoryNames

(

)

Property net.minecraftforge.common.Configuration.getItem	(	String	key,
		int	defaultID
	)

Property net.minecraftforge.common.Configuration.getItem	(	String	key,
		int	defaultID,
		String	comment
	)

Property net.minecraftforge.common.Configuration.getItem	(	String	category,
		String	key,
		int	defaultID
	)

Property net.minecraftforge.common.Configuration.getItem	(	String	category,
		String	key,
		int	defaultID,
		String	comment
	)

Property net.minecraftforge.common.Configuration.getTerrainBlock	(	String	category,
		String	key,
		int	defaultID,
		String	comment
	)

Special version of getBlock to be used when you want to garentee the ID you get is below 256 This should ONLY be used by mods who do low level terrain generation, or ones that add new biomes. EXA: ExtraBiomesXL

Specifically, if your block is used BEFORE the Chunk is created, and placed in the terrain byte array directly. If you add a new biome and you set the top/filler block, they need to be <256, nothing else.

If you're adding a new ore, DON'T call this function.

Normal mods such as '50 new ores' do not need to be below 256 so should use the normal getBlock

boolean net.minecraftforge.common.Configuration.hasCategory

(

String

category)

boolean net.minecraftforge.common.Configuration.hasChanged

(

)

boolean net.minecraftforge.common.Configuration.hasKey	(	String	category,
		String	key
	)

void net.minecraftforge.common.Configuration.load

(

)

void net.minecraftforge.common.Configuration.removeCategory

(

ConfigCategory

category)

void net.minecraftforge.common.Configuration.save

(

)

Member Data Documentation

final String net.minecraftforge.common.Configuration.ALLOWED_CHARS = "._-"

static

final CharMatcher net.minecraftforge.common.Configuration.allowedProperties = CharMatcher.JAVA_LETTER_OR_DIGIT.or(CharMatcher.anyOf(ALLOWED_CHARS))

static

final String net.minecraftforge.common.Configuration.CATEGORY_BLOCK = "block"

static

final String net.minecraftforge.common.Configuration.CATEGORY_GENERAL = "general"

static

final String net.minecraftforge.common.Configuration.CATEGORY_ITEM = "item"

static

final String net.minecraftforge.common.Configuration.CATEGORY_SPLITTER = "."

static

final String net.minecraftforge.common.Configuration.DEFAULT_ENCODING = "UTF-8"

static

String net.minecraftforge.common.Configuration.defaultEncoding = DEFAULT_ENCODING

boolean net.minecraftforge.common.Configuration.isChild = false

final String net.minecraftforge.common.Configuration.NEW_LINE

static

---

The documentation for this class was generated from the following file:

• C:/Users/LazDude/Downloads/MinecraftModding/YATS/forge/mcp/src/minecraft/net/minecraftforge/common/Configuration.java