net.minecraftforge.client.event

Class RenderBlockOverlayEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.client.event.RenderBlockOverlayEvent

public class RenderBlockOverlayEvent
extends Event

Called when a block's texture is going to be overlaid on the player's HUD. Cancel this event to prevent the overlay.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenderBlockOverlayEvent.OverlayType

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
IBlockState	blockForOverlay If the overlay type is BLOCK, then this is the block which the overlay is getting it's icon from
BlockPos	blockPos
RenderBlockOverlayEvent.OverlayType	overlayType The type of overlay to occur
EntityPlayer	player The player which the overlay will apply to
float	renderPartialTicks

Constructor Summary

Constructors

Constructor and Description
RenderBlockOverlayEvent(EntityPlayer player, float renderPartialTicks, RenderBlockOverlayEvent.OverlayType type, Block block, int x, int y, int z) Deprecated.
RenderBlockOverlayEvent(EntityPlayer player, float renderPartialTicks, RenderBlockOverlayEvent.OverlayType type, IBlockState block, BlockPos blockPos)

Method Summary

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, 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 Detail

player

public final EntityPlayer player

The player which the overlay will apply to

renderPartialTicks

public final float renderPartialTicks

overlayType

public final RenderBlockOverlayEvent.OverlayType overlayType

The type of overlay to occur

blockForOverlay

public final IBlockState blockForOverlay

If the overlay type is BLOCK, then this is the block which the overlay is getting it's icon from

blockPos

public final BlockPos blockPos

Constructor Detail

RenderBlockOverlayEvent

@Deprecated
public RenderBlockOverlayEvent(EntityPlayer player,
                                            float renderPartialTicks,
                                            RenderBlockOverlayEvent.OverlayType type,
                                            Block block,
                                            int x,
                                            int y,
                                            int z)

Deprecated.

RenderBlockOverlayEvent

public RenderBlockOverlayEvent(EntityPlayer player,
                               float renderPartialTicks,
                               RenderBlockOverlayEvent.OverlayType type,
                               IBlockState block,
                               BlockPos blockPos)