Index
All Classes|All Packages
A
- ANY - net.fabricmc.loader.api.VersionPredicate.Type
- ARRAY - net.fabricmc.loader.api.metadata.CustomValue.CvType
- asMap() - Method in interface net.fabricmc.loader.api.metadata.ContactInformation
-
Gets all contact information provided as a map from contact type to information.
B
- BOOLEAN - net.fabricmc.loader.api.metadata.CustomValue.CvType
C
- CLIENT - net.fabricmc.api.EnvType
-
Represents the client environment type, in which the
client.jar
for a Minecraft version is the main game jar. - CLIENT - net.fabricmc.loader.api.metadata.ModEnvironment
- ClientModInitializer - Interface in net.fabricmc.api
-
A mod initializer ran only on
EnvType.CLIENT
. - compareTo(SemanticVersion) - Method in interface net.fabricmc.loader.api.SemanticVersion
- COMPONENT_WILDCARD - Static variable in interface net.fabricmc.loader.api.SemanticVersion
-
The value of version component that indicates a wildcard.
- ContactInformation - Interface in net.fabricmc.loader.api.metadata
-
Represents a contact information.
- containsCustomElement(String) - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Deprecated.
- containsCustomValue(String) - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns if the mod's
fabric.mod.json
declares a custom value underkey
. - containsKey(String) - Method in interface net.fabricmc.loader.api.metadata.CustomValue.CvObject
-
Returns whether a
key
is present within this object value. - create(ModContainer, String, Class<T>) - Method in interface net.fabricmc.loader.api.LanguageAdapter
-
Creates an object of
type
from an arbitrary string declaration. - CustomValue - Interface in net.fabricmc.loader.api.metadata
-
Represents a custom value in the
fabric.mod.json
. - CustomValue.CvArray - Interface in net.fabricmc.loader.api.metadata
-
Represents an
CustomValue.CvType.ARRAY
value. - CustomValue.CvObject - Interface in net.fabricmc.loader.api.metadata
-
Represents an
CustomValue.CvType.OBJECT
value. - CustomValue.CvType - Enum in net.fabricmc.loader.api.metadata
-
The possible types of a custom value.
D
- DedicatedServerModInitializer - Interface in net.fabricmc.api
-
A mod initializer ran only on
EnvType.SERVER
. - describe(String) - Method in enum net.fabricmc.loader.api.VersionPredicate.Type
E
- EMPTY - Static variable in interface net.fabricmc.loader.api.metadata.ContactInformation
-
An empty contact information.
- EntrypointContainer<T> - Interface in net.fabricmc.loader.api.entrypoint
-
A container holding both an entrypoint instance and the
ModContainer
which has provided the entrypoint. - EntrypointException - Exception in net.fabricmc.loader.api
-
Represents an exception that arises when obtaining entrypoints.
- EntrypointException(String) - Constructor for exception net.fabricmc.loader.api.EntrypointException
-
Deprecated.For internal use only, to be removed!
- EntrypointException(String, String, Throwable) - Constructor for exception net.fabricmc.loader.api.EntrypointException
-
Deprecated.For internal use only, use regular exceptions!
- EntrypointException(String, Throwable) - Constructor for exception net.fabricmc.loader.api.EntrypointException
-
Deprecated.For internal use only, to be removed!
- EntrypointException(Throwable) - Constructor for exception net.fabricmc.loader.api.EntrypointException
-
Deprecated.For internal use only, to be removed!
- Environment - Annotation Type in net.fabricmc.api
-
Applied to declare that the annotated element is present only in the specified environment.
- EnvironmentInterface - Annotation Type in net.fabricmc.api
-
Applied to declare that a class implements an interface only in the specified environment.
- EnvironmentInterfaces - Annotation Type in net.fabricmc.api
-
A container of multiple
EnvironmentInterface
annotations on a class, often defined implicitly. - EnvType - Enum in net.fabricmc.api
-
Represents a type of environment.
- equals(Object) - Method in class net.fabricmc.loader.api.VersionPredicate
- EQUALS - net.fabricmc.loader.api.VersionPredicate.Type
F
- FabricLoader - Interface in net.fabricmc.loader.api
-
The public-facing FabricLoader instance.
G
- get(int) - Method in interface net.fabricmc.loader.api.metadata.CustomValue.CvArray
-
Gets the value at
index
within this array value. - get(String) - Method in interface net.fabricmc.loader.api.metadata.ContactInformation
-
Gets a certain type of contact information.
- get(String) - Method in interface net.fabricmc.loader.api.metadata.CustomValue.CvObject
-
Gets the value associated with a
key
within this object value. - getAllMods() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Gets all mod containers.
- getAsArray() - Method in interface net.fabricmc.loader.api.metadata.CustomValue
-
Returns this value as an
CustomValue.CvType.ARRAY
. - getAsBoolean() - Method in interface net.fabricmc.loader.api.metadata.CustomValue
-
Returns this value as a
CustomValue.CvType.BOOLEAN
. - getAsNumber() - Method in interface net.fabricmc.loader.api.metadata.CustomValue
-
Returns this value as a
CustomValue.CvType.NUMBER
. - getAsObject() - Method in interface net.fabricmc.loader.api.metadata.CustomValue
-
Returns this value as an
CustomValue.CvType.OBJECT
. - getAsString() - Method in interface net.fabricmc.loader.api.metadata.CustomValue
-
Returns this value as a
CustomValue.CvType.STRING
. - getAuthors() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's authors.
- getBreaks() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's conflicts, with which the Loader will terminate loading.
- getBuildKey() - Method in interface net.fabricmc.loader.api.SemanticVersion
-
Returns the build key in the version notation.
- getConfigDir() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Get the current directory for game configuration files.
- getConfigDirectory() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Deprecated.
- getConflicts() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's conflicts, with which the Loader will emit a warning.
- getContact() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's contact information.
- getContact() - Method in interface net.fabricmc.loader.api.metadata.Person
-
Returns the contact information of the person.
- getContributors() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's contributors.
- getCurrentRuntimeNamespace() - Method in interface net.fabricmc.loader.api.MappingResolver
-
Get the current namespace being used at runtime.
- getCustomElement(String) - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Deprecated.Use
ModMetadata.getCustomValue(java.lang.String)
instead, this will be removed (can't expose GSON types)! - getCustomValue(String) - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's
fabric.mod.json
declared custom value underkey
. - getCustomValues() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Gets all custom values defined by this mod.
- getDepends() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's required dependencies, without which the Loader will terminate loading.
- getDescription() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's description.
- getEntrypoint() - Method in interface net.fabricmc.loader.api.entrypoint.EntrypointContainer
-
Returns the entrypoint instance.
- getEntrypointContainers(String, Class<T>) - Method in interface net.fabricmc.loader.api.FabricLoader
-
Returns all entrypoints declared under a
key
, assuming they are of a specific type. - getEntrypoints(String, Class<T>) - Method in interface net.fabricmc.loader.api.FabricLoader
-
Returns all entrypoints declared under a
key
, assuming they are of a specific type. - getEnvironment() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's environment.
- getEnvironmentType() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Get the current environment type.
- getFriendlyString() - Method in interface net.fabricmc.loader.api.Version
-
Returns the user-friendly representation of this version.
- getGameDir() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Get the current game working directory.
- getGameDirectory() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Deprecated.
- getGameInstance() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Deprecated.This method is experimental and it's use is discouraged.
- getIconPath(int) - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Gets the path to an icon.
- getId() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's ID.
- getInstance() - Static method in interface net.fabricmc.loader.api.FabricLoader
-
Returns the public-facing Fabric Loader instance.
- getKey() - Method in exception net.fabricmc.loader.api.EntrypointException
-
Returns the key of entrypoint in which the exception arose.
- getLaunchArguments(boolean) - Method in interface net.fabricmc.loader.api.FabricLoader
-
Gets the command line arguments used to launch the game.
- getLicense() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's licenses.
- getMappingResolver() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Get the current mapping resolver.
- getMetadata() - Method in interface net.fabricmc.loader.api.ModContainer
-
Returns the metadata of this mod.
- getModContainer(String) - Method in interface net.fabricmc.loader.api.FabricLoader
-
Gets the container for a given mod.
- getModId() - Method in interface net.fabricmc.loader.api.metadata.ModDependency
-
Returns the ID of the mod to check.
- getName() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's display name.
- getName() - Method in interface net.fabricmc.loader.api.metadata.Person
-
Returns the display name of the person.
- getNamespaces() - Method in interface net.fabricmc.loader.api.MappingResolver
-
Get the list of all available mapping namespaces in the loaded instance.
- getPath(String) - Method in interface net.fabricmc.loader.api.ModContainer
-
Gets an NIO reference to a file inside the JAR.
- getPrereleaseKey() - Method in interface net.fabricmc.loader.api.SemanticVersion
-
Returns the prerelease key in the version notation.
- getProvider() - Method in interface net.fabricmc.loader.api.entrypoint.EntrypointContainer
-
Returns the mod that provided this entrypoint.
- getProvides() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's ID provides.
- getRecommends() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's recommended dependencies, without which the Loader will emit a warning.
- getRoot() - Method in interface net.fabricmc.loader.api.ModContainer
-
Deprecated.use
ModContainer.getRootPath()
instead - getRootPath() - Method in interface net.fabricmc.loader.api.ModContainer
-
Returns the root directory of the mod.
- getSuggests() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's suggested dependencies.
- getType() - Method in interface net.fabricmc.loader.api.metadata.CustomValue
-
Returns the type of the value.
- getType() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the type of the mod.
- getType() - Method in class net.fabricmc.loader.api.VersionPredicate
- getVersion() - Method in interface net.fabricmc.loader.api.metadata.ModMetadata
-
Returns the mod's version.
- getVersion() - Method in class net.fabricmc.loader.api.VersionPredicate
- getVersionComponent(int) - Method in interface net.fabricmc.loader.api.SemanticVersion
-
Returns the version component at
pos
. - getVersionComponentCount() - Method in interface net.fabricmc.loader.api.SemanticVersion
-
Returns the number of components in this version.
- getVersionRequirements() - Method in interface net.fabricmc.loader.api.metadata.ModDependency
-
Returns a representation of the dependency's version requirements.
- GREATER_THAN - net.fabricmc.loader.api.VersionPredicate.Type
- GREATER_THAN_OR_EQUAL - net.fabricmc.loader.api.VersionPredicate.Type
H
- hashCode() - Method in class net.fabricmc.loader.api.VersionPredicate
- hasWildcard() - Method in interface net.fabricmc.loader.api.SemanticVersion
-
Returns if a wildcard notation is present in this version.
I
- isDevelopmentEnvironment() - Method in interface net.fabricmc.loader.api.FabricLoader
-
Checks if Fabric Loader is currently running in a "development" environment.
- isModLoaded(String) - Method in interface net.fabricmc.loader.api.FabricLoader
-
Checks if a mod with a given ID is loaded.
- itf() - Method in annotation type net.fabricmc.api.EnvironmentInterface
-
Returns the interface class.
L
- LanguageAdapter - Interface in net.fabricmc.loader.api
-
Creates instances of objects from custom notations.
- LanguageAdapterException - Exception in net.fabricmc.loader.api
-
An exception that occurs during a
LanguageAdapter
's object creation. - LanguageAdapterException(String) - Constructor for exception net.fabricmc.loader.api.LanguageAdapterException
-
Creates a new language adapter exception.
- LanguageAdapterException(String, Throwable) - Constructor for exception net.fabricmc.loader.api.LanguageAdapterException
-
Creates a new language adapter exception.
- LanguageAdapterException(Throwable) - Constructor for exception net.fabricmc.loader.api.LanguageAdapterException
-
Creates a new language adapter exception.
- LESSER_THAN - net.fabricmc.loader.api.VersionPredicate.Type
- LESSER_THAN_OR_EQUAL - net.fabricmc.loader.api.VersionPredicate.Type
M
- mapClassName(String, String) - Method in interface net.fabricmc.loader.api.MappingResolver
-
Map a class name to the mapping currently used at runtime.
- mapFieldName(String, String, String, String) - Method in interface net.fabricmc.loader.api.MappingResolver
-
Map a field name to the mapping currently used at runtime.
- mapMethodName(String, String, String, String) - Method in interface net.fabricmc.loader.api.MappingResolver
-
Map a method name to the mapping currently used at runtime.
- MappingResolver - Interface in net.fabricmc.loader.api
-
Helper class for performing mapping resolution.
- matches(EnvType) - Method in enum net.fabricmc.loader.api.metadata.ModEnvironment
- matches(Version) - Method in interface net.fabricmc.loader.api.metadata.ModDependency
-
Returns if the version fulfills this dependency's version requirement.
- ModContainer - Interface in net.fabricmc.loader.api
-
Represents a mod.
- ModDependency - Interface in net.fabricmc.loader.api.metadata
-
Represents a dependency.
- ModEnvironment - Enum in net.fabricmc.loader.api.metadata
- ModInitializer - Interface in net.fabricmc.api
-
A mod initializer.
- ModMetadata - Interface in net.fabricmc.loader.api.metadata
-
The metadata of a mod.
N
- net.fabricmc.api - package net.fabricmc.api
- net.fabricmc.loader.api - package net.fabricmc.loader.api
- net.fabricmc.loader.api.entrypoint - package net.fabricmc.loader.api.entrypoint
- net.fabricmc.loader.api.metadata - package net.fabricmc.loader.api.metadata
- NULL - net.fabricmc.loader.api.metadata.CustomValue.CvType
- NUMBER - net.fabricmc.loader.api.metadata.CustomValue.CvType
O
- OBJECT - net.fabricmc.loader.api.metadata.CustomValue.CvType
- onInitialize() - Method in interface net.fabricmc.api.ModInitializer
-
Runs the mod initializer.
- onInitializeClient() - Method in interface net.fabricmc.api.ClientModInitializer
-
Runs the mod initializer on the client environment.
- onInitializeServer() - Method in interface net.fabricmc.api.DedicatedServerModInitializer
-
Runs the mod initializer on the server environment.
- onPreLaunch() - Method in interface net.fabricmc.loader.api.entrypoint.PreLaunchEntrypoint
-
Runs the entrypoint.
P
- parse(String) - Static method in interface net.fabricmc.loader.api.SemanticVersion
-
Parses a semantic version from a string notation.
- parse(String) - Static method in interface net.fabricmc.loader.api.Version
-
Parses a version from a string notation.
- parse(Collection<String>) - Static method in class net.fabricmc.loader.api.VersionPredicate
- Person - Interface in net.fabricmc.loader.api.metadata
-
Represents a person.
- prefix() - Method in enum net.fabricmc.loader.api.VersionPredicate.Type
- PreLaunchEntrypoint - Interface in net.fabricmc.loader.api.entrypoint
-
Entrypoint getting invoked just before launching the game.
S
- SAME_MAJOR - net.fabricmc.loader.api.VersionPredicate.Type
- SAME_MAJOR_AND_MINOR - net.fabricmc.loader.api.VersionPredicate.Type
- SemanticVersion - Interface in net.fabricmc.loader.api
-
Represents a Sematic Version.
- SERVER - net.fabricmc.api.EnvType
-
Represents the server environment type, in which the
server.jar
for a Minecraft version is the main game jar. - SERVER - net.fabricmc.loader.api.metadata.ModEnvironment
- size() - Method in interface net.fabricmc.loader.api.metadata.CustomValue.CvArray
-
Returns the number of values within this array value.
- size() - Method in interface net.fabricmc.loader.api.metadata.CustomValue.CvObject
-
Returns the number of key-value pairs within this object value.
- STRING - net.fabricmc.loader.api.metadata.CustomValue.CvType
T
- toString() - Method in class net.fabricmc.loader.api.VersionPredicate
U
- UNIVERSAL - net.fabricmc.loader.api.metadata.ModEnvironment
- unmapClassName(String, String) - Method in interface net.fabricmc.loader.api.MappingResolver
-
Unmap a class name to the mapping currently used at runtime.
V
- value() - Method in annotation type net.fabricmc.api.Environment
-
Returns the environment type that the annotated element is only present in.
- value() - Method in annotation type net.fabricmc.api.EnvironmentInterface
-
Returns the environment type that the specific interface is only implemented in.
- value() - Method in annotation type net.fabricmc.api.EnvironmentInterfaces
-
Returns the
EnvironmentInterface
annotations it holds. - valueOf(String) - Static method in enum net.fabricmc.api.EnvType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.fabricmc.loader.api.metadata.CustomValue.CvType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.fabricmc.loader.api.metadata.ModEnvironment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.fabricmc.loader.api.VersionPredicate.Type
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum net.fabricmc.api.EnvType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.fabricmc.loader.api.metadata.CustomValue.CvType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.fabricmc.loader.api.metadata.ModEnvironment
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.fabricmc.loader.api.VersionPredicate.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- Version - Interface in net.fabricmc.loader.api
-
Represents a version of a mod.
- VersionParsingException - Exception in net.fabricmc.loader.api
- VersionParsingException() - Constructor for exception net.fabricmc.loader.api.VersionParsingException
- VersionParsingException(String) - Constructor for exception net.fabricmc.loader.api.VersionParsingException
- VersionParsingException(String, Throwable) - Constructor for exception net.fabricmc.loader.api.VersionParsingException
- VersionParsingException(Throwable) - Constructor for exception net.fabricmc.loader.api.VersionParsingException
- VersionPredicate - Class in net.fabricmc.loader.api
- VersionPredicate(VersionPredicate.Type, String) - Constructor for class net.fabricmc.loader.api.VersionPredicate
- VersionPredicate.Type - Enum in net.fabricmc.loader.api
All Classes|All Packages
ModMetadata.containsCustomValue(java.lang.String)
instead, this will be removed (can't expose GSON types)!