Template:Effect/doc: Difference between revisions

From Caves of Qud Wiki
Jump to navigation Jump to search
Jerimee (talk | contribs)
No edit summary
Jerimee (talk | contribs)
move doc to doc subpage
Line 3: Line 3:


{{#cargo_declare:_table=Effects|DisplayName=Wikitext|PlainName=String|Description=Wikitext|EffectID=String|Type=String|DamageTypes=String|DontIndex=Boolean}}
{{#cargo_declare:_table=Effects|DisplayName=Wikitext|PlainName=String|Description=Wikitext|EffectID=String|Type=String|DamageTypes=String|DontIndex=Boolean}}
The first argument is the name of the effect, and the second argument is the description. The third is id. The fourth is effect type in base 2.
You can also used named parameters.
{| class="wikitable"
! Parameter name
! Description
|-
| title
| title. unlike unnamed parameters, this is not automatically parsed and you must use qud text or qud shader.
|-
| desc
| effect description.
|-
| id
| the cs class name
|-
| idoverride
| an override ID for the wiki that is stored in cargo instead of the real ID. Should be used only rarely (example: Power Skating shares ID with Sprinting, but we want to treat them separately)
|-
| type
| a string of binary numbers that denotes the type of effect. this is from GetEffectType but converted into binary.
|-
| damagetypes
| a list (<nowiki></br></nowiki> delimited) of damage types caused by this effect, if applicable.
|-
| gameversion
| version number
|-
| dontindex
| 'yes' if this effect should not be indexed (usually because it is a variant of a similar effect that shares the same effect ID). Non-indexed effects do not appear in the effects navbox.
|}
;Usage:
<pre>
{{Effect
| title =
| desc =
| id =
| type =
| damagetypes =
| gameversion =
}}
</pre>
{{doc/end}}
{{doc/end}}

Revision as of 20:59, 31 October 2024

Documentation

{{Effect}}

This template defines the table "Effects". View table.

The first argument is the name of the effect, and the second argument is the description. The third is id. The fourth is effect type in base 2. You can also used named parameters.

Parameter name Description
title title. unlike unnamed parameters, this is not automatically parsed and you must use qud text or qud shader.
desc effect description.
id the cs class name
idoverride an override ID for the wiki that is stored in cargo instead of the real ID. Should be used only rarely (example: Power Skating shares ID with Sprinting, but we want to treat them separately)
type a string of binary numbers that denotes the type of effect. this is from GetEffectType but converted into binary.
damagetypes a list (</br> delimited) of damage types caused by this effect, if applicable.
gameversion version number
dontindex 'yes' if this effect should not be indexed (usually because it is a variant of a similar effect that shares the same effect ID). Non-indexed effects do not appear in the effects navbox.
Usage
{{Effect
| title = 
| desc = 
| id = 
| type = 
| damagetypes = 
| gameversion = 
}}