Class ConvertFtbQuests

java.lang.Object

me.pauleff.converter.plugins.ConvertFtbQuests

All Implemented Interfaces:

MOOCPlugin, MultiServerPlugin

public class ConvertFtbQuests
extends Object
implements MultiServerPlugin

Converts FTB Quests progress SNBT files between online and offline player UUIDs.

Runs for modded servers during an online/offline conversion. Operates on UUID-named progress files under the world's ftbquests folder; quest book definition files are left unchanged.

See Also:

• ConverterV3

Constructor Summary

Constructors

Constructor	Description
ConvertFtbQuests()

Method Summary

Modifier and Type	Method	Description
List<ServerType>	compatibleServerTypes()	Returns ServerType.MODDED as the only compatible server type.
boolean	isEnabled(PluginContext ctx)	Returns true when a conversion is requested, the server is modded, and the ftbquests folder is inside the conversion scope.
PluginMetadata	metadata()	Returns the metadata that identifies and describes this plugin.
void	run(PluginContext ctx, List<Path> resolvedExistingTargets)	Converts UUID-named progress SNBT files under each resolved FTB Quests folder.
List<Path>	setTargets(PluginContext ctx)	Returns the ftbquests folder under the world directory.

Methods inherited from class Object

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

Methods inherited from interface MOOCPlugin

logger, returnAllFilesInFolders

Modifier and Type	Method	Description
default org.slf4j.Logger	logger()	Returns a logger named after the runtime class of this plugin.
default List<Path>	returnAllFilesInFolders(List<Path> worldDimensionRootFolders)	Collects all regular files under the given world dimension root folders.

Constructor Details

ConvertFtbQuests

public ConvertFtbQuests()

Method Details

metadata

public PluginMetadata metadata()

Returns the metadata that identifies and describes this plugin.

Specified by:

metadata in interface MOOCPlugin

Returns:

the plugin metadata

compatibleServerTypes

public List<ServerType> compatibleServerTypes()

Returns ServerType.MODDED as the only compatible server type.

Specified by:

compatibleServerTypes in interface MultiServerPlugin

Returns:

a single-element list containing ServerType.MODDED

isEnabled

public boolean isEnabled(PluginContext ctx)

Returns true when a conversion is requested, the server is modded, and the ftbquests folder is inside the conversion scope.

Specified by:

isEnabled in interface MOOCPlugin

Specified by:

isEnabled in interface MultiServerPlugin

Parameters:

ctx - the shared conversion context

Returns:

true if this plugin should run; false otherwise

setTargets

public List<Path> setTargets(PluginContext ctx)

Returns the ftbquests folder under the world directory.

Specified by:

setTargets in interface MOOCPlugin

Parameters:

ctx - the shared conversion context

Returns:

a single-element list containing the FTB Quests folder path

run

public void run(PluginContext ctx,
 List<Path> resolvedExistingTargets)
         throws IOException

Converts UUID-named progress SNBT files under each resolved FTB Quests folder.

Specified by:

run in interface MOOCPlugin

Parameters:

ctx - the shared conversion context

resolvedExistingTargets - the existing ftbquests directories to process

Throws:

IOException - if reading or writing progress files fails