Menu
▾
▴
[Pcgendocs-commits] pcgendocs/docs/outputsheetpages/tokens outputsheettokensweapon.html,1.5,1.6
|
From: Martijn V. <kar...@us...> - 2005-12-01 11:57:25
|
Update of /cvsroot/pcgendocs/pcgendocs/docs/outputsheetpages/tokens In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26474/pcgendocs/docs/outputsheetpages/tokens Modified Files: outputsheettokensweapon.html Log Message: Added note to most simplistic version of weapon token that to see ammunition bonuses the RANGELIST version must be used. Index: outputsheettokensweapon.html =================================================================== RCS file: /cvsroot/pcgendocs/pcgendocs/docs/outputsheetpages/tokens/outputsheettokensweapon.html,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** outputsheettokensweapon.html 30 Nov 2005 13:06:52 -0000 1.5 --- outputsheettokensweapon.html 1 Dec 2005 11:57:08 -0000 1.6 *************** *** 1 **** ! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <!-- PCGen Documentation Project $Header$ $Author$ $Date$ $Revision$ Contributors: Shane Molnar - shaneATcliftonmotelDOTcomDOTau Eddy Anthony - eddybaATmindspringDOTcom Sigurdur H. Olafsson - shoATtnDOTis Description: Provides information on the use of PCGen Outputsheet Tokens. --> <head> <title>Weapon Output Sheet Tokens</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <link rel="stylesheet" type="text/css" href="../../pcgen.css" /> </head> <body> <h1>Weapon Output Sheet Tokens</h1> <p>The below Tokens control how weapon and weapon proficency information is presented in Output Sheets (OS).</p> <p></p><a name="WEAPON"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used (q):</strong> Text (Merge Type - Optional).</p> <ul class="indent2"> <li>MERGEALL - Causes all weapons with the same name to be merged - default behavior.</li> <li>MERGELOC - Causes all weapons with the same name and in the same location to be merged.</li> <li>MERGENONE - No weapons with the same name are merged.</li> </ul> <p class="indent1"><strong> Variables Used (r):</strong> Text (Weapon Status - Optional).</p> <ul class="indent2"> <li>CARRIED - Creates a 0-based index of carried or equipped weapons.</li> <li>EQUIPPED - Creates a 0-based index of equipped weapons.</li> <li>NOT_CARRIED - Creates a 0-based index of weapons that are not carried or equipped.</li> <li>NOT_EQUIPPED - Creates a 0-based index of weapons that are not equipped (although they may be carried).</li> </ul> <p class="indent1"><strong> Variables Used (s):</strong> Number - The weapons position in the character's weapon list - 0-based index</p> <p class="indent1"><strong> Variables Used (z):</strong> Text (The weapon property to be output).</p> <ul class="indent2"> <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc). <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc).</li> <li>BASEDAMAGE - The weapon's unadjusted damage (e.g. 1d8+3).</li> <li>BASEDAMAGEBONUS - The weapon's unadjusted damage bonus (e.g. +3).</li> <li>BASEHIT - The weapon's to hit containing most adjustments (no adjustment for two weapon fighting, even if weapons are equipped that way in the program).</li> <li>BASICDAMAGE - The weapon's damage including most adjustments (no adjustment for which hand or hands are wielding the weapon).</li> <li>BONUSDAMAGE - The weapon's bonus to damage (+1, etc.).</li> <li>CATEGORY - The weapons category, such as Mithril, Melee, Slashing, etc.</li> <li>CRIT - Weapon's Critical Range (ie 20 = 1, 19-20 = 2, 18-20 = 3, 17-20 = 4).</li> <li>DAMAGE - The amount of damage the weapon does.</li> <li>FEATHIT - Bonus to hit, based on feats.</li> <li>HAND - Hand that weapon is currently equipped in, Else none.</li> <li>HEFT - Returns LIGHT, MEDIUM or HEAVY, looking for weapon size and character size. If the weapon is smaller, then it is LIGHT.</li> <li>HIT - Weapon's modified bonus to hit, from character's total to hit bonus.</li> <li>ISTYPE - Weapon's Type, for detecting if it is a Double Weapon or not.</li> <li>LONGNAME - A more descriptive name.</li> <li>MAGICDAMAGE - Weapon's magical bonus to damage.</li> <li>MAGICHIT - Weapon's magical bonus to hit.</li> <li>MISC - Returns all miscellaneous to hit bonuses.</li> <li>MULT - Multiplier of Critical.</li> <li>NAME(.NOSTAR) - Weapon's name (which matches the entry from the WEAPONPROF.LST file). If .NOSTAR is appended, the asterisk indicating whether the weapon is equipped will be stripped from the output.</li> <li>NUMATTACKS - Displays the number of attacks the PC gets with the selected weapon.</li> <li>OHDAMAGE - Displays the damage done by an offhand attack with the selected weapon (e.g. 1d8+1).</li> <li>OHDAMAGEBONUS - Displays the damage bonus done by an offhand attack with the selected weapon (e.g. +1).</li> <li>RANGE - Range of weapon, in feet.</li> <li>RANGENOUNITS - Range of weapon, in feet (no ' indicator).</li> <li>RATEOFFIRE - Rate of fire of the weapon, displayed as listed in the LST files following the RATEOFFIRE tag.</li> <li>REACH - Reach of weapon, in feet.</li> <li>SIZE - Size of weapon.</li> <li>SIZEMOD - Returns the character size modifier.</li> <li>SPROP - Special Properties of weapon.</li> <li>TEMPLATE - Bonus to hit, from templates.</li> <li>THDAMAGE - Displays the damage done by a two-handed attack with the selected weapon (e.g. 2d6+4).</li> <li>THDAMAGEBONUS - Displays the damage bonus done by a two-handed attack with the selected weapon (e.g. +4).</li> <li>TOTALHIT.x - The weapon's adjusted to hit bonuses for all attacks, or for attack x if it is specified (0-based index).</li> <li>TWOHIT - The weapon's to hit bonuses if used in the off hand.</li> <li>TWPHITH - The weapon's to hit bonuses if used in the primary hand with a heavy weapon in the other hand.</li> <li>TWPHITL - The weapon's to hit bonuses if used in the primary hand with a light weapon in the other hand.</li> <li>TYPE - Type of damage the weapon does.</li> <li>WT - Weight of weapon in lbs.</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays various information about a character¥s weapons.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.SIZE</code></p> <p class="indent3">Displays the size of the first weapon.</p> <p></p><a name="WEAPON_RANGELIST"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.RANGELIST.n.u</p> <p class="indent1"><strong> Variables Used (q):</strong> Text (Merge Type - Optional).</p> <ul class="indent2"> <li>MERGEALL - Causes all weapons with the same name to be merged - default behavior.</li> <li>MERGELOC - Causes all weapons with the same name and in the same location to be merged.</li> <li>MERGENONE - No weapons with the same name are merged.</li> </ul> <p class="indent1"><strong> Variables Used (r):</strong> Text (Weapon Status - Optional).</p> <ul class="indent2"> <li>CARRIED - Creates a 0-based index of carried or equipped weapons.</li> <li>EQUIPPED - Creates a 0-based index of equipped weapons.</li> <li>NOT_CARRIED - Creates a 0-based index of weapons that are not carried or equipped.</li> <li>NOT_EQUIPPED - Creates a 0-based index of weapons that are not equipped (although they may be carried).</li> </ul> <p class="indent1"><strong> Variables Used (u):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays n-th range increment of the selected weapon.</li> <li>DAMAGE - Displays the damage for the n-th range increment of the selected weapon.</li> <li>TOTALHIT - Displays the complete hit progression for the n-th range increment of the selected weapon.</li> <li>TOTALHIT.x - Displays the x-th attacks to hit modifier for the n-th range increment of the selected weapon (0-based index).</li> </ul> <p class="indent1"><strong> Variables Used (z):</strong> Text (The weapon property to be output).</p> <ul class="indent2"> <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc). <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc).</li> <li>BASEDAMAGE - The weapon's unadjusted damage (e.g. 1d8+3).</li> <li>BASEDAMAGEBONUS - The weapon's unadjusted damage bonus (e.g. +3).</li> <li>BASEHIT - The weapon's to hit containing most adjustments (no adjustment for two weapon fighting, even if weapons are equipped that way in the program).</li> <li>BASICDAMAGE - The weapon's damage including most adjustments (no adjustment for which hand or hands are wielding the weapon).</li> <li>BONUSDAMAGE - The weapon's bonus to damage (+1, etc.).</li> <li>CATEGORY - The weapons category, such as Mithril, Melee, Slashing, etc.</li> <li>CRIT - Weapon's Critical Range (ie 20 = 1, 19-20 = 2, 18-20 = 3, 17-20 = 4).</li> <li>DAMAGE - The amount of damage the weapon does.</li> <li>FEATHIT - Bonus to hit, based on feats.</li> <li>HAND - Hand that weapon is currently equipped in, Else none.</li> <li>HEFT - Returns LIGHT, MEDIUM or HEAVY, looking for weapon size and character size. If the weapon is smaller, then it is LIGHT.</li> <li>HIT - Weapon's modified bonus to hit, from character's total to hit bonus.</li> <li>LONGNAME - A more descriptive name.</li> <li>MAGICDAMAGE - Weapon's magical bonus to damage.</li> <li>MAGICHIT - Weapon's magical bonus to hit.</li> <li>MISC - Returns all miscellaneous to hit bonuses.</li> <li>MULT - Multiplier of Critical.</li> <li>NAME(.NOSTAR) - Weapon's name (which matches the entry from the WEAPONPROF.LST file). If .NOSTAR is appended, the asterisk indicating whether the weapon is equipped will be stripped from the output.</li> <li>NUMATTACKS - Displays the number of attacks the PC gets with the selected weapon.</li> <li>OHDAMAGE - Displays the damage done by an offhand attack with the selected weapon (e.g. 1d8+1).</li> <li>OHDAMAGEBONUS - Displays the damage bonus done by an offhand attack with the selected weapon (e.g. +1).</li> <li>RANGE - Range of weapon, in feet.</li> <li>RANGENOUNITS - Range of weapon, in feet (no ' indicator).</li> <li>RATEOFFIRE - Rate of fire of the weapon, displayed as listed in the LST files following the RATEOFFIRE tag.</li> <li>REACH - Reach of weapon, in feet.</li> <li>SIZE - Size of weapon.</li> <li>SIZEMOD - Returns the character size modifier.</li> <li>SPROP - Special Properties of weapon.</li> <li>TEMPLATE - Bonus to hit, from templates.</li> <li>THDAMAGE - Displays the damage done by a two-handed attack with the selected weapon (e.g. 2d6+4).</li> <li>THDAMAGEBONUS - Displays the damage bonus done by a two-handed attack with the selected weapon (e.g. +4).</li> <li>TOTALHIT.x - The weapon's adjusted to hit bonuses for all attacks, or for attack x if it is specified (0-based index).</li> <li>TWOHIT - The weapon's to hit bonuses if used in the off hand.</li> <li>TWPHITH - The weapon's to hit bonuses if used in the primary hand with a heavy weapon in the other hand.</li> <li>TWPHITL - The weapon's to hit bonuses if used in the primary hand with a light weapon in the other hand.</li> <li>TYPE - Type of damage the weapon does.</li> <li>WT - Weight of weapon in lbs.</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays various attack information about a weapon depending on the range increment. The SHORTRANGE (as defined in the miscinfo.lst) is inserted into the range array if it is not already one of the weapon's standard increments.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.RANGELIST.0</code></p> <p class="indent3">Would display the damage for the the 1st range increment for the 1st weapon.</p> <p></p><a name="WEAPON_AMMUNITION"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.RANGELIST.n.u.AMMUNITION.v.w</p> <p class="indent0"><strong>Suntoken Name:</strong> AMMUNITION (Can only be used with RANGELIST)</p> <p class="indent1"><strong> Variables Used (v):</strong> Number (Displays the properties of the v-th ammunition that will fit the s-th selected weapon at the n-th range increment, 0-based index).</p> <p class="indent1"><strong> Variables Used (w):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays y-th range increment of the selected weapon.</li> <li>DAMAGE - Displays the damage for the y-th range increment of the selected weapon.</li> <li>SPROP - Displays the special properties for the y-th ammunition contained by the selected weapon.</li> <li>TOTALHIT - Displays the complete hit progression for the y-th range increment of the selected weapon.</li> <li>TOTALHITx - Displays the x-th attacks to hit modifier for the range increment of the selected weapon (0-based index).</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the ammunition types that will fit the selected weapon at the selected range increment.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.RANGELIST.0.AMMUNITION.0.DAMAGE</code></p> <p class="indent3">Displays the damage from the 1st type of compatible ammunition at point blank range for the 1st weapon.</p> <p></p><a name="WEAPON_CONTENTS"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.CONTENTS.v.w</p> <p class="indent0"><strong>Suntoken Name:</strong> CONTENTS</p> <p class="indent1"><strong> Variables Used (v):</strong> Number (Displays the properties of the v-th ammunition contained by the s-th selected weapon, 0-based index).</p> <p class="indent1"><strong> Variables Used (w):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays name of the v-th selected contents of the s-th selected weapon.</li> <li>QTY - Displays the number of the for the v-th ammunition contained by the s-th selected weapon.</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the contents the selected weapon.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.CONTENTS.0</code></p> <p class="indent3">Displays the name of the 1st type of contained ammunition.</p> <p></p><a name="WEAPON_RANGELIST_CONTENTS"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.RANGELIST.n.u.CONTENTS.v.w</p> <p class="indent0"><strong>Suntoken Name:</strong> CONTENTS</p> <p class="indent1"><strong> Variables Used (v):</strong> Number (Displays the properties of the v-th ammunition contained by the s-th selected weapon at the n-th range increment, 0-based index).</p> <p class="indent1"><strong> Variables Used (w):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays n-th range increment of the selected weapon.</li> <li>DAMAGE - Displays the damage for the n-th range increment of the selected weapon.</li> <li>SPROP - Displays the special properties for the n-th ammunition contained by the selected weapon.</li> <li>TOTALHIT - Displays the complete hit progression for the n-th range increment of the selected weapon.</li> <li>TOTALHITx - Displays the x-th attacks to hit modifier for the n-th range increment of the selected weapon (0-based index).</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the contents the selected weapon at the selected range increment.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.RANGELIST.0.CONTENTS.0.DAMAGE</code></p> <p class="indent3">Displays the damage from the 1st type of contained ammunition at point blank range fired by the 1st weapon.</p> <p></p><a name="WEAPONH"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPONH.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used:</strong> The same options available to the <a href="#WEAPON">WEAPON</a> token.</p> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the "Unarmed" Weapon.</p> <p></p><a name="WEAPONO"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPONO.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used:</strong> The same options available to the <a href="#WEAPON">WEAPON</a> token.</p> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the Weapon equipped to the off-hand.</p> <p></p><a name="WEAPONP"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPONP.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used:</strong> The same options available to the <a href="#WEAPON">WEAPON</a> token.</p> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the Weapon equipped to the primary hand.</p> <p></p><a name=WEAPONPROFS></a><hr> <p class=indent0><strong>Token Name:</strong> WEAPONPROFS</p> <p class=indent1><strong>What it does:</strong></p> <p class=indent2>Displays the characters weapon proficiencies.</p> <p class=indent1><strong>Example:</strong></p> <p class=indent2><code>WEAPONPROFS</code></p> <p class=indent3>Displays the characters weapon proficiencies.</p> <!-- <p class="cvsfooter">$Source$ ($Revision$) last updated $Date$ by $Author$</p> --> </body> </html> \ No newline at end of file --- 1 ---- ! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <!-- PCGen Documentation Project $Header$ $Author$ $Date$ $Revision$ Contributors: Shane Molnar - shaneATcliftonmotelDOTcomDOTau Eddy Anthony - eddybaATmindspringDOTcom Sigurdur H. Olafsson - shoATtnDOTis Description: Provides information on the use of PCGen Outputsheet Tokens. --> <head> <title>Weapon Output Sheet Tokens</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <link rel="stylesheet" type="text/css" href="../../pcgen.css" /> </head> <body> <h1>Weapon Output Sheet Tokens</h1> <p>The below Tokens control how weapon and weapon proficency information is presented in Output Sheets (OS).</p> <p></p><a name="WEAPON"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used (q):</strong> Text (Merge Type - Optional).</p> <ul class="indent2"> <li>MERGEALL - Causes all weapons with the same name to be merged - default behavior.</li> <li>MERGELOC - Causes all weapons with the same name and in the same location to be merged.</li> <li>MERGENONE - No weapons with the same name are merged.</li> </ul> <p class="indent1"><strong> Variables Used (r):</strong> Text (Weapon Status - Optional).</p> <ul class="indent2"> <li>CARRIED - Creates a 0-based index of carried or equipped weapons.</li> <li>EQUIPPED - Creates a 0-based index of equipped weapons.</li> <li>NOT_CARRIED - Creates a 0-based index of weapons that are not carried or equipped.</li> <li>NOT_EQUIPPED - Creates a 0-based index of weapons that are not equipped (although they may be carried).</li> </ul> <p class="indent1"><strong> Variables Used (s):</strong> Number - The weapons position in the character's weapon list - 0-based index</p> <p class="indent1"><strong> Variables Used (z):</strong> Text (The weapon property to be output).</p> <ul class="indent2"> <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc). <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc).</li> <li>BASEDAMAGE - The weapon's unadjusted damage (e.g. 1d8+3).</li> <li>BASEDAMAGEBONUS - The weapon's unadjusted damage bonus (e.g. +3).</li> <li>BASEHIT - The weapon's to hit containing most adjustments (no adjustment for two weapon fighting, even if weapons are equipped that way in the program).</li> <li>BASICDAMAGE - The weapon's damage including most adjustments (no adjustment for which hand or hands are wielding the weapon).</li> <li>BONUSDAMAGE - The weapon's bonus to damage (+1, etc.).</li> <li>CATEGORY - The weapons category, such as Mithril, Melee, Slashing, etc.</li> <li>CRIT - Weapon's Critical Range (ie 20 = 1, 19-20 = 2, 18-20 = 3, 17-20 = 4).</li> <li>DAMAGE - The amount of damage the weapon does.</li> <li>FEATHIT - Bonus to hit, based on feats.</li> <li>HAND - Hand that weapon is currently equipped in, Else none.</li> <li>HEFT - Returns LIGHT, MEDIUM or HEAVY, looking for weapon size and character size. If the weapon is smaller, then it is LIGHT.</li> <li>HIT - Weapon's modified bonus to hit, from character's total to hit bonus.</li> <li>ISTYPE - Weapon's Type, for detecting if it is a Double Weapon or not.</li> <li>LONGNAME - A more descriptive name.</li> <li>MAGICDAMAGE - Weapon's magical bonus to damage.</li> <li>MAGICHIT - Weapon's magical bonus to hit.</li> <li>MISC - Returns all miscellaneous to hit bonuses.</li> <li>MULT - Multiplier of Critical.</li> <li>NAME(.NOSTAR) - Weapon's name (which matches the entry from the WEAPONPROF.LST file). If .NOSTAR is appended, the asterisk indicating whether the weapon is equipped will be stripped from the output.</li> <li>NUMATTACKS - Displays the number of attacks the PC gets with the selected weapon.</li> <li>OHDAMAGE - Displays the damage done by an offhand attack with the selected weapon (e.g. 1d8+1).</li> <li>OHDAMAGEBONUS - Displays the damage bonus done by an offhand attack with the selected weapon (e.g. +1).</li> <li>RANGE - Range of weapon, in feet.</li> <li>RANGENOUNITS - Range of weapon, in feet (no ' indicator).</li> <li>RATEOFFIRE - Rate of fire of the weapon, displayed as listed in the LST files following the RATEOFFIRE tag.</li> <li>REACH - Reach of weapon, in feet.</li> <li>SIZE - Size of weapon.</li> <li>SIZEMOD - Returns the character size modifier.</li> <li>SPROP - Special Properties of weapon.</li> <li>TEMPLATE - Bonus to hit, from templates.</li> <li>THDAMAGE - Displays the damage done by a two-handed attack with the selected weapon (e.g. 2d6+4).</li> <li>THDAMAGEBONUS - Displays the damage bonus done by a two-handed attack with the selected weapon (e.g. +4).</li> <li>TOTALHIT.x - The weapon's adjusted to hit bonuses for all attacks, or for attack x if it is specified (0-based index).</li> <li>TWOHIT - The weapon's to hit bonuses if used in the off hand.</li> <li>TWPHITH - The weapon's to hit bonuses if used in the primary hand with a heavy weapon in the other hand.</li> <li>TWPHITL - The weapon's to hit bonuses if used in the primary hand with a light weapon in the other hand.</li> <li>TYPE - Type of damage the weapon does.</li> <li>WT - Weight of weapon in lbs.</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays various information about a character¥s weapons. Note: Use the WEAPON token with the RANGELIST option (see below) if you want ammunition bonuses included.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.SIZE</code></p> <p class="indent3">Displays the size of the first weapon.</p> <p></p><a name="WEAPON_RANGELIST"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.RANGELIST.n.u</p> <p class="indent1"><strong> Variables Used (q):</strong> Text (Merge Type - Optional).</p> <ul class="indent2"> <li>MERGEALL - Causes all weapons with the same name to be merged - default behavior.</li> <li>MERGELOC - Causes all weapons with the same name and in the same location to be merged.</li> <li>MERGENONE - No weapons with the same name are merged.</li> </ul> <p class="indent1"><strong> Variables Used (r):</strong> Text (Weapon Status - Optional).</p> <ul class="indent2"> <li>CARRIED - Creates a 0-based index of carried or equipped weapons.</li> <li>EQUIPPED - Creates a 0-based index of equipped weapons.</li> <li>NOT_CARRIED - Creates a 0-based index of weapons that are not carried or equipped.</li> <li>NOT_EQUIPPED - Creates a 0-based index of weapons that are not equipped (although they may be carried).</li> </ul> <p class="indent1"><strong> Variables Used (u):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays n-th range increment of the selected weapon.</li> <li>DAMAGE - Displays the damage for the n-th range increment of the selected weapon.</li> <li>TOTALHIT - Displays the complete hit progression for the n-th range increment of the selected weapon.</li> <li>TOTALHIT.x - Displays the x-th attacks to hit modifier for the n-th range increment of the selected weapon (0-based index).</li> </ul> <p class="indent1"><strong> Variables Used (z):</strong> Text (The weapon property to be output).</p> <ul class="indent2"> <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc). <li>ATTACKS - The number of attacks for weapon type (ie: 2 for double headed, etc).</li> <li>BASEDAMAGE - The weapon's unadjusted damage (e.g. 1d8+3).</li> <li>BASEDAMAGEBONUS - The weapon's unadjusted damage bonus (e.g. +3).</li> <li>BASEHIT - The weapon's to hit containing most adjustments (no adjustment for two weapon fighting, even if weapons are equipped that way in the program).</li> <li>BASICDAMAGE - The weapon's damage including most adjustments (no adjustment for which hand or hands are wielding the weapon).</li> <li>BONUSDAMAGE - The weapon's bonus to damage (+1, etc.).</li> <li>CATEGORY - The weapons category, such as Mithril, Melee, Slashing, etc.</li> <li>CRIT - Weapon's Critical Range (ie 20 = 1, 19-20 = 2, 18-20 = 3, 17-20 = 4).</li> <li>DAMAGE - The amount of damage the weapon does.</li> <li>FEATHIT - Bonus to hit, based on feats.</li> <li>HAND - Hand that weapon is currently equipped in, Else none.</li> <li>HEFT - Returns LIGHT, MEDIUM or HEAVY, looking for weapon size and character size. If the weapon is smaller, then it is LIGHT.</li> <li>HIT - Weapon's modified bonus to hit, from character's total to hit bonus.</li> <li>LONGNAME - A more descriptive name.</li> <li>MAGICDAMAGE - Weapon's magical bonus to damage.</li> <li>MAGICHIT - Weapon's magical bonus to hit.</li> <li>MISC - Returns all miscellaneous to hit bonuses.</li> <li>MULT - Multiplier of Critical.</li> <li>NAME(.NOSTAR) - Weapon's name (which matches the entry from the WEAPONPROF.LST file). If .NOSTAR is appended, the asterisk indicating whether the weapon is equipped will be stripped from the output.</li> <li>NUMATTACKS - Displays the number of attacks the PC gets with the selected weapon.</li> <li>OHDAMAGE - Displays the damage done by an offhand attack with the selected weapon (e.g. 1d8+1).</li> <li>OHDAMAGEBONUS - Displays the damage bonus done by an offhand attack with the selected weapon (e.g. +1).</li> <li>RANGE - Range of weapon, in feet.</li> <li>RANGENOUNITS - Range of weapon, in feet (no ' indicator).</li> <li>RATEOFFIRE - Rate of fire of the weapon, displayed as listed in the LST files following the RATEOFFIRE tag.</li> <li>REACH - Reach of weapon, in feet.</li> <li>SIZE - Size of weapon.</li> <li>SIZEMOD - Returns the character size modifier.</li> <li>SPROP - Special Properties of weapon.</li> <li>TEMPLATE - Bonus to hit, from templates.</li> <li>THDAMAGE - Displays the damage done by a two-handed attack with the selected weapon (e.g. 2d6+4).</li> <li>THDAMAGEBONUS - Displays the damage bonus done by a two-handed attack with the selected weapon (e.g. +4).</li> <li>TOTALHIT.x - The weapon's adjusted to hit bonuses for all attacks, or for attack x if it is specified (0-based index).</li> <li>TWOHIT - The weapon's to hit bonuses if used in the off hand.</li> <li>TWPHITH - The weapon's to hit bonuses if used in the primary hand with a heavy weapon in the other hand.</li> <li>TWPHITL - The weapon's to hit bonuses if used in the primary hand with a light weapon in the other hand.</li> <li>TYPE - Type of damage the weapon does.</li> <li>WT - Weight of weapon in lbs.</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays various attack information about a weapon depending on the range increment. The SHORTRANGE (as defined in the miscinfo.lst) is inserted into the range array if it is not already one of the weapon's standard increments.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.RANGELIST.0</code></p> <p class="indent3">Would display the damage for the the 1st range increment for the 1st weapon.</p> <p></p><a name="WEAPON_AMMUNITION"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.RANGELIST.n.u.AMMUNITION.v.w</p> <p class="indent0"><strong>Suntoken Name:</strong> AMMUNITION (Can only be used with RANGELIST)</p> <p class="indent1"><strong> Variables Used (v):</strong> Number (Displays the properties of the v-th ammunition that will fit the s-th selected weapon at the n-th range increment, 0-based index).</p> <p class="indent1"><strong> Variables Used (w):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays y-th range increment of the selected weapon.</li> <li>DAMAGE - Displays the damage for the y-th range increment of the selected weapon.</li> <li>SPROP - Displays the special properties for the y-th ammunition contained by the selected weapon.</li> <li>TOTALHIT - Displays the complete hit progression for the y-th range increment of the selected weapon.</li> <li>TOTALHITx - Displays the x-th attacks to hit modifier for the range increment of the selected weapon (0-based index).</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the ammunition types that will fit the selected weapon at the selected range increment.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.RANGELIST.0.AMMUNITION.0.DAMAGE</code></p> <p class="indent3">Displays the damage from the 1st type of compatible ammunition at point blank range for the 1st weapon.</p> <p></p><a name="WEAPON_CONTENTS"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.CONTENTS.v.w</p> <p class="indent0"><strong>Suntoken Name:</strong> CONTENTS</p> <p class="indent1"><strong> Variables Used (v):</strong> Number (Displays the properties of the v-th ammunition contained by the s-th selected weapon, 0-based index).</p> <p class="indent1"><strong> Variables Used (w):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays name of the v-th selected contents of the s-th selected weapon.</li> <li>QTY - Displays the number of the for the v-th ammunition contained by the s-th selected weapon.</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the contents the selected weapon.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.CONTENTS.0</code></p> <p class="indent3">Displays the name of the 1st type of contained ammunition.</p> <p></p><a name="WEAPON_RANGELIST_CONTENTS"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPON.[q.][r.]s.RANGELIST.n.u.CONTENTS.v.w</p> <p class="indent0"><strong>Suntoken Name:</strong> CONTENTS</p> <p class="indent1"><strong> Variables Used (v):</strong> Number (Displays the properties of the v-th ammunition contained by the s-th selected weapon at the n-th range increment, 0-based index).</p> <p class="indent1"><strong> Variables Used (w):</strong> Text (Weapon Property).</p> <ul class="indent2"> <li>None - Displays n-th range increment of the selected weapon.</li> <li>DAMAGE - Displays the damage for the n-th range increment of the selected weapon.</li> <li>SPROP - Displays the special properties for the n-th ammunition contained by the selected weapon.</li> <li>TOTALHIT - Displays the complete hit progression for the n-th range increment of the selected weapon.</li> <li>TOTALHITx - Displays the x-th attacks to hit modifier for the n-th range increment of the selected weapon (0-based index).</li> </ul> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the contents the selected weapon at the selected range increment.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>WEAPON.0.RANGELIST.0.CONTENTS.0.DAMAGE</code></p> <p class="indent3">Displays the damage from the 1st type of contained ammunition at point blank range fired by the 1st weapon.</p> <p></p><a name="WEAPONH"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPONH.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used:</strong> The same options available to the <a href="#WEAPON">WEAPON</a> token.</p> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the "Unarmed" Weapon.</p> <p></p><a name="WEAPONO"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPONO.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used:</strong> The same options available to the <a href="#WEAPON">WEAPON</a> token.</p> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the Weapon equipped to the off-hand.</p> <p></p><a name="WEAPONP"></a><hr> <p class="indent0"><strong>Token Name:</strong> WEAPONP.[q.][r.]s.z</p> <p class="indent1"><strong> Variables Used:</strong> The same options available to the <a href="#WEAPON">WEAPON</a> token.</p> <p class="indent1"><strong>What it does:</strong></p> <p class="indent2">Displays information about the Weapon equipped to the primary hand.</p> <p></p><a name=WEAPONPROFS></a><hr> <p class=indent0><strong>Token Name:</strong> WEAPONPROFS</p> <p class=indent1><strong>What it does:</strong></p> <p class=indent2>Displays the characters weapon proficiencies.</p> <p class=indent1><strong>Example:</strong></p> <p class=indent2><code>WEAPONPROFS</code></p> <p class=indent3>Displays the characters weapon proficiencies.</p> <!-- <p class="cvsfooter">$Source$ ($Revision$) last updated $Date$ by $Author$</p> --> </body> </html> \ No newline at end of file |