RenderBlockOverlayEvent (Forge API)

java.lang.Object
+
- cpw.mods.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 cpw.mods.fml.common.eventhandler.Event
  +Event.HasResult, Event.Result
+

Nested Classes
Modifier and Type	Class and Description
`static class`	`RenderBlockOverlayEvent.OverlayType`

+ +

Field Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Fields
Modifier and Type	Field and Description
`Block`	`blockForOverlay` + If the overlay type is BLOCK, then this is the block which the overlay is getting it's icon from +
`int`	`blockX`
`int`	`blockY`
`int`	`blockZ`
`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 blockX, + int blockY, + int blockZ)`

+ +

+ + +
Method Summary
+
- + + +
  Methods inherited from class cpw.mods.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 Block blockForOverlay
```
  +
  If the overlay type is BLOCK, then this is the block which the overlay is getting it's icon from
  +
+ + + +
- +
  blockX
  +
```
public final int blockX
```
  +
+ + + +
- +
  blockY
  +
```
public final int blockY
```
  +
+ + + +
- +
  blockZ
  +
```
public final int blockZ
```
  +
+

+ +

+ + +

Constructor Detail

+ + + +

RenderBlockOverlayEvent

public RenderBlockOverlayEvent(EntityPlayer player,
+                       float renderPartialTicks,
+                       RenderBlockOverlayEvent.OverlayType type,
+                       Block block,
+                       int blockX,
+                       int blockY,
+                       int blockZ)

Class RenderBlockOverlayEvent

Nested Class Summary

Nested classes/interfaces inherited from class cpw.mods.fml.common.eventhandler.Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class cpw.mods.fml.common.eventhandler.Event

Methods inherited from class java.lang.Object

Field Detail

player

renderPartialTicks

overlayType

blockForOverlay

blockX

blockY

blockZ

Constructor Detail

RenderBlockOverlayEvent