li.cil.oc.api

Interface Rotatable

All Known Subinterfaces:

Robot

public interface Rotatable

This interface is implemented by the computer case and robot tile entities to allow item components to query the orientation of their host, i.e. to allow getting the facing of the tile entity passed to their drivers' Item.createEnvironment(net.minecraft.item.ItemStack, li.cil.oc.api.driver.Container) method.

Method Summary

Methods

Modifier and Type	Method and Description
net.minecraftforge.common.util.ForgeDirection	facing() The current facing of a tile entity implementing this interface.
net.minecraftforge.common.util.ForgeDirection	toGlobal(net.minecraftforge.common.util.ForgeDirection value) Converts a facing relative to the block's local coordinate system to a global orientation, using south as the standard orientation.
net.minecraftforge.common.util.ForgeDirection	toLocal(net.minecraftforge.common.util.ForgeDirection value) Converts a global orientation to a facing relative to the block's local coordinate system, using south as the standard orientation.

Method Detail

facing

net.minecraftforge.common.util.ForgeDirection facing()

The current facing of a tile entity implementing this interface.

Intended to be used to query the orientation of an item components' host. For example:

 class SomeDriver implements li.cil.oc.api.driver.Item {
     // ...
     ManagedEnvironment createEnvironment(ItemStack stack, TileEntity tileentity) {
         if (tileentity instanceof Rotatable) {
             ForgeDirection facing = ((Rotatable)tileentity).facing();
             // Do something with facing.
         }
     }
 }
 

Returns:

the current facing.

toGlobal

net.minecraftforge.common.util.ForgeDirection toGlobal(net.minecraftforge.common.util.ForgeDirection value)

Converts a facing relative to the block's local coordinate system to a global orientation, using south as the standard orientation.

For example, if the block is facing east, calling this with south will return east, calling it with west will return south and so on.

Parameters:

value - the value to translate.

Returns:

the translated orientation.

toLocal

net.minecraftforge.common.util.ForgeDirection toLocal(net.minecraftforge.common.util.ForgeDirection value)

Converts a global orientation to a facing relative to the block's local coordinate system, using south as the standard orientation.

For example, if the block is facing east, calling this with south will return east, calling it with west will return north and so on.

Parameters:

value - the value to translate.

Returns:

the translated orientation.