Difference between revisions of "New FREQ Example"
(New page: {| align="right" | __TOC__ |} =Template= TITLE: A _meaningful_ title, for example the LST syntax you are affecting, or the benefit to PCGEN you are providing BENEFIT FOR USER: Oft...) |
(→Template) |
||
| Line 5: | Line 5: | ||
=Template= | =Template= | ||
| − | TITLE | + | '''TITLE''' |
A _meaningful_ title, for example the LST syntax you are affecting, or the benefit to PCGEN you are providing | A _meaningful_ title, for example the LST syntax you are affecting, or the benefit to PCGEN you are providing | ||
| − | BENEFIT FOR USER | + | '''BENEFIT FOR USER''' |
Often our freqs are in code/lst speak, we also need to know, _what_ is this actually providing to the user of PCGEN | Often our freqs are in code/lst speak, we also need to know, _what_ is this actually providing to the user of PCGEN | ||
| − | LST SYNTAX | + | '''LST SYNTAX''' |
The complete LST Syntax if appropriate | The complete LST Syntax if appropriate | ||
| − | OS SYNTAX | + | '''OS SYNTAX''' |
The complete OS Syntax if appropriate | The complete OS Syntax if appropriate | ||
| − | DESCRIPTION | + | '''DESCRIPTION''' |
The rest | The rest | ||
| Line 27: | Line 27: | ||
==Example== | ==Example== | ||
| − | TITLE | + | '''TITLE''' |
Add BONUS:SPELL (Calculate spell range) | Add BONUS:SPELL (Calculate spell range) | ||
| − | BENEFIT FOR USER | + | '''BENEFIT FOR USER''' |
This freq will allow users to view the range of a spell they cast on an OS Sheet. It will calculate the range correctly using the appropriate caster levels. | This freq will allow users to view the range of a spell they cast on an OS Sheet. It will calculate the range correctly using the appropriate caster levels. | ||
| − | LST SYNTAX | + | '''LST SYNTAX''' |
BONUS:SPELL=name|RANGE|formula where formula could equal something like | BONUS:SPELL=name|RANGE|formula where formula could equal something like | ||
=5*CL+100 (where CL equals Class Level) | =5*CL+100 (where CL equals Class Level) | ||
| − | OS SYNTAX | + | '''OS SYNTAX''' |
SPELL.RANGE | SPELL.RANGE | ||
| − | DESCRIPTION | + | '''DESCRIPTION''' |
The Range could be evaluated - something like BONUS:SPELL=name|RANGE|formula for spell's range (something like 5*CL+100 since CL gets the class level). This would require adding RANGEEVAL to the SPELLMEM tokens, and for that token return getTotalBonusTo("SPELL="+aSpell.name()","RANGE",true) | The Range could be evaluated - something like BONUS:SPELL=name|RANGE|formula for spell's range (something like 5*CL+100 since CL gets the class level). This would require adding RANGEEVAL to the SPELLMEM tokens, and for that token return getTotalBonusTo("SPELL="+aSpell.name()","RANGE",true) | ||
Latest revision as of 15:30, 1 September 2008
Contents |
Template
TITLE
A _meaningful_ title, for example the LST syntax you are affecting, or the benefit to PCGEN you are providing
BENEFIT FOR USER
Often our freqs are in code/lst speak, we also need to know, _what_ is this actually providing to the user of PCGEN
LST SYNTAX
The complete LST Syntax if appropriate
OS SYNTAX
The complete OS Syntax if appropriate
DESCRIPTION
The rest
Example
TITLE
Add BONUS:SPELL (Calculate spell range)
BENEFIT FOR USER
This freq will allow users to view the range of a spell they cast on an OS Sheet. It will calculate the range correctly using the appropriate caster levels.
LST SYNTAX
BONUS:SPELL=name|RANGE|formula where formula could equal something like =5*CL+100 (where CL equals Class Level)
OS SYNTAX
SPELL.RANGE
DESCRIPTION
The Range could be evaluated - something like BONUS:SPELL=name|RANGE|formula for spell's range (something like 5*CL+100 since CL gets the class level). This would require adding RANGEEVAL to the SPELLMEM tokens, and for that token return getTotalBonusTo("SPELL="+aSpell.name()","RANGE",true)
