li.cil.oc.api.driver

Interface EnvironmentAware

public interface EnvironmentAware

This interface can be added to either item or block drivers.

It is used to statically query the type of environment that would be created for the block or item represented by an item stack. This is used to provide automatically generated ingame help in the NEI usage screen, for example.

For item drivers this will usually be pretty simple to implement, assuming the driver only ever generates one type of environment - just return the class of it and you're done.

For block drivers there is a bit more work involved, since you have to check if the item is the item block that corresponds to the supported block type. This should usually not be an issue either, though.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends Environment>	providedEnvironment(net.minecraft.item.ItemStack stack) Get the type of environment that would be created for the specified block or item.

Method Detail

providedEnvironment

java.lang.Class<? extends Environment> providedEnvironment(net.minecraft.item.ItemStack stack)

Get the type of environment that would be created for the specified block or item.

Note that for block drivers this is called for any type of item stack.

For item drivers this is only called if Item.worksWith(net.minecraft.item.ItemStack) returns true.

Parameters:

stack - the item stack representing a block or item to get the related environment type for.

Returns:

the type of environment this driver would produce, or null if the block or item is not supported.