CasingImpl (TIS-3D MC1.16.2-Fabric-1.6.0.21 API)

java.lang.Object
- li.cil.tis3d.common.machine.CasingImpl

All Implemented Interfaces:

Casing
```
public final class CasingImpl
extends java.lang.Object
implements Casing
```
Implementation of a Casing, holding up to six Modules.

Constructor Summary

Constructors
Constructor and Description

CasingImpl(CasingBlockEntity blockEntity)

Constructors
Constructor and Description
`CasingImpl(CasingBlockEntity blockEntity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`net.minecraft.world.World`	`getCasingWorld()` The world this casing resides in.
`Module`	`getModule(Face face)` Get the module installed on the specified face of the casing.
`net.minecraft.util.math.BlockPos`	`getPosition()` The position of the casing in the world it exists in.
`Pipe`	`getReceivingPipe(Face face, Port port)` Get the receiving pipe on the specified port of a module in this casing.
`Pipe`	`getSendingPipe(Face face, Port port)` Get the sending pipe on the specified port of a module in this casing.
`boolean`	`isEnabled()` Get whether the casing is currently enabled, i.e.
`boolean`	`isLocked()` Get whether the casing is locked.
`void`	`lock(net.minecraft.item.ItemStack stack)` Locks the casing and returns the key for unlocking it.
`void`	`markDirty()` Flag the casing as dirty so it is saved when the chunk containing it saved next.
`void`	`onDisabled()` Calls `Module.onDisabled()` on all modules and resets all pipes.
`void`	`onDisposed()` Calls `Module.onDisposed()` on all modules.
`void`	`onEnabled()` Calls `Module.onEnabled()` on all modules.
`void`	`readFromNBT(net.minecraft.nbt.CompoundTag nbt)` Restore data of all modules and pipes from the specified NBT tag.
`void`	`sendData(Face face, io.netty.buffer.ByteBuf data)` Call this to send some data from a module to it's other representation.
`void`	`sendData(Face face, io.netty.buffer.ByteBuf data, byte type)` Call this to send some data from a module to it's other representation.
`void`	`sendData(Face face, net.minecraft.nbt.CompoundTag data)` Call this to send some data from a module to it's other representation.
`void`	`sendData(Face face, net.minecraft.nbt.CompoundTag data, byte type)` Call this to send some data from a module to it's other representation.
`void`	`setLocked(boolean locked)`
`void`	`setModule(Face face, Module module)` Set the module for the specified face of the casing.
`void`	`stepModules()` Advance the logic of all modules by calling `Module.step()` on them.
`boolean`	`unlock(net.minecraft.item.ItemStack stack)` Try to unlock the casing with the key stored on the specified item.
`boolean`	`unlock(java.util.UUID key)` Try to unlock the casing with the specified key.
`void`	`writeToNBT(net.minecraft.nbt.CompoundTag nbt)` Write the state of all modules and pipes to the specified NBT tag.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CasingImpl
```
public CasingImpl(CasingBlockEntity blockEntity)
```
- Method Detail
  - onEnabled
```
public void onEnabled()
```
    Calls Module.onEnabled() on all modules.
    Used by the controller when its state changes to RUNNING.
  - onDisabled
```
public void onDisabled()
```
    Calls Module.onDisabled() on all modules and resets all pipes.
    Used by the controller when its state changes from RUNNING, or the controller is reset (scan scheduled), or the controller is unloaded.
  - onDisposed
```
public void onDisposed()
```
    Calls Module.onDisposed() on all modules.
    Used by the casing when it is being unloaded.
  - stepModules
```
public void stepModules()
```
    Advance the logic of all modules by calling Module.step() on them.
  - setModule
```
public void setModule(Face face,
                      @Nullable
                      Module module)
```
    Set the module for the specified face of the casing.
    This is automatically called by the casing tile entity when items are added or removed and as a special case directly for forwarder modules.
    This calls Module.onEnabled() and Module.onDisabled() appropriately if the casing is enabled or disabled, respectively.
    
    Parameters:
    
    face - the face to install the module on.
    
    module - the module to install on the face, or null for none.
  - setLocked
```
@Environment(value=CLIENT)
public void setLocked(boolean locked)
```
  - lock
```
public void lock(net.minecraft.item.ItemStack stack)
```
    Locks the casing and returns the key for unlocking it.
    
    Parameters:
    
    stack - the item to store the key for unlocking on.
    
    Throws:
    
    java.lang.IllegalStateException - if the casing is already locked.
  - unlock
```
public boolean unlock(net.minecraft.item.ItemStack stack)
```
    Try to unlock the casing with the key stored on the specified item.
    
    Parameters:
    
    stack - the item containing the key.
    
    Returns:
    
    true if the casing was successfully unlocked; false otherwise.
  - unlock
```
public boolean unlock(java.util.UUID key)
```
    Try to unlock the casing with the specified key.
    
    Parameters:
    
    key - the key to use to unlock the casing.
    
    Returns:
    
    true if the casing was successfully unlocked; false otherwise.
  - readFromNBT
```
public void readFromNBT(net.minecraft.nbt.CompoundTag nbt)
```
    Restore data of all modules and pipes from the specified NBT tag.
    
    Parameters:
    
    nbt - the data to load.
  - writeToNBT
```
public void writeToNBT(net.minecraft.nbt.CompoundTag nbt)
```
    Write the state of all modules and pipes to the specified NBT tag.
    
    Parameters:
    
    nbt - the tag to write the data to.
  - getCasingWorld
```
public net.minecraft.world.World getCasingWorld()
```
    Description copied from interface: Casing
    
    The world this casing resides in.
    
    Specified by:
    
    getCasingWorld in interface Casing
    
    Returns:
    
    the world the casing lives in.
  - getPosition
```
public net.minecraft.util.math.BlockPos getPosition()
```
    Description copied from interface: Casing
    
    The position of the casing in the world it exists in.
    
    Specified by:
    
    getPosition in interface Casing
    
    Returns:
    
    the position of the casing.
  - markDirty
```
public void markDirty()
```
    Description copied from interface: Casing
    
    Flag the casing as dirty so it is saved when the chunk containing it saved next.
    
    Specified by:
    
    markDirty in interface Casing
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: Casing
    
    Get whether the casing is currently enabled, i.e. whether it is connected to a currently enabled controller.
    A controller is considered active when a positive non-zero redstone signal is applied to it. This in particular includes the paused state at a signal strength one.
    This is useful for contextual behavior in modules while rendering or in the activation callback Module.onActivate(PlayerEntity, Hand, Vec3d).
    
    Specified by:
    
    isEnabled in interface Casing
    
    Returns:
    
    whether the casing is currently enabled.
  - isLocked
```
public boolean isLocked()
```
    Description copied from interface: Casing
    
    Get whether the casing is locked.
    Casings can be locked, preventing players to remove modules from the casing or add modules to the casing. Some modules may choose to also ignore Module.onActivate(PlayerEntity, Hand, Vec3d) calls while their casing is locks (such as the execution module to prevent reprogramming).
    
    Specified by:
    
    isLocked in interface Casing
    
    Returns:
    
    true if the casing is currently locked.
  - getModule
```
@Nullable
public Module getModule(Face face)
```
    Description copied from interface: Casing
    
    Get the module installed on the specified face of the casing.
    
    Specified by:
    
    getModule in interface Casing
    
    Parameters:
    
    face - the face to get the module for.
    
    Returns:
    
    the module installed on that face, or null.
  - getReceivingPipe
```
public Pipe getReceivingPipe(Face face,
                             Port port)
```
    Description copied from interface: Casing
    
    Get the receiving pipe on the specified port of a module in this casing.
    There are two Pipes between every pair of Modules in a case. Specifically, each edge of a Casing has two Pipes, going into opposite directions. This method is used to to get a Pipe based on its sink.
    
    Specified by:
    
    getReceivingPipe in interface Casing
    
    Parameters:
    
    face - the face to get the port for.
    
    port - the port for which to get the port.
    
    Returns:
    
    the input port on that port.
  - getSendingPipe
```
public Pipe getSendingPipe(Face face,
                           Port port)
```
    Description copied from interface: Casing
    
    Get the sending pipe on the specified port of a module in this casing.
    There are two Pipes between every pair of Modules in a case. Specifically, each edge of a Casing has two Pipes, going into opposite directions. This method is used to to get a Pipe based on its source.
    
    Specified by:
    
    getSendingPipe in interface Casing
    
    Parameters:
    
    face - the face to get the port for.
    
    port - the port for which to get the port.
    
    Returns:
    
    the output port on that port.
  - sendData
```
public void sendData(Face face,
                     net.minecraft.nbt.CompoundTag data,
                     byte type)
```
    Description copied from interface: Casing
    
    Call this to send some data from a module to it's other representation.
    That is, when called from the client, it will send the data to the instance representing the module on the specified face on the server, when called on the server it will send the data to the client.
    Data is collected each tick, and sent in one big packet. If more than one send request is performed in one tick with the same type, the data will replace the previously queued data. A negative value indicates that no specific type is set and data should not be replaced in the send queue.
    Note that this is a convenience alternative for Casing.sendData(Face, ByteBuf, byte) that is meant to be used for non-frequent data, i.e. data that's only sent every so often. For data you expect may be sent each tick, prefer using the more light-weight ByteBuf.
    Important: the passed NBT tag is not copied, it is stored by reference. If you intend to modify the tag after passing it to this method, pass a copy of it instead.
    
    Specified by:
    
    sendData in interface Casing
    
    Parameters:
    
    face - the face the module is installed in.
    
    data - the data to send to the client.
    
    type - the type of the data being sent.
  - sendData
```
public void sendData(Face face,
                     net.minecraft.nbt.CompoundTag data)
```
    Description copied from interface: Casing
    
    Call this to send some data from a module to it's other representation.
    This behaves like Casing.sendData(Face, ByteBuf, byte), except with no specific type associated, so new data will never replace old data. Where at all possible, providing a type is strongly recommended, to reduce generated network traffic.
    Note that this is a convenience alternative for Casing.sendData(Face, ByteBuf) that is meant to be used for non-frequent data, i.e. data that's only sent every so often. For data you expect may be sent each tick, prefer using the more light-weight ByteBuf.
    Important: the passed NBT tag is not copied, it is stored by reference. If you intend to modify the tag after passing it to this method, pass a copy of it instead.
    
    Specified by:
    
    sendData in interface Casing
    
    Parameters:
    
    face - the face the module is installed in.
    
    data - the data to send to the client.
  - sendData
```
public void sendData(Face face,
                     io.netty.buffer.ByteBuf data,
                     byte type)
```
    Description copied from interface: Casing
    
    Call this to send some data from a module to it's other representation.
    That is, when called from the client, it will send the data to the instance representing the module on the specified face on the server, when called on the server it will send the data to the client.
    Data is collected each tick, and sent in one big packet. If more than one send request is performed in one tick with the same type, the data will replace the previously queued data. A negative value indicates that no specific type is set and data should not be replaced in the send queue.
    Important: the passed buffer is not copied, it is stored by reference. If you intend to modify the buffer after passing it to this method, pass a copy of it instead.
    
    Specified by:
    
    sendData in interface Casing
    
    Parameters:
    
    face - the face the module is installed in.
    
    data - the data to send to the client.
    
    type - the type of the data being sent.
  - sendData
```
public void sendData(Face face,
                     io.netty.buffer.ByteBuf data)
```
    Description copied from interface: Casing
    
    Call this to send some data from a module to it's other representation.
    This behaves like Casing.sendData(Face, ByteBuf, byte), except with no specific type associated, so new data will never replace old data. Where at all possible, providing a type is strongly recommended, to reduce generated network traffic.
    Important: the passed buffer is not copied, it is stored by reference. If you intend to modify the buffer after passing it to this method, pass a copy of it instead.
    
    Specified by:
    
    sendData in interface Casing
    
    Parameters:
    
    face - the face the module is installed in.
    
    data - the data to send to the client.

Class CasingImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CasingImpl

Method Detail

onEnabled

onDisabled

onDisposed

stepModules

setModule

setLocked

lock

unlock

unlock

readFromNBT

writeToNBT

getCasingWorld

getPosition

markDirty

isEnabled

isLocked

getModule

getReceivingPipe

getSendingPipe

sendData

sendData

sendData

sendData