Package net.fabricmc.fabric.api.client.rendering.v1

Interface DimensionRenderingRegistry

public interface DimensionRenderingRegistry

Dimensional renderers render world specific visuals of a world. They may be used to render the sky, weather, or clouds. The DimensionEffects is the vanilla dimensional renderer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DimensionRenderingRegistry.CloudRenderer
static interface	DimensionRenderingRegistry.SkyRenderer
static interface	DimensionRenderingRegistry.WeatherRenderer

Method Summary

Static Methods

Modifier and Type	Method	Description
static @Nullable DimensionRenderingRegistry.CloudRenderer	getCloudRenderer(RegistryKey<World> key)	Gets the custom cloud renderer for the given World.
static @Nullable DimensionEffects	getDimensionEffects(Identifier key)	Gets the dimension effects registered for an id.
static @Nullable DimensionRenderingRegistry.SkyRenderer	getSkyRenderer(RegistryKey<World> key)	Gets the custom sky renderer for the given World.
static @Nullable DimensionRenderingRegistry.WeatherRenderer	getWeatherRenderer(RegistryKey<World> key)	Gets the custom weather effect renderer for the given World.
static void	registerCloudRenderer(RegistryKey<World> key, DimensionRenderingRegistry.CloudRenderer renderer)	Registers a custom cloud renderer for a World.
static void	registerDimensionEffects(Identifier key, DimensionEffects effects)	Registers dimension effects for an Identifier.
static void	registerSkyRenderer(RegistryKey<World> key, DimensionRenderingRegistry.SkyRenderer renderer)	Registers the custom sky renderer for a World.
static void	registerWeatherRenderer(RegistryKey<World> key, DimensionRenderingRegistry.WeatherRenderer renderer)	Registers a custom weather renderer for a World.

Method Details

registerSkyRenderer

static void registerSkyRenderer(RegistryKey<World> key,
 DimensionRenderingRegistry.SkyRenderer renderer)

Registers the custom sky renderer for a World.

This overrides Vanilla's sky rendering.

Parameters:

key - A RegistryKey for your World

renderer - A DimensionRenderingRegistry.SkyRenderer implementation

Throws:

IllegalArgumentException - if key is already registered.

registerWeatherRenderer

static void registerWeatherRenderer(RegistryKey<World> key,
 DimensionRenderingRegistry.WeatherRenderer renderer)

Registers a custom weather renderer for a World.

This overrides Vanilla's weather rendering.

Parameters:

key - A RegistryKey for your World

renderer - A DimensionRenderingRegistry.WeatherRenderer implementation

Throws:

IllegalArgumentException - if key is already registered.

registerDimensionEffects

static void registerDimensionEffects(Identifier key,
 DimensionEffects effects)

Registers dimension effects for an Identifier.

This registers a new option for the "effects" entry of the dimension type json.

Parameters:

key - The Identifier for the new option entry.

effects - The DimensionEffects option.

Throws:

IllegalArgumentException - if key is already registered.

registerCloudRenderer

static void registerCloudRenderer(RegistryKey<World> key,
 DimensionRenderingRegistry.CloudRenderer renderer)

Registers a custom cloud renderer for a World.

This overrides Vanilla's cloud rendering.

Parameters:

key - A RegistryKey for your World

renderer - A DimensionRenderingRegistry.CloudRenderer implementation

Throws:

IllegalArgumentException - if key is already registered.

getSkyRenderer

@Nullable
static @Nullable DimensionRenderingRegistry.SkyRenderer getSkyRenderer(RegistryKey<World> key)

Gets the custom sky renderer for the given World.

Parameters:

key - A RegistryKey for your World

Returns:

null if no custom sky renderer is registered for the dimension.

getCloudRenderer

@Nullable
static @Nullable DimensionRenderingRegistry.CloudRenderer getCloudRenderer(RegistryKey<World> key)

Gets the custom cloud renderer for the given World.

Parameters:

key - A RegistryKey for your World

Returns:

null if no custom cloud renderer is registered for the dimension.

getWeatherRenderer

@Nullable
static @Nullable DimensionRenderingRegistry.WeatherRenderer getWeatherRenderer(RegistryKey<World> key)

Gets the custom weather effect renderer for the given World.

Returns:

null if no custom weather effect renderer is registered for the dimension.

getDimensionEffects

@Nullable
static @Nullable DimensionEffects getDimensionEffects(Identifier key)

Gets the dimension effects registered for an id.

Parameters:

key - A RegistryKey for your World.

Returns:

overworld effect if no dimension effects is registered for the key.