Ubidibity

CompuCraft ME Interface methods

Jul 14th, 2021 (edited)
160
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
Lua 12.33 KB | Source Code | 0 0
  1. {
  2.   getStoredPower = {
  3.     returnTypes = "number",
  4.     args = {},
  5.     description = "Get the stored power in the network.",
  6.     source = "me_network",
  7.   },
  8.   getAdvancedMethodsData = {
  9.     returnTypes = "table",
  10.     args = {
  11.       {
  12.         optional = true,
  13.         description = "",
  14.         type = "openperipheral.adapter.types.SingleArgType@17f008a8",
  15.         name = "method",
  16.       },
  17.     },
  18.     description = "Get a complete table of information about all available methods",
  19.     source = "<meta>",
  20.   },
  21.   pullItem = {
  22.     returnTypes = "number",
  23.     args = {
  24.       {
  25.         type = "openperipheral.adapter.types.BoundedType@465f7e76",
  26.         name = "direction",
  27.         description = "The direction of the other inventory",
  28.       },
  29.       {
  30.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  31.         name = "slot",
  32.         description = "The slot in the OTHER inventory that you're pulling from",
  33.       },
  34.       {
  35.         optional = true,
  36.         description = "The maximum amount of items you want to pull",
  37.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  38.         name = "maxAmount",
  39.       },
  40.       {
  41.         optional = true,
  42.         description = "The slot in the current inventory that you want to pull into",
  43.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  44.         name = "intoSlot",
  45.       },
  46.     },
  47.     description = "Pull an item from a slot in another inventory into a slot in this one. Returns the amount of items moved",
  48.     source = "inventory-world",
  49.   },
  50.   destroyStack = {
  51.     returnTypes = "()",
  52.     args = {
  53.       {
  54.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  55.         name = "slotNumber",
  56.         description = "The slot number",
  57.       },
  58.     },
  59.     description = "Destroy a stack",
  60.     source = "inventory",
  61.   },
  62.   getCraftingCPUs = {
  63.     returnTypes = "table",
  64.     args = {},
  65.     description = "Get a list of tables representing the available CPUs in the network.",
  66.     source = "me_network",
  67.   },
  68.   requestCrafting = {
  69.     returnTypes = "()",
  70.     args = {
  71.       {
  72.         type = "openperipheral.integration.vanilla.ModuleVanilla$1@14f934f8",
  73.         name = "fingerprint",
  74.         description = "Details of the item you want to craft. Can be found with .getStackInSlot on inventory and .getAvailableItems on AE network",
  75.       },
  76.       {
  77.         optional = true,
  78.         description = "The quantity of items you want to craft",
  79.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  80.         name = "qty",
  81.       },
  82.       {
  83.         optional = true,
  84.         description = "The name of the CPU you want to use",
  85.         type = "openperipheral.adapter.types.SingleArgType@17f008a8",
  86.         name = "cpu",
  87.       },
  88.     },
  89.     description = "Requests the specified item to get crafted.",
  90.     source = "me_interface",
  91.   },
  92.   listMethods = {
  93.     returnTypes = "string",
  94.     args = {
  95.       {
  96.         optional = true,
  97.         description = "",
  98.         type = "openperipheral.adapter.types.SingleArgType@17f008a8",
  99.         name = "filterSource",
  100.       },
  101.     },
  102.     description = "List all the methods available",
  103.     source = "<meta>",
  104.   },
  105.   exportItem = {
  106.     returnTypes = "table",
  107.     args = {
  108.       {
  109.         type = "openperipheral.integration.vanilla.ModuleVanilla$1@14f934f8",
  110.         name = "fingerprint",
  111.         description = "Details of the item you want to export (can be result of .getStackInSlot() or .getAvailableItems())",
  112.       },
  113.       {
  114.         type = "openperipheral.adapter.types.BoundedType@26c85a6d",
  115.         name = "direction",
  116.         description = "Location of target inventory",
  117.       },
  118.       {
  119.         optional = true,
  120.         description = "The maximum amount of items you want to export",
  121.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  122.         name = "maxAmount",
  123.       },
  124.       {
  125.         optional = true,
  126.         description = "The slot in the other inventory that you want to export into",
  127.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  128.         name = "intoSlot",
  129.       },
  130.     },
  131.     description = "Exports the specified item into the target inventory.",
  132.     source = "me_interface",
  133.   },
  134.   getInventorySize = {
  135.     returnTypes = "number",
  136.     args = {},
  137.     description = "Get the size of this inventory",
  138.     source = "inventory",
  139.   },
  140.   getItemDetail = {
  141.     returnTypes = "object",
  142.     args = {
  143.       {
  144.         type = "openperipheral.integration.vanilla.ModuleVanilla$1@14f934f8",
  145.         name = "item",
  146.         description = "Details of the item you are looking for",
  147.       },
  148.       {
  149.         optional = true,
  150.         description = "If false, method will compute whole table, instead of returning proxy",
  151.         type = "openperipheral.adapter.types.SingleArgType@275a341",
  152.         name = "proxy",
  153.       },
  154.     },
  155.     description = "Retrieves details about the specified item from the ME Network.",
  156.     source = "me_network",
  157.   },
  158.   pullItemIntoSlot = {
  159.     returnTypes = "number",
  160.     args = {
  161.       {
  162.         type = "openperipheral.adapter.types.BoundedType@465f7e76",
  163.         name = "direction",
  164.         description = "The direction of the other inventory",
  165.       },
  166.       {
  167.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  168.         name = "slot",
  169.         description = "The slot in the OTHER inventory that you're pulling from",
  170.       },
  171.       {
  172.         optional = true,
  173.         description = "The maximum amount of items you want to pull",
  174.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  175.         name = "maxAmount",
  176.       },
  177.       {
  178.         optional = true,
  179.         description = "The slot in the current inventory that you want to pull into",
  180.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  181.         name = "intoSlot",
  182.       },
  183.     },
  184.     description = "Pull an item from a slot in another inventory into a slot in this one. Returns the amount of items moved",
  185.     source = "inventory-world",
  186.   },
  187.   pushItemIntoSlot = {
  188.     returnTypes = "number",
  189.     args = {
  190.       {
  191.         type = "openperipheral.adapter.types.BoundedType@5bd0c31",
  192.         name = "direction",
  193.         description = "The direction of the other inventory",
  194.       },
  195.       {
  196.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  197.         name = "slot",
  198.         description = "The slot in the current inventory that you're pushing from",
  199.       },
  200.       {
  201.         optional = true,
  202.         description = "The maximum amount of items you want to push",
  203.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  204.         name = "maxAmount",
  205.       },
  206.       {
  207.         optional = true,
  208.         description = "The slot in the other inventory that you want to push into (ignored when target is pipe",
  209.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  210.         name = "intoSlot",
  211.       },
  212.     },
  213.     description = "Push an item from the current inventory into pipe or slot on the other inventory. Returns the amount of items moved",
  214.     source = "inventory-world",
  215.   },
  216.   listSources = {
  217.     returnTypes = "table",
  218.     args = {},
  219.     description = "List all method sources",
  220.     source = "<meta>",
  221.   },
  222.   getStackInSlot = {
  223.     returnTypes = "object",
  224.     args = {
  225.       {
  226.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  227.         name = "slotNumber",
  228.         description = "Slot number",
  229.       },
  230.       {
  231.         optional = true,
  232.         description = "If true, method will return proxy instead of computing whole table",
  233.         type = "openperipheral.adapter.types.SingleArgType@275a341",
  234.         name = "proxy",
  235.       },
  236.     },
  237.     description = "Get details of an item in a particular slot",
  238.     source = "inventory",
  239.   },
  240.   getAllStacks = {
  241.     returnTypes = "table",
  242.     args = {
  243.       {
  244.         optional = true,
  245.         description = "If false, method will compute whole table, instead of returning proxy",
  246.         type = "openperipheral.adapter.types.SingleArgType@275a341",
  247.         name = "proxy",
  248.       },
  249.     },
  250.     description = "Get a table with all the items of the chest",
  251.     source = "inventory",
  252.   },
  253.   swapStacks = {
  254.     returnTypes = "()",
  255.     args = {
  256.       {
  257.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  258.         name = "from",
  259.         description = "The first slot",
  260.       },
  261.       {
  262.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  263.         name = "to",
  264.         description = "The other slot",
  265.       },
  266.       {
  267.         optional = true,
  268.         description = "",
  269.         type = "openperipheral.adapter.types.BoundedType@3b266715",
  270.         name = "fromDirection",
  271.       },
  272.       {
  273.         optional = true,
  274.         description = "",
  275.         type = "openperipheral.adapter.types.BoundedType@5fd9492e",
  276.         name = "fromDirection",
  277.       },
  278.     },
  279.     description = "Swap two slots in the inventory",
  280.     source = "inventory",
  281.   },
  282.   getAvgPowerInjection = {
  283.     returnTypes = "number",
  284.     args = {},
  285.     description = "Get the average power injection into the network",
  286.     source = "me_network",
  287.   },
  288.   getAvgPowerUsage = {
  289.     returnTypes = "number",
  290.     args = {},
  291.     description = "Get the average power usage of the network.",
  292.     source = "me_network",
  293.   },
  294.   condenseItems = {
  295.     returnTypes = "()",
  296.     args = {},
  297.     description = "Condense and tidy the stacks in an inventory",
  298.     source = "inventory",
  299.   },
  300.   doc = {
  301.     returnTypes = "string",
  302.     args = {
  303.       {
  304.         type = "openperipheral.adapter.types.SingleArgType@17f008a8",
  305.         name = "method",
  306.         description = "",
  307.       },
  308.     },
  309.     description = "Brief description of method",
  310.     source = "<meta>",
  311.   },
  312.   getAvailableItems = {
  313.     returnTypes = "table",
  314.     args = {
  315.       {
  316.         optional = true,
  317.         description = "Format of stored items details (defalt: none)",
  318.         type = "openperipheral.adapter.types.BoundedType@1fe6da8e",
  319.         name = "details",
  320.       },
  321.     },
  322.     description = "Get a list of the stored and craftable items in the network.",
  323.     source = "me_network",
  324.   },
  325.   getMaxStoredPower = {
  326.     returnTypes = "number",
  327.     args = {},
  328.     description = "Get the maximum stored power in the network.",
  329.     source = "me_network",
  330.   },
  331.   canExport = {
  332.     returnTypes = "boolean",
  333.     args = {
  334.       {
  335.         type = "openperipheral.adapter.types.BoundedType@6f44fbba",
  336.         name = "direction",
  337.         description = "Location of target inventory",
  338.       },
  339.     },
  340.     description = "Returns true when the interface can export to side.",
  341.     source = "me_interface",
  342.   },
  343.   getIdlePowerUsage = {
  344.     returnTypes = "number",
  345.     args = {},
  346.     description = "Get the idle power usage of the network.",
  347.     source = "me_network",
  348.   },
  349.   getInventoryName = {
  350.     returnTypes = "string",
  351.     args = {},
  352.     description = "Get the name of this inventory",
  353.     source = "inventory",
  354.   },
  355.   pushItem = {
  356.     returnTypes = "number",
  357.     args = {
  358.       {
  359.         type = "openperipheral.adapter.types.BoundedType@5bd0c31",
  360.         name = "direction",
  361.         description = "The direction of the other inventory",
  362.       },
  363.       {
  364.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  365.         name = "slot",
  366.         description = "The slot in the current inventory that you're pushing from",
  367.       },
  368.       {
  369.         optional = true,
  370.         description = "The maximum amount of items you want to push",
  371.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  372.         name = "maxAmount",
  373.       },
  374.       {
  375.         optional = true,
  376.         description = "The slot in the other inventory that you want to push into (ignored when target is pipe",
  377.         type = "openperipheral.adapter.types.SingleArgType@713d6f9f",
  378.         name = "intoSlot",
  379.       },
  380.     },
  381.     description = "Push an item from the current inventory into pipe or slot on the other inventory. Returns the amount of items moved",
  382.     source = "inventory-world",
  383.   },
  384.   expandStack = {
  385.     returnTypes = "table",
  386.     args = {
  387.       {
  388.         type = "openperipheral.adapter.types.NamedTupleType@493e348e",
  389.         name = "stack",
  390.         description = "",
  391.       },
  392.     },
  393.     description = "Get full stack information from id and/or damage",
  394.     source = "inventory",
  395.   },
  396. }
Add Comment
Please, Sign In to add comment