Editing Module:ProfessionList/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=ProfessionList |
{{Helper module|name=ProfessionList |
||
|fname1=currency_cell(amount) |
|fname1=currency_cell(amount) |
||
|ftype1= |
|ftype1=amount: number, or nil |
||
|fuse1=Returns the HTML to create a table currency cell using |
|fuse1=Returns the HTML to create a table currency cell using module:currency._cell.<br> |
||
If instead it is supplied with nil then a 10x1 cell is created with the text "unknown".<br> |
If instead it is supplied with nil then a 10x1 cell is created with the text "unknown".<br> |
||
Use within :node() |
Use within :node() |
||
|fname2=unknown_value_cell(size) |
|fname2=unknown_value_cell(size) |
||
|ftype2= |
|ftype2=size: integer |
||
|fuse2=Returns the HTML to create a |
|fuse2=Returns the HTML to create a 'size'x1 cell with the text "unknown".<br> |
||
Use within :node() |
Use within :node() |
||
|fname3=unknown_value_edit_cell(page,size) |
|fname3=unknown_value_edit_cell(page,size) |
||
|ftype3= |
|ftype3=page: string name of page<br>size: integer |
||
| ⚫ | |||
<code>size</code>: integer |
|||
| ⚫ | |||
Use within :node() |
Use within :node() |
||
|fname4=generate_recipe_table(queryString) |
|fname4=generate_recipe_table(queryString) |
||
|ftype4= |
|ftype4=queryString: string |
||
| ⚫ | |||
<code>screenFunction</code>: function, <code>table > boolean</code> |
|||
queryString is just a selection of pages, from any combination of SMW properties and categories.<br> |
|||
| ⚫ | |||
| ⚫ | |||
<code>queryString</code> is an SMW query, but it only needs to be the selection of pages. Parameters to be returned are chosen by the function.<br> |
|||
The results table entries are the recipe/activity JSONs, with pageName and pageImage parameters added.<br> |
|||
<code>screenFunction</code> is a function which takes one recipe from the search and returns true if that recipe is to be kept, or false if it is to be discarded. Parameters available to the screening function are those present in the Recipe JSON or Activity JSON, as well as the name and image of the page that held the JSON.<br> |
|||
| ⚫ | |||
The results table entries are the decoded recipe/activity JSONs, parsed through <code>Module:RecipeTreeSearch|main</code> to get the full recipe materials, xp, kp, duration, and costs. Added to these are the name and image of the page that held the JSON.<br> |
|||
The results table is sorted by recipe/activity level, independent of profession. |
The results table is sorted by recipe/activity level, independent of profession. |
||
|fname5=one_column_image_text(sort,materials) |
|||
|ftype5=<code>sort</code>: string, to sort the multicolumn cell by<br> |
|||
<code>materials</code>: table, each entry is a name/quantity pair for an item to display |
|||
|fuse5=Produces 1 cells with multiple lines of text in a standard format to display a list of materials for a recipe.<br> |
|||
Includes the quantity of each material.<br> |
|||
Requires that the image of each item is exactly the same as the item name itself.<br> |
|||
For example: the reagents and bottle to produce a potion. |
|||
|fname6=two_column_image_text(sort,image,text,link) |
|||
|ftype6=<code>sort</code>: string, to sort the multicolumn cell by<br> |
|||
<code>image</code>: string, image name to use, including '''File:''' and '''.png'''<br> |
|||
<code>text</code>: string, text to display<br> |
|||
<code>link</code>: string, page to link the image and text to |
|||
|fuse6=Produces 2 cells in a standard format to display an image and some text, which link to the same page.<br> |
|||
For example: the image and name of a skill node, but linking to the item they make. |
|||
|fname7=three_column_image_text(sort,quantity,image,text,link) |
|||
|ftype7=<code>sort</code>: string, to sort the multicolumn cell by<br> |
|||
<code>quantity</code>: number, will be displayed with "×" after it<br> |
|||
<code>image</code>: string, image name to use, including '''File:''' and '''.png'''<br> |
|||
<code>text</code>: string, text to display<br> |
|||
<code>link</code>: string, page to link the image and text to |
|||
|fuse7=Produces 3 cells in a standard format to display a quantity, an image, and some text, which link to the same page.<br> |
|||
For example: the quantity, image, and name of a recipe product. |
|||
}} |
}} |
||