li.cil.tis3d.api.prefab.client

Class AbstractModuleItemRenderer

java.lang.Object

li.cil.tis3d.api.prefab.client.AbstractModuleItemRenderer

All Implemented Interfaces:

net.minecraftforge.client.IItemRenderer

Direct Known Subclasses:

SimpleModuleRenderer

public abstract class AbstractModuleItemRenderer
extends java.lang.Object
implements net.minecraftforge.client.IItemRenderer

Base class provided for convenience of rendering module items in the same way the modules in TIS-3D are rendered. This by default reuses the TIS-3D model for modules and allows applying a custom overlay texture.

Use this by registering an instance of a specialization of this as the item renderer of your module item.

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraftforge.client.IItemRenderer

net.minecraftforge.client.IItemRenderer.ItemRendererHelper, net.minecraftforge.client.IItemRenderer.ItemRenderType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCATION_MODULE_MODEL
static java.lang.String	LOCATION_MODULE_TEXTURE
protected net.minecraftforge.client.model.IModelCustom	model The model used for rendering modules.
static net.minecraftforge.client.model.IModelCustom	MODULE_MODEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractModuleItemRenderer() Construct the module renderer using the default model.
protected	AbstractModuleItemRenderer(net.minecraftforge.client.model.IModelCustom model) Construct the module renderer using the specified model.

Method Summary

Modifier and Type	Method and Description
abstract net.minecraft.util.IIcon	getOverlayIcon(net.minecraftforge.client.IItemRenderer.ItemRenderType type, net.minecraft.item.ItemStack item, java.lang.Object... data) Get the icon representation of the texture to use as the overlay of the module (specifying the texture coordinates on the texture location specified in getTextureLocation(net.minecraftforge.client.IItemRenderer.ItemRenderType, net.minecraft.item.ItemStack, java.lang.Object...)).
protected net.minecraft.util.ResourceLocation	getTextureLocation(net.minecraftforge.client.IItemRenderer.ItemRenderType type, net.minecraft.item.ItemStack item, java.lang.Object... data) Determines the texture being used for rendering the module's overlay.
boolean	handleRenderType(net.minecraft.item.ItemStack item, net.minecraftforge.client.IItemRenderer.ItemRenderType type)
protected void	renderCasing(net.minecraftforge.client.IItemRenderer.ItemRenderType type, net.minecraft.item.ItemStack item, java.lang.Object... data) Renders the base model of the module.
void	renderItem(net.minecraftforge.client.IItemRenderer.ItemRenderType type, net.minecraft.item.ItemStack item, java.lang.Object... data)
protected void	renderOverlay(net.minecraftforge.client.IItemRenderer.ItemRenderType type, net.minecraft.item.ItemStack item, java.lang.Object... data) Render the overlay of the module.
protected boolean	shouldIgnoreLighting(net.minecraftforge.client.IItemRenderer.ItemRenderType type, net.minecraft.item.ItemStack item, java.lang.Object... data) Determines whether the overlay texture of the module should ignore lighting, i.e.
boolean	shouldUseRenderHelper(net.minecraftforge.client.IItemRenderer.ItemRenderType type, net.minecraft.item.ItemStack item, net.minecraftforge.client.IItemRenderer.ItemRendererHelper helper)

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION_MODULE_MODEL

public static final java.lang.String LOCATION_MODULE_MODEL

See Also:

Constant Field Values

LOCATION_MODULE_TEXTURE

public static final java.lang.String LOCATION_MODULE_TEXTURE

See Also:

Constant Field Values

MODULE_MODEL

public static final net.minecraftforge.client.model.IModelCustom MODULE_MODEL

model

protected final net.minecraftforge.client.model.IModelCustom model

The model used for rendering modules.

Constructor Detail

AbstractModuleItemRenderer

protected AbstractModuleItemRenderer(net.minecraftforge.client.model.IModelCustom model)

Construct the module renderer using the specified model.

Parameters:

model - the model to use for this renderer.

AbstractModuleItemRenderer

protected AbstractModuleItemRenderer()

Construct the module renderer using the default model.

Method Detail

getTextureLocation

protected net.minecraft.util.ResourceLocation getTextureLocation(net.minecraftforge.client.IItemRenderer.ItemRenderType type,
                                                                 net.minecraft.item.ItemStack item,
                                                                 java.lang.Object... data)

Determines the texture being used for rendering the module's overlay.

Parameters:

type - the current render type.

item - the item stack of the module being rendered.

data - additional data (unused).

Returns:

the location of the texture to use.

getOverlayIcon

public abstract net.minecraft.util.IIcon getOverlayIcon(net.minecraftforge.client.IItemRenderer.ItemRenderType type,
                                                        net.minecraft.item.ItemStack item,
                                                        java.lang.Object... data)

Get the icon representation of the texture to use as the overlay of the module (specifying the texture coordinates on the texture location specified in getTextureLocation(net.minecraftforge.client.IItemRenderer.ItemRenderType, net.minecraft.item.ItemStack, java.lang.Object...)).

Parameters:

type - the current render type.

item - the item stack of the module being rendered.

data - additional data (unused).

Returns:

the icon of the overlay, or null for no overlay.

shouldIgnoreLighting

protected boolean shouldIgnoreLighting(net.minecraftforge.client.IItemRenderer.ItemRenderType type,
                                       net.minecraft.item.ItemStack item,
                                       java.lang.Object... data)

Determines whether the overlay texture of the module should ignore lighting, i.e. whether it should be fully lit regardless of light conditions, effectively making it glow.

Parameters:

type - the current render type.

item - the item stack of the module being rendered.

data - additional data (unused).

Returns:

true if the overlay texture should ignore lighting.

renderCasing

protected void renderCasing(net.minecraftforge.client.IItemRenderer.ItemRenderType type,
                            net.minecraft.item.ItemStack item,
                            java.lang.Object... data)

Renders the base model of the module.

Parameters:

type - the current render type.

item - the item stack of the module being rendered.

data - additional data (unused).

renderOverlay

protected void renderOverlay(net.minecraftforge.client.IItemRenderer.ItemRenderType type,
                             net.minecraft.item.ItemStack item,
                             java.lang.Object... data)

Render the overlay of the module.

Parameters:

type - the current render type.

item - the item stack of the module being rendered.

data - additional data (unused).

handleRenderType

public boolean handleRenderType(net.minecraft.item.ItemStack item,
                                net.minecraftforge.client.IItemRenderer.ItemRenderType type)

Specified by:

handleRenderType in interface net.minecraftforge.client.IItemRenderer

shouldUseRenderHelper

public boolean shouldUseRenderHelper(net.minecraftforge.client.IItemRenderer.ItemRenderType type,
                                     net.minecraft.item.ItemStack item,
                                     net.minecraftforge.client.IItemRenderer.ItemRendererHelper helper)

Specified by:

shouldUseRenderHelper in interface net.minecraftforge.client.IItemRenderer

renderItem

public void renderItem(net.minecraftforge.client.IItemRenderer.ItemRenderType type,
                       net.minecraft.item.ItemStack item,
                       java.lang.Object... data)

Specified by:

renderItem in interface net.minecraftforge.client.IItemRenderer