me.desht.pneumaticcraft.common.config.subconfig

Interface IAuxConfig

All Known Implementing Classes:

AmadronPlayerOffers, ArmorFeatureStatus, ArmorHUDLayout, AuxConfigJson, MicromissileDefaults, ProgWidgetConfig, ThirdPartyConfig

public interface IAuxConfig

Method Summary

Modifier and Type	Method and Description
default void	clear() Clear the contents of this config when init'ing a new config file.
java.lang.String	getConfigFilename() Get the filename (within the "pneumaticcraft/" folder in the top-level config directory) where this config should be stored.
void	postInit(java.io.File file) Called during the post-init phase, after the server has finished loading.
void	preInit(java.io.File file) Called during the pre-init phase, with the top-level mod config file name (pneumaticcraft.cfg)
default boolean	useWorldSpecificDir() If true, use a world-local directory for this config, outside the normal config/ hierarchy.

Method Detail

getConfigFilename

java.lang.String getConfigFilename()

Get the filename (within the "pneumaticcraft/" folder in the top-level config directory) where this config should be stored.

Returns:

the config file name

preInit

void preInit(java.io.File file)
      throws java.io.IOException

Called during the pre-init phase, with the top-level mod config file name (pneumaticcraft.cfg)

Parameters:

file - the config file name

Throws:

java.io.IOException - if there is a problem reading/writing any files

postInit

void postInit(java.io.File file)
       throws java.io.IOException

Called during the post-init phase, after the server has finished loading.

Parameters:

file - the config file name

Throws:

java.io.IOException - if there is a problem reading/writing any files

clear

default void clear()

Clear the contents of this config when init'ing a new config file. This is required for world-specific configs to avoid carrying configs between worlds when switching worlds in single-player.

useWorldSpecificDir

default boolean useWorldSpecificDir()

If true, use a world-local directory for this config, outside the normal config/ hierarchy. Used for world-specific (rather than game-global) saved data.

Returns:

true to use a world-specific directory, false to use the usual config directory