Package net.fabricmc.loom.extension

Class LoomGradleExtensionImpl

java.lang.Object

net.fabricmc.loom.extension.LoomGradleExtensionApiImpl

net.fabricmc.loom.extension.LoomGradleExtensionImpl

All Implemented Interfaces:

LoomGradleExtensionAPI, LoomGradleExtension

public abstract class LoomGradleExtensionImpl
extends LoomGradleExtensionApiImpl
implements LoomGradleExtension

Field Summary

Fields inherited from class net.fabricmc.loom.extension.LoomGradleExtensionApiImpl

accessWidener, customMetadata, DEFAULT_INTERMEDIARY_URL, deprecationHelper, fabricModJsonPath, generateSrgTiny, hasEvaluatedLayeredMappings, intermediary, intermediateMappingsProvider, jarProcessors, knownIndyBsms, layeredMappingsDependencyMap, layeredSpecBuilderScope, log4jConfigs, modProvidedJavadoc, remapperExtensions, settingsPostEdit, versionsManifests

Constructor Summary

Constructors

Constructor	Description
LoomGradleExtensionImpl(org.gradle.api.Project project, LoomFiles files)

Method Summary

Modifier and Type	Method	Description
void	addTransitiveAccessWideners(List<AccessWidenerFile> accessWidenerFiles)
protected <T extends IntermediateMappingsProvider> void	configureIntermediateMappingsProviderInternal(T provider)
boolean	disableObfuscation()	When enabled disable all forms of remapping.
boolean	dontRemapOutputs()	When enabled do not remap the output jars.
DownloadBuilder	download(String url)
@Nullable MappingConfiguration	findMappingConfiguration()	Returns 已建立的映射配置；本工程不使用映射（disableObfuscation / unobfuscated Forge） 或尚未 setup 时为 null.
protected abstract org.gradle.api.configuration.BuildFeatures	getBuildFeatures()
org.gradle.api.provider.Provider<ArtifactMetadata.MixinRemapType>	getDefaultMixinRemapTypeEnum()
DependencyProviders	getDependencyProviders()
LoomFiles	getFiles()
ForgeExtensionAPI	getForge()	Gets the Forge extension used to configure Forge details.
ForgeRunsProvider	getForgeRunsProvider()
InstallerData	getInstallerData()
IntermediaryMinecraftProvider<?>	getIntermediaryMinecraftProvider()
Collection<LayeredMappingsFactory>	getLayeredMappingFactories()
org.gradle.api.provider.ListProperty<LibraryProcessorManager.LibraryProcessorFactory>	getLibraryProcessors()
MappingConfiguration	getMappingConfiguration()
MinecraftMetadataProvider	getMetadataProvider()
org.gradle.api.file.FileCollection	getMinecraftJarsCollection(MappingsNamespace mappingsNamespace)	取某个命名空间下的 Minecraft jar 集合.
MinecraftProvider	getMinecraftProvider()
MixinExtension	getMixin()
MojangMappedMinecraftProvider<?>	getMojangMappedMinecraftProvider()
NamedMinecraftProvider<?>	getNamedMinecraftProvider()
NeoForgeExtensionAPI	getNeoForge()	Gets the NeoForge extension used to configure NeoForge details.
org.gradle.api.provider.Provider<MappingsNamespace>	getProductionNamespaceEnum()
protected org.gradle.api.Project	getProject()
org.gradle.api.provider.ListProperty<RemapperExtensionHolder>	getRemapperExtensions()
SrgMinecraftProvider<?>	getSrgMinecraftProvider()
List<AccessWidenerFile>	getTransitiveAccessWideners()
org.gradle.api.file.ConfigurableFileCollection	getUnmappedModCollection()
boolean	isCollectingDependencyVerificationMetadata()
boolean	isConfigurationCacheActive()
boolean	isProjectIsolationActive()
boolean	manualRefreshDeps()
void	noIntermediateMappings()	An Experimental option to provide empty intermediate mappings, to be used for game versions without any intermediate mappings.
boolean	refreshDeps()
void	setDependencyProviders(DependencyProviders dependencyProviders)
void	setForgeRunsProvider(ForgeRunsProvider forgeRunsProvider)
void	setInstallerData(InstallerData object)
void	setIntermediaryMinecraftProvider(IntermediaryMinecraftProvider<?> intermediaryMinecraftProvider)
void	setMappingConfiguration(MappingConfiguration mappingConfiguration)
void	setMetadataProvider(MinecraftMetadataProvider metadataProvider)
void	setMinecraftJarsTaskOutputs(MappingsNamespace mappingsNamespace, org.gradle.api.file.FileCollection taskOutputs)	登记某个命名空间下、由任务产出的 Minecraft jar 集合.
void	setMinecraftProvider(MinecraftProvider minecraftProvider)
void	setMojangMappedMinecraftProvider(MojangMappedMinecraftProvider<?> mojangMappedMinecraftProvider)
void	setNamedMinecraftProvider(NamedMinecraftProvider<?> namedMinecraftProvider)
void	setRefreshDeps(boolean refreshDeps)
void	setSrgMinecraftProvider(SrgMinecraftProvider<?> srgMinecraftProvider)

Methods inherited from class net.fabricmc.loom.extension.LoomGradleExtensionApiImpl

addMinecraftJarProcessor, addRemapConfiguration, addRemapperExtension, areEnvironmentSourceSetsSplit, createRemapConfigurations, decompilers, disableDeprecatedPomGeneration, forge, getAccessWidenerPath, getCustomMinecraftMetadata, getDecompilerOptions, getDecompileTask, getDefaultMixinRemapType, getDeprecationHelper, getEnableModProvidedJavadoc, getEnableTransitiveAccessWideners, getFabricModJsonPath, getGameJarProcessors, getInterfaceInjection, getIntermediaryUrl, getIntermediateMappingsProvider, getKnownIndyBsms, getLog4jConfigs, getMappingsFile, getMinecraftJarConfiguration, getMinecraftJarProcessors, getMinecraftVersion, getMods, getModVersion, getNamedMinecraftJars, getPlatform, getProductionNamespace, getRemapConfigurations, getRemapJsrAnnotationsToJetBrains, getRunConfigs, getRuntimeOnlyLog4j, getRuntimeOnlyLwjglGraphics, getSettingsPostEdit, getSplitModDependencies, getTasksBeforeRun, getUncompressNestedJars, getUseIntermediateMappings, getVersionsManifests, injectAccessWidener, isSilentMojangMappingsLicenseEnabled, layered, mixin, mods, neoForge, nestJars, nestJars, nestJars, officialMojangMappings, runs, setGenerateSrgTiny, setIntermediateMappingsProvider, setIntermediateMappingsProvider, shouldGenerateSrgTiny, silentMojangMappingsLicense, splitEnvironmentSourceSets

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fabricmc.loom.LoomGradleExtension

addPlatformMappingsDependency, getForgeProvider, getForgeUniversalProvider, getForgeUserdevProvider, getMcpConfigProvider, getMinecraftJars, getPatchProvider, getPlatformMappingFile, getSrgProvider, isDataGenEnabled, isForgeLikeAndNotOfficial, isForgeLikeAndOfficial, isLegacyForge, isModernForgeLike, isUnobfuscatedForge

Methods inherited from interface net.fabricmc.loom.api.LoomGradleExtensionAPI

addJarProcessor, addMinecraftJarProcessor, addRemapConfiguration, addRemapperExtension, addTaskBeforeRun, areEnvironmentSourceSetsSplit, clientOnlyMinecraftJar, createRemapConfigurations, decompilers, disableDeprecatedPomGeneration, forge, getAccessWidenerPath, getCompileRemapConfigurations, getCustomMinecraftManifest, getCustomMinecraftMetadata, getDecompilerOptions, getDecompileTask, getDefaultMixinRemapType, getDeprecationHelper, getEnableModProvidedJavadoc, getEnableTransitiveAccessWideners, getFabricModJsonPath, getGameJarProcessors, getInterfaceInjection, getIntermediaryUrl, getIntermediateMappingsProvider, getKnownIndyBsms, getLog4jConfigs, getMappingsFile, getMinecraftJarConfiguration, getMinecraftJarProcessors, getMinecraftVersion, getMods, getModVersion, getNamedMinecraftJars, getPlatform, getProductionNamespace, getRemapConfigurations, getRemapJsrAnnotationsToJetBrains, getRunConfigs, getRuns, getRuntimeOnlyLog4j, getRuntimeOnlyLwjglGraphics, getRuntimeRemapConfigurations, getSettingsPostEdit, getSplitModDependencies, getTasksBeforeRun, getUncompressNestedJars, getUseIntermediateMappings, getVersionsManifests, injectAccessWidener, injectAccessWidener, interfaceInjection, isForge, isForgeLike, isNeoForge, isQuilt, isSilentMojangMappingsLicenseEnabled, layered, mixin, mods, neoForge, nestJars, nestJars, nestJars, officialMojangMappings, runs, serverOnlyMinecraftJar, setGenerateSrgTiny, setIntermediateMappingsProvider, setIntermediateMappingsProvider, shouldGenerateSrgTiny, silentMojangMappingsLicense, splitEnvironmentSourceSets, splitMinecraftJar, versionsManifests

Constructor Details

LoomGradleExtensionImpl

@Inject
public LoomGradleExtensionImpl(org.gradle.api.Project project,
 LoomFiles files)

Method Details

getBuildFeatures

@Inject
protected abstract org.gradle.api.configuration.BuildFeatures getBuildFeatures()

getProject

protected org.gradle.api.Project getProject()

Specified by:

getProject in class LoomGradleExtensionApiImpl

getFiles

public LoomFiles getFiles()

Specified by:

getFiles in interface LoomGradleExtension

Specified by:

getFiles in class LoomGradleExtensionApiImpl

getMetadataProvider

public MinecraftMetadataProvider getMetadataProvider()

Specified by:

getMetadataProvider in interface LoomGradleExtension

setMetadataProvider

public void setMetadataProvider(MinecraftMetadataProvider metadataProvider)

Specified by:

setMetadataProvider in interface LoomGradleExtension

getMinecraftProvider

public MinecraftProvider getMinecraftProvider()

Specified by:

getMinecraftProvider in interface LoomGradleExtension

setMinecraftProvider

public void setMinecraftProvider(MinecraftProvider minecraftProvider)

Specified by:

setMinecraftProvider in interface LoomGradleExtension

getMappingConfiguration

public MappingConfiguration getMappingConfiguration()

Specified by:

getMappingConfiguration in interface LoomGradleExtension

findMappingConfiguration

public @Nullable MappingConfiguration findMappingConfiguration()

Description copied from interface: LoomGradleExtension

Returns 已建立的映射配置；本工程不使用映射（disableObfuscation / unobfuscated Forge） 或尚未 setup 时为 null..

与 LoomGradleExtension.getMappingConfiguration() 的差别只有一个：不抛异常。任务侧需要「有就接线、没有就跳过」 的语义（见 LoomGradleExtension.addPlatformMappingsDependency(Task)），在那里抛异常会把一个可选的接线点变成崩溃点。

Specified by:

findMappingConfiguration in interface LoomGradleExtension

Returns:

已建立的映射配置；本工程不使用映射（disableObfuscation / unobfuscated Forge） 或尚未 setup 时为 null

setMappingConfiguration

public void setMappingConfiguration(MappingConfiguration mappingConfiguration)

Specified by:

setMappingConfiguration in interface LoomGradleExtension

getNamedMinecraftProvider

public NamedMinecraftProvider<?> getNamedMinecraftProvider()

Specified by:

getNamedMinecraftProvider in interface LoomGradleExtension

getIntermediaryMinecraftProvider

public IntermediaryMinecraftProvider<?> getIntermediaryMinecraftProvider()

Specified by:

getIntermediaryMinecraftProvider in interface LoomGradleExtension

setNamedMinecraftProvider

public void setNamedMinecraftProvider(NamedMinecraftProvider<?> namedMinecraftProvider)

Specified by:

setNamedMinecraftProvider in interface LoomGradleExtension

setIntermediaryMinecraftProvider

public void setIntermediaryMinecraftProvider(IntermediaryMinecraftProvider<?> intermediaryMinecraftProvider)

Specified by:

setIntermediaryMinecraftProvider in interface LoomGradleExtension

noIntermediateMappings

public void noIntermediateMappings()

Description copied from interface: LoomGradleExtensionAPI

An Experimental option to provide empty intermediate mappings, to be used for game versions without any intermediate mappings.

Specified by:

noIntermediateMappings in interface LoomGradleExtensionAPI

getSrgMinecraftProvider

public SrgMinecraftProvider<?> getSrgMinecraftProvider()

Specified by:

getSrgMinecraftProvider in interface LoomGradleExtension

setSrgMinecraftProvider

public void setSrgMinecraftProvider(SrgMinecraftProvider<?> srgMinecraftProvider)

Specified by:

setSrgMinecraftProvider in interface LoomGradleExtension

getMojangMappedMinecraftProvider

public MojangMappedMinecraftProvider<?> getMojangMappedMinecraftProvider()

Specified by:

getMojangMappedMinecraftProvider in interface LoomGradleExtension

setMojangMappedMinecraftProvider

public void setMojangMappedMinecraftProvider(MojangMappedMinecraftProvider<?> mojangMappedMinecraftProvider)

Specified by:

setMojangMappedMinecraftProvider in interface LoomGradleExtension

getMinecraftJarsCollection

public org.gradle.api.file.FileCollection getMinecraftJarsCollection(MappingsNamespace mappingsNamespace)

Description copied from interface: LoomGradleExtension

取某个命名空间下的 Minecraft jar 集合.

已登记任务产出（见 LoomGradleExtension.setMinecraftJarsTaskOutputs(net.fabricmc.loom.api.mappings.layered.MappingsNamespace, org.gradle.api.file.FileCollection)）时，返回的集合派生自产出任务， 携带任务依赖；未登记时回退到配置期已经落盘的文件，此时集合里是裸 File， 不携带任何任务依赖。

同一命名空间返回的是同一份集合实例

消费方通常在**自己的任务注册期**就调用本方法，而产出方的登记发生在更晚（afterEvaluate 里的 provide）。因此登记不是「换一份新集合」，而是把任务产出并进已发出的那一份 （见 LoomGradleExtension.setMinecraftJarsTaskOutputs(net.fabricmc.loom.api.mappings.layered.MappingsNamespace, org.gradle.api.file.FileCollection)）；否则先取走引用的消费方手里永远是未登记时的快照， 任务依赖会静默丢失，冷缓存下消费方就会读到一个还不存在的 jar。

Specified by:

getMinecraftJarsCollection in interface LoomGradleExtension

Parameters:

mappingsNamespace - 目标命名空间

Returns:

该命名空间下的 Minecraft jar 集合

setMinecraftJarsTaskOutputs

public void setMinecraftJarsTaskOutputs(MappingsNamespace mappingsNamespace,
 org.gradle.api.file.FileCollection taskOutputs)

Description copied from interface: LoomGradleExtension

登记某个命名空间下、由任务产出的 Minecraft jar 集合.

为什么必须由产出方登记

消费方（ValidateAccessWidenerTask、ValidateModProvidedJavadocTask 等） 在注册自己的任务时看不到产出 MC jar 的那个 TaskProvider，无法自行接上依赖； 产出方在注册任务之后调用本方法，是唯一能把这份依赖传播给全部消费方的位置。

对入参的要求

taskOutputs 必须派生自 TaskProvider，例如 project.files(remapTask.flatMap(t -> t.getOutputJar()))。 携带任务依赖的是 Provider 本身，裸 File/Path 不会携带—— 传入裸文件等价于没有登记。

登记是「并进」而不是「替换引用」

本方法把 taskOutputs 并进 LoomGradleExtension.getMinecraftJarsCollection(net.fabricmc.loom.api.mappings.layered.MappingsNamespace) 为该命名空间返回的 那一份集合实例（尚未取过则现建一份），因此已经持有引用的消费方同样能拿到任务依赖。 同一命名空间重复登记时内容以最后一次为准——后一次会整体替换前一次的内容， 而不是把两份 jar 都留在集合里（例如 processed provider 覆盖未处理的 provider）。

Specified by:

setMinecraftJarsTaskOutputs in interface LoomGradleExtension

Parameters:

mappingsNamespace - 该集合所属的命名空间

taskOutputs - 由任务产出的 jar 集合

getUnmappedModCollection

public org.gradle.api.file.ConfigurableFileCollection getUnmappedModCollection()

Specified by:

getUnmappedModCollection in interface LoomGradleExtension

setInstallerData

public void setInstallerData(InstallerData object)

Specified by:

setInstallerData in interface LoomGradleExtension

getInstallerData

public InstallerData getInstallerData()

Specified by:

getInstallerData in interface LoomGradleExtension

getMixin

public MixinExtension getMixin()

Specified by:

getMixin in interface LoomGradleExtension

Specified by:

getMixin in interface LoomGradleExtensionAPI

getTransitiveAccessWideners

public List<AccessWidenerFile> getTransitiveAccessWideners()

Specified by:

getTransitiveAccessWideners in interface LoomGradleExtension

addTransitiveAccessWideners

public void addTransitiveAccessWideners(List<AccessWidenerFile> accessWidenerFiles)

Specified by:

addTransitiveAccessWideners in interface LoomGradleExtension

download

public DownloadBuilder download(String url)

Specified by:

download in interface LoomGradleExtension

manualRefreshDeps

public boolean manualRefreshDeps()

Specified by:

manualRefreshDeps in interface LoomGradleExtension

refreshDeps

public boolean refreshDeps()

Specified by:

refreshDeps in interface LoomGradleExtension

setRefreshDeps

public void setRefreshDeps(boolean refreshDeps)

Specified by:

setRefreshDeps in interface LoomGradleExtension

getLibraryProcessors

public org.gradle.api.provider.ListProperty<LibraryProcessorManager.LibraryProcessorFactory> getLibraryProcessors()

Specified by:

getLibraryProcessors in interface LoomGradleExtension

getRemapperExtensions

public org.gradle.api.provider.ListProperty<RemapperExtensionHolder> getRemapperExtensions()

Specified by:

getRemapperExtensions in interface LoomGradleExtension

getLayeredMappingFactories

public Collection<LayeredMappingsFactory> getLayeredMappingFactories()

Specified by:

getLayeredMappingFactories in interface LoomGradleExtension

configureIntermediateMappingsProviderInternal

protected <T extends IntermediateMappingsProvider>
void configureIntermediateMappingsProviderInternal(T provider)

Specified by:

configureIntermediateMappingsProviderInternal in class LoomGradleExtensionApiImpl

isConfigurationCacheActive

public boolean isConfigurationCacheActive()

Specified by:

isConfigurationCacheActive in interface LoomGradleExtension

isProjectIsolationActive

public boolean isProjectIsolationActive()

Specified by:

isProjectIsolationActive in interface LoomGradleExtension

isCollectingDependencyVerificationMetadata

public boolean isCollectingDependencyVerificationMetadata()

Specified by:

isCollectingDependencyVerificationMetadata in interface LoomGradleExtension

Returns:

true when '--write-verification-metadata` is set

dontRemapOutputs

public boolean dontRemapOutputs()

Description copied from interface: LoomGradleExtension

When enabled do not remap the output jars.

Specified by:

dontRemapOutputs in interface LoomGradleExtension

disableObfuscation

public boolean disableObfuscation()

Description copied from interface: LoomGradleExtension

When enabled disable all forms of remapping.

Specified by:

disableObfuscation in interface LoomGradleExtension

getForge

public ForgeExtensionAPI getForge()

Description copied from interface: LoomGradleExtensionAPI

Gets the Forge extension used to configure Forge details.

Specified by:

getForge in interface LoomGradleExtensionAPI

Returns:

the Forge extension

See Also:

• LoomGradleExtensionAPI.isForge()

getNeoForge

public NeoForgeExtensionAPI getNeoForge()

Description copied from interface: LoomGradleExtensionAPI

Gets the NeoForge extension used to configure NeoForge details.

Specified by:

getNeoForge in interface LoomGradleExtensionAPI

Returns:

the NeoForge extension

See Also:

• LoomGradleExtensionAPI.isNeoForge()

getDependencyProviders

public DependencyProviders getDependencyProviders()

Specified by:

getDependencyProviders in interface LoomGradleExtension

setDependencyProviders

public void setDependencyProviders(DependencyProviders dependencyProviders)

Specified by:

setDependencyProviders in interface LoomGradleExtension

getForgeRunsProvider

public ForgeRunsProvider getForgeRunsProvider()

Specified by:

getForgeRunsProvider in interface LoomGradleExtension

setForgeRunsProvider

public void setForgeRunsProvider(ForgeRunsProvider forgeRunsProvider)

Specified by:

setForgeRunsProvider in interface LoomGradleExtension

getProductionNamespaceEnum

public org.gradle.api.provider.Provider<MappingsNamespace> getProductionNamespaceEnum()

Specified by:

getProductionNamespaceEnum in interface LoomGradleExtension

getDefaultMixinRemapTypeEnum

public org.gradle.api.provider.Provider<ArtifactMetadata.MixinRemapType> getDefaultMixinRemapTypeEnum()

Specified by:

getDefaultMixinRemapTypeEnum in interface LoomGradleExtension