Editing Module:RecipeTreeSearch/doc

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

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=<code>item</code>: string, name of an item page
|ftype1=item: 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>
|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
All base materials, including their buy price in shops
Line 10: Line 10:
Total values for XP, KP, duration
Total values for XP, KP, duration
|fname2=treeSearch(inputs)
|fname2=treeSearch(inputs)
|ftype2=<code>inputs</code>: table of name/quantity pairs, for the inputs to a recipe
|ftype2=inputs: 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.
|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 17: Line 17:
Returns a the same structure Lua Table as main(), however it lacks any information on the final step.
Returns a the same structure Lua Table as main(), however it lacks any information on the final step.
|fname3 = getRecipe(item)
|fname3 = getRecipe(item)
|ftype3 = <code>item</code>: string, name of an item page
|ftype3 = item: string name of an item page
|fuse3 = Returns the Lua Table of the Recipe for the single step.<br>
|fuse3 = Returns a Lua Table structured as a Recipe for the single step
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)
|fname4 = getShopBuyPrice(item)
|ftype4 = <code>item</code>: string, name of an item page
|ftype4 = item: string name of an item page
|fuse4 = Returns the value that the item can be bought at, or nil if it cannot be bought
|fuse4 = Returns the value that the item can be bought at, or nil if it cannot be bought
|fname5 = getShopSellPrice(item)
|fname5 = getShopSellPrice(item)
|ftype5 = <code>item</code>: string, name of an item page
|ftype5 = item: string name of an item page
|fuse5 = Returns the value that the item can be sold for, or nil if it cannot be sold
|fuse5 = Returns the value that the item can be sold for, or nil if it cannot be sold


Please note that all contributions to Brighter Shores Wiki are considered to be released under the CC BY-NC-SA 3.0 (see Brighter Shores:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

This page is a member of a hidden category: