-
Notifications
You must be signed in to change notification settings - Fork 469
Component Generator
Florian Nücke edited this page Dec 7, 2013
·
7 revisions
This component is provided by the generator upgrade for robots. Generators have an internal inventory that can store one item stack of fuel items. This API allows interaction with that inventory.
Component name: generator.
Callbacks:
-
count(): number
The current number of fuel items still in the generator. -
insert([count: number]): boolean[, string]
Inserts up to the specified number of fuel items from the currently selected inventory slot into the generator's inventory. Returnstrueif at least one item was moved to the generator's inventory. Returnsfalseand an error message otherwise. -
remove([count: number]): boolean
Removes up to the specified number of fuel items from the generator and places them into the currently selected slot or the first free slot after it. Returnstrueif at least on item was removed from the generator's inventory,falseotherwise.
Example use:
-- Assuming the generator was just added to a robot and
-- the selected slot contains one stack of coal:
local g = component.generator -- get primary generator component
print(g.count()) -- 0
g.insert(1) -- true
print(g.count()) -- 0 because the item was immediately consumed, generator is running now
g.insert(5)
print(g.count()) -- 5
g.remove() -- remove everything from the generator
print(g.count()) -- 0
g.insert() -- insert everything into the generator
print(g.count()) -- 63 (minus the one consumed in the beginning)