com.pixelmonmod.pixelmon.api.spawning.util

Class SetLoader

java.lang.Object

com.pixelmonmod.pixelmon.api.spawning.util.SetLoader

public class SetLoader
extends java.lang.Object

Class responsible for the importing and exporting of SpawnSets. It also acts as storage for the sets that have been loaded.

Created by Hiroku

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SPAWN_SET_FOLDER
static java.lang.String	SPAWN_SET_ROOT
static java.lang.Class<? extends SpawnSet>	targetedSpawnSetClass This is the class that the JSON loader will target for spawn sets.

Constructor Summary

Constructors

Constructor and Description
SetLoader()

Method Summary

Modifier and Type	Method and Description
static void	addSet(SpawnSet set) Adds the given set to the cache.
static void	checkForMissingSpawnSets() Checks for any missing SpawnSets in the default set folder.
static void	clearAll() Clears all sets from the cache.
static void	export(java.lang.String dir, java.lang.String name) Exports a set with the given name to the given directory, if possible.
static void	exportAll(java.lang.String dir) Exports all sets to the given directory.
static <T> com.google.common.collect.ImmutableList<T>	getAllSets() Gets all the SpawnSets.
static <T> T	getSet(java.lang.String name) Gets the set with the given name.
static java.lang.String	getSpawnSetPath() Gets the current loading directory for SpawnSets.
static java.util.ArrayList<SpawnSet>	importSetsFrom(java.lang.String dir) Imports all sets from the given directory.
static void	recursiveSetSearch(java.lang.String dir, java.util.ArrayList<java.io.File> jsons) Utility function for doing a recursive search for JSON files.
static java.util.ArrayList<SpawnSet>	retrieveSpawnSetsFromAssets(java.lang.String folder) Pulls the default SpawnSets from the jar, and if external spawning JSONs are on, and the file found in the assets does not exist in the default SpawnSet folder, copies it out into that location.

Methods inherited from class java.lang.Object

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

Field Detail

targetedSpawnSetClass

public static java.lang.Class<? extends SpawnSet> targetedSpawnSetClass

This is the class that the JSON loader will target for spawn sets. This might be changed if the spawn sets are an extension of SpawnSet with customised additional fields or behaviour.

SPAWN_SET_ROOT

public static final java.lang.String SPAWN_SET_ROOT

See Also:

Constant Field Values

DEFAULT_SPAWN_SET_FOLDER

public static final java.lang.String DEFAULT_SPAWN_SET_FOLDER

See Also:

Constant Field Values

Constructor Detail

SetLoader

public SetLoader()

Method Detail

getAllSets

public static <T> com.google.common.collect.ImmutableList<T> getAllSets()

Gets all the SpawnSets. Parameterizing will cause an attempt to cast all sets to that type.

clearAll

public static void clearAll()

Clears all sets from the cache.

getSet

public static <T> T getSet(java.lang.String name)

Gets the set with the given name. This could be null. If parameterized, an attempt will be made to cast it to this type.

export

public static void export(java.lang.String dir,
                          java.lang.String name)

Exports a set with the given name to the given directory, if possible.

exportAll

public static void exportAll(java.lang.String dir)

Exports all sets to the given directory.

importSetsFrom

public static java.util.ArrayList<SpawnSet> importSetsFrom(java.lang.String dir)

Imports all sets from the given directory. This will do a recursive folder search. In the case of SpawnInfoPokemon, it will discard any that do not fit the configured available generations as defined by the PixelmonConfig.

recursiveSetSearch

public static void recursiveSetSearch(java.lang.String dir,
                                      java.util.ArrayList<java.io.File> jsons)

Utility function for doing a recursive search for JSON files.

addSet

public static void addSet(SpawnSet set)

Adds the given set to the cache.

getSpawnSetPath

public static java.lang.String getSpawnSetPath()

Gets the current loading directory for SpawnSets.

checkForMissingSpawnSets

public static void checkForMissingSpawnSets()

Checks for any missing SpawnSets in the default set folder.

retrieveSpawnSetsFromAssets

public static java.util.ArrayList<SpawnSet> retrieveSpawnSetsFromAssets(java.lang.String folder)

Pulls the default SpawnSets from the jar, and if external spawning JSONs are on, and the file found in the assets does not exist in the default SpawnSet folder, copies it out into that location. This does not regenerate modified files, only removed ones. If external spawning JSONs are not on, the sets are added into the cache as per usual.