Interface CustomWeatherEffectRenderer

public interface CustomWeatherEffectRenderer

A custom renderer for snow and rain that can be registered using RegisterCustomEnvironmentEffectRendererEvent.registerWeatherEffectRenderer(Identifier, CustomWeatherEffectRenderer) and used with NeoForgeEnvironmentAttributes.CUSTOM_WEATHER_EFFECTS.

Custom render state needed for the various render methods must be extracted via ExtractLevelRenderStateEvent and stored in the provided LevelRenderState.

See Also:

• RegisterCustomEnvironmentEffectRendererEvent.registerWeatherEffectRenderer(Identifier, CustomWeatherEffectRenderer)
• NeoForgeEnvironmentAttributes.CUSTOM_WEATHER_EFFECTS

Method Summary

Modifier and Type	Method	Description
default void	prepare(LevelRenderState levelRenderState, WeatherRenderState weatherRenderState, Vec3 camPos)	Prepare the geometry and other buffers to be rendered in renderSnowAndRain(LevelRenderState, WeatherRenderState, Vec3, RenderPass) or renderSnowAndRainOit(LevelRenderState, WeatherRenderState, Vec3, OitStage, RenderPass).
default boolean	renderSnowAndRain(LevelRenderState levelRenderState, WeatherRenderState weatherRenderState, Vec3 camPos, RenderPass renderPass)	Renders the snow and rain effects of this dimension.
default boolean	renderSnowAndRainOit(LevelRenderState levelRenderState, WeatherRenderState weatherRenderState, Vec3 camPos, OitStage stage, RenderPass renderPass)	Renders the snow and rain effects of this dimension with order-independent translucency.
default boolean	tickRain(ClientLevel level, long ticks, Camera camera)	Ticks the rain of this dimension.

Method Details

prepare

default void prepare(LevelRenderState levelRenderState,
 WeatherRenderState weatherRenderState,
 Vec3 camPos)

Prepare the geometry and other buffers to be rendered in renderSnowAndRain(LevelRenderState, WeatherRenderState, Vec3, RenderPass) or renderSnowAndRainOit(LevelRenderState, WeatherRenderState, Vec3, OitStage, RenderPass).

See Also:

• WeatherEffectRenderer.prepare(Vec3, WeatherRenderState)

renderSnowAndRain

default boolean renderSnowAndRain(LevelRenderState levelRenderState,
 WeatherRenderState weatherRenderState,
 Vec3 camPos,
 RenderPass renderPass)

Renders the snow and rain effects of this dimension.

Returns:

true to prevent vanilla snow and rain rendering

See Also:

• WeatherEffectRenderer.render(WeatherRenderState, RenderPass)

renderSnowAndRainOit

default boolean renderSnowAndRainOit(LevelRenderState levelRenderState,
 WeatherRenderState weatherRenderState,
 Vec3 camPos,
 OitStage stage,
 RenderPass renderPass)

Renders the snow and rain effects of this dimension with order-independent translucency.

Returns:

true to prevent vanilla snow and rain rendering

See Also:

• WeatherEffectRenderer.renderOit(OitStage, WeatherRenderState, RenderPass)

tickRain

default boolean tickRain(ClientLevel level,
 long ticks,
 Camera camera)

Ticks the rain of this dimension.

Returns:

true to prevent vanilla rain ticking