Editing Module:RecipeTreeSearch/doc
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 2: | Line 2: | ||
{{Helper module|name=RecipeTreeSearch |
{{Helper module|name=RecipeTreeSearch |
||
|fname1=main(item) |
|fname1=main(item) |
||
|ftype1= |
|ftype1=name of an item page, as a string |
||
|fuse1=Returns a Lua Table structured as a Recipe, but containing additional information about a multi-stage crafting process such including: |
|fuse1=Returns a Lua Table structured as a Recipe, but containing additional information about a multi-stage crafting process such including: |
||
All base materials, including their buy price in shops |
All base materials, including their buy price in shops |
||
| Line 9: | Line 9: | ||
Total values for XP, KP, duration |
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. |
|||
IMPORTANT: within the Infobox Recipe that constructs a recipe, it is imporant to use this function instead of main(), so that this module will not attempt to use the recipe before it has been constructed. |
|||
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 |
|||
}} |
}} |
||