Menu
▾
▴
[pcgen-commit-svn] SF.net SVN: pcgen: [3550] Trunk/pcgen/docs/listfilepages/datafilestagpages/ datafilesability.html
|
From: <tak...@us...> - 2007-07-25 23:38:53
|
Revision: 3550
http://pcgen.svn.sourceforge.net/pcgen/?rev=3550&view=rev
Author: takeyabue
Date: 2007-07-25 16:38:55 -0700 (Wed, 25 Jul 2007)
Log Message:
-----------
W3C Validation Effort
Modified Paths:
--------------
Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesability.html
Modified: Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesability.html
===================================================================
--- Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesability.html 2007-07-25 20:45:18 UTC (rev 3549)
+++ Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesability.html 2007-07-25 23:38:55 UTC (rev 3550)
@@ -1,164 +1,278 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+
-<html>
+
+<html>
+
<!--
- PCGen Documentation Project
+
+ PCGen Documentation Project
- $Header: /cvsroot/pcgendocs/pcgendocs/docs/listfilepages/globalfilestagpages/globalfilesABility.html$
- $Author: fitzs $
- $Date: $
- $Revision: $
- Contributors:
- Shane Molnar - shaneATcliftonmotelDOTcomDOTau
- Eddy Anthony - eddybaATmindspringDOTcom
- Terry FitzSimons - fitzsimonsATmintelDOTnet
+ $Author: fitzs $
+
+ $Date: $
+
+ $Revision: $
+
+
+
+ Contributors:
+
+ Shane Molnar - shaneATcliftonmotelDOTcomDOTau
+
+ Eddy Anthony - eddybaATmindspringDOTcom
+
+ Terry FitzSimons - fitzsimonsATmintelDOTnet
+
Eric C. Smith - mareduddATblackrootDOTorg
- Description:
- Provides information on the use of PCGen Ability Tags.
+
+ Description:
+
+ Provides information on the use of PCGen Ability Tags.
+
-->
- <head>
- <title>ABILITY: Tag</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" type="text/css" href="../../pcgen.css" />
- </head>
+
+<head>
- <body>
- <h1>Ability Tags</h1>
+ <title>ABILITY: Tag</title>
- <p></p>
- <p><strong>NOTE:</strong>
- This page is broken into three sections. The first section, the <a href="#AbilityFileTags">Ability File Tags</a>,
- lists the new ability file tags, the second section, <a href="#GlobalAbilityTags">Global Ability Tags</a>,
- and the third section, <a href="#OtherAbilityTags">Other Ability Tags</a>, lists the tags located else where in
- the PCGen documentation.</p>
+ <link rel="stylesheet" type="text/css" href="../../pcgen.css" >
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
- <p></p><a name="AbilityFileTags"></a><hr>
- <h2>The Ability File Tags</h2>
- <p></p><a name="ADDSPELLLEVEL"></a><hr>
- <p class="new">*** New 5.11.x</p>
- <p class="indent0"><strong>Tag Name:</strong> ADDSPELLLEVEL:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong> Number (Increase in spell slot level)</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <p class="indent2"> This tag is used in metamagic abilities to denote how much higher the spell level slot requires.</p>
- <p class="indent1"><strong>Example:</strong></p>
- <p class="indent2"><code>ADDSPELLLEVEL:2</code></p>
- <p class="indent3">A spell with this metamagic ability applied to it takes up a slot two levels higher than the normal spell.</p>
+<body>
- <p></p><a name="BENEFIT"></a><hr>
- <p class="new">*** New 5.11.x</p>
- <p class="indent0"><strong>Tag Name:</strong> BENEFIT:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong> Text (benefit text)</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <p class="indent2">This is the benefit text of the ability from the source material.
- This text will be displayed in the feat description field if the
- <a href="../../menupages/settings/appearance/appearancedisplay.html">"Display
- Feat Description"</a> checkbox in the Appearance/Display Options Preference window
- is unchecked. Otherwise the text from the DESC tag will be displayed.</p>
- <p class="indent1"><strong>Example:</strong></p>
- <p class="indent2"><code>BENEFIT:This is sample text for the example purposes</code></p>
- <p class="indent3">Adds ability benefit.</p>
+ <h1>Ability Tags</h1>
- <p></p><a name="CATEGORY2"></a><hr>
- <p class="indent0"><strong>Tag Name:</strong> CATEGORY:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong> Text (Ability category)</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <p class="indent2">This is the ability category [link to docs for Ability Category game mode tag] that
- the ability belongs to.
+ <p></p>
+
+ <p><strong>NOTE:</strong> This page is broken into three sections. The first section, the <a href="#AbilityFileTags">Ability File
+ Tags</a>, lists the new ability file tags, the second section, <a href="#GlobalAbilityTags">Global Ability Tags</a>,
+ and
+ the third section, <a href="#OtherAbilityTags">Other Ability Tags</a>, lists the tags located else where in the PCGen documentation.</p>
+
+
+ <p></p>
+<hr>
+
+
+ <h2><a name="AbilityFileTags">The Ability File Tags</a></h2>
+
+ <p></p>
+
+<hr>
+
+ <p class="new">*** New 5.11.x</p>
+
+ <p class="indent0"><strong>Tag Name:</strong> ADDSPELLLEVEL:x</p>
+
+ <p class="indent1"><strong>Variables Used (x):</strong> Number (Increase in spell slot level)</p>
+
+ <p class="indent1"><strong>What it does:</strong></p>
+
+ <p class="indent2"> This tag is used in metamagic abilities to denote how much higher the spell level slot requires.</p>
+
+ <p class="indent1"><strong>Example:</strong></p>
+
+ <p class="indent2"><code>ADDSPELLLEVEL:2</code></p>
+ <p class="indent3">A spell with this metamagic ability applied to it takes up a slot two levels higher than the normal spell.</p>
+
+
+<hr>
+
+
+ <p class="new">*** New 5.11.x</p>
+ <p class="indent0"><strong>Tag Name:</strong> BENEFIT:x</p>
+
+ <p class="indent1"><strong>Variables Used (x):</strong> Text(benefit text)</p>
+ <p class="indent1"><strong>What it does:</strong></p>
+ <p class="indent2">This is the benefit text of the ability from the source material. This text will be displayed in the feat
+ description field if the
+ <a href="../../menupages/settings/appearance/appearancedisplay.html">"Display Feat
+ Description"</a> checkbox in the Appearance/Display Options Preference window is unchecked. Otherwise the text
+ from the DESC tag will be displayed.</p>
+
+ <p class="indent1"><strong>Example:</strong></p>
+ <p class="indent2"><code>BENEFIT:This is sample text for the example purposes</code></p>
+ <p class="indent3">Adds ability benefit.</p>
+ <p></p>
+
+<hr>
+
+
+ <p class="indent0"><strong>Tag Name:</strong> CATEGORY:x</p>
+ <p class="indent1"><strong>Variables Used (x):</strong> Text (Ability category)</p>
+ <p class="indent1"><strong>What it does:</strong></p>
+
+ <p class="indent2">This is the ability category [link to docs for Ability Category game mode tag] that the ability belongs to.
The ability category is a broad group of abilities, defined in the game mode. An ability's key name
- need only be unique within its category.</p>
- <p class="indent1"><strong>Examples:</strong></p>
- <p class="indent2"><code>CATEGORY:SpecialAttack</code></p>
- <p class="indent3">This ability is part of the "SpecialAttack" ability category.</p>
- <p class="indent2"><code>CATEGORY:Feat</code></p>
- <p class="indent3">This ability is part of the "Feat" ability category, which is a special case of
- abilities that can be selected as feats.</p>
+ need only be unique
+ within its category.</p>
+ <p class="indent1"><strong>Examples:</strong></p>
+
+ <p class="indent2"><code>CATEGORY:SpecialAttack</code></p>
+ <p class="indent3">This ability is part of the "SpecialAttack" ability category.</p>
+ <p class="indent2"><code>CATEGORY:Feat</code></p>
- <p></p><a name="COST"></a><hr>
- <p class="new">*** New 5.11.x</p>
- <p class="indent0"><strong>Tag Name:</strong> COST:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong> Number (ability point cost)</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <p class="indent2">This is how many ability points the ability costs. A decimal value,
- as the example below, would mean that it only costs 1/2 an ability point.</p>
- <p class="indent1"><strong>Example:</strong></p>
- <p class="indent2"><code>COST:1</code></p>
- <p class="indent3">Ability costs one ability point.</p>
- <p class="indent2"><code>COST:.5</code></p>
- <p class="indent3">Ability costs half a ability point.</p>
+ <p class="indent3">This ability is part of the "Feat" ability category, which is a special case of abilities that can be selected
+ as feats.</p>
- <p></p><a name="MODIFYABILITYCHOICE"></a><hr>
- <p class="new">*** New 5.11.x</p>
- <p class="indent0"><strong>Tag Name:</strong> MODIFYABILITYCHOICE:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong>Text (ability name)</p>
- <p class="indent1"><strong>Variables Used (x):</strong>TYPE=Text (ability type)</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <ul class="indent2">
- <li>This tag allows for a previous ability choice to be replaced by a new one.</li>
- <li>The ability called must allow choices to be a valid ability.</li>
- </ul>
- <p class="indent1"><strong>Example:</strong></p>
- <p class="indent2"><code>MODIFYABILITYCHOICE:TYPE=NinjaMonkeySchool</code></p>
- <p class="indent3">An ability with this tag will allow the selection of a new school
- from a list of schools of type 'NinjaMonkeySchool' to replace a previously selected one.</p>
- <p class="indent2"><code>MODIFYABILITYCHOICE:Ninja Monkey Primary Weapon Reselection</code></p>
- <p class="indent3">Allows a ninja monkey to select a new primary weapon, replacing
- an earlier selected primary weapon.</p>
-
- <p></p><a name="MULT"></a><hr>
- <p class="new">*** New 5.11.x</p>
- <p class="indent0"><strong>Tag Name:</strong> MULT:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong> Boolean ('YES' or 'NO')</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <p class="indent2">This determines if an ability can be taken multiple times. If the
- value is set to 'YES', then you <strong>MUST</strong> also use a 'CHOOSE' tag.</p>
- <p class="indent1"><strong>Example:</strong></p>
- <p class="indent2"><code>MULT:YES</code></p>
- <p class="indent3">This Ability can be taken multiple times.</p>
- <p></p><a name="STACK"></a><hr>
- <p class="new">*** New 5.11.x</p>
- <p class="indent0"><strong>Tag Name:</strong> STACK:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong> Boolean ('YES' or 'NO')</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <p class="indent2">This tells PCGen if the ability benefits may be stacked on one another.</p>
- <p class="indent1"><strong>Example:</strong></p>
- <p class="indent2"><code>STACK:YES</code></p>
- <p class="indent3">This Ability may be stack on it's self.</p>
+ <p></p>
+
+<hr>
- <p></p><a name="VISIBLE"></a><hr>
- <p class="new">*** New 5.11.x</p>
- <p class="indent0"><strong>Tag Name:</strong> VISIBLE:x</p>
- <p class="indent1"><strong>Variables Used (x):</strong> YES</p>
- <p class="indent1"><strong>Variables Used (x):</strong> NO</p>
- <p class="indent1"><strong>Variables Used (x):</strong> DISPLAY</p>
- <p class="indent1"><strong>Variables Used (x):</strong> EXPORT</p>
- <p class="indent1"><strong>What it does:</strong></p>
- <ul class="indent2">
- <li><code>YES</code> - Shows the ability name in PCGen and on export to a character sheet.
- (This is the default setting).</li>
- <li><code>NO</code> - Hides the ability name in PCGen and on export to a character sheet.</li>
- <li><code>DISPLAY</code> - Displays the ability name in PCGen but not on the character sheet.</li>
- <li><code>EXPORT</code> - Hides the ability name from PCGen but displays it on the character sheet.</li>
- </ul>
- <p class="indent1"><strong>Example:</strong></p>
- <p class="indent2"><code>VISIBLE:YES</code></p>
- <p class="indent3">Shows the ability name in PCGen and on the Output sheet.</p>
+ <p class="new">*** New 5.11.x</p>
- <p></p><a name="GlobalAbilityTags"></a><hr>
- <h2>Global Ability Tags</h2>
+ <p class="indent0"><strong>Tag Name:</strong> COST:x</p>
+ <p class="indent1"><strong>Variables Used (x):</strong> Number (ability point cost)</p>
+
+ <p class="indent1"><strong>What it does:</strong></p>
- <li><a href="../globalfilestagpages/globalfilesother.html#ABILITY2">ABILITY</a> <span class="note">(Global Other)</span></li>
+ <p class="indent2">This is how many ability points the ability costs. A decimal value,
+as the example below, would mean that
+ it only costs 1/2 an ability point.</p>
- <p></p><a name="OtherAbilityTags"></a><hr>
- <h2>Other Ability Tags</h2>
+ <p class="indent1"><strong>Example:</strong></p>
+
+ <p class="indent2"><code>COST:1</code></p>
+ <p class="indent3">Ability costs one ability point.</p>
+
+ <p class="indent2"><code>COST:.5</code></p>
- <p>These are not true global tags as the tags in the first section are. All tags are being listed
- here to make them easier to locate and understand.</p>
+ <p class="indent3">Ability costs half a ability point.</p>
+
+ <p></p>
+
+<hr>
+
- <p></p><a name="GameModeMiscInfoAbilityTags"></a><hr>
+ <p class="new">*** New 5.11.x</p>
+
+ <p class="indent0"><strong>Tag Name:</strong>MODIFYABILITYCHOICE:x</p>
+ <p class="indent1"><strong>Variables Used (x):</strong>Text (ability name)</p>
+ <p class="indent1"><strong>Variables Used (x):</strong>TYPE=Text (ability type)</p>
+
+ <p class="indent1"><strong>What it does:</strong></p>
+ <ul class="indent2">
+
+<li>This tag allows for a previous ability choice to be replaced by a new one.</li>
+ <li>The ability called must allow choices to be a valid ability.</li>
+
+ </ul>
+
+ <p class="indent1"><strong>Example:</strong></p>
+ <p class="indent2"><code>MODIFYABILITYCHOICE:TYPE=NinjaMonkeySchool</code></p>
+ <p class="indent3">An ability with this tag will allow the selection of a new school from a list of schools of type
+ 'NinjaMonkeySchool' to replace a previously selected one.</p>
+
+ <p class="indent2"><code>MODIFYABILITYCHOICE:Ninja Monkey Primary Weapon Reselection</code></p>
+
+ <p class="indent3">Allows a ninja monkey to select a new primary weapon, replacing an earlier selected primary weapon.</p>
+
+ <p></p>
+
+<hr>
+
+
+ <p class="new">*** New 5.11.x</p>
+ <p class="indent0"><strong>Tag Name:</strong> MULT:x</p>
+ <p class="indent1"><strong>Variables Used (x):</strong> Boolean ('YES' or 'NO')</p>
+ <p class="indent1"><strong>What it does:</strong></p>
+
+ <p class="indent2">This determines if an ability can be taken multiple times. If the value is set to 'YES', then you
+ <strong>MUST</strong> also use a 'CHOOSE' tag.</p>
+
+ <p class="indent1"><strong>Example:</strong></p>
+ <p class="indent2"><code>MULT:YES</code></p>
+ <p class="indent3">This Ability can be taken multiple times.</p>
+
+ <p></p>
+
+<hr>
+
+
+ <p class="new">*** New 5.11.x</p>
+
+ <p class="indent0"><strong>Tag Name:</strong> STACK:x</p>
+ <p class="indent1"><strong>Variables Used (x):</strong> Boolean ('YES' or 'NO')</p>
+ <p class="indent1"><strong>What it does:</strong></p>
+
+ <p class="indent2">This tells PCGen if the ability benefits may be stacked on one another.</p>
+
+ <p class="indent1"><strong>Example:</strong></p>
+
+ <p class="indent2"><code>STACK:YES</code></p>
+
+ <p class="indent3">This Ability may be stack on it's self.</p>
+
+
+ <p></p>
+
+<hr>
+
+
+ <p class="new">*** New 5.11.x</p>
+
+ <p class="indent0"><strong>Tag Name:</strong> VISIBLE:x</p>
+
+ <p class="indent1"><strong>Variables Used (x):</strong> YES</p>
+
+ <p class="indent1"><strong>Variables Used (x):</strong> NO</p>
+
+ <p class="indent1"><strong>Variables Used (x):</strong> DISPLAY</p>
+
+ <p class="indent1"><strong>Variables Used (x):</strong> EXPORT</p>
+
+ <p class="indent1"><strong>What it does:</strong></p>
+
+ <ul class="indent2">
+
+ <li><code>YES</code> - Shows the ability name in PCGen and on export to a character sheet. (This is the default
+ setting).</li>
+
+ <li><code>NO</code> - Hides the ability name in PCGen and on export to a character sheet.</li>
+ <li><code>DISPLAY</code> - Displays the ability name in PCGen but not on the character sheet.</li>
+
+ <li><code>EXPORT</code> - Hides the ability name from PCGen but displays it on the character sheet.</li>
+
+ </ul>
+
+ <p class="indent1"><strong>Example:</strong></p>
+ <p class="indent2"><code>VISIBLE:YES</code></p>
+ <p class="indent3">Shows the ability name in PCGen and on the Output sheet.</p>
+
+ <p></p>
+
+<hr>
+
+
+ <h2><a name="AbilityFileTags">Global Ability Tags</a></h2>
+
+
+
+ <li><a href="../globalfilestagpages/globalfilesother.html#ABILITY2">ABILITY</a> <span class="note">(Global Other)</span></li>
+
+ <p></p>
+
+<hr>
+
+ <h2><a name="OtherAbilityTags">Other Ability Tags</a></h2>
+
+
+
+ <p>These are not true global tags as the tags in the first section are. All tags are being listed
+ here to make them easier to
+ locate and understand.</p>
+
+
+ <p></p>
+
+<a name="GameModeMiscInfoAbilityTags"></a><hr>
<h3>Game Mode - Misc Info File</h3>
<li><a href="../systemfilestagpages/gamemodemiscinfolist.html#ABILITYCATEGORY">ABILITYCATEGORY</a> <span class="note">(Misc Info)</span></li>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|