dan200.computercraft.api.turtle.event

Class TurtleBlockEvent.Inspect

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

dan200.computercraft.api.turtle.event.TurtleEvent

dan200.computercraft.api.turtle.event.TurtleActionEvent

dan200.computercraft.api.turtle.event.TurtlePlayerEvent

dan200.computercraft.api.turtle.event.TurtleBlockEvent

dan200.computercraft.api.turtle.event.TurtleBlockEvent.Inspect

Enclosing class:

TurtleBlockEvent

public static class TurtleBlockEvent.Inspect
extends TurtleBlockEvent

Fired when a turtle gathers data on a block in world. You may prevent blocks being inspected, or add additional information to the result.

See Also:

TurtleAction.INSPECT

Nested Class Summary

Nested classes/interfaces inherited from class dan200.computercraft.api.turtle.event.TurtleBlockEvent

TurtleBlockEvent.Dig, TurtleBlockEvent.Inspect, TurtleBlockEvent.Move, TurtleBlockEvent.Place

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

net.minecraftforge.fml.common.eventhandler.Event.HasResult, net.minecraftforge.fml.common.eventhandler.Event.Result

Constructor Summary

Constructors

Constructor and Description
Inspect(ITurtleAccess turtle, net.minecraftforge.common.util.FakePlayer player, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState state, java.util.Map<java.lang.String,java.lang.Object> data)

Method Summary

Modifier and Type	Method and Description
void	addData(java.util.Map<java.lang.String,?> newData) Add new information to the inspection result.
java.util.Map<java.lang.String,java.lang.Object>	getData() Get the "inspection data" from this block, which will be returned to the user.
net.minecraft.block.state.IBlockState	getState() Get the block state which is being inspected.

Methods inherited from class dan200.computercraft.api.turtle.event.TurtleBlockEvent

getPos, getWorld

Methods inherited from class dan200.computercraft.api.turtle.event.TurtlePlayerEvent

getPlayer

Methods inherited from class dan200.computercraft.api.turtle.event.TurtleActionEvent

getAction, getFailureMessage, setCanceled, setCanceled

Methods inherited from class dan200.computercraft.api.turtle.event.TurtleEvent

getTurtle

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

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

Inspect

public Inspect(@Nonnull
               ITurtleAccess turtle,
               @Nonnull
               net.minecraftforge.common.util.FakePlayer player,
               @Nonnull
               net.minecraft.world.World world,
               @Nonnull
               net.minecraft.util.math.BlockPos pos,
               @Nonnull
               net.minecraft.block.state.IBlockState state,
               @Nonnull
               java.util.Map<java.lang.String,java.lang.Object> data)

Method Detail

getState

@Nonnull
public net.minecraft.block.state.IBlockState getState()

Get the block state which is being inspected.

Returns:

The inspected block state.

getData

@Nonnull
public java.util.Map<java.lang.String,java.lang.Object> getData()

Get the "inspection data" from this block, which will be returned to the user.

Returns:

This block's inspection data.

addData

public void addData(@Nonnull
                    java.util.Map<java.lang.String,?> newData)

Add new information to the inspection result. Note this will override fields with the same name.

Parameters:

newData - The data to add. Note all values should be convertable to Lua (see IPeripheral.callMethod(IComputerAccess, ILuaContext, int, Object[])).