Package net.minecraftforge.client.event

Class EntityViewRenderEvent.RenderFogEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.EntityViewRenderEvent

net.minecraftforge.client.event.EntityViewRenderEvent.FogEvent

net.minecraftforge.client.event.EntityViewRenderEvent.RenderFogEvent

Enclosing class:

EntityViewRenderEvent

public static class EntityViewRenderEvent.RenderFogEvent
extends EntityViewRenderEvent.FogEvent

This event allows for customization of parameters related to fog rendering. The plane distances are based on the player's render distance. For the event to have an effect, you must cancel it. The FogMode is NOT customizable. It describes the type of fog being modified. A FogMode of FOG_SKY is the skybox's fog. A FogMode of FOG_TERRAIN is what the fog induced by render distance uses. This works best for reducing the camera's visibility.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.client.event.EntityViewRenderEvent

EntityViewRenderEvent.CameraSetup, EntityViewRenderEvent.FieldOfView, EntityViewRenderEvent.FogColors, EntityViewRenderEvent.FogDensity, EntityViewRenderEvent.RenderFogEvent

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private float	farPlaneDistance
private FogShape	fogShape
private float	nearPlaneDistance
private final FogRenderer.FogMode	type

Constructor Summary

Constructors

Constructor	Description
RenderFogEvent(FogRenderer.FogMode type, Camera camera, float partialTicks, float distance)	Deprecated, for removal: This API element is subject to removal in a future version. Use other constructor with all the params.
RenderFogEvent(FogRenderer.FogMode type, Camera camera, float partialTicks, float nearPlaneDistance, float farPlaneDistance, FogShape fogShape)

Method Summary

Modifier and Type	Method	Description
float	getFarPlaneDistance()
FogShape	getFogShape()
FogRenderer.FogMode	getMode()
float	getNearPlaneDistance()
void	scaleFarPlaneDistance(float factor)
void	scaleNearPlaneDistance(float factor)
void	setFarPlaneDistance(float distance)
void	setFogShape(FogShape shape)
void	setNearPlaneDistance(float distance)

Methods inherited from class net.minecraftforge.client.event.EntityViewRenderEvent

getCamera, getPartialTicks, getRenderer

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getParentListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Field Details

type

private final FogRenderer.FogMode type

farPlaneDistance

private float farPlaneDistance

nearPlaneDistance

private float nearPlaneDistance

fogShape

private FogShape fogShape

Constructor Details

RenderFogEvent

@Deprecated(forRemoval=true,
            since="1.18.2")
public RenderFogEvent(FogRenderer.FogMode type,
 Camera camera,
 float partialTicks,
 float distance)

Deprecated, for removal: This API element is subject to removal in a future version.

Use other constructor with all the params. Will be removed in 1.19

RenderFogEvent

public RenderFogEvent(FogRenderer.FogMode type,
 Camera camera,
 float partialTicks,
 float nearPlaneDistance,
 float farPlaneDistance,
 FogShape fogShape)

Method Details

getMode

public FogRenderer.FogMode getMode()

Overrides:

getMode in class EntityViewRenderEvent.FogEvent

getFarPlaneDistance

public float getFarPlaneDistance()

getNearPlaneDistance

public float getNearPlaneDistance()

getFogShape

public FogShape getFogShape()

setFarPlaneDistance

public void setFarPlaneDistance(float distance)

setNearPlaneDistance

public void setNearPlaneDistance(float distance)

setFogShape

public void setFogShape(FogShape shape)

scaleFarPlaneDistance

public void scaleFarPlaneDistance(float factor)

scaleNearPlaneDistance

public void scaleNearPlaneDistance(float factor)