Skip to content

Latest commit

 

History

History
277 lines (264 loc) · 10.2 KB

COMPUTERCRAFT.md

File metadata and controls

277 lines (264 loc) · 10.2 KB
Raw

Create Crafts & Additions: Computercraft Peripheral API

Version 1.1

Supported Blocks:

Other Languages

简体中文 (Simplified Chinese)

Electric Motor

To set the speed of the Electric Motor, call setSpeed(rpm) where the argument rpm is a number between -256 and 256. The function will throw an exception if it is called too many times per second.

motor.setSpeed(rpm)

The function stop() is a shorthand for setSpeed(0).

motor.stop()

In the following example, the motor attached to the left of the computer will rotate at 32RPM for 5 seconds and then stop.

local motor = peripheral.wrap("left")
motor.setSpeed(32)
sleep(5)
motor.stop()

The function rotate(degrees, [rpm]) will return the time it will take to rotate the shaft by the argument degrees at the current speed. If the optional argument rpm is given it will set the speed of the motor and return the rotation time at the new speed.

motor.setSpeed(32)
sleep(motor.rotate(90))
motor.stop()

In the following example, the motor will first rotate 180 degrees in the clockwise direction, then 180 degrees at half the speed in the anti-clockwise direction and then finaly stop.

local motor = peripheral.wrap("left")
sleep(motor.rotate(180, 32))
sleep(motor.rotate(-180, 16))
motor.stop()

The function translate(blocks, [rpm]) will return the time it will take to rotate the shaft to push a piston or gantry shaft by distance given by the argument blocks at the current speed. If the optional argument rpm is given it will set the speed of the motor and return the action time at the new speed.

motor.setSpeed(32)
sleep(motor.translate(5))
motor.stop()

In the following example, the motor attached to a piston will extend the piston by 5 blocks, stop for a second, retract, and then finally stop.

local motor = peripheral.wrap("left")
sleep(motor.translate(5, 32))
sleep(1)
sleep(motor.translate(-5, 32))
motor.stop()

The function getSpeed() will return the current motor speed.

local rpm = motor.getSpeed()

The function getStressCapacity() will return the produced stress capacity (output su).

local su = motor.getStressCapacity()

The function getEnergyConsumption() will return the motor energy consumption in FE/t.

local fe = motor.getEnergyConsumption()

The function getMaxInsert() will return the Motor max input in fe.

local fe = motor.getMaxInsert()

The function getMaxExtract() will return the Motor max output in fe (Always 0).

local fe = motor.getMaxExtract()

The function getType() will return the motor peripheral name, which will always be "electric_motor".

print("Peripheral: " .. motor.getType())

Accumulator

In the following example, we get the peripheral of an Accumulator on the left.

local accumulator = peripheral.wrap("left")

The function getEnergy() will return the accumulator total stored charge in fe.

local fe = accumulator.getEnergy()

The function getCapacity() will return the accumulator total capacity in fe.

local fe = accumulator.getCapacity()

The function getPercent() will return the accumulator total charge in relation to the total capacity in percent.

local percent = accumulator.getPercent()

The function getMaxInsert() will return the accumulator max input per block face in fe.

local fe = accumulator.getMaxInsert()

The function getMaxExtract() will return the accumulator max output per block face in fe.

local fe = accumulator.getMaxExtract()

The function getHeight() will return the accumulator height in block.

local blocks = accumulator.getHeight()

The function getWidth() will return the accumulator width in block.

local blocks = accumulator.getWidth()

The function getType() will return the accumulator peripheral name, which will always be "modular_accumulator".

print("Peripheral: " .. accumulator.getType())

Portable Energy Interface (PEI)

In the following example, we get the peripheral of a PEI on the left.

local pei = peripheral.wrap("left")

The function getEnergy() will return the connected contraption total stored charge in fe, (-1 if not connected).

local fe = pei.getEnergy()

The function getCapacity() will return the connected contraption total capacity in fe, (-1 if not connected).

local fe = pei.getCapacity()

The function isConnected() will return true if a contraption is connected.

local connected = pei.isConnected()

The function getMaxInsert() will return the PEI max input in fe.

local fe = accumulator.getMaxInsert()

The function getMaxExtract() will return the PEI max output in fe.

local fe = accumulator.getMaxExtract()

The function getType() will return the PEI peripheral name, which will always be "portable_energy_interface".

print("Peripheral: " .. pei.getType())

Redstone Relay

In the following example, we get the peripheral of a Redstone Relay on the left.

local relay = peripheral.wrap("left")

The function getMaxInsert() will return the Relay max input in fe.

local fe = relay.getMaxInsert()

The function getMaxExtract() will return the Relay max output in fe.

local fe = relay.getMaxExtract()

The function getThroughput() will return the current throughput in fe.

local fe = relay.getThroughput()

The function isPowered() will return the redstone state of the Relay.

local powered = relay.isPowered()

The function getType() will return the Relay peripheral name, which will always be "redstone_relay".

print("Peripheral: " .. relay.getType())

Digital Adapter

In the following example, we get the peripheral of a Digital Adapter on the left.

local da = peripheral.wrap("left")

The function getType() will return the Adapter peripheral name, which will always be "digital_adapter".

print("Peripheral: " .. da.getType())

Rotational Speed Controller

The function setTargetSpeed(side, speed) will set the target speed of a Rotation Speed Controller attached to the side of a Digital Adapter.

da.setTargetSpeed("top", 64)

The function getTargetSpeed(side, speed) will get the target speed of a Rotation Speed Controller attached to the side of a Digital Adapter.

local speed = da.getTargetSpeed("top")

Stressometer

The function getKineticStress(side) will get the stress of a Stressometer attached to the side of a Digital Adapter.

local stress = da.getKineticStress("bottom")

The function getKineticCapacity(side) will get the stress capacity of a Stressometer attached to the side of a Digital Adapter.

local capacity = da.getKineticCapacity("bottom")

Speedometer

The function getKineticSpeed(side) will get the speed of a Speedometer attached to the side of a Digital Adapter.

local speed = da.getKineticSpeed("north")

The function getKineticTopSpeed() will get the top speed as set by Create.

local topSpeed = da.getKineticTopSpeed()

Pulleys

The function getPulleyDistance(side) will get the extended distance of a Rope, Hose, or Elevator -Pulley attached to the side of a Digital Adapter.

local blocks = da.getPulleyDistance("south")

Elevator Pulley

The function getElevatorFloor(side) will get the current floor index of an Elevator Pulley attached to the side of a Digital Adapter.

local floor = da.getElevatorFloor("south")

The function getElevatorFloors(side) will get the number of floors of an Elevator Pulley attached to the side of a Digital Adapter.

local floorCount = da.getElevatorFloors("south")

The function getElevatorFloorName(side, index) will get floor name at floor index of a Elevator Pulley attached to the side of a Digital Adapter.

local floorName = da.getElevatorFloorName("south", 0)

The function gotoElevatorFloor(side, index) will trigger a Elevator Pulley attached to the side of a Digital Adapter to move to the given floor index and returns the delta-y to move.

local floorName = da.gotoElevatorFloor("south", 0)

Mechanical Piston

The function getPistonDistance(side) will get the extended distance of a Mechanical Piston attached to the side of a Digital Adapter.

local blocks = da.getPistonDistance("east")

Mechanical Bearing

The function getBearingAngle(side) will get the angle of a Mechanical Bearing attached to the side of a Digital Adapter.

local degrees = da.getBearingAngle("west")

Display Link

The function print(text) will print a string on the currently selected line to an internal buffer which can be read by a Display Link and put on a Display Board, print will increment the currently selected line.

print("Hello World!")

The function clearLine() will clear the text on the currently selected line.

The function clear() will clear all the text on all lines.

The function getLine() will return the currently selected line (starts at 1).

The function setLine(line) will set the currently selected line to line (starts at 1).

da.print("Text on first line")
da.print("Text on second line")
da.setLine(1)
da.print("Text on first line again")

The function getMaxLines() will return the max number of lines that can be displayable using the Digital Adapter (will always return 16).

Other

The function getDurationDistance(blocks, rpm) will return the time needed to push a Mechanical Piston, Pulley or Gantry a number of blocks at the given rpm.

The function getDurationAngle(degrees, rpm) will return the time needed to rotate a Mechanical Bearing by a number of degrees at the given rpm.