li.cil.oc.api.internal

Interface Robot

All Superinterfaces:

Agent, Environment, EnvironmentHost, net.minecraftforge.fluids.IFluidHandler, net.minecraft.inventory.IInventory, net.minecraft.inventory.ISidedInventory, net.minecraft.world.IWorldNameable, MachineHost, Rotatable, Tiered

public interface Robot
extends Agent, Environment, EnvironmentHost, Tiered, net.minecraft.inventory.ISidedInventory, net.minecraftforge.fluids.IFluidHandler

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
• equipmentInventory.getSizeInventory hot-swappable components.
• mainInventory.getSizeInventory 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).

This interface is not meant to be implemented, just used.

Method Summary

Modifier and Type	Method and Description
int	componentCount() The number of built-in components in this robot.
Environment	getComponentInSlot(int index) Get the environment for the component in the specified slot.
boolean	shouldAnimate() This essentially returns whether the robot is currently running or not.
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 li.cil.oc.api.internal.Agent

equipmentInventory, mainInventory, name, ownerName, ownerUUID, player, selectedSlot, selectedTank, setName, setSelectedSlot, setSelectedTank, tank

Methods inherited from interface li.cil.oc.api.machine.MachineHost

componentSlot, internalComponents, machine, onMachineConnect, onMachineDisconnect

Methods inherited from interface li.cil.oc.api.network.EnvironmentHost

markChanged, world, xPosition, yPosition, zPosition

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

facing, toGlobal, toLocal

Methods inherited from interface li.cil.oc.api.network.Environment

node, onConnect, onDisconnect, onMessage

Methods inherited from interface li.cil.oc.api.internal.Tiered

tier

Methods inherited from interface net.minecraft.inventory.ISidedInventory

canExtractItem, canInsertItem, getSlotsForFace

Methods inherited from interface net.minecraft.inventory.IInventory

clear, closeInventory, decrStackSize, getField, getFieldCount, getInventoryStackLimit, getSizeInventory, getStackInSlot, isItemValidForSlot, isUseableByPlayer, markDirty, openInventory, removeStackFromSlot, setField, setInventorySlotContents

Methods inherited from interface net.minecraft.world.IWorldNameable

getDisplayName, getName, hasCustomName

Methods inherited from interface net.minecraftforge.fluids.IFluidHandler

canDrain, canFill, drain, drain, fill, getTankInfo

Method Detail

componentCount

int componentCount()

The number of built-in components in this robot.

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.

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.

shouldAnimate

boolean shouldAnimate()

This essentially returns whether the robot is currently running or not.

This is explicitly meant for client side use, to allow upgrade renderers to know whether to resume animations or not, based on whether the robot is currently powered on or not.