From HBM's Nuclear Tech Wiki
OpenComputers (commonly called OC) is a mod that allows the user to use in-game computers to control/show information about other blocks/machines. NTM has built-in integration with OC, allowing for players to access/control many components of the mod with ease and automation. You will sometimes see this integration referred to as OC-NTM integration/compatibility.
Setup
Connecting a NTM machine/block to an OpenComputers system can be done by using OC cables to connect the OC system directly to the block/machine (without using an adapter).
Getting the values from the components is not as easy as it may seem. Every compatible machine/block from NTM, when connected to an OpenComputers network, will be given a unique component address that can be used to call that block in code. These addresses can be seen by typing components into the OpenOS shell (or whatever shell the OS you are using has). Additionally, you can use an analyzer to see the address by shift-clicking a block/machine, and copy the address by ctrl-shift-clicking it.
Unlocalized Names
NTM returns unlocalized names when getting fluid types through OC, meaning they sometimes will not have the same name as the name shown in-game. A table for finding unlocalized names and IDs for fluids can be found on this page.
Basic Terminology
number: OC uses this term to describe any number value, regardless of decimals.string: A sequence or string of characters.boolean: A true or false value.nil: No value.table: An array of values with the first value being at index 1.list: Similar to a table, however the elements of the list are separated. Ex: a, b, c = foo()
Functions
RBMK
- Component Name:
"rbmk_fuel_rod"
Functions
| Callback |
Return |
Type
|
getHeat()
|
Column heat in °C.
|
number
|
getSkinHeat()
|
Fuel skin heat in °C, or N/A if no rod.
|
number or string
|
getCoreHeat()
|
Fuel core heat in °C, or N/A if no rod.
|
number or string
|
getFluxQuantity()
|
Flux recieved by the rod.
|
number
|
getFluxRatio()
|
Percent of the flux recieved by the rod that is fast.
|
number
|
getDepletion()
|
Fuel enrichment in percentage, or N/A if no rod.
|
number or string
|
getXenonPoison()
|
Fuel xenon poisoning in percentage, or N/A if no rod.
|
number or string
|
getType()
|
Internal name (unlocalized) of the fuel rod, or N/A if no rod.
Example: "rbmk_fuel_hep" = "High Enriched Plutonium-239 RBMK Fuel Rod"
|
string
|
getModerated()
|
If the rod is moderated.
|
boolean
|
getCoordinates()
|
Global position of the column in the world.
Return Values for getCoordinates()
| Index |
Value |
Type
|
1 |
X Coordinate |
number
|
2 |
Y Coordinate |
number
|
3 |
Z Coordinate |
number
|
|
list
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getHeat()
|
2 |
getSkinHeat()
|
3 |
getCoreHeat()
|
4 |
getFluxQuantity()
|
5 |
getFluxRatio()
|
6 |
getDepletion()
|
7 |
getXenonPoison()
|
8 |
getType()
|
9 |
getModerated()
|
10-12 |
getCoordinates()
|
|
list
|
- Component Name:
"rbmk_control_rod"
Functions
| Callback |
Return |
Type
|
getHeat()
|
Column heat in °C.
|
number
|
getLevel()
|
Control rod height in percentage.
|
number
|
getTargetLevel()
|
Control rod target height in percentage.
|
number
|
setLevel(number)
|
Accepts one argument from 0-100% and sets the control rod target to the passed value. Returns true.
|
boolean
|
getColor()
|
Control rod color.
|
number
|
getCoordinates()
|
Global position of the column in the world.
Return Values for getCoordinates()
| Index |
Value |
Type
|
1 |
X Coordinate |
number
|
2 |
Y Coordinate |
number
|
3 |
Z Coordinate |
number
|
|
list
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getHeat()
|
2 |
getLevel()
|
3 |
getTargetLevel()
|
4-6 |
getCoordinates()
|
|
list
|
- Component Name:
"rbmk_boiler"
Functions
| Callback |
Return |
Type
|
getHeat()
|
Column heat in °C.
|
number
|
getSteam()
|
Steam in the column in mB.
|
number
|
getSteamMax()
|
Maximum steam that can be stored in the column in mB.
|
number
|
getWater()
|
Water in the column in mB.
|
number
|
getWaterMax()
|
Maximum water that can be stored in the column in mB.
|
number
|
getSteamType()
|
Steam type in a number.
|
number
|
setSteamType(number)
|
Accepts one argument from 0-3 and sets the steam type to the passed value based on the above table. Returns true.
|
boolean
|
getCoordinates()
|
Global position of the column in the world.
Return Values for getCoordinates()
| Index |
Value |
Type
|
1 |
X Coordinate |
number
|
2 |
Y Coordinate |
number
|
3 |
Z Coordinate |
number
|
|
list
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getHeat()
|
2 |
getSteam()
|
3 |
getSteamMax()
|
4 |
getWater()
|
5 |
getWaterMax()
|
6 |
getSteamType()
|
7-9 |
getCoordinates()
|
|
list
|
- Component Name:
"rbmk_cooler"
Functions
| Callback |
Return |
Type
|
getHeat()
|
Column heat in °C.
|
number
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getCoordinates()
|
Global position of the column in the world.
Return Values for getCoordinates()
| Index |
Value |
Type
|
1 |
X Coordinate |
number
|
2 |
Y Coordinate |
number
|
3 |
Z Coordinate |
number
|
|
list
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getHeat()
|
2-5 |
getCoolant()
|
6-7 |
getCoordinates()
|
|
list
|
- Component Name:
"rbmk_heater"
Functions
| Callback |
Return |
Type
|
getHeat()
|
Column heat in °C.
|
number
|
getFill()
|
Input fluid in the column in mB.
|
number
|
getFillMax()
|
Maximum input fluid that can be stored in the column in mB.
|
number
|
getExport()
|
Output fluid in the column in mB.
|
number
|
getExportMax()
|
Maximum output fluid that can be stored in the column in mB.
|
number
|
getFillType()
|
Type of fluid in the input tank (unlocalized).
Example: "Coolant" = "COOLANT"
|
string
|
getExportType()
|
Type of fluid in the output tank (unlocalized).
Example: "Hot Coolant" = "COOLANT_HOT"
|
string
|
getCoordinates()
|
Global position of the column in the world.
Return Values for getCoordinates()
| Index |
Value |
Tyoe
|
1 |
X Coordinate |
number
|
2 |
Y Coordinate |
number
|
3 |
Z Coordinate |
number
|
|
list
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getHeat()
|
2 |
getFill()
|
3 |
getFillMax()
|
4 |
getExport()
|
5 |
getExportMax()
|
6 |
getFillType()
|
7 |
getExportType()
|
8-10 |
getCoordinates()
|
|
list
|
- Component Name:
"rbmk_outgasser"
Functions
| Callback |
Return |
Type
|
getGas()
|
Gas in the output tank of the column in mB.
|
number
|
getGasMax()
|
Maximum gas in the output tank of the column in mB.
|
number
|
getGasType()
|
Type of gas in the output tank of the column.
Example: "High-Performance Solvent" = "RADIOSOLVENT"
|
string
|
getProgress()
|
Progress of irradiation in the column (out of 10000).
|
number
|
getCoordinates()
|
Global position of the column in the world.
Return Values for getCoordinates()
| Index |
Value |
Type
|
1 |
X Coordinate |
number
|
2 |
Y Coordinate |
number
|
3 |
Z Coordinate |
number
|
|
list
|
getCrafting()
|
Unlocalized item name and stack size in the column. Returns an empty string and a stack size of zero if empty.
Return Values for getCrafting()
| Index |
Value |
Type
|
1 |
Unlocalized Item Name |
string
|
2 |
Item Stack Size |
number
|
|
list
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getGas()
|
2 |
getGasMax()
|
3 |
getGasType()
|
4 |
getProgress()
|
5-7 |
getCoordinates()
|
8-9 |
getCrafting()
|
|
list
|
- Component Name:
"rbmk_console"
Functions
| Callback
|
Return
|
Type
|
getColumnData(x: number, y: number)
|
Accepts two arguments for relative column position, as shown on the console's GUI, with 0,0 being the bottom left.
Return values depend on column type.
General Return Values
| Key
|
Value
|
"type"
|
number
|
"hullTemp"
|
number
|
"realSimWater"
|
number
|
"realSimSteam"
|
number
|
"moderated"
|
boolean
|
"level"
|
number
|
"targetLevel"
|
number
|
"color"
|
number
|
"enrichment"
|
number
|
"xenon"
|
number
|
"coreSkinTemp"
|
number
|
"coreTemp"
|
number
|
"coreMaxTemp"
|
number
|
Fuel Rod Return Values
| Key
|
Value
|
"fluxQuantity"
|
number
|
"fluxRatio"
|
number
|
"rodName"
|
string
|
Boiler Return Values
| Key
|
Value
|
"water"
|
number
|
"steam"
|
number
|
"steamType"
|
string
|
Outgasser Return Values
| Key
|
Value
|
"fluxProgress"
|
number
|
"requiredFlux"
|
number
|
"craftingName"
|
string
|
"craftingNumber"
|
number
|
Heater Return Values
| Key
|
Value
|
"coolant"
|
number
|
"hotcoolant"
|
number
|
"coldtype"
|
number
|
"hottype"
|
number
|
Storage Return Values
| Key
|
Value
|
"slot[x]coreSkinTemp"
|
number
|
"slot[x]coreTemp"
|
number
|
"slot[x]enrichment"
|
number
|
"slot[x]xenon"
|
number
|
"slot[x]rodName"
|
string
|
x is the slot in the storage column. There are 12 slots.
|
table
|
setLevel(number)
|
Sets level for all control rods
|
nil or string
|
setColor(x: number, y: number, color: number)
|
Sets color group for specified column, given relative coordinates
|
nil or string
|
pressAZ5()
|
Starts AZ-5 Sequence
|
nil or string
|
setColorLevel()
|
Sets control rod level for control rods within given color group
|
nil or string
|
setColumnLevel()
|
Sets level of specified control rod, given relative coordinates
|
nil or string
|
getRBMKPos()
|
Returns coordinates of reactor's center column
|
list
|
- Component Name:
"rbmk_crane"
Functions
| Callback |
Return |
Type
|
move(string)
|
Accepts one argument. Returns nil if success, "Crane not found" if failed.
Argument Values for move()
| Value |
Operation
|
"up" |
Moves crane 1/20th of a block upwards.
|
"down" |
Moves crane 1/20th of a block downwards.
|
"left" |
Moves crane 1/20th of a block left.
|
"right" |
Moves crane 1/20th of a block right.
|
|
nil or string
|
load()
|
Load a rod from the fuel rod below into the crane. Returns nil if success, "Crane not found" if failed.
|
nil
|
getRodInfo()
|
Currently loaded rod information. Returns false, "No rod loaded" if there's no loaded rod.
Return Values for getRodInfo()
| Key
|
Value
|
Type
|
coreSkinTemp
|
Hull temperature
|
number
|
coreTemp
|
Core temperature
|
number
|
enrichment
|
Enrichment
|
number
|
xenon
|
Xenon poisoning
|
number
|
rodName
|
Unlocalized item name
|
string
|
|
table or boolean, string
|
getDepletion()
|
Enrichment of the rod inside the crane, "N/A" if no rod.
|
string
|
getXenonPoison()
|
Xenon poisoning of the rod inside the crane, "N/A" if no rod.
|
number
|
getCranePos()
|
Global position of the crane.
Return Values for getCranePos()
| Index |
Value |
Type
|
1 |
X Coordinate |
number
|
2 |
Z Coordinate |
number
|
|
list
|
- Component Name:
"ntm_fusion_torus"
Functions
| Callback |
Return |
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Current power stored in HE.
|
number
|
2
|
Maximum power that can be stored in HE.
|
number
|
|
list
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index
|
Value
|
Type
|
1
|
Fuel tank 1 level.
|
number
|
2
|
Fuel tank 1 max level.
|
number
|
3
|
Fuel tank 1 unlocalized name.
|
string
|
4
|
Fuel tank 2 level.
|
number
|
5
|
Fuel tank 2 max level.
|
number
|
6
|
Fuel tank 2 unlocalized name.
|
string
|
7
|
Fuel tank 3 level.
|
number
|
8
|
Fuel tank 3 max level.
|
number
|
9
|
Fuel tank 3 unlocalized name.
|
string
|
10
|
Output tank level.
|
number
|
11
|
Output tank max level.
|
number
|
12
|
Output tank unlocalized name.
|
string
|
|
list
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getKlystronEnergy()
|
Klystron input energy in KyU/t.
|
number
|
getPlasmaEnergy()
|
Plasma output energy in TU/t.
|
number
|
getFuelConsumption()
|
Fuel consumption in mB/t.
|
number
|
getRecipeProgress()
|
Recipe information.
Return Values for getRecipeProgress()
| Index
|
Value
|
Type
|
1
|
Current recipe progress value.
|
number
|
2
|
Bonus progress value from collectors.
|
number
|
|
list
|
getInfo() |
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
2-14
|
getFluid()
|
15-18
|
getCoolant()
|
19
|
getKlystronEnergy()
|
20
|
getPlasmaEnergy()
|
21
|
getFuelConsumption()
|
22-23
|
getRecipeProgress()
|
|
list
|
- Component Name:
"ntm_fusion_klystron"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Current power stored in HE.
|
number
|
2
|
Maximum power that can be stored in HE.
|
number
|
|
list
|
getAir()
|
Air tank information.
Return Values for getAir()
| Index
|
Value
|
Type
|
1
|
Current compressed air level.
|
number
|
2
|
Max compressed air level.
|
number
|
|
list
|
getOutput()
|
Energy output information.
Return Values for getOutput()
| Index
|
Value
|
Type
|
1
|
Produced output in KyU/t.
|
number
|
2
|
Target output in KyU/t.
|
number
|
|
list
|
setOutput(number)
|
Sets energy output. Capped to 1,000,000.
|
nil
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
3-4
|
getAir()
|
5-6
|
getOutput()
|
|
list
|
- Component Name:
"ntm_fusion_breeder"
Functions
| Callback
|
Return
|
Type
|
getNeutronEnergy()
|
Received neutron energy in flux.
|
number
|
getProgress()
|
Recipe progress.
|
number
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index
|
Value
|
Type
|
1
|
Input fluid level.
|
number
|
2
|
Input fluid max level.
|
number
|
3
|
Input fluid unlocalized name.
|
string
|
4
|
Output fluid level.
|
number
|
5
|
Output fluid max level.
|
number
|
6
|
Output fluid unlocalized name.
|
string
|
|
list
|
getCrafting()
|
Item slots information.
Return Values for getCrafting()
| Index
|
Value
|
Type
|
1
|
Stack size of slot 1
|
number
|
2
|
Unlocalized item name of slot 1
|
string
|
3
|
Stack size of slot 2
|
number
|
4
|
Unlocalized item name of slot 2
|
string
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1
|
getNeutronEnergy()
|
2
|
getProgress()
|
3-8
|
getFluid()
|
9-12
|
getCrafting()
|
|
list
|
- Component Name:
"ntm_fusion_boiler"
Functions
| Callback
|
Return
|
Type
|
getPlasmaEnergy()
|
Received plasma energy in TU.
|
number
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index
|
Value
|
Type
|
1
|
Water level.
|
number
|
2
|
Water max level.
|
number
|
3
|
Super dense steam level.
|
number
|
4
|
Super dense steam max level.
|
number
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1
|
getPlasmaEnergy()
|
2-5
|
getFluid()
|
|
list
|
- Component Name:
"ntm_fusion_mhdt"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Current energy in the buffer. Has no limit.
|
list
|
getPlasmaEnergy()
|
Received plasma energy in TU.
|
number
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1
|
getEnergyInfo()
|
2
|
getPlasmaEnergy()
|
3-6
|
getCoolant()
|
|
list
|
Source
- Component Name:
"ntm_pa_source"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Current power stored in HE.
|
number
|
2
|
Maximum power that can be stored in HE.
|
number
|
|
list
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getMomentum()
|
Current particle momentum.
|
number
|
getState()
|
Unlocalized state of the accelerator.
|
string
|
getCrafting()
|
Item slots information.
Return Values for getCrafting()
| Index
|
Value
|
Type
|
1
|
Input slot 1 unlocalized name.
|
string
|
2
|
Input slot 1 stack size.
|
number
|
3
|
Input slot 2 unlocalized name.
|
string
|
4
|
Input slot 2 stack size.
|
number
|
5
|
Output slot 1 unlocalized name.
|
string
|
6
|
Output slot 1 stack size.
|
number
|
7
|
Output slot 2 unlocalized name.
|
string
|
8
|
Output slot 1 stack size.
|
number
|
|
list
|
cancelOperation()
|
Cancels the current operation.
|
nil
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
3-6
|
getCoolant()
|
7-14
|
getCrafting()
|
15
|
getMomentum()
|
16
|
getState()
|
|
list
|
Dipole Magnets
- Component Name:
"ntm_pa_dipole"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Current power stored in HE.
|
number
|
2
|
Maximum power that can be stored in HE.
|
number
|
|
list
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getDirLower()
|
Direction of the particle if the momentum is under the threshold.
|
string
|
getDirUpper()
|
Direction of the particle if the momentum is above the threshold.
|
string
|
getDirRedstone()
|
Direction of the particle if activated with redstone.
|
string
|
getThreshold()
|
Particle momentum threshold.
|
number
|
setDirLower(string)
|
Sets the direction for the particle to go if the momentum is under the threshold.
Argument Values for setDirLower()
| Allowed Values
|
"north"
|
"east"
|
"south"
|
"west"
|
|
nil
|
setDirUpper(string)
|
Sets the direction for the particle to go if the momentum is above the threshold.
Argument Values for setDirUpper()
| Allowed Values
|
"north"
|
"east"
|
"south"
|
"west"
|
|
nil
|
setDirRedstone(string)
|
Sets the direction for the particle to go if activated with redstone.
Argument Values for setDirRedstone()
| Allowed Values
|
"north"
|
"east"
|
"south"
|
"west"
|
|
nil
|
setThreshold(number)
|
Sets the particle momentum threshold.
|
nil
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
3-6
|
getCoolant()
|
7
|
getDirLower()
|
8
|
getDirUpper()
|
9
|
getDirRedstone()
|
10
|
getThreshold()
|
|
list
|
Quadrupole Magnets
- Component Name:
"ntm_pa_quad"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Current power stored in HE.
|
number
|
2
|
Maximum power that can be stored in HE.
|
number
|
|
list
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
3-6
|
getCoolant()
|
|
list
|
RF Cavity
- Component Name:
"ntm_pa_rfc"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Current power stored in HE.
|
number
|
2
|
Maximum power that can be stored in HE.
|
number
|
|
list
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
3-6
|
getCoolant()
|
|
list
|
Detector
- Component Name:
"ntm_pa_detector"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Current power stored in HE.
|
number
|
2
|
Maximum power that can be stored in HE.
|
number
|
|
list
|
getCoolant()
|
Coolant information.
Return Values for getCoolant()
| Index
|
Value
|
Type
|
1
|
Cold perfluoromethyl level.
|
number
|
2
|
Cold perfluoromethyl max level.
|
number
|
3
|
Perfluoromethyl level.
|
number
|
4
|
Perfluoromethyl max level.
|
number
|
|
list
|
getCrafting()
|
Item slots information.
Return Values for getCrafting()
| Index
|
Value
|
Type
|
1
|
Input slot 1 unlocalized name.
|
string
|
2
|
Input slot 1 stack size.
|
number
|
3
|
Input slot 2 unlocalized name.
|
string
|
4
|
Input slot 2 stack size.
|
number
|
5
|
Output slot 1 unlocalized name.
|
string
|
6
|
Output slot 1 stack size.
|
number
|
7
|
Output slot 2 unlocalized name.
|
string
|
8
|
Output slot 1 stack size.
|
number
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
3-6
|
getCoolant()
|
7-14
|
getCrafting()
|
|
list
|
Miscellaneous Reactors
- Component Name:
"zirnox_reactor"
Functions
| Callback |
Return |
Type
|
getTemp()
|
Reactor heat in (max heat / 800).
|
number
|
getPressure()
|
Reactor pressure in (max pressure / 30).
|
number
|
getWater()
|
Reactor water level in mB.
|
number
|
getSteam()
|
Reactor steam level in mB.
|
number
|
getCarbonDioxide()
|
Reactor carbon dioxide level in mB.
|
number
|
isActive()
|
If reactor is active (rods raised).
|
boolean
|
setActive(boolean)
|
Activates/deactivates the reactor.
|
nil
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getTemp()
|
2 |
getPressure()
|
3 |
getWater()
|
4 |
getSteam()
|
5 |
getCarbonDioxide()
|
6 |
isActive()
|
|
list
|
- Component Name:
"research_reactor"
Functions
| Callback |
Return |
Type
|
getTemp()
|
Reactor heat in °C.
|
number
|
getLevel()
|
Reactor control rod level in percentage.
|
number
|
getTargetLevel()
|
Reactor control rod target in percentage.
|
number
|
getFlux()
|
Reactor flux.
|
number
|
setLevel(number)
|
Accepts one argument 0-100%. Sets the reactor control rod target extraction to the passed value.
|
nil
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getTemp()
|
2 |
getLevel()
|
3 |
getTargetLevel()
|
4 |
getFlux()
|
|
list
|
- Component Name:
"reactor_control"
Functions
| Callback |
Return |
Type
|
isLinked()
|
If the controller is connected to a reactor.
|
boolean
|
getReactor()
|
Linked reactor's values.
Return Values for getReactor()
| Index |
Value |
Type
|
1 |
Reactor rod level in percentage (0 if unlinked). |
number
|
2 |
Reactor flux (0 if unlinked). |
number
|
3 |
Reactor heat * 0.00002 * 980 + 20 (0 if unlinked). |
number
|
|
list
|
getTargetLevel()
|
Reactor control rod target in percentage.
|
number
|
setParams(type: number, maxHeat: number, minHeat: number, levelMax: number, levelMin: number)
|
Accepts five arguments. Sets the automatic control settings for the controller.
Argument Values for setParams()
| Index |
Argument |
Type
|
1 |
New function type.
Function Types
| Value |
Function type
|
0 |
Linear
|
1 |
Quadratic
|
2 |
Logarithmic
|
|
number (0-2)
|
2
|
Maximum heat.
|
number (0-9999)
|
3
|
Minimum heat.
|
number (0-9999)
|
4
|
Level at maximum heat.
|
number (0-100%)
|
5
|
Level at minimum heat.
|
number (0-100%)
|
|
number
|
getParams()
|
Returns the parameters of the automatic control in the format of the above table.
|
list
|
- Component Name:
"breeding_reactor"
Functions
| Callback |
Return |
Type
|
getFlux()
|
Current incoming flux into the reactor.
|
number
|
getProgress()
|
Breeding progress from 0-1.
|
number
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getFlux()
|
2 |
getProgress()
|
|
list
|
- Component Name:
"ntm_pwr_control"
Functions
| Callback |
Return |
Type
|
getHeat()
|
Heat information.
Return Values for getHeat()
| Index |
Value |
Type
|
1 |
Current core heat. |
number
|
2 |
Current hull heat. |
number
|
3
|
Core heat capacity.
|
number
|
4
|
Hull heat capacity.
|
number
|
|
list
|
getFlux()
|
Current flux.
|
number
|
getLevel()
|
Control rods information.
Return Values for getLevel()
| Index |
Value |
Type
|
1 |
Current control rods target. |
number
|
2 |
Current control rods level. |
number
|
|
list
|
getCoolantInfo()
|
Coolant information.
Return Values for getCoolantInfo()
| Index |
Value |
Type
|
1 |
Current cold coolant level. |
number
|
2
|
Max cold coolant level.
|
number
|
3
|
Current hot coolant level.
|
number
|
4 |
Max hot coolant level. |
number
|
|
list
|
getFuelInfo()
|
Fuel information.
Return Values for getFuelInfo()
| Index |
Value |
Type
|
1 |
Amount of fuel rods loaded. |
number
|
2
|
Current depletion progress of fuel.
|
number
|
3
|
Maximum depletion progress of fuel.
|
number
|
|
list
|
setLevel(number)
|
Accepts one argument. Sets control rods target (0-100%). for some reason this is inverted, 5% from this command with result in 95% in the PWR GUI.
|
nil
|
getInfo()
|
Return Values for getInfo()
| Index |
Value
|
1-4 |
getHeat()
|
5
|
getFlux()
|
6-7
|
getLevel()
|
8-10
|
getFuelInfo()
|
11-14
|
getCoolantInfo()
|
|
list
|
- Component Name:
"ntm_icf_reactor"
Functions
| Callback
|
Return
|
Type
|
getHeat()
|
Current heat in TU.
|
number
|
getHeatingRate()
|
Current heating rate in TU.
|
number
|
getMaxHeat()
|
Maximum heat in TU.
|
number
|
getPower()
|
Output power of both lasers in TU.
|
number
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index
|
Value
|
Type
|
1
|
Cold coolant tank level.
|
number
|
2
|
Cold coolant tank max level.
|
number
|
3
|
Cold coolant tank unlocalized name.
|
string
|
4
|
Hot coolant tank level.
|
number
|
5
|
Hot coolant tank max level.
|
number
|
6
|
Hot coolant tank unlocalized name.
|
string
|
7
|
Stellar flux tank level.
|
number
|
8
|
Stellar flux tank max level.
|
number
|
|
list
|
getPelletStats()
|
Pellet information.
Return Values for getPelletStats()
| Index
|
Value
|
Type
|
1
|
Current depletion.
|
number
|
2
|
Maximum depletion.
|
number
|
3
|
Heat required.
|
number
|
4
|
First fuel name.
|
string
|
5
|
Second fuel name.
|
string
|
|
list
|
DFC Components
- Component Name:
"dfc_emitter"
Functions
| Callback |
Return |
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index |
Value |
Type
|
1 |
Current power stored in HE. |
number
|
2 |
Maximum power that can be stored in HE. |
number
|
|
list
|
getCryogel()
|
Current cryogel level in the emitter in mB.
|
number
|
getInput()
|
Emitter output in percentage.
|
number
|
isActive()
|
If the emitter is active.
|
boolean
|
setActive(boolean)
|
Accepts one argument. Activates/deactivates the reactor based on the passed value.
|
nil
|
setInput(number)
|
Accepts one argument. Sets the emitter power to the passed value (0-100%).
|
nil
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1-2 |
getEnergyInfo()
|
3 |
getCryogel()
|
4 |
getInput()
|
5 |
isActive()
|
|
list
|
- Component Name:
"dfc_stabilizer"
Functions
| Callback |
Return |
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index |
Value |
Type
|
1 |
Current power stored in HE. |
number
|
2 |
Maximum power that can be stored in HE. |
number
|
|
list
|
getInput()
|
Stabilizer output in percentage.
|
number
|
getDurability()
|
Durability of the lens, returns "N/A" if no lens.
|
number
|
setInput()
|
Accepts one argument. Sets the stabilizer output to the passed value (0-100%).
|
nil
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1-2 |
getEnergyInfo()
|
3 |
getInput()
|
4 |
getDurability()
|
|
list
|
- Component Name:
"dfc_injector"
Functions
| Callback |
Return |
Type
|
getFirstFuel()
|
Current amount of fuel in the first tank in mB.
|
number
|
getSecondFuel()
|
Current amount of fuel in the second tank in mB.
|
number
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getFirstFuel()
|
2 |
getSecondFuel()
|
|
list
|
- Component Name:
"dfc_receiver"
Functions
| Callback |
Return |
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index |
Value |
Type
|
1 |
Current power stored in HE. |
number
|
2 |
Maximum power stored in HE. |
number
|
|
list
|
getCryogel()
|
Amount of cryogel in the receiver's tank.
|
number
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1-2 |
getEnergyInfo()
|
3 |
getCryogel()
|
|
list
|
Fluid
Functions
| Callback |
Return |
Type
|
getFluidStored()
|
Current amount of fluid stored inside the tank in mB.
|
number
|
getMaxStored()
|
Maximum amount of fluid that can be stored inside the tank in mB.
|
number
|
getTypeStored()
|
Type of fluid in the tank (unlocalized).
Example: "Reformate Gas" = "REFORMGAS"
|
string
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getFluidStored()
|
2 |
getMaxFluidStored()
|
3 |
getTypeStored()
|
|
list
|
Fluid Duct Gauge
- Component Name:
"ntm_fluid_gauge"
Functions
| Callback |
Return |
Type
|
getTransfer()
|
Amount of fluid being transferred through the network in mB/t and mB/s.
Return Values for getTransfer()
| Index |
Value |
Type
|
1 |
Transfer rate in mB/t. |
number
|
2 |
Transfer rate in mB/s. |
number
|
|
list
|
getFluid()
|
Type of fluid in the network (unlocalized).
Example: "Desulfurized Crude Oil" = "OIL_DS"
|
string
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1-2 |
getTransfer()
|
3 |
getFluid()
|
|
list
|
Fluid Valve with Counter
- Component Name:
"ntm_fluid_counter_valve"
Functions
| Callback
|
Return
|
Type
|
getFluid()
|
Type of fluid in the network (unlocalized).
Example: "Desulfurized Crude Oil" = "OIL_DS"
|
string
|
getCounter()
|
Current value in the counter.
|
number
|
getState()
|
Whenever the valve is open or closed.
|
boolean
|
setState(number)
|
Opens or closes the valve. Returns a bad argument error if invalid.
|
nil
|
Flow Control Pump
- Component Name:
"ntm_fluid_pump"
Functions
| Callback
|
Return
|
Type
|
getFluid()
|
Unlocalized fluid type name.
|
string
|
getPressure()
|
Fluid pressure.
|
number
|
getFlow()
|
Fluid flow.
|
number
|
setFlow()
|
Sets fluid flow. Accepts number. Range: 0-10000. Returns nil and string if outside of range.
|
boolean or nil, string
|
getPriority()
|
Fluid priority.
|
string
|
setPriority()
|
Sets fluid priority. Accepts number. Returns nil and string if invalid.
Argument Values for setPriority()
| Index
|
Value
|
0
|
LOWEST
|
1
|
LOW
|
2
|
NORMAL
|
3
|
HIGH
|
4
|
HIGHEST
|
|
boolean or nil, string
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1
|
getFluid()
|
2
|
getPressure()
|
3
|
getFlow()
|
4
|
getPriority()
|
|
list
|
Energy
Battery Socket
- Component Name:
"ntm_energy_storage"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index |
Value |
Type
|
1 |
Current power stored in HE. |
number
|
2 |
Maximum power stored in HE. |
number
|
3
|
Power delta in HE/s.
|
number
|
|
list
|
getPackInfo()
|
Currently inserted battery information.
Return Values for getPackInfo()
| Index
|
Value
|
Type
|
1
|
Unlocalized item name.
|
string
|
2
|
Charge rate in HE/t.
|
number
|
3
|
Discharge rate in HE/t.
|
number
|
|
list
|
getModeInfo()
|
Output modes and charge priority.
Return Values for getModeInfo()
| Index
|
Value
|
Type
|
1
|
No redstone signal mode.
|
number
|
2
|
Redstone signal mode.
|
number
|
3
|
Charge priority.
|
number
|
Mode Values
| Value
|
Mode
|
0
|
Input
|
1
|
Buffer
|
2
|
Output
|
Charge Priority Values
| Value
|
Priority
|
0
|
Low
|
1
|
Normal
|
2
|
High
|
|
list
|
setModeLow(number)
|
Changes no redstone signal mode. Returns "Invalid mode" if provided mode is invalid.
|
nil or string
|
setModeHigh(number)
|
Changes redstone signal mode. Returns "Invalid mode" if provided mode is invalid.
|
nil or string
|
setPriority(number)
|
Changes charge priority. Returns "Invalid mode" if provided priority is invalid.
|
nil or string
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-3
|
getEnergyInfo()
|
4-6
|
getModeInfo()
|
7-9
|
getPackInfo()
|
|
list
|
FEnSU
- Extends
"ntm_energy_storage" API
- Component Name:
"ntm_energy_storage"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index |
Value |
Type
|
1 |
Current power stored in HE. |
number
|
2
|
Power delta in HE/s.
|
number
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getEnergyInfo()
|
3-5
|
getModeInfo()
|
|
list
|
- Component Name:
"ntm_energy_storage_legacy"
Functions
| Callback |
Return |
Type
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index |
Value |
Type
|
1 |
Current power stored in HE. |
number
|
2 |
Maximum power stored in HE. |
number
|
|
list
|
getInfo() |
This function is for compatibility between components; output is equal to getEnergyInfo().
Return Values for getInfo()
| Index |
Value
|
1-2 |
getEnergyInfo()
|
|
list
|
Power Gauge
- Component Name:
"ntm_power_gauge"
Functions
| Callback
|
Return
|
Type
|
getTransfer()
|
Amount of energy being transferred to the network in HE/t and HE/s.
Return Values for getTransfer()
| Index
|
Value
|
Type
|
1
|
Transfer rate in HE/t
|
number
|
2
|
Energy transfer rate in HE/s
|
number
|
|
list
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
Type
|
1-2
|
getTransfer()
|
|
3
|
X coordinate.
|
number
|
4
|
Y coordinate.
|
number
|
5
|
Z coordinate.
|
number
|
|
list
|
- Component Name:
"capacitor"
Functions
| Callback
|
Return
|
Type
|
getEnergy()
|
Stored energy.
|
number
|
getMaxEnergy()
|
Maximum energy.
|
number
|
getEnergySent()
|
Sent energy.
|
number
|
getEnergyReceived()
|
Received energy.
|
number
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1
|
getEnergy()
|
2
|
getMaxEnergy()
|
3
|
getEnergySent()
|
4
|
getEnergyReceived()
|
|
list
|
Generation
- Applies to all turbines.
- Component Name:
"ntm_turbine"
Functions
| Callback |
Return |
Type
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index |
Value |
Type
|
1 |
Current steam in the input tank in mB. |
number
|
2 |
Maximum amount of steam that can be stored in the input tank in mB. |
number
|
3 |
Current amount of low-pressure steam in the output tank in mB. |
number
|
4 |
Maximum amount of low-pressure steam that can be stored in the output tank in mB. |
number
|
|
list
|
getType()
|
Steam type in a number.
|
number
|
getPower()
|
Steam turbine power output.
|
number
|
getFlywheel()
|
Steam turbine's current speed percentage. Currently only applies to the new industrial steam turbine.
|
number
|
setType(number)
|
Accepts one argument. Sets the steam type of the turbine based on the passed argument and the above table. Currently doesn't apply to the new industrial steam turbine.
|
nil
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1-4 |
getFluid()
|
5 |
getType()
|
6
|
getPower()
|
7
|
getFlywheel()
|
|
list
|
- Component Name:
"ntm_gas_turbine"
Functions
| Callback |
Return |
Type
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index |
Value |
Type
|
1 |
Current amount of gas in the fuel tank in mB. |
number
|
2 |
Maximum amount of gas that can be stored in the fuel tank in mB. |
number
|
3 |
Current amount of engine lubricant in mB. |
number
|
4 |
Maximum amount of engine lubricant that can be stored in mB. |
number
|
5 |
Current amount of water in the tank in mB. |
number
|
6 |
Maximum amount of water that can be stored in the tank in mB. |
number
|
7 |
Current amount of steam in the tank in mB. |
number
|
8 |
Maximum amount of steam that can be stored in the tank in mB. |
number
|
|
list
|
getType()
|
Type of gas in the turbine (unlocalized).
Example: "Reformate Gas" = "REFORMGAS"
|
string
|
getPower()
|
Current power stored in HE.
|
number
|
getThrottle()
|
Current turbine throttle (0-100%).
|
number
|
getState()
|
Current turbine state.
Turbine States
| Value |
State
|
0 |
Turbine is shut down.
|
-1 |
Turbine is currently starting up.
|
1 |
Turbine is online and running.
|
|
number
|
getAuto()
|
If the turbine's automatic mode is enabled.
|
boolean
|
setThrottle(number)
|
Accepts one argument from 0-100% and sets the turbine throttle to the passed value.
|
nil
|
setAuto(boolean)
|
Accepts one argument (true/false) and enables/disables the turbine automatic mode based on the passed value.
|
nil
|
start()
|
Starts the turbine (if possible).
|
nil
|
stop()
|
Stops the turbine.
|
nil
|
getInfo() |
Return Values for getInfo()
| Index |
Value
|
1 |
getThrottle()
|
2 |
getState()
|
3-10 |
getFluid()
|
|
list
|
- Component Name:
"ntm_combustion_engine"
Functions
| Callback
|
Return
|
Type
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index
|
Value
|
Type
|
1
|
Tank level.
|
number
|
2
|
Tank max level.
|
number
|
|
list
|
getType()
|
Unlocalized fluid type name.
|
string
|
getPower()
|
Stored energy. Max energy is 2,500,000.
|
number
|
getState()
|
Whenever the engine is running or not.
|
boolean
|
getEfficiency()
|
Combustion efficiency of the fuel.
|
number
|
getThrottle()
|
Current throttle.
|
number
|
setThrottle(number)
|
Sets throttle. Allowed range: 0-30. Returns a boolean and a string if outside of range.
|
nil or boolean, string
|
start()
|
Starts the engine.
|
nil
|
stop()
|
Stops the engine.
|
nil
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1
|
getThrottle()
|
2
|
getState()
|
3
|
getPower()
|
4
|
getEfficiency()
|
5-6
|
getFluid()
|
7
|
getType()
|
|
list
|
Turrets
Base Turret
- Applies to all turrets.
- Component Name:
"ntm_turret"
Functions
| Callback
|
Return
|
Type
|
setActive(boolean)
|
Turns the turret on or off
|
nil
|
isActive()
|
Gets whether the turret is on or off
|
boolean
|
getEnergyInfo()
|
Return Values
| Index
|
Value
|
Type
|
1
|
Stored Energy
|
number
|
2
|
Max Energy
|
number
|
|
list
|
getWhitelisted()
|
Returns a table of authorized user names
|
table
|
addWhitelist(string)
|
Attempts to add a user to the whitelist. Returns true on success, false if the user is already in the list.
|
boolean
|
removeWhitelist(string)
|
Attempts to remove a user from the whitelist. Returns true on success, false if user not in list.
|
boolean
|
setTargeting(players: boolean, animals: boolean, mobs: boolean, machines: boolean)
|
Sets whether or not to target players, animals, mobs, and machines. Arguments are ordered in respect to the list.
|
nil
|
getTargeting()
|
Return Values for getTargeting()
| Index
|
Value
|
Type
|
1
|
Target Players
|
boolean
|
2
|
Target Animals
|
boolean
|
3
|
Target Mobs
|
boolean
|
4
|
Target Machines
|
boolean
|
|
list
|
hasTarget()
|
Returns true if turret is tracking a target, otherwise returns false
|
boolean
|
getAngle()
|
Return Values for getAngle()
| Index
|
Value
|
Type
|
1
|
Pitch
|
number
|
2
|
Yaw
|
number
|
|
list
|
isAligned()
|
Returns true if the turret is aligned with the target, otherwise returns false
|
boolean
|
getPos()
|
Return Values for getPos()
| Index
|
Value
|
Type
|
1
|
X Coordinate
|
number
|
2
|
Y Coordinate
|
number
|
3
|
Z Coordinate
|
number
|
|
list
|
Artillery
- Extends
"ntm_turret" API
- Applies to both rocket and cannon artillery
- Component Name:
"ntm_artillery"
Functions
| Callback
|
Return
|
Type
|
getCurrentTarget()
|
Return Values for getCurrentTarget()
| Index
|
Value
|
Type
|
1
|
Target X Coordinate
|
number
|
2
|
Target Y Coordinate
|
number
|
3
|
Target Z Coordinate
|
number
|
|
list
|
getTargetDistance()
|
Returns direct distance to target
|
number
|
Rocket Artillery
- Extends
"ntm_artillery" API
Functions
| Callback
|
Return
|
Type
|
addCoords(x: number, y: number, z: number)
|
Argument Values for addCoords()
| Index
|
Value
|
Type
|
1
|
Target X Coordinate
|
number
|
2
|
Target Y Coordinate
|
number
|
3
|
Target Z Coordinate
|
number
|
|
nil
|
Cannon Artillery
- Extends
"ntm_artillery" API
Functions
| Callback
|
Return
|
Type
|
addCoords(x: number, y: number, z: number)
|
Argument Values for addCoords()
| Index
|
Value
|
Type
|
1
|
Target X Coordinate
|
number
|
2
|
Target Y Coordinate
|
number
|
3
|
Target Z Coordinate
|
number
|
Returns true if target is in range, returns false if target out of range
|
boolean
|
Launch Pads
Large Launch Pad
- Used for launching custom missiles
- Component Name:
"ntm_custom_launch_pad"
Functions
| Callback
|
Return
|
Type
|
getLaunchInfo()
|
Return Values for getLaunchInfo()
| Index
|
Value
|
Type
|
1
|
Can launch
|
boolean
|
2
|
Is missile valid
|
boolean
|
3
|
Has designator
|
boolean
|
4
|
Has fuel
|
boolean
|
|
list
|
getCoords()
|
Return Values for getCoords()
| Index
|
Value
|
Type
|
1
|
Target X Coordinate
|
number
|
2
|
Target Z Coordinate
|
number
|
Returns the above list if there is a designator with set coordinates, returns false if no coordinates are set or designator is missing.
|
list or boolean
|
setCoords(x: number, y: number)
|
Argument Values for setCoords()
| Index
|
Value
|
Type
|
1
|
Target X Coordinate
|
number
|
2
|
Target Z Coordinate
|
number
|
Returns true on success, returns false if designator is missing.
|
boolean
|
launch()
|
Returns true on success, otherwise returns false.
|
boolean
|
Generic Missile Launch Pads
- Includes "Launch Pad" and "Silo Launch Pad"
- Used for launching generic missiles
- Component Name:
"ntm_launch_pad"
Functions
| Callback
|
Return
|
Type
|
getFluid()
|
Return Values for getFluid()
| Index
|
Value
|
Type
|
1
|
Amount of fluid in first tank
|
number
|
2
|
Max amount of fluid in first tank
|
number
|
3
|
Unlocalized name of fluid in first tank
|
string
|
4
|
Amount of fluid in second tank
|
number
|
5
|
Max amount of fluid in second tank
|
number
|
6
|
Unlocalized name of fluid in second tank
|
string
|
|
list
|
getEnergyInfo()
|
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Stored Energy
|
number
|
2
|
Max Energy
|
number
|
|
list
|
canLaunch()
|
Returns false if missile is not valid, missile has no fuel, or any other conditions exist preventing launch.
|
boolean
|
getTier()
|
Returns the missile tier.
|
number
|
launch()
|
Argument Values for launch()
| Index
|
Value
|
Type
|
1
|
Target X Coordinate
|
number
|
2
|
Target Z Coordinate
|
number
|
Return Values for launch()
| Index
|
Value
|
Type
|
1
|
Target X Coordinate
|
number
|
2
|
Target Z Coordinate
|
number
|
Returns the above list on success, returns false if missile is not valid, missile has no fuel, or any other conditions exist preventing launch.
|
list or boolean
|
Transmitter & Receiver
- Component Name:
"radio_torch"
Functions
| Callback
|
Return
|
Type
|
setChannel(string)
|
Sets the torch's channel.
|
nil
|
setPolling(boolean)
|
Sets the state change mode.
|
nil
|
setCustomMap(boolean)
|
Redstone passthrough or custom mapping.
|
nil
|
setCustomMapValues(map: table)
|
Sets the custom mapping values. Accepts a table of 16 values.
Table Example
| Key
|
Value
|
1
|
id1
|
8
|
id2
|
16
|
id3
|
|
nil
|
Gauge
- Component Name:
"rbmk_gauge"
Functions
| Callback
|
Return
|
Type
|
getGaugeInfo(number)
|
Returns a table containing gauge information of the input index.
Return Values for getGaugeInfo()
| Key
|
Value
|
Type
|
"active"
|
Gauge visibility
|
boolean
|
"polling"
|
RoR polling
|
boolean
|
"color"
|
Gauge hex color
|
number
|
"label"
|
Gauge label
|
string
|
"channel"
|
RoR channel
|
string
|
"min"
|
Minimum value
|
number
|
"max"
|
Maximum value
|
number
|
"value"
|
Current value
|
number
|
|
table
|
setGaugeActive(gauge: number, active: boolean)
|
Sets gauge visibility.
|
boolean
|
setGaugePolling(gauge: number, polling: boolean)
|
Sets gauge polling.
|
boolean
|
setGaugeColor(gauge: number, color: number)
|
Sets gauge color. Must be a hex color.
|
boolean
|
setGaugeLabel(gauge: number, label: string)
|
Sets gauge label.
|
boolean
|
setGaugeChannel(gauge: number, channel: string)
|
Sets gauge channel.
|
boolean
|
setGaugeMin(gauge: number, min: number)
|
Sets gauge minimum value.
|
boolean
|
setGaugeMax(gauge: number, max: number)
|
Sets gauge maximum value.
|
boolean
|
setGaugeValue(gauge: number, value: number)
|
Sets gauge value.
|
boolean
|
Graph
- Component Name:
"rbmk_graph"
Functions
| Callback
|
Return
|
Type
|
getGraphInfo(number)
|
Returns a table containing graph information of the input index.
Return Values for getGraphInfo()
| Key
|
Value
|
Type
|
"active"
|
Graph visibility
|
boolean
|
"polling"
|
RoR polling
|
boolean
|
"label"
|
Graph label
|
string
|
"channel"
|
RoR channel
|
string
|
"values"
|
Graph values
|
number[20]
|
|
table
|
getGraphMin(number)
|
Gets the graph's minimum value.
|
number
|
getGraphMax(number)
|
Gets the graph's maximum value.
|
number
|
getGraphAvg(number)
|
Gets the graph's average value.
|
number
|
setGraphActive(graph: number, active: boolean)
|
Sets graph visibility.
|
number
|
setGraphPolling(graph: number, polling: boolean)
|
Sets graph polling.
|
number
|
setGraphLabel(graph: number, label: string)
|
Sets graph label.
|
number
|
setGraphChannel(graph: number, channel: string)
|
Sets graph channel.
|
number
|
pushGraphValue(graph: number, value: number)
|
Pushes a value to the graph.
|
number
|
Keypad
- Component Name:
"rbmk_keypad"
Functions
| Callback
|
Return
|
Type
|
getKeyInfo(number)
|
Returns a table containing key information of the input index.
Return Values for getKeyInfo()
| Key
|
Value
|
Type
|
"active"
|
Key visibility
|
boolean
|
"polling"
|
RoR polling
|
boolean
|
"pressed"
|
Key state
|
boolean
|
"color"
|
Key hex color
|
number
|
"label"
|
Key label
|
string
|
"channel"
|
RoR channel
|
string
|
"command"
|
RoR command when key is pressed
|
string
|
|
table
|
setKeyActive(key: number, active: boolean)
|
Sets key visibility.
|
boolean
|
setKeyPolling(key: number, polling: boolean)
|
Sets key polling.
|
boolean
|
setKeyColor(key: number, color: number)
|
Sets key color. Must be a hex color.
|
boolean
|
setKeyLabel(key: number, label: string)
|
Sets key label.
|
boolean
|
setKeyChannel(key: number, channel: string)
|
Sets key channel.
|
boolean
|
setKeyCommand(key: number, command: string)
|
Sets key command.
|
boolean
|
pressKey(key: number)
|
Toggles a key.
|
boolean
|
getKeyPressed(key: number)
|
Gets key state.
|
boolean
|
Numeric Display
- Component Name:
"rbmk_numitron"
Functions
| Callback
|
Return
|
Type
|
getDisplayInfo(number)
|
Returns a table containing display information of the input index.
Return Values for getDisplayInfo()
| Key
|
Value
|
Type
|
"active"
|
Display visibility
|
boolean
|
"polling"
|
RoR polling
|
boolean
|
"label"
|
Display level
|
string
|
"channel"
|
RoR channel
|
string
|
"value"
|
Current value
|
number
|
"shorten_number"
|
Shortens the number (e.g. 1000 becomes 1.0k)
|
boolean
|
"leading_zeroes"
|
Adds leading zeroes (e.g. 1 becomes 0000001)
|
boolean
|
|
table
|
setDisplayActive(display: number, active: boolean)
|
Sets display visibility.
|
boolean
|
setDisplayPolling(display: number, polling: boolean)
|
Sets display polling.
|
boolean
|
setDisplayLabel(display: number, label: string)
|
Sets display label.
|
boolean
|
setDisplayChannel(display: number, channel: string)
|
Sets display channel.
|
boolean
|
setDisplayValue(display: number, value: number)
|
Sets display value.
|
boolean
|
setDisplayLeadingZeroes(display: number, showLeadingZeroes: boolean)
|
Adds leading zeroes if enabled. (e.g. 1 becomes 0000001)
|
boolean
|
setDisplayActiveDigits(display: number, bitmask: number)
|
Makes certain digits active. This is a 7-bit bitmask, with a maximum value of 127. For example, 0b01111111 would make all 7 digits visible, while 0b01000001 will make only the 1st and 7th digit visible.
|
boolean
|
setDisplayShortenNumber(display: number, shortenNumber: boolean)
|
Shortens the number if enabled. (e.g. 1000 becomes 1.0k)
|
boolean
|
Indicator Lights
- Component Name:
"rbmk_indicator"
Functions
| Callback
|
Return
|
Type
|
getIndicatorInfo(number)
|
Returns a table containing indicator information of the input index.
Return Values for getIndicatorInfo()
| Key
|
Value
|
Type
|
"active"
|
Indicator visibility
|
boolean
|
"polling"
|
RoR polling
|
boolean
|
"light"
|
Indicator state
|
boolean
|
"color"
|
Indicator hex color
|
number
|
"label"
|
Indicator label
|
string
|
"channel"
|
RoR channel
|
string
|
"min"
|
Minimum value
|
number
|
"max"
|
Maximum value
|
number
|
|
table
|
setIndicatorActive(indicator: number, active: boolean)
|
Sets indicator visibility.
|
boolean
|
setIndicatorLight(indicator: number, state: boolean)
|
Sets indicator state.
|
boolean
|
setIndicatorColor(indicator: number, color: number)
|
Sets indicator color. Must be a hex color.
|
boolean
|
setIndicatorLabel(indicator: number, label: string)
|
Sets indicator label.
|
boolean
|
setIndicatorBounds(indicator: number, min: number, max: number)
|
Sets indicator bounds.
|
boolean
|
Lever
- Component Name:
"rbmk_lever"
Functions
| Callback
|
Return
|
Type
|
getLeverInfo(number)
|
Returns a table containing lever information of the input index.
Return Values for getLeverInfo()
| Key
|
Value
|
Type
|
"active"
|
Lever visibility
|
boolean
|
"polling"
|
RoR polling
|
boolean
|
"state"
|
Lever state
|
boolean
|
"progress"
|
Lever animation progress
|
number
|
"label"
|
Lever label
|
string
|
"channel"
|
RoR channel
|
string
|
"commandOn"
|
RoR command when state is set to true
|
string
|
"commandOff"
|
RoR command when state is set to false
|
string
|
|
table
|
setLeverActive(lever: number, active: boolean)
|
Sets lever visibility.
|
boolean
|
setLeverLabel(lever: number, label: string)
|
Sets lever label.
|
boolean
|
Miscellaneous
- Component Name:
"ntm_radar"
Functions
| Callback |
Return |
Type
|
getSettings()
|
Returns the current scanning settings for the radar.
Return Values for getSettings()
| Index |
Value |
Type
|
1 |
If the radar is scanning for missiles. |
boolean
|
2 |
If the radar is scanning for artillery shells. |
boolean
|
3 |
If the radar is scanning for players. |
boolean
|
4 |
If the radar is scanning for missiles that have an upwards Y trajectory (Smart Mode). |
boolean
|
|
list
|
setSettings(scan: boolean, artScan: boolean, plrScan: boolean, smart: boolean)
|
Sets the scanning settings for the radar.
Argument Values for setSettings()
| Index |
Argument |
Type
|
1
|
Missile scan mode.
|
boolean
|
2
|
Artillery shell scan mode.
|
boolean
|
3
|
Player scan mode.
|
boolean
|
4
|
Smart mode.
|
boolean
|
|
number
|
getRange(number)
|
Gets the range of the current type of radar. This can either be 1,000 for the normal radar, or 3,000 for the large radar.
|
number
|
getEnergyInfo()
|
Energy information.
Return Values for getEnergyInfo()
| Index |
Value |
Type
|
1 |
Current power stored in HE. |
number
|
2 |
Maximum power stored in HE. |
number
|
|
list
|
isJammed()
|
If the radar is currently jammed by digamma radiation.
|
boolean
|
getAmount()
|
Part of the foundation for radar compatibility. Returns the amount of entities detected by the radar (missiles, players, shells, etc.).
|
number
|
isIndexPlayer(number)
|
Part of the indexing system for radar compatibility. Accepts a number as an index, finds the entity at that index, and then returns true if it is a player, false otherwise. Will return {nil, "No entity exists at that index."} if the index is out-of-bounds.
|
boolean
|
getIndexType(number)
|
Part of the indexing system for radar compatibility. Accepts a number as an index, finds the entity at that index, and then returns the "blip level" of the entity. {nil, "No entity exists at that index."} if the index is out-of-bounds.
Radar Blip Level
| Value |
Entity Type
|
0 |
Tier 0 Missile (Micro Missile Assemblies).
|
1 |
Tier 1 Missile.
|
2 |
Tier 2 Missile.
|
3 |
Tier 3 Missile.
|
4 |
Tier 4 Missile (Nuclear/Doomsday).
|
5 |
Size 10 Custom Missiles.
|
6 |
Size 10/15 Custom Missiles.
|
7 |
Size 15 Custom Missiles.
|
8 |
Size 15/20 Custom Missiles.
|
9 |
Size 20 Custom Missiles.
|
10 |
AB (Anti-Ballistic) Missiles.
|
11 |
Player.
|
12 |
Artillery Shells.
|
|
number
|
getEntityAtIndex(number)
|
Part of the indexing system for radar compatibility. Accepts a number as an index, finds the entity at that index, then returns information on the entity. Will return {nil, "No entity exists at that index."} if the index is out-of-bounds.
Return Values for getEntityAtIndex()
| Index |
Value |
Type
|
1 |
If the entity selected is a player. |
boolean
|
2 |
X-Position of the entity. |
number
|
3 |
Y-Position of the entity. |
number
|
4 |
Z-Position of the entity. |
number
|
5 |
"Blip Level" of the entity. |
number
|
6 |
Name of the entity (only applies to when a player is detected). |
string
|
|
list
|
getPos()
|
Returns a list containing the coordinates of the radar
Return Values for getPos()
| Index |
Value |
Type
|
1 |
X-Position of the radar |
number
|
2 |
Y-Position of the entity. |
number
|
3 |
Z-Position of the entity. |
number
|
|
list
|
Telex
- Component Name:
"ntm_telex"
Functions
| Callback
|
Return
|
Type
|
getChannels()
|
Return Values for getChannels()
| Index
|
Value
|
Type
|
1
|
Receiving Channel
|
string
|
2
|
Sending Channel
|
string
|
|
list
|
setChannels(recv: string, send: string)
|
Argument Values for setChannels()
| Index
|
Value
|
Type
|
1
|
New Receiving Channel
|
string
|
2
|
New Sending Channel
|
string
|
Return Values for setChannels()
| Index
|
Value
|
Type
|
1
|
Previous Receiving Channel
|
string
|
2
|
Previous Sending Channel
|
string
|
|
list
|
getSendingTexts()
|
Return Values for getSendingTexts()
| Index
|
Value
|
Type
|
1
|
Row 1 text
|
string
|
2
|
Row 2 text
|
string
|
3
|
Row 3 text
|
string
|
4
|
Row 4 text
|
string
|
5
|
Row 5 text
|
string
|
|
list
|
getReceivingText()
|
Return Values for getReceivingText()
| Index
|
Value
|
Type
|
1
|
Row 1 text
|
string
|
2
|
Row 2 text
|
string
|
3
|
Row 3 text
|
string
|
4
|
Row 4 text
|
string
|
5
|
Row 5 text
|
string
|
|
list
|
setSendingText(r1: string, r2: string, r3: string, r4: string, r5: string)
|
Argument Values for setSendingText()
| Index
|
Value
|
Type
|
1
|
Row 1 text
|
string
|
2
|
Row 2 text
|
string
|
3
|
Row 3 text
|
string
|
4
|
Row 4 text
|
string
|
5
|
Row 5 text
|
string
|
|
boolean
|
printMessage()
|
Prints the last received message
|
nil
|
clearAll()
|
Clear receiving buffer
|
nil
|
sendMessage()
|
Sends the message that is in the buffer
|
boolean
|
- Component Name:
"ntm_geiger"
Functions
| Callback
|
Return
|
Type
|
getRads()
|
Gets the current radiation level.
|
number
|
- Component Name:
"ntm_coker"
Functions
| Callback
|
Return
|
Type
|
getTypeStored()
|
Fluid type of the tanks.
Return Values for getTypeStored()
| Index
|
Value
|
Type
|
1
|
Tank 1 fluid type.
|
number
|
2
|
Tank 2 fluid type.
|
number
|
|
list
|
getFluidStored()
|
Fill level of the tanks.
Return Values for getFluidStored()
| Index
|
Value
|
Type
|
1
|
Tank 1 fill level.
|
number
|
2
|
Tank 2 fill level.
|
number
|
|
list
|
getHeat()
|
Current heat in TU.
|
number
|
getInfo()
|
Return Values for getInfo()
| Index
|
Value
|
1-2
|
getTypeStored()
|
3-4
|
getFluidStored()
|
5
|
getHeat()
|
|
list
|
Air Vent
- Component Name:
"ntm_atmospheric_vent"
Functions
| Callback
|
Return
|
Type
|
getAtmosphereDetails()
|
Fluids currently in the blob's atmosphere.
Return Values for getAtmosphereDetails()
| Index
|
Value
|
Type
|
1
|
Unlocalized fluid name
|
string
|
2
|
Fluid pressure
|
number
|
| and more fluids if there are any remaining...
|
|
list
|
getFluid()
|
Fluid information.
Return Values for getFluid()
| Index
|
Value
|
Type
|
1
|
Oxygen fill level.
|
number
|
2
|
Oxygen max fill level.
|
number
|
|
list
|
isSealed()
|
Blob sealing status.
|
boolean
|
Stardar
- Component Name:
"ntm_stardar"
Functions
| Callback
|
Return
|
Type
|
getPlanetStats(string)
|
Planet stats. Returns nil, "No body with that name found." if the specified planet doesn't exist.
Return Values for getPlanetStats()
| Index
|
Value
|
Type
|
1
|
Planet name
|
string
|
2
|
Parent planet name
|
string
|
3
|
Star name
|
string
|
4
|
Tidally locked to planet, nil if not locked
|
string
|
5
|
Axial tilt (deg)
|
number
|
6
|
Landable
|
boolean
|
7
|
Planet mass (kg)
|
number
|
8
|
Processing level required
|
number
|
9
|
Radius (km)
|
number
|
10
|
Semi-major axis (km)
|
number
|
11
|
Sun power (percentage)
|
number
|
12
|
Surface gravity (m/s²)
|
number
|
13
|
Rotational period (ticks)
|
number
|
14
|
Orbital period (days)
|
number
|
|
list or nil
|
getCurrentPlanet()
|
Unlocalized name of current planet the Stardar is on
|
string
|
getSatellites(string)
|
Satellites of specified planet. Returns nil, "No body with that name found." if the specified planet doesn't exist. table.pack can be used to turn the list into a table.
Return Values for getSatellites()
| Index
|
Value
|
Type
|
1
|
Satellite name
|
string
|
| and more...
|
|
list or nil
|
Rocket Launch Pad
- Component Name:
"ntm_rocket_pad"
Functions
| Callback
|
Return
|
Type
|
getEnergyInfo()
|
Return Values for getEnergyInfo()
| Index
|
Value
|
Type
|
1
|
Stored Energy
|
number
|
2
|
Max Energy
|
number
|
|
list
|
getFuel()
|
This returns a list of table.
Return Values for getFuel()
| Index
|
Value
|
Type
|
1
|
Tank fill
|
number
|
2
|
Tank max fill
|
number
|
3
|
Unlocalized fluid name
|
string
|
| and more tanks...
|
|
list
|
getSolidFuel()
|
Return Values for getSolidFuel()
| Index
|
Value
|
Type
|
1
|
Current solid fuel amount
|
number
|
2
|
Max solid fuel amount
|
number
|
|
list
|
canLaunch()
|
Whenever the rocket can launch. This depends on many checks
|
boolean
|
getRocketStats()
|
Returns nil, "" if there's no rocket on the pad.
Return Values for getRocketStats()
| Index
|
Value
|
Type
|
1
|
Amount of stages
|
number
|
2
|
Launch mass
|
number
|
3
|
Height
|
number
|
|
list or nil, string
|
launch()
|
"Launches" the rocket if all launch requirements are met.
|
nil
|
getDestination()
|
Destination of the current drive. If there's no drive, nil, "No destination drive." is returned. If there's no destination, nil, "Drive has no destination" is returned instead.
|
string or nil, string
|
