me.desht.pneumaticcraft.common.thirdparty.computercraft

Class PneumaticTilePeripheral

java.lang.Object

me.desht.pneumaticcraft.common.thirdparty.computercraft.PneumaticTilePeripheral

All Implemented Interfaces:

dan200.computercraft.api.peripheral.IDynamicPeripheral, dan200.computercraft.api.peripheral.IPeripheral, ComputerEventManager.IComputerEventSender

public class PneumaticTilePeripheral
extends java.lang.Object
implements dan200.computercraft.api.peripheral.IDynamicPeripheral, ComputerEventManager.IComputerEventSender

Field Summary

Fields

Modifier and Type	Field and Description
static net.minecraftforge.common.capabilities.Capability<dan200.computercraft.api.peripheral.IPeripheral>	PERIPHERAL_CAPABILITY

Method Summary

Modifier and Type	Method and Description
void	attach(dan200.computercraft.api.peripheral.IComputerAccess computer) Is called when when a computer is attaching to the peripheral.
dan200.computercraft.api.lua.MethodResult	callMethod(dan200.computercraft.api.peripheral.IComputerAccess computer, dan200.computercraft.api.lua.ILuaContext ctx, int method, dan200.computercraft.api.lua.IArguments args) This is called when a lua program on an attached computer calls peripheral.call() with one of the methods exposed by IDynamicPeripheral.getMethodNames().
void	detach(dan200.computercraft.api.peripheral.IComputerAccess computer) Called when a computer is detaching from the peripheral.
boolean	equals(dan200.computercraft.api.peripheral.IPeripheral other) Determine whether this peripheral is equivalent to another one.
java.lang.String[]	getMethodNames() Should return an array of strings that identify the methods that this peripheral exposes to Lua.
java.lang.String	getType() Should return a string that uniquely identifies this type of peripheral.
void	sendEvent(net.minecraft.tileentity.TileEntity te, java.lang.String name, java.lang.Object... params)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dan200.computercraft.api.peripheral.IPeripheral

getTarget

Field Detail

PERIPHERAL_CAPABILITY

public static net.minecraftforge.common.capabilities.Capability<dan200.computercraft.api.peripheral.IPeripheral> PERIPHERAL_CAPABILITY

Method Detail

getMethodNames

@Nonnull
public java.lang.String[] getMethodNames()

Description copied from interface: dan200.computercraft.api.peripheral.IDynamicPeripheral

Should return an array of strings that identify the methods that this peripheral exposes to Lua. This will be called once before each attachment, and should not change when called multiple times.

Specified by:

getMethodNames in interface dan200.computercraft.api.peripheral.IDynamicPeripheral

Returns:

An array of strings representing method names.

See Also:

IDynamicPeripheral.callMethod(dan200.computercraft.api.peripheral.IComputerAccess, dan200.computercraft.api.lua.ILuaContext, int, dan200.computercraft.api.lua.IArguments)

callMethod

@Nonnull
public dan200.computercraft.api.lua.MethodResult callMethod(@Nonnull
                                                                     dan200.computercraft.api.peripheral.IComputerAccess computer,
                                                                     @Nonnull
                                                                     dan200.computercraft.api.lua.ILuaContext ctx,
                                                                     int method,
                                                                     @Nonnull
                                                                     dan200.computercraft.api.lua.IArguments args)
                                                              throws dan200.computercraft.api.lua.LuaException

Description copied from interface: dan200.computercraft.api.peripheral.IDynamicPeripheral

This is called when a lua program on an attached computer calls peripheral.call() with one of the methods exposed by IDynamicPeripheral.getMethodNames(). Be aware that this will be called from the ComputerCraft Lua thread, and must be thread-safe when interacting with Minecraft objects.

Specified by:

callMethod in interface dan200.computercraft.api.peripheral.IDynamicPeripheral

Parameters:

computer - The interface to the computer that is making the call. Remember that multiple computers can be attached to a peripheral at once.

ctx - The context of the currently running lua thread. This can be used to wait for events or otherwise yield.

method - An integer identifying which of the methods from getMethodNames() the computercraft wishes to call. The integer indicates the index into the getMethodNames() table that corresponds to the string passed into peripheral.call()

args - The arguments for this method.

Returns:

A MethodResult containing the values to return or the action to perform.

Throws:

dan200.computercraft.api.lua.LuaException - If you throw any exception from this function, a lua error will be raised with the same message as your exception. Use this to throw appropriate errors if the wrong arguments are supplied to your method.

See Also:

IDynamicPeripheral.getMethodNames()

getType

@Nonnull
public java.lang.String getType()

Description copied from interface: dan200.computercraft.api.peripheral.IPeripheral

Should return a string that uniquely identifies this type of peripheral. This can be queried from lua by calling peripheral.getType()

Specified by:

getType in interface dan200.computercraft.api.peripheral.IPeripheral

Returns:

A string identifying the type of peripheral.

equals

public boolean equals(@Nullable
                      dan200.computercraft.api.peripheral.IPeripheral other)

Description copied from interface: dan200.computercraft.api.peripheral.IPeripheral

Determine whether this peripheral is equivalent to another one. The minimal example should at least check whether they are the same object. However, you may wish to check if they point to the same block or tile entity.

Specified by:

equals in interface dan200.computercraft.api.peripheral.IPeripheral

Parameters:

other - The peripheral to compare against. This may be null.

Returns:

Whether these peripherals are equivalent.

attach

public void attach(@Nonnull
                   dan200.computercraft.api.peripheral.IComputerAccess computer)

Description copied from interface: dan200.computercraft.api.peripheral.IPeripheral

Is called when when a computer is attaching to the peripheral. This will occur when a peripheral is placed next to an active computer, when a computer is turned on next to a peripheral, when a turtle travels into a square next to a peripheral, or when a wired modem adjacent to this peripheral is does any of the above. Between calls to attach and IPeripheral.detach(dan200.computercraft.api.peripheral.IComputerAccess), the attached computer can make method calls on the peripheral using peripheral.call(). This method can be used to keep track of which computers are attached to the peripheral, or to take action when attachment occurs. Be aware that will be called from both the server thread and ComputerCraft Lua thread, and so must be thread-safe and reentrant.

Specified by:

attach in interface dan200.computercraft.api.peripheral.IPeripheral

Parameters:

computer - The interface to the computer that is being attached. Remember that multiple computers can be attached to a peripheral at once.

See Also:

IPeripheral.detach(dan200.computercraft.api.peripheral.IComputerAccess)

detach

public void detach(@Nonnull
                   dan200.computercraft.api.peripheral.IComputerAccess computer)

Description copied from interface: dan200.computercraft.api.peripheral.IPeripheral

Called when a computer is detaching from the peripheral. This will occur when a computer shuts down, when the peripheral is removed while attached to computers, when a turtle moves away from a block attached to a peripheral, or when a wired modem adjacent to this peripheral is detached. This method can be used to keep track of which computers are attached to the peripheral, or to take action when detachment occurs. Be aware that this will be called from both the server and ComputerCraft Lua thread, and must be thread-safe and reentrant.

Specified by:

detach in interface dan200.computercraft.api.peripheral.IPeripheral

Parameters:

computer - The interface to the computer that is being detached. Remember that multiple computers can be attached to a peripheral at once.

See Also:

IPeripheral.attach(dan200.computercraft.api.peripheral.IComputerAccess)

sendEvent

public void sendEvent(net.minecraft.tileentity.TileEntity te,
                      java.lang.String name,
                      java.lang.Object... params)

Specified by:

sendEvent in interface ComputerEventManager.IComputerEventSender