Package net.fabricmc.loader.api.metadata

Interface ModOrigin

public interface ModOrigin

Representation of the various locations a mod was loaded from originally.

This location is not necessarily identical to the code source used at runtime, a mod may get copied or otherwise transformed before being put on the class path. It thus mostly represents the installation and initial loading, not what is being directly accessed at runtime.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ModOrigin.Kind	Non-exhaustive list of possible ModOrigin kinds.

Method Summary

Modifier and Type	Method	Description
ModOrigin.Kind	getKind()	Get the kind of this origin, determines the available methods.
String	getParentModId()	Get the parent mod for a ModOrigin.Kind.NESTED origin.
String	getParentSubLocation()	Get the sub-location within the parent mod for a ModOrigin.Kind.NESTED origin.
List<Path>	getPaths()	Get the jar or folder paths for a ModOrigin.Kind.PATH origin.

Method Details

getKind

ModOrigin.Kind getKind()

Get the kind of this origin, determines the available methods.

Returns:

mod origin kind

getPaths

List<Path> getPaths()

Get the jar or folder paths for a ModOrigin.Kind.PATH origin.

Returns:

jar or folder paths

Throws:

UnsupportedOperationException - for incompatible kinds

getParentModId

String getParentModId()

Get the parent mod for a ModOrigin.Kind.NESTED origin.

Returns:

parent mod

Throws:

UnsupportedOperationException - for incompatible kinds

getParentSubLocation

String getParentSubLocation()

Get the sub-location within the parent mod for a ModOrigin.Kind.NESTED origin.

Returns:

sub-location

Throws:

UnsupportedOperationException - for incompatible kinds