li.cil.oc.api.network

Interface Analyzable

public interface Analyzable

Allows defining a callback for when a block is right-clicked with an analyzer.

This has to be implemented by a TileEntity, else it will have no effect.

Method Summary

Methods

Modifier and Type	Method and Description
Node[]	onAnalyze(net.minecraft.entity.player.EntityPlayer player, int side, float hitX, float hitY, float hitZ) Called when a player uses the analyzer tool on the tile entity's block.

Method Detail

onAnalyze

Node[] onAnalyze(net.minecraft.entity.player.EntityPlayer player,
               int side,
               float hitX,
               float hitY,
               float hitZ)

Called when a player uses the analyzer tool on the tile entity's block.

This can be used to display additional block specific information in the player's chat when the analyzer is used (or do whatever) and may also be used to redirect the query to some other environment by returning some other environment than this. The latter is used by multi-block screens, for example, to always show information of the primary screen.

Return null to suppress any further node information being displayed.

Parameters:

player - the player that used the analyzer.

side - the side of the block the player clicked.

hitX - the relative X coordinate the player clicked.

hitY - the relative Y coordinate the player clicked.

hitZ - the relative Z coordinate the player clicked.

Returns:

the nodes to display information for, usually an environment's main node (i.e. this.node()).