Skip to content

Mekanism API Notes

Jump to bottom
Mikayla Fischler edited this page Jan 25, 2022 · 7 revisions

Mekanism Computer Integration: https://docs.google.com/spreadsheets/d/1sheh1BIeP_vSto881H6UtgXvxdbyJEfILM_uUW_UD7Q/

API Functions for Machines in Use

Reactor Logic Port

  • activation
  • high temperature
  • excess waste
  • damage critical (100%+)
  • insufficient fuel

Mekanism logic:

  • activate = isPowered() == 1
  • high temp = getTemperature() >= 1200
  • excess waste = getWasteNeeded() == 0
  • damaged = getDamagePercent() >= 100
  • depleted = getFuelFilledPercentage() == 0

Fission Reactor (fissionReactor)

  • getHeatCapacity
  • getFuelAssemblies
  • getFuelSurfaceArea
  • getFuelCapacity
  • getWasteCapacity
  • getCoolantCapacity
  • getHeatedCoolantCapacity
  • getStatus
  • getHeatingRate
  • getTemperature
  • getDamagePercent
  • getBoilEfficiency
  • getEnvironmentalLoss
  • getFuel
  • getFuelNeeded
  • getFuelFilledPercentage
  • getWaste
  • getWasteNeeded
  • getWasteFilledPercentage
  • getCoolant = ['name': mekanism:sodium, 'amount': 45000000]
  • getCoolantNeeded
  • getCoolantFilledPercentage
  • getHeatedCoolant
  • getHeatedCoolantNeeded
  • getHeatedCoolantFilledPercentage
  • getBurnRate
  • getActualBurnRate
  • getMaxBurnRate
  • scram
  • setBurnRate
  • activate

Boiler (boiler)

  • getSuperheaters
  • getBoilCapacity
  • getSteamCapacity
  • getWaterCapacity
  • getHeatedCoolantCapacity
  • getCooledCoolantCapacity
  • getTemperature
  • getEnvironmentalLoss
  • getBoilRate
  • getMaxBoilRate
  • getSteamNeeded
  • getSteam
  • getSteamFilledPercentage
  • getWater
  • getWaterNeeded
  • getWaterFilledPercentage
  • getHeatedCoolant
  • getHeatedCoolantNeeded
  • getHeatedCoolantFilledPercentage
  • getCooledCoolant
  • getCooledCoolantNeeded
  • getCooledCoolantFilledPercentage

Turbine (turbine)

  • getCoils
  • getBlades
  • getVents
  • getDispersers
  • getCondensers
  • getDumpingMode
  • getSteamCapacity
  • getProductionRate
  • getMaxProduction
  • getLastSteamInputRate
  • getFlowRate
  • getMaxFlowRate
  • getMaxWaterOutput
  • getSteam
  • getSteamNeeded
  • getSteamFilledPercentage

Induction Matrix (generic mekanismMachine)

  • getTotalEnergyFilledPercentage
  • getTotalEnergy
  • getTotalMaxEnergy
  • getTotalEnergyNeeded

If you need help beyond this wiki, open a support discussion or ask on Discord! If you prefer videos, they can be found on my YouTube channel.

Homepage

  1. User Manual
    1. System Setup Guide
      1. Device Layout
        1. Coordinator Displays
      2. Connecting to Mekanism Machines
      3. Application Installation
        1. Space Requirements
        2. Installation
        3. Updating
        4. Uninstalling
      4. Setup & Configuration
        1. Network Channels
        2. Supervisor Setup
        3. Coordinator Setup
        4. Reactor PLC Setup
        5. RTU Gateway Setup
      5. Initial Startup
    2. Configurator Tools
      1. Supervisor Configurator
      2. Coordinator Configurator
      3. Reactor PLC Configurator
      4. RTU Gateway Configurator
    3. Redstone Waste Setup Guide
    4. TL;DR Quickstart
    5. FAQ and Common Problems
    6. Colorblind Accessibility
    7. Annunciator Panels
    8. Alarms
    9. System Views
      1. Main View Screen
      2. Valve & Flow Screen
      3. Unit View Screens
    10. Operating Procedure
    11. Status Messages
    12. Glossary
  2. Computer Applications
    1. Reactor PLC
    2. RTU Gateway
    3. Supervisory Computer
    4. Coordinator Computer
    5. Pocket
  3. Notable System Components
    1. Threaded Reactor PLC & RTU Gateway
    2. Project File Layout/Overview
    3. PPM - Protected Peripherals Manager
    4. RSIO - Redstone I/O
    5. Utility Classes
    6. Networking
  4. Notes
    1. Known Issues
    2. Process Closed Loop Controller
    3. Project Files and Layout
    4. Alternative Installation Strategies
  5. Investigations
    1. Startup Rate High
    2. Reactor Temperature Calculation
  6. References & Resources
    1. CC: Tweaked Character Set
    2. Mekanism API Notes
    3. Design & Regulatory References
  7. Legacy
    1. coord.settings File
    2. config.lua Files
      1. Supervisor config.lua
      2. Coordinator config.lua
      3. Reactor PLC config.lua
      4. RTU Gateway config.lua
Clone this wiki locally