Package net.neoforged.fml.loading

Class FMLServiceProvider

java.lang.Object

net.neoforged.fml.loading.FMLServiceProvider

All Implemented Interfaces:

ITransformationService

public class FMLServiceProvider
extends Object
implements ITransformationService

Nested Class Summary

Nested classes/interfaces inherited from interface cpw.mods.modlauncher.api.ITransformationService

ITransformationService.OptionResult, ITransformationService.Resource

Field Summary

Fields

Modifier and Type	Field	Description
private joptsimple.ArgumentAcceptingOptionSpec<String>	fmlOption
private joptsimple.ArgumentAcceptingOptionSpec<String>	forgeOption
(package private) ILaunchContext	launchContext
private static final org.slf4j.Logger	LOGGER
private List<String>	mavenRootsArgumentList
private joptsimple.ArgumentAcceptingOptionSpec<String>	mavenRootsOption
private joptsimple.ArgumentAcceptingOptionSpec<String>	mcOption
private joptsimple.ArgumentAcceptingOptionSpec<String>	mcpOption
private List<String>	mixinConfigsArgumentList
private joptsimple.ArgumentAcceptingOptionSpec<String>	mixinConfigsOption
private List<String>	modListsArgumentList
private joptsimple.ArgumentAcceptingOptionSpec<String>	modListsOption
private List<String>	modsArgumentList
private joptsimple.ArgumentAcceptingOptionSpec<String>	modsOption
private VersionInfo	versionInfo

Constructor Summary

Constructors

Constructor	Description
FMLServiceProvider()

Method Summary

Modifier and Type	Method	Description
void	arguments(BiFunction<String,String,joptsimple.OptionSpecBuilder> argumentBuilder)	Define command line arguments for your mod service.
void	argumentValues(ITransformationService.OptionResult option)
List<ITransformationService.Resource>	beginScanning(IEnvironment environment)	Scan for mods (but don't classload them), identify metadata that might drive game functionality, return list of elements and target module layer (One of PLUGIN or GAME)
List<ITransformationService.Resource>	completeScan(IModuleLayerManager layerManager)
void	initialize(IEnvironment environment)	Initialize your service.
String	name()	The name of this mod service.
void	onLoad(IEnvironment environment, Set<String> otherServices)	Load your service.
List<? extends ITransformer<?>>	transformers()	The ITransformer is the fundamental operator of the system.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

modsOption

private joptsimple.ArgumentAcceptingOptionSpec<String> modsOption

modListsOption

private joptsimple.ArgumentAcceptingOptionSpec<String> modListsOption

mavenRootsOption

private joptsimple.ArgumentAcceptingOptionSpec<String> mavenRootsOption

mixinConfigsOption

private joptsimple.ArgumentAcceptingOptionSpec<String> mixinConfigsOption

fmlOption

private joptsimple.ArgumentAcceptingOptionSpec<String> fmlOption

forgeOption

private joptsimple.ArgumentAcceptingOptionSpec<String> forgeOption

mcOption

private joptsimple.ArgumentAcceptingOptionSpec<String> mcOption

mcpOption

private joptsimple.ArgumentAcceptingOptionSpec<String> mcpOption

modsArgumentList

private List<String> modsArgumentList

modListsArgumentList

private List<String> modListsArgumentList

mavenRootsArgumentList

private List<String> mavenRootsArgumentList

mixinConfigsArgumentList

private List<String> mixinConfigsArgumentList

versionInfo

private VersionInfo versionInfo

launchContext

@VisibleForTesting
ILaunchContext launchContext

Constructor Details

FMLServiceProvider

public FMLServiceProvider()

Method Details

name

public String name()

Description copied from interface: ITransformationService

The name of this mod service. It will be used throughout the system. It should be lower case, the first character should be alphanumeric and it should only consist of standard alphanumeric characters

Specified by:

name in interface ITransformationService

Returns:

the name of the mod service

initialize

public void initialize(IEnvironment environment)

Description copied from interface: ITransformationService

Initialize your service.

Specified by:

initialize in interface ITransformationService

Parameters:

environment - environment - query state from here to determine viability

beginScanning

public List<ITransformationService.Resource> beginScanning(IEnvironment environment)

Description copied from interface: ITransformationService

Scan for mods (but don't classload them), identify metadata that might drive game functionality, return list of elements and target module layer (One of PLUGIN or GAME)

Specified by:

beginScanning in interface ITransformationService

Parameters:

environment - environment

completeScan

public List<ITransformationService.Resource> completeScan(IModuleLayerManager layerManager)

Specified by:

completeScan in interface ITransformationService

onLoad

public void onLoad(IEnvironment environment,
 Set<String> otherServices)
            throws IncompatibleEnvironmentException

Description copied from interface: ITransformationService

Load your service. Called immediately on loading with a list of other services found. Use to identify and immediately indicate incompatibilities with other services, and environment configuration. This is to try and immediately abort a guaranteed bad environment.

Specified by:

onLoad in interface ITransformationService

Parameters:

environment - environment - query state from here

otherServices - other services loaded with the system

Throws:

IncompatibleEnvironmentException - if there is an incompatibility detected. Identify specifics in the exception message

arguments

public void arguments(BiFunction<String,String,joptsimple.OptionSpecBuilder> argumentBuilder)

Description copied from interface: ITransformationService

Define command line arguments for your mod service. These will be prefixed by your ITransformationService.name() to prevent collisions.

Specified by:

arguments in interface ITransformationService

Parameters:

argumentBuilder - a function mapping name, description to a set of JOptSimple properties for that argument

argumentValues

public void argumentValues(ITransformationService.OptionResult option)

Specified by:

argumentValues in interface ITransformationService

transformers

public List<? extends ITransformer<?>> transformers()

Description copied from interface: ITransformationService

The ITransformer is the fundamental operator of the system.

Specified by:

transformers in interface ITransformationService

Returns:

A list of transformers for your ITransformationService. This is called after ITransformationService.onLoad(IEnvironment, Set) and ITransformationService.initialize(IEnvironment), so you can return an appropriate Transformer set for the environment you find yourself in.