User:Gorgon/Sandbox/Sandbox Charlie: Difference between revisions

From Avlis Wiki
Jump to navigation Jump to search
m (Test version of emplate:Ifparadef (If parameter defined).)
m (spell name description tweaks)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#switch: {{{1|¬}}}
<b>[[Magic:{{{School}}}|{{{School}}}]]</b> {{{Subschool}}} {{{Descriptors}}} <br>
|   = {{{4| {{{2|}}} }}} <!-- Defined, empty. Must come before {{{1|}}}, since " " = " " -->
<b>[[Magic:Level|Level]]:</b> {{{Level}}}<br>
| ¬ = {{{3|}}}           <!-- Not defined. Must come before {{{1|}}}, since ¬ = ¬ -->
<b>[[Magic:Innate Level|Innate Level]]:</b> {{{Innate Level}}}<br>
| {{{1|}}} = {{{2|}}}   <!-- Defined, not empty. {{{1}}} = {{{1}}} -->
<b>[[Magic:Components|Component(s)]]:</b> {{{Components}}} <br>
}}<noinclude>
<b>[[Magic:Casting Time|Casting Time]]:</b> {{{Casting Time}}} <br>
<b>[[Magic:Range|Range]]:</b> {{{Range}}} <br>
<b>[[Magic:Target|Target]]:</b> {{{Target}}} <br>
<b>[[Magic:Duration|Duration]]:</b> {{{Duration}}} <br>
<b>[[Magic:Counter|Counter(s)]]:</b> {{{Counters}}}<br>
<b>[[Magic:Saving Throw|Saving Throw]]:</b> {{{Saving Throw}}} <br>
<b>[[Magic:Spell Resistance|Spell Resistance]]:</b> {{{Spell Resistance}}} <br>
<b>[[Magic:Metamagic|Metamagic]]:</b> {{{Metamagic}}}<br>
<b>[[Magic:Energy Substitution|Energy Substitution]]:</b> {{{Energy Substitution}}}<br>


{{{Description}}}
<noinclude>


== Template:Ifparadef (If parameter defined) ==
==Template data==


This template is based on [[Wikipedia:Template:Ifparadef | Template:Ifparadef]].
<templatedata>
 
{
It uses the original markup. The documentation below was copied to this template, since we do not use [[Wikipedia:Wikipedia:Template_documentation#How_to_create_a_documentation_subpage | documentation sub-pages]]. Most of the [[Wikipedia:Main_Page | Wikipedia]] specific information, links and sub-templates have either been removed, or modified for the Avlis wiki.
    "description": "Spell template parameter descriptions.\nNote: All parameter values (except the 'Description') should be in uppercase unless using full sentences. Try to keep any description of effects in the 'Description' parameter.",
 
    "format": "block",
See the [[Wikipedia:Template:Ifparadef/doc | original template documentation]] for further details.
    "params": {
 
        "Name": {
 
            "label": "Spell Name",
== Template documentation ==
            "description": "The name of the spell that shows in the main [[Magic:Spell_List|Spell List]] and spell school category lists.\n- It should match the page name, but without any underscores.\n- All words in the spell name use [[Wikipedia:Title_case|Title Case]]. All words are capitalized, except for minor words (typically articles, short prepositions, and some conjunctions) that are not the first or last word of the spell name.",
 
            "example": "Cone of Cold",
This template is used to test if a parameter is defined; thus, it should only be directly used on other templates.
            "type": "line",
 
            "required": true
 
        },
=== Usage ===
        "School": {
 
            "label": "School",
This template accepts up to four unnamed parameters.
            "description": "The [[Magic:School|Magical School]] to which the spell belongs.",
* Standard functionality: <code><nowiki>{{ifparadef | {{{parameter_name | ¬}}} | Defined | Not defined}}</nowiki></code>
            "type": "line",
* Extended functionality: <code><nowiki>{{ifparadef | {{{parameter_name | ¬}}} | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
            "suggestedvalues": [
 
                "Abjuration",
The first parameter, which is required, is the name of the parameter to be tested. It must be formatted as <code><nowiki>{{{parameter_name | ¬}}}</nowiki></code>, '''with the "¬"''', otherwise the template will not work correctly (see the [[#Examples | Examples]] section below for examples with and without the "¬").
                "Conjuration",
 
                "Divination",
The second parameter is the text to display if the tested parameter is defined. If the fourth parameter is also used, the second parameter is the text displayed when the tested parameter is defined and not empty.
                "Enchantment",
 
                "Evocation",
The third parameter is the text to display if the tested parameter is not defined.
                "Illusion",
 
                "Necromancy",
The fourth parameter is the text to display if the tested parameter is defined and empty (or if it contains only whitespace). If this parameter is omitted, only one defined test is performed, and the contents (or default) of the second parameter are used as long as the tested parameter is defined.
                "Transmutation",
 
                "Universal"
This template uses "¬" to test for a defined parameter; the template cannot detect when a literal "¬" is passed as input from a final deployment (such as an article), and will give incorrect results in such cases. If you need to handle that case too, then see <nowiki>{{</nowiki>[[Wikipedia:Template:ifparadef full |ifparadef full]]<nowiki>}}</nowiki>.
            ],
 
            "required": true
 
        },
==== Examples ====
        "Subschool": {
 
            "label": "Sub-School",
{| class="wikitable" style="width: 98%;"
            "description": "The [[Magic:Subschool|Sub-School]] to which the spell belongs.\n- Only [[Magic:Conjuration|Conjuration]], [[Magic:Enchantment|Enchantment]], and [[Magic:Illusion|Illusion]] schools can have a sub-school.\n- Include a link to the specific sub-school entry when adding one, and place it inside of round (brackets).",
|+ Normal use
            "example": "([[Magic:Conjuration#Calling|Calling]]) / ([[Magic:Enchantment#Compulsion|Compulsion]])",
|-
            "type": "line",
! Code !! Result
            "default": "",
|-
            "suggestedvalues": [
| <code><nowiki>{{ifparadef | {{{parameter_name | ¬}}} | Defined | Not defined}}</nowiki></code>
                "([[Magic:Conjuration#Calling|Calling]])",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | {{{parameter_name | ¬}}} | Defined | Not defined}}
                "([[Magic:Conjuration#Creation|Creation]])",
|-
                "([[Magic:Conjuration#Healing|Healing]])",
| <code><nowiki>{{ifparadef | {{{parameter_name | Some text}}} | Defined | Not defined}}</nowiki></code>
                "([[Magic:Conjuration#Summoning|Summoning]])",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | {{{parameter_name | Some text}}} | Defined | Not defined}}
                "([[Magic:Enchantment#Charm|Charm]])",
|-
                "([[Magic:Enchantment#Compulsion|Compulsion]])",
| <code><nowiki>{{ifparadef | Some text | Defined | Not defined}}</nowiki></code>
                "([[Magic:Illusion#Figment|Figment]])",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | Some text | Defined | Not defined}}
                "([[Magic:Illusion#Glamer|Glamer]])",
|-
                "([[Magic:Illusion#Pattern|Pattern]])",
| <code><nowiki>{{ifparadef |  | Defined | Not defined}}</nowiki></code>
                "([[Magic:Illusion#Phantasm|Phantasm]])",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined | Not defined}}
                "([[Magic:Illusion#Shadow|Shadow]])"
|-
            ]
|}
        },
{| class="wikitable" style="width: 98%;"
        "Descriptors": {
|+ Extended use (with fourth parameter)
            "label": "Descriptors",
|-
            "description": "[[Magic:Descriptors|Descriptors]] indicate the nature of a spell.\n- Include a link to the specific [[Magic:Descriptors|Descriptors]] entry when adding one.\n- Spells may have multiple descriptors, and they should all be inside a set of square [ brackets ].",
! Code !! Result
            "example": "[ [[Magic:Descriptors#Acid|Acid]] ] / [ [[Magic:Descriptors#Good|Good]], [[Magic:Descriptors#Evil|Evil]] ]",
|-
            "type": "line",
| <code><nowiki>{{ifparadef | {{{parameter_name | }}} | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
            "default": "",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | {{{parameter_name | }}} | Defined, not empty | Not defined | Defined, empty}}
            "suggestedvalues": [
|-
                "[ [[Magic:Descriptors#Acid|Acid]] ]",
| <code><nowiki>{{ifparadef | {{{parameter_name | Some text}}} | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
                "[ [[Magic:Descriptors#Chaotic|Chaotic]] ]",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | {{{parameter_name | Some text}}} | Defined, not empty | Not defined | Defined, empty}}
                "[ [[Magic:Descriptors#Cold|Cold]] ]",
|-
                "[ [[Magic:Descriptors#Darkness|Darkness]] ]",
| <code><nowiki>{{ifparadef | {{{parameter_name | ¬}}} | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
                "[ [[Magic:Descriptors#Death|Death]] ]",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | {{{parameter_name | ¬}}} | Defined, not empty | Not defined | Defined, empty}}
                "[ [[Magic:Descriptors#Disease|Disease]] ]",
|-
                "[ [[Magic:Descriptors#Divine|Divine]] ]",
| <code><nowiki>{{ifparadef | Some text | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
                "[ [[Magic:Descriptors#Electricity|Electricity]] ]",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | Some text | Defined, not empty | Not defined | Defined, empty}}
                "[ [[Magic:Descriptors#Evil|Evil]] ]",
|-
                "[ [[Magic:Descriptors#Fear|Fear]] ]",
| <code><nowiki>{{ifparadef |  | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
                "[ [[Magic:Descriptors#Fire|Fire]] ]",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined, not empty | Not defined | Defined, empty}}
                "[ [[Magic:Descriptors#Force|Force]] ]",
|}
                "[ [[Magic:Descriptors#Good|Good]] ]",
{| class="wikitable" style="width: 98%;"
                "[ [[Magic:Descriptors#Language-dependent|Language-dependent]] ]",
|+ <span style="color:red">'''Incorrect'''</span> <nowiki>{{ifparadef}}</nowiki> usage in a template named <nowiki>{{ifparadef/test}}</nowiki>, containing: <code><nowiki>{{ifparadef | {{{parameter | }}} | Defined | Not defined}}</nowiki></code>
                "[ [[Magic:Descriptors#Lawful|Lawful]] ]",
|-
                "[ [[Magic:Descriptors#Light|Light]] ]",
! Code !! Result
                "[ [[Magic:Descriptors#Mind-affecting|Mind-affecting]] ]",
|-
                "[ [[Magic:Descriptors#Negative|Negative]] ]",
| <code><nowiki>{{ifparadef/test | parameter = Some text}}</nowiki></code>
                "[ [[Magic:Descriptors#Nature|Nature]] ]",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | Some text | Defined | Not defined}}
                "[ [[Magic:Descriptors#Paralyze|Paralyze]] ]",
|-
                "[ [[Magic:Descriptors#Poison|Poison]] ]",
| <code><nowiki>{{ifparadef/test | parameter = }}</nowiki></code>
                "[ [[Magic:Descriptors#Positive|Positive]] ]",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined | Not defined}}
                "[ [[Magic:Descriptors#Sonic|Sonic]] ]",
|-
                "[ [[Magic:Descriptors#Teleportation|Teleportation]] ]",
| <code><nowiki>{{ifparadef/test}}</nowiki></code>
                "[ [[Magic:Descriptors#Weapon_Enchantment|Weapon Enchantment]] ]"
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined | Not defined}}
            ]
|}
        },
{| class="wikitable" style="width: 98%;"
        "Level": {
|+ <span style="color:green">'''Correct'''</span> <nowiki>{{ifparadef}}</nowiki> usage in a template named <nowiki>{{ifparadef/test2}}</nowiki>, containing: <code><nowiki>{{ifparadef | {{{parameter | ¬}}} | Defined | Not defined}}</nowiki></code>
            "label": "Class/Domain Levels",
|-
            "description": "[[Magic:Level|Level]] shows abbreviations for each class that can cast this spell and at what level it is cast. It also indicates if a spell is a domain spell and at what its level is cast.\n- Standard spellcasting class abbreviations are: Brd, Clr, Drd, Pal, Rgr, Sor/Wiz.\n- Include a link to the [[Magic:Level|domain]] entry when adding one (see the included example for [[Magic:Haste|Haste]]).",
! Code !! Result
            "example": "Brd 3, Sor/Wiz 3, [[Magic:Level#Travel|Travel 5]]",
|-
            "type": "line",
| <code><nowiki>{{ifparadef/test2 | parameter = Some text}}</nowiki></code>
            "required": true
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | Some text | Defined | Not defined}}
        },
|-
        "Innate Level": {
| <code><nowiki>{{ifparadef/test2 | parameter = }}</nowiki></code>
            "label": "Innate Level",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined | Not defined}}
            "description": "[[Magic:Innate_Level|Innate Level]] is the level number of the the spell when there is no reference to a particular spellcasting class. Typically, the innate level is the lowest spell level among all the classes that can cast the spell (check the 'Innate' column for the spell in [https://nwn.wiki/display/NWN1/spells.2da spells.2da]).\n- The innate level is used when a class-dependent spell level cannot be determined, such as a spell cast from an item. It is also used when countering the spell with [[nwn:Counterspell|universal counter spells]].",
|-
            "type": "number",
| <code><nowiki>{{ifparadef/test2}}</nowiki></code>
            "required": true
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | ¬ | Defined | Not defined}}
        },
|}
        "Components": {
{| class="wikitable" style="width: 98%;"
            "label": "Components",
|+ <span style="color:red">'''Incorrect'''</span> <nowiki>{{ifparadef}}</nowiki> usage in a template named <nowiki>{{ifparadef/test3}}</nowiki>, containing: <code><nowiki>{{ifparadef | {{{parameter | }}} | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
            "description": "[[Magic:Components|Components]] indicates what the character must do to cast the spell. Spells in NWN only use V (Verbal) and/or S (Somatic) as components unless they include extra component code (see: [https://nwn.wiki/display/NWN1/spells.2da spells.2da - 'VS']).",
|-
            "type": "line",
! Code !! Result
            "suggestedvalues": [
|-
                "V",
| <code><nowiki>{{ifparadef/test3 | parameter = Some text}}</nowiki></code>
                "S",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | Some text | Defined, not empty | Not defined | Defined, empty}}
                "V, S"
|-
            ],
| <code><nowiki>{{ifparadef/test3 | parameter = }}</nowiki></code>
            "required": true
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined, not empty | Not defined | Defined, empty}}
        },
|-
        "Casting Time": {
| <code><nowiki>{{ifparadef/test3}}</nowiki></code>
            "label": "Casting Time",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined, not empty | Not defined | Defined, empty}}
            "description": "[[Magic:Casting_Time|Casting Time]] in NWN is 1 Action. The actual casting time can vary by a few seconds, but you can cast 1 spell per round as an action (more actions while hasted, quickened, and so on).",
|}
            "type": "line",
{| class="wikitable" style="width: 98%;"
            "default": "1 Action",
|+ <span style="color:green">'''Correct'''</span> <nowiki>{{ifparadef}}</nowiki> usage in a template named <nowiki>{{ifparadef/test4}}</nowiki>, containing: <code><nowiki>{{ifparadef | {{{parameter | ¬}}} | Defined, not empty | Not defined | Defined, empty}}</nowiki></code>
            "required": true
|-
        },
! Code !! Result
        "Range": {
|-
            "label": "Target Range",
| <code><nowiki>{{ifparadef/test4 | parameter = Some text}}</nowiki></code>
            "description": "[[Magic:Range|Range]] is the maximum distance from the caster at which the spell can affect a target.\n- Ranges are: (P) Personal - 0m, (T) Touch - 2.25m, (S) Short - 8m, (M) Medium - 20m, (L) Long - 40m.",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | Some text | Defined, not empty | Not defined | Defined, empty}}
            "type": "line",
|-
            "suggestedvalues": [
| <code><nowiki>{{ifparadef/test4 | parameter = }}</nowiki></code>
                "P",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | | Defined, not empty | Not defined | Defined, empty}}
                "T",
|-
                "S",
| <code><nowiki>{{ifparadef/test4}}</nowiki></code>
                "M",
| {{<!-- ifparadef -->User:Gorgon/Sandbox/Sandbox Charlie | ¬ | Defined, not empty | Not defined | Defined, empty}}
                "L"
|}
            ],
 
            "required": true
 
        },
=== Hardcoding ===
        "Target": {
 
            "label": "Target",
An alternative to using this meta-template is to hardcode this functionality in your template. Use the code below for standard and extended functionality:
            "description": "[[Magic:Target|Target]] lists what is affected and the area of effect.\n- Format begins with either 'Caster', 'Target', or 'Area', optionally followed by the area of effect size. If the target can be either an object or area location, then use both.\n- Standard AoE sizes (non-standard sizes are also used): Personal, Single, Small - 1.67m, Medium - 3.33m, Large - 5.0m, Huge - 6.67m, Gargantuan  - 8.33m, Colossal - 10m.",
 
            "example": "Caster: Personal / Target: Single / Area: Medium / Target/Area: 14m Cone",
<pre style="white-space: pre">
            "type": "line",
{{#ifeq: {{{parameter_name | ¬}}} | ¬
            "required": true
| Not defined.
        },
| Defined. (Empty or has data.)
        "Duration": {
}}
            "label": "Duration",
 
            "description": "[[Magic:Duration|Duration]] is how long the spell lasts.\n- Standard durations are: Instantaneous, Permanent, Concentration, Discharge, or a timed duration value.\n- If the duration line ends with '(D)', the character can dismiss the spell at will (e.g., [[Magic:Shapechange|Shapechange]]).\n- Discharge means the same as 'Permanent (D)', with it only dispelled by the caster (e.g., Shifter forms if they were spells).\n- Avlis spell durations are all measured in 'real life' seconds or minutes. 'In game' time (i.e. the 20 RL minutes per game hour server setting) has no effect on hooked spell durations. There are no 'hour per level' or 'per day' hooked spells in Avlis (all old hour durations are '4 minutes', and day durations are '96 minutes').\n- The term 'turn' no meaning in NWN, and should always be replaced with 'minute'.\n- A 'round' does have special meaning in NWN, but as far as spell durations, it is '6 seconds' ('round' may be included for completeness).\n- You may use the suggested values as a base and edit them to suit your needs. See the examples.",
{{#switch: {{{parameter_name | ¬}}}
            "example": "Instantaneous / 1 Round (6 Seconds)/2 Levels  / 1 Minute/Level / 4 Minutes/Level / 96 Minutes",
| ¬ = Not defined.
            "type": "line",
|  = Defined, empty.
            "suggestedvalues": [
| #default = Defined, not empty.
                "Instantaneous",
}}
                "Permanent",
</pre>
                "Concentration",
 
                "Discharge",
 
                "1 Round (6 Seconds)/Level",
For code that works with any input (detects "¬" as defined, not empty), see [[Wikipedia:Template:ifparadef full#Hardcoding | Template:Ifparadef full#Hardcoding]]. Use the code below for standard and extended functionality:
                "1 Minute/Level",
 
                "4 Minutes/Level",
<pre style="white-space: pre-wrap">
                "96 Minutes"
{{#ifeq: {{{parameter_name | x}}} | {{{parameter_name | y}}}
            ],
| Defined. (Empty or has data.)
            "required": true
| Not defined.
        },
}}
        "Counters": {
 
            "label": "Counters",
{{#switch: {{{parameter_name | x}}}{{{parameter_name | y}}}
            "description": "[[Magic:Counter|Counters]] is a list of additional counter spells. This is a required parameter. If the spell doesn't have extra counters, or you don't know them, always use the default value of '--' (do not use 'None').\n- Include a link to the spell entry when adding one (see the included example for [[Magic:Entangle|Entangle]]).",
| xy = Not defined.
            "example": "[[Magic:Freedom of Movement|Freedom of Movement]]",
|    = Defined, empty.
            "type": "line",
| #default = Defined, not empty.
            "default": "--",
}}</pre>
            "required": true
 
        },
 
        "Saving Throw": {
=== See also ===
            "label": "Saving Throw",
 
            "description": "[[Magic:Saving_Throw|Saving Throw]] lists if the spell allows a save, what type(s), and the effects.\n- Anything more than a few words should be in the main 'Description'. Get the general save info in there and they can read on if they need to.",
* <nowiki>{{</nowiki>[[Wikipedia:Template:ifparadef full |ifparadef full]]<nowiki>}}</nowiki> - Extended version of this template, but works with any input (correctly detects "¬" as defined, not empty).
            "example": "Fortitude: Negates, Will: Half / Reflex 1/2 (Evasion Ineffective) / Will And Fortitude: Partial",
* <nowiki>{{</nowiki>[[Wikipedia:Template:ifempty |ifempty]]<nowiki>}}</nowiki> - Allows testing of up to four parameters, returning the contents of the first non-empty one.
            "type": "line",
 
            "suggestedvalues": [
{{ns detect | template = [[Category:Templates |{{PAGENAME}}]] }}</noinclude>
                "None",
                "Fortitude",
                "Reflex",
                "Will"
            ],
            "required": true
        },
        "Spell Resistance": {
            "label": "Spell Resistance",
            "description": "[[Magic:Spell_Resistance|Spell Resistance]] shows if spell resistance (SR) resists this spell.\n- Do not guess. If you don't know, leave it blank.",
            "type": "line",
            "default": "",
            "suggestedvalues": [
                "No",
                "Yes"
            ]
        },
        "Metamagic": {
            "label": "Metamagic",
            "description": "[[Magic:Metamagic|Metamagic]] that can be use with this spell.\n- This can be a bit complicated to set correctly. [https://nwn.wiki/display/NWN1/spells.2da spells.2da 'MetaMagic'] determines what a caster can do with spell metamagic feats, but the code determines what effects can happen. Metamagic rods and other sources override (ignore) spells.2da settings, but they will not do anything if the code doesn't support it.\n- Do not guess. If you don't know, and don't have access to code source to confirm it, only add what you are sure of.\n- Do not say 'None'. Leave it blank instead. There are many custom metamagic types that will almost certainly work, even if the standard ones don't.\n- Do not use custom Avlis metamagic values here (only the types in the example). None of the custom metamagic applies to specific spells, and it should be obvious if they affect certain spell types.",
            "example": "Extend, Empower, Maximize, Silent, Still, Quicken",
            "type": "line",
            "default": ""
        },
        "Energy Substitution": {
            "label": "Energy Substitution",
            "description": "[[Magic:Energy_Substitution|Energy Substitution]] shows if the spell can use energy substitution.\n- This is enabled in the spell code, and can be used with metamagic rods.\n- Do not guess. If you don't know, leave it blank.",
            "type": "line",
            "default": "",
            "suggestedvalues": [
                "No",
                "Yes"
            ]
        },
        "Description": {
            "label": "Spell Description",
            "description": "Details of what the spell does and how it works.\n- Only add details for what a spell actually does in game terms. This is about the facts.\n- [[Wikipedia:WYSIWYG|WYSIWYG]] in game, and nothing more. Do not add imagined or flowery descriptive details.\n- Do not include details about what a spell is supposed to do, whether or not a fix/update may happen in the future. Only describe the current spell behavior. The wiki can be updated if/when changes are made.",
            "type": "unbalanced-wikitext",
            "required": true
        }
    },
    "paramOrder": [
        "Name",
        "School",
        "Subschool",
        "Descriptors",
        "Level",
        "Innate Level",
        "Components",
        "Casting Time",
        "Range",
        "Target",
        "Duration",
        "Counters",
        "Saving Throw",
        "Spell Resistance",
        "Metamagic",
        "Energy Substitution",
        "Description"
    ]
}
</templatedata>
</noinclude>

Latest revision as of 00:22, 5 January 2024

[[Magic:{{{School}}}|{{{School}}}]] {{{Subschool}}} {{{Descriptors}}}
Level: {{{Level}}}
Innate Level: {{{Innate Level}}}
Component(s): {{{Components}}}
Casting Time: {{{Casting Time}}}
Range: {{{Range}}}
Target: {{{Target}}}
Duration: {{{Duration}}}
Counter(s): {{{Counters}}}
Saving Throw: {{{Saving Throw}}}
Spell Resistance: {{{Spell Resistance}}}
Metamagic: {{{Metamagic}}}
Energy Substitution: {{{Energy Substitution}}}

{{{Description}}}


Template data

<templatedata> {

   "description": "Spell template parameter descriptions.\nNote: All parameter values (except the 'Description') should be in uppercase unless using full sentences. Try to keep any description of effects in the 'Description' parameter.",
   "format": "block",
   "params": {
       "Name": {
           "label": "Spell Name",
           "description": "The name of the spell that shows in the main Spell List and spell school category lists.\n- It should match the page name, but without any underscores.\n- All words in the spell name use Title Case. All words are capitalized, except for minor words (typically articles, short prepositions, and some conjunctions) that are not the first or last word of the spell name.",
           "example": "Cone of Cold",
           "type": "line",
           "required": true
       },
       "School": {
           "label": "School",
           "description": "The Magical School to which the spell belongs.",
           "type": "line",
           "suggestedvalues": [
               "Abjuration",
               "Conjuration",
               "Divination",
               "Enchantment",
               "Evocation",
               "Illusion",
               "Necromancy",
               "Transmutation",
               "Universal"
           ],
           "required": true
       },
       "Subschool": {
           "label": "Sub-School",
           "description": "The Sub-School to which the spell belongs.\n- Only Conjuration, Enchantment, and Illusion schools can have a sub-school.\n- Include a link to the specific sub-school entry when adding one, and place it inside of round (brackets).",
           "example": "(Calling) / (Compulsion)",
           "type": "line",
           "default": "",
           "suggestedvalues": [
               "(Calling)",
               "(Creation)",
               "(Healing)",
               "(Summoning)",
               "(Charm)",
               "(Compulsion)",
               "(Figment)",
               "(Glamer)",
               "(Pattern)",
               "(Phantasm)",
               "(Shadow)"
           ]
       },
       "Descriptors": {
           "label": "Descriptors",
           "description": "Descriptors indicate the nature of a spell.\n- Include a link to the specific Descriptors entry when adding one.\n- Spells may have multiple descriptors, and they should all be inside a set of square [ brackets ].",
           "example": "[ Acid ] / [ Good, Evil ]",
           "type": "line",
           "default": "",
           "suggestedvalues": [
               "[ Acid ]",
               "[ Chaotic ]",
               "[ Cold ]",
               "[ Darkness ]",
               "[ Death ]",
               "[ Disease ]",
               "[ Divine ]",
               "[ Electricity ]",
               "[ Evil ]",
               "[ Fear ]",
               "[ Fire ]",
               "[ Force ]",
               "[ Good ]",
               "[ Language-dependent ]",
               "[ Lawful ]",
               "[ Light ]",
               "[ Mind-affecting ]",
               "[ Negative ]",
               "[ Nature ]",
               "[ Paralyze ]",
               "[ Poison ]",
               "[ Positive ]",
               "[ Sonic ]",
               "[ Teleportation ]",
               "[ Weapon Enchantment ]"
           ]
       },
       "Level": {
           "label": "Class/Domain Levels",
           "description": "Level shows abbreviations for each class that can cast this spell and at what level it is cast. It also indicates if a spell is a domain spell and at what its level is cast.\n- Standard spellcasting class abbreviations are: Brd, Clr, Drd, Pal, Rgr, Sor/Wiz.\n- Include a link to the domain entry when adding one (see the included example for Haste).",
           "example": "Brd 3, Sor/Wiz 3, Travel 5",
           "type": "line",
           "required": true
       },
       "Innate Level": {
           "label": "Innate Level",
           "description": "Innate Level is the level number of the the spell when there is no reference to a particular spellcasting class. Typically, the innate level is the lowest spell level among all the classes that can cast the spell (check the 'Innate' column for the spell in spells.2da).\n- The innate level is used when a class-dependent spell level cannot be determined, such as a spell cast from an item. It is also used when countering the spell with universal counter spells.",
           "type": "number",
           "required": true
       },
       "Components": {
           "label": "Components",
           "description": "Components indicates what the character must do to cast the spell. Spells in NWN only use V (Verbal) and/or S (Somatic) as components unless they include extra component code (see: spells.2da - 'VS').",
           "type": "line",
           "suggestedvalues": [
               "V",
               "S",
               "V, S"
           ],
           "required": true
       },
       "Casting Time": {
           "label": "Casting Time",
           "description": "Casting Time in NWN is 1 Action. The actual casting time can vary by a few seconds, but you can cast 1 spell per round as an action (more actions while hasted, quickened, and so on).",
           "type": "line",
           "default": "1 Action",
           "required": true
       },
       "Range": {
           "label": "Target Range",
           "description": "Range is the maximum distance from the caster at which the spell can affect a target.\n- Ranges are: (P) Personal - 0m, (T) Touch - 2.25m, (S) Short - 8m, (M) Medium - 20m, (L) Long - 40m.",
           "type": "line",
           "suggestedvalues": [
               "P",
               "T",
               "S",
               "M",
               "L"
           ],
           "required": true
       },
       "Target": {
           "label": "Target",
           "description": "Target lists what is affected and the area of effect.\n- Format begins with either 'Caster', 'Target', or 'Area', optionally followed by the area of effect size. If the target can be either an object or area location, then use both.\n- Standard AoE sizes (non-standard sizes are also used): Personal, Single, Small - 1.67m, Medium - 3.33m, Large - 5.0m, Huge - 6.67m, Gargantuan  - 8.33m, Colossal - 10m.",
           "example": "Caster: Personal / Target: Single / Area: Medium / Target/Area: 14m Cone",
           "type": "line",
           "required": true
       },
       "Duration": {
           "label": "Duration",
           "description": "Duration is how long the spell lasts.\n- Standard durations are: Instantaneous, Permanent, Concentration, Discharge, or a timed duration value.\n- If the duration line ends with '(D)', the character can dismiss the spell at will (e.g., Shapechange).\n- Discharge means the same as 'Permanent (D)', with it only dispelled by the caster (e.g., Shifter forms if they were spells).\n- Avlis spell durations are all measured in 'real life' seconds or minutes. 'In game' time (i.e. the 20 RL minutes per game hour server setting) has no effect on hooked spell durations. There are no 'hour per level' or 'per day' hooked spells in Avlis (all old hour durations are '4 minutes', and day durations are '96 minutes').\n- The term 'turn' no meaning in NWN, and should always be replaced with 'minute'.\n- A 'round' does have special meaning in NWN, but as far as spell durations, it is '6 seconds' ('round' may be included for completeness).\n- You may use the suggested values as a base and edit them to suit your needs. See the examples.",
           "example": "Instantaneous / 1 Round (6 Seconds)/2 Levels  / 1 Minute/Level / 4 Minutes/Level / 96 Minutes",
           "type": "line",
           "suggestedvalues": [
               "Instantaneous",
               "Permanent",
               "Concentration",
               "Discharge",
               "1 Round (6 Seconds)/Level",
               "1 Minute/Level",
               "4 Minutes/Level",
               "96 Minutes"
           ],
           "required": true
       },
       "Counters": {
           "label": "Counters",
           "description": "Counters is a list of additional counter spells. This is a required parameter. If the spell doesn't have extra counters, or you don't know them, always use the default value of '--' (do not use 'None').\n- Include a link to the spell entry when adding one (see the included example for Entangle).",
           "example": "Freedom of Movement",
           "type": "line",
           "default": "--",
           "required": true
       },
       "Saving Throw": {
           "label": "Saving Throw",
           "description": "Saving Throw lists if the spell allows a save, what type(s), and the effects.\n- Anything more than a few words should be in the main 'Description'. Get the general save info in there and they can read on if they need to.",
           "example": "Fortitude: Negates, Will: Half / Reflex 1/2 (Evasion Ineffective) / Will And Fortitude: Partial",
           "type": "line",
           "suggestedvalues": [
               "None",
               "Fortitude",
               "Reflex",
               "Will"
           ],
           "required": true
       },
       "Spell Resistance": {
           "label": "Spell Resistance",
           "description": "Spell Resistance shows if spell resistance (SR) resists this spell.\n- Do not guess. If you don't know, leave it blank.",
           "type": "line",
           "default": "",
           "suggestedvalues": [
               "No",
               "Yes"
           ]
       },
       "Metamagic": {
           "label": "Metamagic",
           "description": "Metamagic that can be use with this spell.\n- This can be a bit complicated to set correctly. spells.2da 'MetaMagic' determines what a caster can do with spell metamagic feats, but the code determines what effects can happen. Metamagic rods and other sources override (ignore) spells.2da settings, but they will not do anything if the code doesn't support it.\n- Do not guess. If you don't know, and don't have access to code source to confirm it, only add what you are sure of.\n- Do not say 'None'. Leave it blank instead. There are many custom metamagic types that will almost certainly work, even if the standard ones don't.\n- Do not use custom Avlis metamagic values here (only the types in the example). None of the custom metamagic applies to specific spells, and it should be obvious if they affect certain spell types.",
           "example": "Extend, Empower, Maximize, Silent, Still, Quicken",
           "type": "line",
           "default": ""
       },
       "Energy Substitution": {
           "label": "Energy Substitution",
           "description": "Energy Substitution shows if the spell can use energy substitution.\n- This is enabled in the spell code, and can be used with metamagic rods.\n- Do not guess. If you don't know, leave it blank.",
           "type": "line",
           "default": "",
           "suggestedvalues": [
               "No",
               "Yes"
           ]
       },
       "Description": {
           "label": "Spell Description",
           "description": "Details of what the spell does and how it works.\n- Only add details for what a spell actually does in game terms. This is about the facts.\n- WYSIWYG in game, and nothing more. Do not add imagined or flowery descriptive details.\n- Do not include details about what a spell is supposed to do, whether or not a fix/update may happen in the future. Only describe the current spell behavior. The wiki can be updated if/when changes are made.",
           "type": "unbalanced-wikitext",
           "required": true
       }
   },
   "paramOrder": [
       "Name",
       "School",
       "Subschool",
       "Descriptors",
       "Level",
       "Innate Level",
       "Components",
       "Casting Time",
       "Range",
       "Target",
       "Duration",
       "Counters",
       "Saving Throw",
       "Spell Resistance",
       "Metamagic",
       "Energy Substitution",
       "Description"
   ]

} </templatedata>