Package net.neoforged.neoforge.client.event

Class RegisterCustomEnvironmentEffectRendererEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterCustomEnvironmentEffectRendererEvent

All Implemented Interfaces:

IModBusEvent

public class RegisterCustomEnvironmentEffectRendererEvent
extends net.neoforged.bus.api.Event
implements IModBusEvent

Allows users to register custom environmental effect renderers, such as CustomCloudsRenderer, CustomSkyboxRenderer or CustomWeatherEffectRenderer.

This event is not cancellable.

This event is fired on the mod-specific event bus, only on the logical client.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<Identifier,CustomCloudsRenderer>	cloudRenderers
private final Map<Identifier,CustomSkyboxRenderer>	skyboxRenderers
private final Map<Identifier,CustomWeatherEffectRenderer>	weatherEffectsRenderers

Constructor Summary

Constructors

Constructor	Description
RegisterCustomEnvironmentEffectRendererEvent(Map<Identifier,CustomCloudsRenderer> cloudRenderers, Map<Identifier,CustomSkyboxRenderer> skyboxRenderers, Map<Identifier,CustomWeatherEffectRenderer> weatherEffectsRenderers)

Method Summary

Modifier and Type	Method	Description
void	registerCloudRenderer(Identifier id, CustomCloudsRenderer effects)	Registers the renderer for a given custom clouds type.
void	registerSkyboxRenderer(Identifier id, CustomSkyboxRenderer effects)	Registers the renderer for a given custom skybox type.
void	registerWeatherEffectRenderer(Identifier id, CustomWeatherEffectRenderer effects)	Registers the renderer for a given custom weather effects type.

Methods inherited from class java.lang.Object

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

Field Details

cloudRenderers

private final Map<Identifier,CustomCloudsRenderer> cloudRenderers

skyboxRenderers

private final Map<Identifier,CustomSkyboxRenderer> skyboxRenderers

weatherEffectsRenderers

private final Map<Identifier,CustomWeatherEffectRenderer> weatherEffectsRenderers

Constructor Details

RegisterCustomEnvironmentEffectRendererEvent

@Internal
public RegisterCustomEnvironmentEffectRendererEvent(Map<Identifier,CustomCloudsRenderer> cloudRenderers,
 Map<Identifier,CustomSkyboxRenderer> skyboxRenderers,
 Map<Identifier,CustomWeatherEffectRenderer> weatherEffectsRenderers)

Method Details

registerCloudRenderer

public void registerCloudRenderer(Identifier id,
 CustomCloudsRenderer effects)

Registers the renderer for a given custom clouds type.

See Also:

• NeoForgeEnvironmentAttributes.CUSTOM_CLOUDS

registerSkyboxRenderer

public void registerSkyboxRenderer(Identifier id,
 CustomSkyboxRenderer effects)

Registers the renderer for a given custom skybox type.

See Also:

• NeoForgeEnvironmentAttributes.CUSTOM_SKYBOX

registerWeatherEffectRenderer

public void registerWeatherEffectRenderer(Identifier id,
 CustomWeatherEffectRenderer effects)

Registers the renderer for a given custom weather effects type.

See Also:

• NeoForgeEnvironmentAttributes.CUSTOM_WEATHER_EFFECTS