Class ExtractBlockScreenEffectEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ExtractBlockScreenEffectEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class ExtractBlockScreenEffectEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

Fired when a block screen effect overlay is being extracted.

This event is cancellable. If this event is canceled, then the vanilla overlay will not be rendered.

This event is fired on the main game event bus, only on the logical client.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExtractBlockScreenEffectEvent.OverlayType	The type of the block overlay to be rendered.

Field Summary

Fields

Modifier and Type	Field	Description
private final Camera	camera
private final ExtractBlockScreenEffectEvent.OverlayType	overlayType
private final LocalPlayer	player
private final float	playerPartialTick
private final PlayerRenderState	playerRenderState
private final BlockPos	pos
private final BlockState	state
private final float	worldPartialTick

Constructor Summary

Constructors

Constructor	Description
ExtractBlockScreenEffectEvent(LocalPlayer player, PlayerRenderState playerRenderState, BlockPos pos, BlockState state, Camera camera, float worldPartialTick, float playerPartialTick, ExtractBlockScreenEffectEvent.OverlayType type)

Method Summary

Modifier and Type	Method	Description
Camera	getCamera()
ExtractBlockScreenEffectEvent.OverlayType	getOverlayType()	Returns the type of the overlay.
LocalPlayer	getPlayer()	Returns the player which the overlay will apply to.
float	getPlayerPartialTick()
PlayerRenderState	getPlayerRenderState()	Returns the render state of the player which the overlay will apply to.
BlockPos	getPos()	Returns the position of the block which the overlay is gotten from.
BlockState	getState()	Returns the block which the overlay is gotten from.
float	getWorldPartialTick()
void	setCanceled(boolean canceled)
void	setCustomRenderer(CustomBlockScreenEffectRenderer renderer)	Set a custom renderer to prepend or replace the vanilla effect rendering.

Methods inherited from class Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled

Field Details

player

private final LocalPlayer player

playerRenderState

private final PlayerRenderState playerRenderState

pos

private final BlockPos pos

state

private final BlockState state

camera

private final Camera camera

worldPartialTick

private final float worldPartialTick

playerPartialTick

private final float playerPartialTick

overlayType

private final ExtractBlockScreenEffectEvent.OverlayType overlayType

Constructor Details

ExtractBlockScreenEffectEvent

@Internal
public ExtractBlockScreenEffectEvent(LocalPlayer player,
 PlayerRenderState playerRenderState,
 BlockPos pos,
 BlockState state,
 Camera camera,
 float worldPartialTick,
 float playerPartialTick,
 ExtractBlockScreenEffectEvent.OverlayType type)

Method Details

getPlayer

public LocalPlayer getPlayer()

Returns the player which the overlay will apply to.

Returns:

the player which the overlay will apply to

getPlayerRenderState

public PlayerRenderState getPlayerRenderState()

Returns the render state of the player which the overlay will apply to.

Returns:

the render state of the player which the overlay will apply to

getPos

public BlockPos getPos()

Returns the position of the block which the overlay is gotten from.

Returns:

the position of the block which the overlay is gotten from

getState

public BlockState getState()

Returns the block which the overlay is gotten from.

Returns:

the block which the overlay is gotten from

getCamera

public Camera getCamera()

getWorldPartialTick

public float getWorldPartialTick()

getPlayerPartialTick

public float getPlayerPartialTick()

getOverlayType

public ExtractBlockScreenEffectEvent.OverlayType getOverlayType()

Returns the type of the overlay.

Returns:

the type of the overlay

setCustomRenderer

public void setCustomRenderer(CustomBlockScreenEffectRenderer renderer)

Set a custom renderer to prepend or replace the vanilla effect rendering.

Parameters:

renderer - The effect renderer to apply

setCanceled

public void setCanceled(boolean canceled)

Specified by:

setCanceled in interface net.neoforged.bus.api.ICancellableEvent