API tools faq
paste
Advertisement
Guest User

tileinterface

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