li.cil.oc.api.machine

Interface Robot

All Superinterfaces:

net.minecraft.inventory.IInventory, net.minecraft.inventory.ISidedInventory, Rotatable

public interface Robot
extends net.minecraft.inventory.ISidedInventory, Rotatable

This interface allows interaction with robots.

It is intended to be used by components when installed in a robot. In that case, the robot in question is the tile entity passed to item driver when asked to create the component's environment.

A robot's inventory contains component items and items in the actual inventory. The physical layout in the underlying 'real' inventory is as follows:

• Tool
• containerCount hot-swappable components.
• inventorySize internal inventory slots.
• componentCount hard-wired components.

Note that there may be no hot-swappable (or even built-in) components or no inventory, depending on the configuration of the robot. The hard-wired components cannot be changed (removed/replaced).

Method Summary

Methods

Modifier and Type	Method and Description
int	componentCount() The number of built-in components in this robot.
int	containerCount() The number of hot-swappable component slots in this robot.
Environment	getComponentInSlot(int index) Get the environment for the component in the specified slot.
net.minecraft.item.ItemStack	getStackInSlot(int index) Get the item stack in the specified inventory slot.
int	inventorySize() The size of the internal inventory in this robot, excluding tool and component slots.
net.minecraft.entity.player.EntityPlayer	player() Returns the fake player used to represent the robot as an entity for certain actions that require one.
int	selectedSlot() Gets the index of the currently selected slot in the robot's inventory.
void	synchronizeSlot(int slot) Sends the state of the item in the specified slot to the client if it is an upgrade.

Methods inherited from interface net.minecraft.inventory.ISidedInventory

canExtractItem, canInsertItem, getAccessibleSlotsFromSide

Methods inherited from interface net.minecraft.inventory.IInventory

closeInventory, decrStackSize, getInventoryName, getInventoryStackLimit, getSizeInventory, getStackInSlotOnClosing, hasCustomInventoryName, isItemValidForSlot, isUseableByPlayer, markDirty, openInventory, setInventorySlotContents

Methods inherited from interface li.cil.oc.api.Rotatable

facing, toGlobal, toLocal

Method Detail

player

net.minecraft.entity.player.EntityPlayer player()

Returns the fake player used to represent the robot as an entity for certain actions that require one.

This will automatically be positioned and rotated to represent the robot's current position and rotation in the world. Use this to trigger events involving the robot that require a player entity, and for more in-depth interaction with the robots' inventory.

Returns:

the fake player for the robot.

containerCount

int containerCount()

The number of hot-swappable component slots in this robot.

Note: this will always be three, regardless of the number of installed containers. For unused slots the inventory will simply be empty at that slot.

componentCount

int componentCount()

The number of built-in components in this robot.

inventorySize

int inventorySize()

The size of the internal inventory in this robot, excluding tool and component slots.

getStackInSlot

net.minecraft.item.ItemStack getStackInSlot(int index)

Get the item stack in the specified inventory slot.

This operates on the underlying, real inventory, as described in the comment on top of this class.

This will return null for empty slots.

Specified by:

getStackInSlot in interface net.minecraft.inventory.IInventory

Parameters:

index - the index of the slot from which to get the stack.

Returns:

the content of that slot, or null.

getComponentInSlot

Environment getComponentInSlot(int index)

Get the environment for the component in the specified slot.

This operates on the underlying, real inventory, as described in the comment on top of this class.

This will return null for slots that do not contain components, or components that do not have an environment (on the calling side).

Parameters:

index - the index of the slot from which to get the environment.

Returns:

the environment for that slot, or null.

selectedSlot

int selectedSlot()

Gets the index of the currently selected slot in the robot's inventory.

This is the index in the underlying, real inventory. To get the 'local' index, i.e. the way the robot itself addresses it, add one for the tool and containerCount to this value.

Returns:

the index of the currently selected slot.

synchronizeSlot

void synchronizeSlot(int slot)

Sends the state of the item in the specified slot to the client if it is an upgrade.

Use this to update the state of an upgrade in that slot for rendering purposes (e.g. this is used by the generator upgrade to update the active state so the renderer knows which texture to use).

This is necessary because inventories are not synchronized by default, only if a player is currently 'looking into' the inventory (opened the GUI of the inventory).

The component will be saved to its item's NBT tag compound, as it would be when the game is saved, and then the item is re-sent to the client. Keep the number of calls to this function low, since each call causes a network packet to be sent.