Module:FetchItemStats/doc - Revision history

Alex at 10:22, 17 October 2024

2024-10-17T10:22:45Z

← Older revision		Revision as of 12:22, 17 October 2024
Line 15:		Line 15:
	\|fuse3 = Fetches all item stats for a list of given SMW names. If an ambiguous item name is given anywhere in this list (i.e. one that has different versions), this function will ''not'' automatically pick the one that would otherwise be chosen by <code>defaultVersion</code>. A specific SMW name needs to be entered for this function.		\|fuse3 = Fetches all item stats for a list of given SMW names. If an ambiguous item name is given anywhere in this list (i.e. one that has different versions), this function will ''not'' automatically pick the one that would otherwise be chosen by <code>defaultVersion</code>. A specific SMW name needs to be entered for this function.

	Sort keys and sort orders may be provided as optional second and third arguments. No custom sorting will be applied if these arrays are empty or <code>nil</code>. Note that Semantic MediaWiki queries automatically sort the output ~~mw.~~pages based on alphabetical pagename order. If no sorting should be applied whatsoever, set <code>sort_key1</code> to something [[Module:Yesno\|recognised as being falsy]] (e.g. <code>{'no'}</code>).		Sort keys and sort orders may be provided as optional second and third arguments. No custom sorting will be applied if these arrays are empty or <code>nil</code>. Note that Semantic MediaWiki queries automatically sort the output pages based on alphabetical pagename order. If no sorting should be applied whatsoever, set <code>sort_key1</code> to something [[Module:Yesno\|recognised as being falsy]] (e.g. <code>{'no'}</code>).

	Possible sorting orders are: 'ascending', 'asc', 'descending', 'desc', 'reverse', 'random' and 'rand'.		Possible sorting orders are: 'ascending', 'asc', 'descending', 'desc', 'reverse', 'random' and 'rand'.

Alex at 23:12, 16 October 2024

2024-10-16T23:12:06Z

← Older revision		Revision as of 01:12, 17 October 2024
Line 15:		Line 15:
	\|fuse3 = Fetches all item stats for a list of given SMW names. If an ambiguous item name is given anywhere in this list (i.e. one that has different versions), this function will ''not'' automatically pick the one that would otherwise be chosen by <code>defaultVersion</code>. A specific SMW name needs to be entered for this function.		\|fuse3 = Fetches all item stats for a list of given SMW names. If an ambiguous item name is given anywhere in this list (i.e. one that has different versions), this function will ''not'' automatically pick the one that would otherwise be chosen by <code>defaultVersion</code>. A specific SMW name needs to be entered for this function.

	Sort keys and sort orders may be provided as optional second and third arguments. No custom sorting will be applied if these arrays are empty or <code>nil</code>. Note that Semantic MediaWiki queries automatically sort the output pages based on alphabetical pagename order. If no sorting should be applied whatsoever, set <code>sort_key1</code> to something [[Module:Yesno\|recognised as being falsy]] (e.g. <code>{'no'}</code>).		Sort keys and sort orders may be provided as optional second and third arguments. No custom sorting will be applied if these arrays are empty or <code>nil</code>. Note that Semantic MediaWiki queries automatically sort the output mw.pages based on alphabetical pagename order. If no sorting should be applied whatsoever, set <code>sort_key1</code> to something [[Module:Yesno\|recognised as being falsy]] (e.g. <code>{'no'}</code>).

	Possible sorting orders are: 'ascending', 'asc', 'descending', 'desc', 'reverse', 'random' and 'rand'.		Possible sorting orders are: 'ascending', 'asc', 'descending', 'desc', 'reverse', 'random' and 'rand'.

Eq: Created page with "{{documentation}} This module provides three functions that make obtaining an item's information easier. {{Helper module |name = FetchItemStats |fname1 = defaultVersion(pagename) |ftype1 = String, String |fuse1 = Returns a string of the default version (format: `Pagename#Versionname`) that can be used for further SMW searches. Also returns a wikilink to the matched page name (following redirects from the given `pagename`, as the second return valu..."

2024-10-12T12:38:35Z

Created page with "{{documentation}} This module provides three functions that make obtaining an item's information easier. {{Helper module |name = FetchItemStats |fname1 = defaultVersion(pagename) |ftype1 = String, String |fuse1 = Returns a string of the default version (format: <code>Pagename#Versionname</code>) that can be used for further SMW searches. Also returns a wikilink to the matched page name (following redirects from the given <code>pagename</code>, as the second return valu..."

New page

{{documentation}}

This module provides three functions that make obtaining an item's information easier.

{{Helper module
|name = FetchItemStats
|fname1 = defaultVersion(pagename)
|ftype1 = String, String
|fuse1 = Returns a string of the default version (format: <code>Pagename#Versionname</code>) that can be used for further SMW searches. Also returns a wikilink to the matched page name (following redirects from the given <code>pagename</code>, as the second return value.
|fname2 = value(item_smwname)
|ftype2 = Number
|fuse2 = Returns the item value for either the specified SMW version (if the given name links to a specific item), or the version that is shown on the page by default (the same version as returned by <code>defaultVersion</code>.
|fname3 = equipmentStats(<br/>{item1_smwname, ...},<br/>{sort_key1, ...},<br/>{sort_order1, ...}<br/>)
|ftype3 = { Table1, Table2, ... }
|fuse3 = Fetches all item stats for a list of given SMW names. If an ambiguous item name is given anywhere in this list (i.e. one that has different versions), this function will ''not'' automatically pick the one that would otherwise be chosen by <code>defaultVersion</code>. A specific SMW name needs to be entered for this function.

Sort keys and sort orders may be provided as optional second and third arguments. No custom sorting will be applied if these arrays are empty or <code>nil</code>. Note that Semantic MediaWiki queries automatically sort the output pages based on alphabetical pagename order. If no sorting should be applied whatsoever, set <code>sort_key1</code> to something [[Module:Yesno|recognised as being falsy]] (e.g. <code>{'no'}</code>).

Possible sorting orders are: 'ascending', 'asc', 'descending', 'desc', 'reverse', 'random' and 'rand'.

The returned stats are formatted as a Table containing a single Table for each of the items, in the order given by the sort keys, or the default SMW sorting. The stats that are returned in each of these Tables are:
<pre>
{
astab = 'Stab attack bonus',
aslash = 'Slash attack bonus',
acrush = 'Crush attack bonus',
amagic = 'Magic attack bonus',
arange = 'Range attack bonus',
dstab = 'Stab defence bonus',
dslash = 'Slash defence bonus',
dcrush = 'Crush defence bonus',
dmagic = 'Magic defence bonus',
drange = 'Range defence bonus',
str = 'Strength bonus',
mdmg = 'Magic Damage bonus',
rstr = 'Ranged Strength bonus',
prayer = 'Prayer bonus',
weight = 'Weight',
image = 'Image',
subobj = 'Has subobject'
}
</pre>
}}