Module:RecipeTreeSearch/doc: Difference between revisions
m
update documentation for 19th dec changes
mNo edit summary |
m (update documentation for 19th dec changes) |
||
| (One intermediate revision by the same user not shown) | |||
Line 2:
{{Helper module|name=RecipeTreeSearch
|fname1=main(item)
|ftype1=<code>item</code>: string, name of an item page
|fuse1=Returns a Lua Table structured as a Recipe, but containing additional information about a multi-stage crafting process such including:<br>
All base materials, including their buy price in shops
Line 10:
Total values for XP, KP, duration
|fname2=treeSearch(inputs)
|ftype2=<code>inputs</code>: table of name/quantity pairs, for the inputs to a recipe
|fuse2=Use this function on the inputs to a recipe rather than the name of the output of a recipe. This allows the tree to be searched before the final recipe has been made.
Line 16:
Returns a the same structure Lua Table as main(), however it lacks any information on the final step.
|fname3 = getRecipe(item)
|ftype3 = <code>item</code>: string, name of an item page
|fuse3 = Returns the Lua Table of the Recipe for the single step.<br>
Will also find an activitiy which produce the item on the specified page.<br>
Will only ever return one recipe/activity, the one it finds first.
|fname4 = getShopBuyPrice(item)
|ftype4 = <code>item</code>: string, name of an item page
|fuse4 = Returns the value that the item can be bought at, or nil if it cannot be bought
|fname5 = getShopSellPrice(item)
|ftype5 = <code>item</code>: string, name of an item page
|fuse5 = Returns the value that the item can be sold for, or nil if it cannot be sold
}}
| |||