Module (TIS-3D MC1.10.2-1.2.3.21 API)

All Known Subinterfaces:

BlockChangeAware, BundledRedstone, Redstone, Rotatable

All Known Implementing Classes:

AbstractModule, AbstractModuleRotatable, ModuleAudio, ModuleBundledRedstone, ModuleDisplay, ModuleExecution, ModuleInfrared, ModuleKeypad, ModuleQueue, ModuleRandom, ModuleRandomAccessMemory, ModuleReadOnlyMemory, ModuleRedstone, ModuleSerialPort, ModuleStack, ModuleTerminal, ModuleTimer
```
public interface Module
```
A module that can be installed in a TIS-3D Casing.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Casing`	`getCasing()` The `Casing` the `Module` is installed in.
`Face`	`getFace()` The `Face` the `Module` is installed on in its `Casing`.
`boolean`	`onActivate(net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand, net.minecraft.item.ItemStack heldItem, float hitX, float hitY, float hitZ)` Called when a player right-clicks the module while installed in a casing.
`void`	`onData(io.netty.buffer.ByteBuf data)` Called with data sent from the remote instance of the module.
`void`	`onData(net.minecraft.nbt.NBTTagCompound nbt)` Called with NBT data sent from the remote instance of the module.
`void`	`onDisabled()` Called when the multi-block of casings the module is installed in is disabled, or when the module was removed from an enabled casing.
`void`	`onDisposed()` Called when the `Casing` housing the module is being disposed, e.g.
`void`	`onEnabled()` Called when the multi-block of casings the module is installed in is enabled, or when the module was installed into an enabled casing.
`void`	`onInstalled(net.minecraft.item.ItemStack stack)` Called when the module is being installed into a `Casing`.
`void`	`onUninstalled(net.minecraft.item.ItemStack stack)` Called after the module was uninstalled from a `Casing`.
`void`	`onWriteComplete(Port port)` Called from a pipe this module is writing to when the data was read.
`void`	`readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)` Restore the state of the module from the specified NBT compound.
`void`	`render(boolean enabled, float partialTicks)` Called to allow the module to render dynamic content on the casing it is installed in.
`void`	`step()` Advance the state of the module.
`void`	`writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)` Save the state of the module to the specified NBT compound.

- Method Detail
  - getCasing
```
Casing getCasing()
```
    The Casing the Module is installed in.
    
    Returns:
    
    the casing the module is installed in.
  - getFace
```
Face getFace()
```
    The Face the Module is installed on in its Casing.
    
    Returns:
    
    the face the module is installed on.
  - step
```
void step()
```
    Advance the state of the module.
    This is called by the controller of the system the module is part of each tick the system is running.
  - onInstalled
```
void onInstalled(net.minecraft.item.ItemStack stack)
```
    Called when the module is being installed into a Casing.
    This is mainly for convenience and having things in one place, you could just as well restore state in your ModuleProvider's ModuleProvider.createModule(ItemStack, Casing, Face) method.
    This is called before the first onEnabled(), and also before it is actually set in the containing Casing. Particularly this means Casing.getModule(Face) for the module's Face will return null in this callback.
    Note that this is only called on the server.
    
    Parameters:
    
    stack - the item stack the module was created from.
  - onUninstalled
```
void onUninstalled(net.minecraft.item.ItemStack stack)
```
    Called after the module was uninstalled from a Casing.
    This allows storing any data that should be persisted onto the module's item representation. For most modules this will not apply, since they are generally stateless / reset state when the computer shuts down.
    This is called after the last onDisabled() and is equivalent to a dispose method (i.e. the module will not be used again after this).
    Note that this is only called on the server.
    
    Parameters:
    
    stack - the stack representing the module.
  - onEnabled
```
void onEnabled()
```
    Called when the multi-block of casings the module is installed in is enabled, or when the module was installed into an enabled casing.
    Note that this is only called on the server.
  - onDisabled
```
void onDisabled()
```
    Called when the multi-block of casings the module is installed in is disabled, or when the module was removed from an enabled casing.
    Modules should use this to reset their state, so that cycling power of a controller resets the whole multi-block system.
    Note that this is only called on the server.
  - onDisposed
```
void onDisposed()
```
    Called when the Casing housing the module is being disposed, e.g. due to a chunk being unloaded.
    This is intended for freeing up resources (e.g. allocated texture or audio memory). Unlike onDisabled() this is only called once on a module, at the very end of its life. Avoid world interaction in this callback to avoid loading the chunk again.
    This is called on the server and the client.
  - onWriteComplete
```
void onWriteComplete(Port port)
```
    Called from a pipe this module is writing to when the data was read.
    This allows completing the operation in the same tick in which the read operation was completed. This is particularly useful when writing to multiple ports at a time but the written value may only be read once; in this case the remaining writes can be canceled in this callback.
    
    Parameters:
    
    port - the port on which the write operation was completed.
  - onActivate
```
boolean onActivate(net.minecraft.entity.player.EntityPlayer player,
                   net.minecraft.util.EnumHand hand,
                   @Nullable
                   net.minecraft.item.ItemStack heldItem,
                   float hitX,
                   float hitY,
                   float hitZ)
```
    Called when a player right-clicks the module while installed in a casing.
    The face is implicitly given by the face the module is installed in, as is the world via the casing's world.
    Note that there should be some way in which a click can be ignored, e.g. by a player sneaking, otherwise the module cannot be removed from the casing by hand.
    
    Parameters:
    
    player - the player that clicked the module.
    
    hand - the hand the player used to activate the module.
    
    heldItem - the item the player is holding in that hand.
    
    hitX - the relative x position that was clicked.
    
    hitY - the relative y position that was clicked.
    
    hitZ - the relative z position that was clicked.
    
    Returns:
    
    true if the click was handled, false otherwise.
  - onData
```
void onData(net.minecraft.nbt.NBTTagCompound nbt)
```
    Called with NBT data sent from the remote instance of the module.
    This can be called on both the server and the client, depending on which side sent the message (i.e. the client can send messages to the server this way and vice versa).
    
    Parameters:
    
    nbt - the received data.
    
    See Also:
    
    Casing.sendData(Face, NBTTagCompound, byte), Casing.sendData(Face, NBTTagCompound)
  - onData
```
void onData(io.netty.buffer.ByteBuf data)
```
    Called with data sent from the remote instance of the module.
    This can be called on both the server and the client, depending on which side sent the message (i.e. the client can send messages to the server this way and vice versa).
    
    Parameters:
    
    data - the received data.
    
    See Also:
    
    Casing.sendData(Face, ByteBuf, byte), Casing.sendData(Face, ByteBuf)
  - render
```
void render(boolean enabled,
            float partialTicks)
```
    Called to allow the module to render dynamic content on the casing it is installed in.
    The render state will be adjusted to take into account the face the module is installed in, i.e. rendering from (0, 0, 0) to (1, 1, 0) will render the full quad of face of the casing the module is installed in.
    Note that the enabled is the same as Casing.isEnabled(), it is merely passed along for backwards compatibility from before the time that getter existed.
    
    Parameters:
    
    enabled - whether the module is currently enabled.
    
    partialTicks - the partial time elapsed in this tick.
  - readFromNBT
```
void readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)
```
    Restore the state of the module from the specified NBT compound.
    
    Parameters:
    
    nbt - the tag to load the state from.
  - writeToNBT
```
void writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)
```
    Save the state of the module to the specified NBT compound.
    
    Parameters:
    
    nbt - the tag to save the state to.

Interface Module

Method Summary

Method Detail

getCasing

getFace

step

onInstalled

onUninstalled

onEnabled

onDisabled

onDisposed

onWriteComplete

onActivate

onData

onData

render

readFromNBT

writeToNBT