Difference between revisions of "Related/Documentation"

m (→‎Parameters: quotation marks)
m (better description)
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
Returns a list of all skills related to a [[Stat]].
+
Displays a stylized list of all pages in the specified categories that contain the specified [[Stat]].
 
==Usage==
 
==Usage==
{{T|Related|category|stat}}
+
{{T|Related|category/categories|stat|notext{{=}}notext}}
{{T|Related|category|stat|format}}
 
  
 
==Parameters==
 
==Parameters==
{{parameter|1|The category to query.}}
+
{{parameter|1|The categories to query.|4=Comma separated, can be <code>skills</code> or <code>passive talents</code>}}
 
{{parameter|2|The stat to query.}}
 
{{parameter|2|The stat to query.}}
{{parameter|3|The format of the result.|table|Can be "<code>row</code>" or "<code>table</code>".}}
+
{{parameter|notext|Whether or not to include descriptor text.||If not set, the following text will display:
 +
<pre>
 +
==Related==
 +
The following can affect (or are affected by) a character's {{{2}}}.
 +
</pre>
 +
[For each category, a stylized list and accompanying subheading will display.]
 +
}}
 +
 
 +
==Errors==
 +
'''Invalid category. Check documentation.'''

Latest revision as of 18:34, 15 August 2023

Description[edit]

Displays a stylized list of all pages in the specified categories that contain the specified Stat.

Usage[edit]

{{Related|<category/categories>|<stat>|<notext=notext>}}

Parameters[edit]

Arrow.png1: The categories to query.
Required.
Notes: Comma separated, can be skills or passive talents
Arrow.png2: The stat to query.
Required.
Arrow.pngnotext: Whether or not to include descriptor text.
Optional.
Notes: If not set, the following text will display:
==Related==
The following can affect (or are affected by) a character's {{{2}}}.

[For each category, a stylized list and accompanying subheading will display.]

Errors[edit]

Invalid category. Check documentation.