https://wiki.roll20.net/api.php?action=feedcontributions&user=92730&feedformat=atomRoll20 Wiki - User contributions [en]2024-03-29T15:23:15ZUser contributionsMediaWiki 1.20.3https://wiki.roll20.net/Pathfinder_Community_SheetPathfinder Community Sheet2018-07-15T04:13:54Z<p>92730: /* Instructions */</p>
<hr />
<div><br />
= Known issues =<br />
# /em or /fx may not work in a macro. '''Workaround:''' move them to end of macro, and place return character before the slash.<br />
<br />
= <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Intro</blockquote> =<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF Core.jpg|400px|thumbnail|Pathfinder Character Sheet]]<br />
<br />
<br />
:This Pathfinder's Character Sheet Guide is for the regular[https://app.roll20.net Roll20] Pathfinder Character sheet(neceros). The sheet was originally created by Sam M. ([https://app.roll20.net/users/63511/sam Sam on Roll20]). Thank you Sam for all your time and effort spent on creating this sheet. The Pathfinder character sheet tries to best accommodate the [http://paizo.com/pathfinderRPG/prd/ Pathfinder rules as written(RAW)] while macro fields to allow for house rule customization have been provided. The sheet auto-calculates many attributes utilizing [[Sheet_Worker_Scripts|sheet worker]] javascript for, Ability scores, Buffs, Conditions, Skills, HP max, Saves, Attack/Damage modifiers, etc., and is actively supported by Roll20 '''volunteers'''. Please feel free to lend your support through, feedback, testing, suggestions, coding, and keeping this guide updated and helpful.<br />
<br />
::'''Please post questions, comments, suggestions, etc. on the most current Pathfinder Character Sheet forum;'''<br />
<br />
::[https://app.roll20.net/forum/post/4735667/pf-pathfinder-sheet-thread-6<nowiki>[PF]</nowiki> Pathfinder Sheet Thread 6]<br />
<br />
:The latest community version of the sheet can be found on GitHub, [https://github.com/Roll20/roll20-character-sheets/tree/master/Pathfinder-Neceros Pathfinder-Neceros] If you are using the community Pathfinder sheet, any updates to the sheet will be pushed automatically.<br />
<br />
=== Sheet Information ===<br />
<br />
:The Pathfinder character sheet meets all requirements of the standard character sheet while adding features unique to Roll20. Much of the sheet is '''auto-calculated''' utilizing [[Sheet_Worker_Scripts|sheet worker]] (javascript), saving player's and GM's valuable time when creating, leveling, or modifying a character or NPC. A tabbed interface combined with optional "show/hide" sub-sections allow for a more manageable sheet. '''Sheet rolls''' ("built-in" macros) can be rolled directly from the sheet, activated by the roll's name using a macro, or dragging a button to the macro quick bar. [http://i.imgur.com/BnV7XVK.gif See animated demo.] All attributes and sheet rolls are easily determined with a quick '''mouse-over'''. Chat menu buttons are included to handle all the most import rolls needed from chat without having to scour the sheet to locate a roll. <br />
<br />
:Many areas of the sheet use repeatable sections for maximum flexibility. ie Attacks, Abilities, Equipment, Spells, etc. Most sections of the sheet make allowances for the multitude of rules options available for Pathfinder. Additional features and sheet customization's can be enabled using the [[Pathfinder_Character_Sheet#Sheet Configuration|Settings]] page. Pathfinder Unchained, Mythic Adventures, and Ultimate Psionics, while limited in scope, are optionally supported. <br />
<br />
:Finally, while the sheet has a page specifically for NPC's (to enable; check "Is NPC or Monster" from the Settings page), there are many overlapping attributes and sections that co-exist with the PC section of the sheet. You may enter data in either section.<br />
<br />
:Detailed explanation and instructions can be found using the guide below.<br />
<br />
</div></div><br />
<br clear=all><br />
<br />
= <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">FAQ</blockquote> =<br />
<div class="toccolours mw-collapsible"><br />
<br />
<div class="mw-collapsible-content"><br />
'''Q: Why don't I see the latest sheet changes/updates or features in my macros?'''<br />
:'''A''': The particular macro may have been customized. First try hitting the Recalc <span style="font-family:pictos; vertical-align: top;"> 1 </span> button to see if that fixes the macro. If not, <br />
:# check '''⛭ Settings(Sheet configuration)|Advanced|Display roll templates for customization''', <br />
:# then go back to the row and click on the "macro-text" arrow. This exposes the macro for this attack/spell/whatever row. <br />
:# Copy the macro to a text editor to save your customizations. <br />
:# Delete the macro on the sheet and tab/click on another field. After a few seconds the macro will be replaced with the latest default version. <br />
:# Finally, add your changes back to the macro. For attacks you may need to repeat this for the iterative macros.<br />
<br />
<br />
'''Q: Why does the token ability I created linked to a menu not work?'''<br />
:'''A''': To create token abilities: you must use a ''different name'' for the token ability than the button name the ability calls. Such as add an underscore before the name. If you use the same name, then technically there will be two abilities with the same name and it will not work correctly half the time. The Pathfinder API Companion will create token abilities for you to avoid this issue.<br />
<br />
<br />
'''Q: Where is the rest of the sheet? All I see is the sheet configuration page...'''[[File:Pf mode recalc settings.png|thumbnail|Pathfinder: Important Buttons]]<br />
:'''A''': New sheets open to the settings/configuration page by default to encourage users to look over the options that are available. Use the <div style="display: inline-block;position: relative;top: 12px;">[[File:PF settings.png|35px]]</div> '''Settings''' button(located at the top of the sheet, between the logo and character name) to toggle between the sheet and settings.<br />
<br />
<br />
'''Q: Where did the macro-text, user-defined, extra damage, etc. fields go?'''[[File:PF Nav Probs.png|150px|thumbnail|right|More to consider...]]<br />
:'''A''': More advanced areas of the sheet are hidden by default.<br />
:*Make sure you are in <div style="display: inline-block;position: relative;top: 8px;">[[File:PF mode.png|35px]]</div>"Expanded/edit Mode". <br />
:*Ensure full macro-text(editable roll template fields for button rolls) are seen by checking '''⛭ Settings(Sheet configuration)|Advanced|Display roll templates for customization'''. You can also show other advanced fields such as "real-time" macro-text and user-defined fields from this area. <br />
:*Some sections also include a '''<span style="color:#c00;">Show more fields</span>''' option that can toggle the advanced fields locally.<br />
<br />
<br />
'''Q: I still can't see certain fields or sections...'''<br />
:'''A''':You may be in <div style="display: inline-block;position: relative;top: 8px;">[[File:PF mode.png|35px]]</div> '''Compact Mode'''. There are two modes now: Compact and Expanded. In Compact mode many fields are hidden to offer a simplified view. Switch to Expanded mode to expose all editable fields as per the sheet's Settings.<br />
<br />
<br />
'''Q: My hit points are too high, where are the extra hit points coming from?'''<br />
:'''A''': Go to the Core Page, '''Class, Race, and Experience''' section, check '''Add Race/Monster HD''', you may see monster hit points filled in. Delete them, then uncheck '''Add Race/Monster HD''' ('''Note:''' any values found in the '''Race/Monster HD''' section will affect HP calculations even if the section is unchecked(hidden).) This should be fixed in version 1.18 and later. If there are still mystery hit points, switch to Expanded mode, expand all rows on the class grid, check your 'Drain' setting, and (if mythic is enabled) check mythic hit points.<br />
<br />
<br />
'''Q: How do I use the compendium to drag and drop monster/npc's?'''<br />
[[File:PF monster parser.png|400px|thumbnail|Pathfinder: Monster statblock import]]<br />
:'''A''': Drag and drop will not work if you are using Popped out character sheets. Check your games settings from the sidebar. You can access the "Monster statblock input section" by checking '''⛭ Settings|Sheet Configuration|Pages|Is NPC or monster'''. This will make the NPC page/tab view-able. Close Settings and go to the NPC tab/page. The parse feature is near the top of the NPC page. Expand/Open the "Monster statblock input section". Drag and drop a monster's '''name''' from the compendium bestiary from the sidebar. After the statblock has been input, you can review values and make adjustments if needed(normally only necessary if you experience any issues after attempting an import). [http://i.imgur.com/5e4zqw1.gif See animated demo.] Once you are satisfied with the values, use the "Parse" button to migrate the statblock to the Pathfinder sheet. ('''note:''' the parsing process can take some time depending on the complexity of the statblock. If you attempt to drag/drop from the compendium over the top of a previous import, duplication of values will result and cause issues. '''ONLY PARSE ONCE'''.)<br />
<br />
<br />
'''Q: I'm having difficulty manually entering stat-block values into the NPC page. Fields are either read-only or are completely missing.'''<br />
:'''A''': There are many fields/attributes shared across the PC and NPC sections of the sheet. If you cannot find or edit an attribute on the NPC page, try looking in the relevant PC section.<br />
<br />
<br />
'''Q: Why does it say my Dexterity is penalized?'''<br />
:'''A''': Check other conditions, some penalize or limit dexterity to AC. Next check the max dex of armor worn. Finally check the encumbrance on the Equip tab. Medium or heavier armor carries penalties besides Max Dex. Another place to check is carried currency, this adds to weight carried. If currency should not contribute to weight enter it in the Other/Non carried Currency fields. To ignore encumbrance use the Encumbrance dropdown on the Settings page.<br />
<br />
<br />
'''Q: Can I set sheet values from a macro?'''<br />
:'''A''': No, you must be a Pro member and use the API to set sheet or token values from macros. If a token bar is mapped to an attribute, setting the token will update the sheet, but it will not call any custom sheet code and update secondary fields. <br />
<br />
<br />
'''Q: I think I found something wrong with the sheet, but how can I check if it's a known problem?'''<br />
:'''A''': Go to the '''[https://app.roll20.net/forum/permalink/4735667/ Pathfinder Page Status and Known Issue post]''' first to see if your issue is already being worked on. If you don't see it, follow the instructions in the next question:<br />
<br />
<br />
'''Q: I found a bug, have a question, suggestion, need help, etc. regarding the Pathfinder Character Sheet. What should I do?'''<br />
:'''A''': The best resource regarding the sheet is to post to the '''[https://app.roll20.net/forum/post/4735667/pf-pathfinder-sheet-thread-6<nowiki>[PF]</nowiki> Pathfinder Sheet Thread 6]''' within Roll20's [https://app.roll20.net/forum/category/277980 Character Sheets] forum. Please include as much detail as possible to help isolate the bug to expedite a fix.<br />
<br />
<br />
'''Q: Why can't I adjust some of the fields on the sheet?'''<br />
:'''A''': There are many auto-calculated attributes found on the sheet and are depicted as number fields with a gray background. In these cases you can only adjust the fields that are used to calculate the gray background value. For instance, you can edit base strength, and any enhancement to it. The final strength score (after enhancements and negative conditions) and strength modifier are calculated for you.<br />
<br />
<br />
'''Q: How will users of the Pathfinder sheet know when the sheet is updated?'''<br />
:'''A''': You can always check the bottom of the character sheet to see the latest build date and to check for announcements of upcoming changes. Updates to the sheet will be pushed automatically. <br />
<br />
<br />
'''Q: When I roll initiative, I'm getting this weird result with decimals. What's that about?'''<br />
:'''A''': The decimal portion of the result is just the initiative modifier included as a tiebreaker.<br />
<br />
<br />
'''Q: How do I make a (class ability, attack, feat, spell, inventory item, racial trait, trait) macro using a sheet roll?'''<br />
:'''A''': Create a Macro/Ability that includes a button's name ie <code>%{selected|button_name}</code>. If you mouse-over the buttons it shows you what the button's name is. e.g.(To create a macro for weapon attack 0, include <code>%{selected|repeating_weapon_$0_Attack}</code> within your macro.) You can also drag and drop any repeating section/row button to the macro quick bar.<br />
<br />
<br />
'''Q: I edited a macro with <code>[[1d6]]</code> and it doesn't work, why?'''<br />
:'''A''': Macro fields with an (a) superscript on the title that evaluate to numbers, such as for buffs, weapon damage bonus are almost like macros but not quite. Rolls are not allowed.<br />
<br />
<br />
'''Q: A macro field has a red dashed outline, why?'''<br />
:'''A''': If a macro fields with an (a) superscript has a red dashed outline, that means the text entered cannot be parsed into a number, usually due to a syntax error. When the problem is corrected the red outline will disappear, and the grey background number next to it will populate with the correct value.<br />
<br />
<br />
'''Q: My feat/weapon/spell is outlined with a message to delete it, why?'''<br />
:'''A''': This means the row has a bug internal to Roll20 and must be deleted. You must delete all rows with this outline before adding new rows back or you may experience indeterminate results.<br />
<br />
<br />
'''Q: How do I setup an animal companion or cohort or regularly summoned creature?'''<br />
:'''A''': Create a new character in the campaign, and use a new sheet to record stats for your animal companion. You may find it easier to use the "NPC" tab which has a a small subset of all fields.<br />
<br />
<br />
'''Q: What can I do if my sheet isn't updating some or all of the attributes?'''<br />
:'''A''': Make sure you have entered the appropriate data. While the sheet does it's best to parse each field to allow only field appropriate data, illegal characters, malformed formula, etc. can cause the sheet to stop functioning. Try clearing the problematic field(s) or using "0" to see if that fixes the issue. Toggling selectors, entering a new/different value in a field, etc. can also help trigger auto-calculation. Finally, try using the '''Recalc''' '''Bold text'''<span style="font-family:pictos; vertical-align: top;"> 1 </span> button at the top of the sheet to force a sheet-wide re-calculation. Please report any persistent issues to the Pathfinder thread. <br />
<br />
<br />
'''Q: What would keep my spell buttons from showing up in chat when I hit the sheet button SPELLBOOK?'''<br />
:'''A''': 1. On top, make sure you have caster level filled in (the editable field has to be > 0) 2. Make sure you have an ability selected in the dropdown for caster ability (WIS) 3. Make sure the spells have spell level filled in for each one. 4. Keep "show only prepared" unchecked for now. (limits it to only rows where you have the "uses" > 0 on the left ) If the above are true: then hit the '''Recalc''' <span style="font-family:pictos; vertical-align: top;"> 1 </span> button at the upper right. (looks like circular arrow)<br />
<br />
'''Q: How do I setup a Kineticist?'''<br />
# Check '''Settings | Rule Options | Use Kineticist Burn''' to display Kineticist section of Abilities page.<br />
# On the Abilities page in the Kineticist section, choose the appropriate class from the dropdown.<br />
# Choose the appropriate ability score for kinetic powers.<br />
# Check ''Use Buff bonus types and stacking'' on '''Settings'''<br />
# Choose''Elemental Overload'' as a buff from the '''Common Buffs''' dropdown and add it to buffs, then check it to enable it. It will automatically add bonuses as your burn score increases.<br />
<br />
<br />
'''Q: How do I setup a Kinetic Blast?'''<br />
# Pick the type of attack (ranged for normal blast, or melee for Kinetic Blade or Whip)<br />
# Pick 'Kinetic' for base blast, or Composite.<br />
# Pick Energy or Physical damage type<br />
# Check Devastating Infusion if applicable (only valid for Melee and Physical)<br />
# Click on ''Create Macros''<br />
# Verify macros are correct for your character. ''Elemental Overload'' buff will apply to all attacks, and to ranged damage. Make any adjustments necessary.<br />
# Click on ''Create Attack'' a row in the Attacks page will be entered. The macros are copied to the 'extra damage' and 'attack' bonus fields of the attack.<br />
# You can now change dropdowns or macros to create another attack.<br />
# If you want to use Alt Melee and Alt Ranged, then you can instead add the macros to a new buff row that adds to Alt Melee attack and Alt Ranged attack. You will need to delete the macro from the 'Attack' field on the attack row generated (so it is not duplicated) and change the dropdown to the 'Alt' version. Damage bonuses would still need to be kept per attack row, because they will change depending on type of damage.<br />
<br />
</div></div><br />
<br clear=all><br />
<br />
= Sheet =<br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Header</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<br />
<div class="mw-collapsible-content"><br />
<br clear=all><br />
=== At-A-Glance Information ===<br />
[[File:PF_Header.JPG|300px|thumbnail|Pathfinder Header]]<br />
:*PC sheet: '''Character Name''', '''Player Name''', '''Class'''(class 0), '''Level'''(total of all classes)<br />
<br />
:*NPC sheet: '''Character Name'''(monster or NPC name), '''Type(sub-type)''', '''CR''', and '''#HD'''<br />
<br />
=== Sheet Announcements ===<br />
: The Pathfinder sheet includes an Announcements section at the top of the sheet. Read about upcoming changes and important information about the sheet.<br />
<br />
=== Important Edit Mode and Settings Buttons ===<br />
<br />
==== Mode ====<br />
[[File:PF mode.png|35px]] '''Mode''': toggle the sheet between '''Expanded mode'''(full editing) or '''Compact mode'''(important fields only).<br />
:* Expanded Mode: expanded shows all editable fields based on the sheet's Settings/Configuration options.<br />
:* Compact Mode: compact mode is a simplified version of the sheet that tried to show only the most import fields. This may be a better option when you do not need to edit your sheet.<br />
<br />
==== Recalc ====<br />
[[File:PF recalc.png|35px]] '''Recalc''': used to force all fields handled by sheetworkers(javascript) to perform a "refresh" of calculations. If you find that the sheet does not seem to be functioning properly (not calculating fields), try using the '''Recalc''' button to solve the problem.<br />
<br />
==== Settings ====<br />
[[File:PF settings.png|35px]] '''Settings''': toggle the sheet between the [[Pathfinder_Character_Sheet#Settings_2|Settings/Configuration]] page(which is the default when opening a new sheet) and the fully editable character sheet.<br />
<br />
=== Buffs ===<br />
:New Buffs are enabled on the Settings page at '''(⛭ Settings|Sheet Configuration|Buffs|Use buff bonus types and stacking)'''. These new buffs implement the Pathfinder stacking rules, and also take into account existing fields on the sheet. Any "misc" fields on the sheet are considered Untyped. [[File:PF_NewBuffs.png|250px|thumbnail|New Buffs]]<br />
[[File:PF_WillWNote.png|150px|thumbnail|Roll with Buff Note]]<br />
<br />
:The possible values are:<br />
<br />
:* Enabled: to turn the buff on or off<br />
:* Name: the name you wish to give this<br />
:* Type: Dropdown determines which tab to place the buff under. This has no consequence to the sheet, it is for your organization purposes.<br />
:* Add note to roll: Select a roll type to add a conditional note (the note at the bottom of this buff row) to the roll when the buff is enabled. This allows you to note additions for certain circumstances, such as a morale buff to saves vs fear, instead of adding the bonus to all saves.<br />
:* Buff 1, Buff 2... Buff 6: Enable up to 6 buffs for this row.<br />
:* Bonus: the attribute that is affected by the buff.<br />
:* Bonus type: the bonus type (Morale, Insight, Competence, etc)<br />
:* Buff calc: the 'evaluate at edit-time' bonus calculation.<br />
:* Buff (readonly): the value of the buff.<br />
<br />
==== Copy / merge old buffs ====<br />
To copy old buffs:[[File:PF_buffMerge.png|250px|thumbnail|copy old buffs]] to the new buff list.<br />
<br />
# Enable '''Buff Types And Stacking''' on the Settings page.<br />
# Click the '''Merge''' button to copy old buffs to new buffs.<br />
# Verify the buff totals and rows are correct.<br />
# Click the '''trashcan''' next to the '''Merge''' button to delete old buffs. Press '''confirm''' to delete.<br />
<br />
'''YOU DO NOT HAVE TO DELETE OLD BUFFS RIGHT AWAY''' you can take time verifying the new buffs work. As long as ''Use Buff types and stacking'' is checked the old buffs will not affect calculations.<br />
<br />
==== Stacking and Buffs ====<br />
When using the new Buff system, the following rules will apply.<br />
:* Always Stack: Dodge bonus to AC, Circumstance bonus to any, temporary hit points (no bonus type), Untyped to any<br />
:* Never Stack: Size bonus (no bonus type), non-Enhancement bonus to Armor/Shield/Natural Armor<br />
:* Stacking with ''sheet fields'': Some bonus types are already on the sheet. The Buffs will take the max value of these, and ''only the remainder will be printed at the top''. e.g. if you have a 2 in STR-enh, and you apply a 4 Enhancement bonus to Strength in the buffs, the buff_STR-total field will only show a 2. This is so the sheet can add the 2 fields together to get 4, which is the max of the 2 on the sheet and the 4 in the buff rows.<br />
:* Misc fields on sheet: always treated as untyped, so will always stack.<br />
:* Custom: apply to custom fields on the Custom tab<br />
<br />
==== Armor, Shield, Natural Armor rules ====<br />
Armor Shield, Natural Armor are available as types of buffs, not bonus types. So instead of "Armor to AC", you will enter "Untyped to Armor" to add an Armor bonus to AC, or "Enhancement to Armor". (Anything ''bonus type'' that is not ''Enhancement'' will be treated as "Armor to AC" and the type ignored.) <br />
<br />
The same rules apply to Shield and Natural Armor. this was done to avoid having "Armor", "Shield", and "Natural Armor" appear in both dropdowns<br />
<br />
==== Parent bonuses ====<br />
The bonuses on the left below are 'parent' bonuses. A bonus to one is applied to all the bonuses on the right. If you have an additional bonus that is from the right, it will not stack, but instead the highest of the parent and child bonuses will be used. (For instance, a bonus to AC will be added to CMD. If you have an additional bonus to CMD only the highest will be applied).<br />
:* '''AC:''' (Touch,Flat-Footed,CMD)<br />
:* '''Attack:''' (Melee Attack,Ranged Attack,CMB)<br />
:* '''Saves:''' (Fort,Reflex,Will)<br />
:* '''Skill &amp; Ability Checks:''' (Skill Checks,'Ability Checks)<br />
:* '''Skill Checks:''' (<any ability>-based Skills)<br />
:* '''Melee Attack:''' (Alt Melee Attack) 'Melee attack' applies to both the main and Alt Melee attacks<br />
:* '''Ranged Attack:''' (Alt Ranged Attack) 'Ranged attack' applies to both the main and Alt Ranged attacks<br />
:* '''CMB:''' (Alt CMB Attack) 'CMB' applies to both the main and Alt CMB attacks<br />
<br />
==== Attack and damage bonuses ====<br />
Attack bonus and Damage bonus apply to ALL attacks.<br />
Melee attack bonus only applies to melee attacks, this is IN ADDITION to the Attack bonus above.<br />
Ranged attack bonus is similar, both Ranged bonus and base Attack bonus are added.<br />
<br />
<br />
Damage bonuses are the same: damage bonus applies to all attacks. Melee damage bonus applies only to melee damage, and is ADDED to the base damage bonus buff (so melee attack damage adds both buffs to the damage roll)<br />
<br />
Melee applies to both the main Melee and "Alternate Melee" attacks. So Melee is a parent of Alt Melee.<br />
Similarly, Ranged applies to both Ranged and Alt Ranged, and CMB applies to CMB and Alt CMB.<br />
<br />
==== Set Buffs via API ====<br />
:'''NOTE:''' The new buffs have a different naming convention than the old buffs. To convert macros:<br />
# Change "repeating_buff" to "repeating_buff2" and <br />
# remove the "buff-" after the row id.<br />
:For example using the [[Script:ChatSetAttr|ChatSetAttr]] script you can enter:<br />
<br />
:<pre>!setattr --sel --repeating_buff2_$0_enable_toggle|[[1-@{selected|repeating_buff2_$0_enable_toggle}]]</pre><br />
<br />
=== Old Buffs ===<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Buffs.JPG|250px|thumbnail|Pathfinder: Buffs Array]]<br />
:The Buffs section allows users to add modifiers that can be easily toggled on/off for use during play. The total buff for any given attribute is applied sheet-wide where applicable and will be seen as "Buffs" when active. Stacking rules will apply if enabled; go to '''(⛭ Settings|Sheet Configuration|Buffs|Use buff bonus types and stacking)''' Currently only a BETA option.<br />
<br />
:To add a new buff, click the Add button. You can give it a memorable name (such as Bull's Strength, Rage, Bard's Song, etc). From the the Select Buffs sub-section, click the checkbox next to each attribute affected by the buff. Enter the bonuses in the input fields included above. These fields can include macro-text so that you can use other attributes and calculations in determining the value. <nowiki>(⒜ Evaluated at edit time, must evaluate to number No queries Extended Expressions allowed)</nowiki> Bonuses will be added to the attribute selected when the buff is enabled.<br />
<br />
:Buffs(conditions) that negatively affect abilities will be reflected on the "Debuff" column of the Abilities section.<br />
<br />
:Buffs that are enabled will be added to the Buffs status panel to quickly identify which buffs are in effect. Do not forget to disable buffs once they no longer apply.<br />
<br />
==== Buffs Available ====<br />
:* Abilities: ( '''Ability Checks''' '''STR''', '''DEX''', '''CON''', '''INT''', '''WIS''', '''CHA''' )<br />
:* Skills: ( '''Skill Checks''' '''STR skills''', '''DEX skills''', '''CON skills''', '''INT skills''', '''WIS skills''', '''CHA skills''' )<br />
:* Attacks: ( '''Melee''', '''Ranged''', '''CMB only''', '''Melee dmg''', '''Ranged dmg''' )<br />
:* Defenses: ( '''AC''', '''Touch''', '''FF AC''', '''CMD''', '''Armor''', '''Shield''', '''Nat AC''', '''Deflection''', '''Dodge''' )<br />
:* Other: ( '''Temp HP''', '''Fort''', '''Ref''', '''Will''', '''Init''', '''Size''', '''Speed''', '''Caster Level''', )<br />
<br />
==== Set Buffs via API ====<br />
:'''NOTE:''' Buffs can only be enabled directly from the sheet or through an API script. <br />
:For example using the [[Script:ChatSetAttr|ChatSetAttr]] script you can enter:<br />
<br />
:<pre>!setattr --sel --repeating_buff_$0_buff-enable_toggle|[[1-@{selected|repeating_buff_$0_buff-enable_toggle}]]</pre><br />
</div></div><br />
<br />
=== Conditions ===<br />
[[File:PF_Conditions.PNG|250px|thumbnail|Pathfinder: Conditions]]<br />
:You can toggle some of the most common Conditions found in Pathfinder from within this area. (note: not all Conditions used in Pathfinder are found here. Some conditions have no effect on the character sheet, but are included to indicate a condition exists.) <br />
<br />
:There are 17 available Conditions utilized on the sheet that will make the appropriate changes to attributes '''sheet-wide'''. <br />
<br />
:As conditions are applied, their name will be added to the Conditions field to quickly identify which conditions are in effect. Do not forget to disable the conditions once they no longer apply.<br />
<br />
==== Base Conditions Available ====<br />
:These conditions affect sheet calculations (or were present before version 1.6)<br />
:Blinded, Cowering, Dazed*, Dazzled, Deafened, Energy Drain, Entangled, Exhausted, Fascinated, Fatigued, Fear (use for Shaken, Frightened, or Panicked), Flat-footed, Grappled, Helpless, Invisible, Nauseated*, Pinned, Prone, Sickened, Stunned, Unconscious*<br />
<br />
:<nowiki>*</nowiki> These also have no numeric effects, but are considered base because they contain text that is added to some rolls (such as attacks or saves).<br />
<br />
==== Extra Conditions Available ====<br />
:Press '''SHOW ALL CONDITIONS''' to display all conditions available. The below extra conditions can be used to track character state, but do not have effects on the character sheet stats.<br />
:Bleed, Dead, Disabled, Drowning, Dying, Incorporeal, Paralyzed, Petrified, Stable, Suffocating<br />
<br />
=== Menu Buttons ===<br />
[[File:Pf attackbook_chat.png|145px|thumbnail|left|Attacks Menu]]<br />
[[File:PF_Buttons.JPG|250px|thumbnail|Pathfinder: Menu Buttons]]<br />
: Clicking on an appropriate button will send a "menu" of choices to chat. Make sheet-based rolls by clicking on a menu item from chat. Drag and drop menu buttons to the quickbar or use the button's name from within another macro.<br />
<br />
: Included menu buttons: Ability Checks, INIT, Defenses, Attacks, Abilities, Combat Skills, All Skills(if Unchained skills are enabled, you will also see Adventures, Background, or Consolidated), Spellbooks for each spell casting class, and Items<br />
<br />
:'''Sheet rolls''' for menu buttons: <code>%{selected|allmenus}</code>, <code>%{selected|ability_checks}</code>, <code>%{selected|Roll-for-initiative}</code>, <code>%{selected|defenses}</code>, <code>%{selected|attacks}</code>, <code>%{selected|abilities}</code>, <code>%{selected|combat_skills}</code>, <code>%{selected|skills}</code>, <code>%{selected|adventures_skills}</code>, <code>%{selected|background_skills}</code>, <code>%{selected|consolidated_skills}</code>, <code>%{selected|spellbook-0}</code>, <code>%{selected|spellbook-1}</code>, <code>%{selected|spellbook-2}</code><br />
<br />
:'''NPC rolls''' for NPC whisper: the same as above, but add "NPC-" after "selected|"<br />
:'''To create token abilities''': you must use a '''different''' name for the token ability than the button name above. Such as add an underscore before the name. Otherwise pressing the token will only work half the time. The ''Pathfinder API Companion'' will create them for you.<br />
<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Core</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF Core.jpg|300px|thumbnail|Pathfinder Core]]<br />
<br />
=== Character Details ===<br />
:Use this section to give the details and description of your character. '''Title/Nickname''', '''Race''', '''Type(sub-type)''', '''Alignment''', '''Gender''', '''Default Size''', '''Size''' (this will determine modifiers/penalties for other attributes), '''Mod''' (attack and AC modifier due to size), '''Skill''' (skill modifier due to size), '''Quad''' (non-bipedal. Used to determine encumbrance), '''Age''','''Height''', '''Weight''', '''Eyes''', '''Hair''', '''Skin''', '''Deity''', '''Homeland''', '''Occupation''', '''Vision/Senses''', '''Languages''', '''Description'''. You can also use the [[Journal|Bio & Info]] tab of the character journal to elaborate on your character further. <br />
:'''(Note:''' Many of these fields will "stretch" to fit their content.)<br />
<br />
=== Ability Scores ===<br />
:These are your character's basic [http://paizo.com/pathfinderRPG/prd/gettingStarted.html#the-abilities Ability Scores] ('''STR, DEX, CON, INT, WIS, CHA''') and are integral to nearly all calculations used in the Pathfinder character sheet. The '''Base''' column is used for your ability score, while the additional columns are used as situational modifiers that will effect your Total Ability score. Buffs/Debuffs and Conditions are applied automatically when enabled from the Conditions and/or Buffs sections from the top of the sheet. If "Display roll templates for customization" is enabled from '''⛭ Settings|Sheet Configuration|Advanced''' section, the final column of the ability grid exposes each ability roll's macro-text for customization.<br />
<br />
::'''Modifiers:''' ( Inherent, Enhancement, Miscellaneous, Buffs )<br />
::'''Penalties:''' ( Damage, Penalty, Drain, Debuff, Condition )<br />
<br />
:'''Sheet rolls''' for the Ability Scores: <code>%{selection|STR-Check}, %{selection|DEX-Check}, %{selection|CON-Check}, %{selection|INT-Check}, %{selection|WIS-Check}, %{selection|CHA-Check}</code><br />
<br />
=== Class Information ===<br />
:Here you can enter character class information. The Pathfinder sheet provides for up to six (0-5) separate classes. Click the navigational arrow along the left margin to expand additional rows for multi-class characters. <br />
<br />
Like the [[Pathfinder_Character_Sheet#Character_Ability_Scores|Character Ability Scores]] section above, it is important that you fill-in the class information correctly since it will be used to auto-calculate other areas of the character sheet. <br />
<br />
:'''FC''' is [http://paizo.com/pathfinderRPG/prd/classes.html#favored-class Favored Class] and it is used for either '''FC HP''' or '''FC Skill'''. While '''Skills/lvl''', Racial Modifiers e.g.(Skilled: Humans gain an additional skill rank at first level and one additional rank whenever they gain a level.) can be added on the [[Pathfinder_Character_Sheet#Skills|Skills]] tab of the sheet using the "Racial" column, alternately you could include it as part of the '''Skill Pts/Lvl'''.<br />
<br />
==== Add Race/Monster HD ====<br />
:Include additional HP-related racial adjustments. These values will be added to the regular class HP calculations and are included even if the section is not toggled/seen.<br />
<br />
==== Class(es) and Levels ====<br />
*'''Class #''' - Lists all classes (0-5). If you add a spellcasting class be sure to enable the Spells tab/page (Settings|Sheet Configuration|Uses Spells)<br />
*'''Class Name''' - Name of the class.<br />
*'''Level''' - Current class level.<br />
*'''d(hitdie)''' - hit dice(number of sides) used.<br />
*'''Class hp''' - total Hit Points rolled for each class. ('''Note''': Total HP is calculated from '''ALL''' classes listed)<br />
*'''FC hp''' - Favored Class bonus hit point instead of an FC Skill rank. ('''Note''': this will be added to Total HP)<br />
*'''BAB''' - Base Attack Bonus (from class table).<br />
*'''Skill Pts/Lvl''' - Skill points per level as given in the class description. Additional modifier for INT '''SHOULD NOT''' be included here since it is added into the max skills formula automatically. While there is a per/skill racial modifier option on the skills grid, you might include any additional skills/lvl. ( ie +1/lvl Human racial bonus) from here instead.<br />
*'''FC Skill''' - Favored Class skill point instead of FC hp.<br />
*'''FC Alt''' - Alternate Favored Class. This can be used to indicate any other non hp or skill point favored class bonuses. These will not be automatically added to any other fields.<br />
*'''Fort''' - Fortitude Save (from class table)<br />
*'''Ref''' - Reflex Save (from class table)<br />
*'''Will''' - Willpower Save (from class table)<br />
<br />
:'''Fractional Advancement and Multi-classing''' You can enter decimals in the fields for BAB, Fort, Ref, etc, to support fractional advancement as per the Pathfinder Unchained rules. Use .25, .3334,.5, .6667 for 1/4, 1/3, 1/2, and 2/3, respectively, etc. The sums will be rounded down in the total row.<br />
<br />
=== Experience and Hero Points ===<br />
:Enter current [http://paizo.com/pathfinderRPG/prd/classes.html#advancing-your-character experience points](XP) and the XP needed to reach the next level. These fields are not auto-calculated.<br />
<br />
:Enable Prestige, Fame, and Hero Points from the Settings page. Prestige and Fame are used with the optional [http://paizo.com/pathfinderRPG/prd/ultimateCampaign/campaignSystems/reputationAndFame.html# Reputation rules]. [http://paizo.com/pathfinderRPG/prd/advanced/advancedNewRules.html#hero-points Hero Points] are also optional.<br />
<br />
=== Health and Wounds ===<br />
[[File:PF_Health.JPG|300px|thumbnail|Pathfinder: Health and Wounds]]<br />
==== Hit Points ====<br />
::*'''Current HP:''' Current HP must be manually adjusted.<br />
::*'''Max HP:''' Auto-calculated <br />
The default formula for '''Max HP'''; <code>(@{CON-mod} * @{level}) + @{total-hp} + (5 * @{condition-Drained})</code><br />
:'''Temp HP''' must be manually adjusted. '''Max Temp HP''' can be set using Misc (@{HP-temp-misc}) as needed. <br />
<br />
::*'''Reset:''' recalculate HP and Temp HP and set their values to Max.<br />
::*'''Non-lethal Damage:''' track non-lethal damage<br />
::*'''Heal conditions:'''<br />
<br />
==== Hit Point Calculations ====<br />
:This section shows how '''Max HP''' is calculated. Includes a macro-text field (Evaluated at edit time, must evaluate to number. No queries. Extended Expressions allowed.)<br />
::*'''Ability:''' Choose the which ability bonus will apply. Default is CON.<br />
::*'''Mod:''' auto-calculated from ability<br />
::*'''Level/HD:''' auto-calc based on total class level, and/or hit dice for NPC's.<br />
::*'''Ability Bonus:''' auto-calc based on total ability bonus<br />
::*'''Class HD/hp:''' auto-calc based on total class hp and/or hit dice.<br />
::*'''Miscellaneous Bonus:''' macro-text field (Evaluated at edit time, must evaluate to number. No queries. Extended Expressions allowed.)<br />
::*'''Mod:''' auto-calculated from miscellaneous<br />
<br />
==== Wound Threshold ====<br />
:'''Wound Threshold''': this section is provided as an alternate ruleset found in Pathfinder Unchained. Display the Wound Threshold section from the [[https://wiki.roll20.net/Pathfinder_Character_Sheet#Configuration Configuration Tab]].<br />
<br />
=== Initiative and Speeds ===<br />
[[File:Pf_init_speed.png|300px|thumbnail|Pathfinder: Initiative and Speed]]<br />
====Initiative====<br />
:Use the sheet roll button to roll for [http://paizo.com/pathfinderRPG/prd/combat.html#initiative Initiative]. In order to have your token added to the [[Turn_Tracker|Turn Tracker]] you must have your token selected before using the sheet roll. Results will be sent to chat. Although DEX-mod is the default modifier for initiative, you may select any ability modifier using the drop-down selector. (note: the '''@{init}''' total is added to the result after the decimal and can be used as a "tiebreaker".)<br />
:You may add initiative notes and as an option include them when making a sheet roll.<br />
<br />
:'''Sheet roll''' for Initiative: <code>%{selected|Roll-for-initiative}</code><br />
<br />
:'''Initiative Macro:'''<code>[[ (1d20 + [[ @{init} ]][init] + [[ {(0.01 * @{init}),0}kh1 ]][tie-breaker]) &{tracker} ]]</code><br />
* '''Total:''' shows total initiative<br />
* '''Ability:''' choose the ability initiative is based on. Default is DEX.<br />
* '''Mod:''' modifier as determined by Ability chosen.<br />
* '''Trait:''' trait that may effect initiative<br />
* '''Misc:''' macro-text field. (Evaluated at edit time, must evaluate to number. No queries. Extended Expressions allowed.)<br />
* '''Mod:''' modifier as determined by Misc macro-text.<br />
* '''Cond:''' Condition Deafened.<br />
* '''Cond:''' Condition based on ability check.<br />
* '''Buff:''' Buffs that may apply.<br />
<br />
:('''Note 1:'''<code>@{init}</code> can now be passed to the [[Script:Group Initiative|Group-Initiative]] API script (in 2015 it could not be used) ).<br />
:('''Note 2:''' If you create a global macro, ensure that you update <code>@{init}</code> (see example macro above) to either "@{selected|init}" or "@{target|init}" in your macro, otherwise there is no way to specify '''which''' character's init attribute to use.<br />
<br />
====Speed====<br />
* '''Base''': enter speed in feet. This should be auto-adjusted for armor/encumbrance as per the rules. Manually adjust other forms of movement as necessary e.g.(1/4 speed for [http://paizo.com/pathfinderRPG/prd/skills/climb.html#climb Climb], 1/2 for [http://paizo.com/pathfinderRPG/prd/skills/swim.html#swim Swim]), etc.<br />
<br />
* '''Speed''' is now affected by encumbrance. Enter your speed in <code>@{speed-base}</code> and the encumbrance-modified speed is in <code>@{speed-modified}</code> You can adjust how encumbrance is handled using '''Settings|Sheet Configuration|Encumbrance'''.<br />
* '''Fly'''<br />
* '''Swim''' ie 1/4 speed for move action<br />
* '''Climb''' ie 1/4 speed for move action<br />
* '''Burrow'''<br />
* '''User Defined''' fields to enter custom movements.<br />
* '''User Defined''' fields to enter custom movements.<br />
* '''Run Mult''': multiplier used to determine the run speed (ie x3 heavy armor, x4 light armor)<br />
* '''Run''': auto-calculated<br />
<br />
:Adjusting Encumbrance will affect speed. <br />
('''Note:''' If ''use Dwarf encumbrance rules'' is checked on the ''Settings'' page, speed will ignore encumbrance from armor and weight (up to max) as per the Pathfinder rules))<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Defenses</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Defenses.jpg|300px|thumbnail|Pathfinder Defenses]]<br />
<br />
=== Saving Throws ===<br />
*'''<span style="color:#c00;">Show more fields</span>''' - check to show advanced fields and a ''misc'' entry for adjusting saves.<br />
<br />
:'''Fort'''(fortitude), '''Ref'''(reflex), '''Will'''(willpower) Each Save has an included sheet roll button.<br />
'''Sheet Rolls''' for Saving Throws: <code>%{selected|Fort-Save}, %{selected|Ref-Save}, %{selected|Will-Save}</code><br />
<br />
*'''Save''' - type of Saving Throw.<br />
*'''Total''' - auto-calculated row totals.<br />
*'''Base''' - auto-calculated from Class Information.<br />
*'''Ability''' - select a primary ability modifier.<br />
*'''Mod''' - auto-calculated by the primary ability selected.<br />
*'''Trait''' - enter modifiers/penalty<br />
*'''Enh''' - enter modifiers/penalty<br />
*'''Resistances''' - enter modifiers/penalty<br />
*'''Misc''' - enter modifiers/penalty<br />
*'''Cond''' - auto-calculated for Conditions that are enabled.<br />
*'''Buff''' - auto-calculated for Buffs that are enabled.<br />
*'''Save Notes''' - add notes with an option to include them with Saving Throw rolls.<br />
<br />
=== Defense Values ===<br />
:This section of the sheet consists mainly of auto-calculated attributes; [http://paizo.com/pathfinderRPG/prd/combat.html#armor-class Armor Class] values. '''AC''', '''Touch''', '''Flat-Footed''', '''CMD''', and '''FF CMD'''(flat-footed). <br />
<br />
*'''Armor Class''' - type of Armor Class<br />
*'''Total''' - auto-calculated row totals<br />
*'''Armor''' - auto-calculated adjustment for worn armor<br />
*'''Shield''' - auto-calculated adjustment for an equipped shield<br />
*'''Ability''' - select a primary ability modifier (DEX by default)<br />
*'''Mod''' - auto-calculated by the primary ability selected. ('''NOTE:''' <span style="border:2px dashed #B8860B; background-color:#E0EEf7; padding:0 5px 0 5px;"> a yellow dashed border indicates a '''Max DEX''' restriction is in effect due to Armor, Shield, and Load.</span><br />
*'''Size''' - auto-calculated as determined by the size attribute (Character Details) <br />
*'''Dodge''' - enter modifiers/penalty<br />
*'''Natural''' - enter modifiers/penalty<br />
*'''Deflect''' - enter modifiers/penalty<br />
*'''Misc''' - enter modifiers/penalty<br />
*'''Buff''' - auto-calculated for Buffs that are enabled<br />
*'''Cond''' - auto-calculated for Conditions that are enabled<br />
<br />
=== Armor and Shield ===<br />
('''Note:''' Add armor and shield from the '''Inventory''' page's, Equipment List section. Enter details using the "Armor Attributes" subsection of any equipment item and finally, use "Set Armor" or "Set Shield" as appropriate to sync with Defenses)<br />
:This lists the type of armor and/or shield. Use the "Equip" toggle to indicate if the armor or shield is being worn.<br />
:These are read-only fields. Make changes using the equipment list, armor attributes subsection.<br />
*'''Equip''' - toggle if worn/equipped.<br />
*'''Armor or Shield Name''' - type of armor/shield<br />
*'''AC''' - Armor Class bonus<br />
*'''Enh''' - Enhancement bonus<br />
*'''Max DEX''' - maximum DEX modifier allowed due to armor/load<br />
*'''ACP''' - Armor Check Penalty<br />
*'''Spell Fail''' - chance of Spell Failure.<br />
*'''Type''' - select type of armor/shield<br />
*'''Prof''' - armor proficiency<br />
<br />
=== Armor Penalties ===<br />
: Displays the total penalties for ACP, Attack Penalty(for non-proficiency), Max Dex, and Spell Failure.<br />
('''Note:''' Encumbrance is set to "Ignore" from Settings|Sheet Configuration|Encumbrance, '''ACP''' will be set to "0" and '''Max Dex''' will be set to "99").<br />
*'''ACP''' - total Armor Check Penalty for armor, shield, and encumbrance.<br />
*'''Attack Penalty''' - auto-calculated penalty for armor non-proficiency<br />
*'''Max DEX''' - maximum DEX modifier allowed due to armor/load(encumbrance)<br />
*'''Spell Failure Sheet roll''' shows chance of Spell Failure: <code>%{selected|Spell-Fail-Check}</code> and rolls a check.<br />
<br />
=== Sanity ===<br />
[[File:PF Sanity.JPG|300px|thumbnail|right|Sanity]]<br />
:optional feature '''(⛭ Settings|Rule Options|Horror Adventures|)'''<br />
<br />
=== Defense Notes ===<br />
:'''Armor Notes''', '''CMD Notes''', and '''Defense Notes'''. These notes will be included when making a Defenses menu sheet roll for Defensive Stats.<br />
<br />
=== Special Defenses ===<br />
:You can enter descriptive text as well as inline rolls for <br />
*'''DR:''' Damage reduction <br />
*'''SR:''' Spell Resistance macro-text field (evaluated at edit time, must evaluate to number. No queries. Extended Expressions allowed.)<br />
*'''SR Bonus:''' Spell resistance modifier derived from SR macro-text<br />
*'''Resistances''' <br />
*'''Immunities'''<br />
*'''Weaknesses'''<br />
<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Attacks</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Attacks.jpg|300px|thumbnail|Pathfinder Attacks]]<br />
<br />
=== Attack and Combat Maneuver Bonuses ===<br />
:*'''Attack Types'''<br />
:**'''Melee''' and '''Alt-Melee''' (good for Weapon Finesse)<br />
:**'''Ranged''' and '''Alt-Ranged''' (Settings>Attacks>"Display Alt-Ranged Type")<br />
:**'''CMB''' and '''Alt-CMB''' (Settings>Attacks>"Display Alt-CMB Type")<br />
:'''Sheet roll buttons:''' <code>%{selected|Melee-Attack-Roll}</code>, <code>%{selected|Melee2-Attack-Roll}</code>, <code>%{selected|Ranged-Attack-Roll}</code>, <code>%{selected|Ranged2-Attack-Roll}</code>, <code>%{selected|CMB-Check}</code>, and <code>%{selected|CMB2-Check}</code><br />
:*'''Ability Type''': choose the ability used to modify attack<br />
:*'''Mod''': ability mod applied<br />
:*'''Size''': size adjustment modifier(Core>Character Details section)<br />
:*'''BAB''': Dropdown to pick Base Attack Bonus or total level/hd. Total @{BAB} derived from the Class(es) and Levels section on the Core page, or @{level} , or any of the class levels, (like class 1, 2, etc) for classes with abilities that allow them to substitute level for bab for certain attacks.<br />
:*'''Misc''': miscellaneous modifier, treated as untyped.<br />
:*'''Buff''': Buffs that may be in effect<br />
:*'''Cond''': Conditions the may be in effect<br />
:*'''+Crit''': crit ''confirmation'' roll modifier<br />
:*'''Description''': included with sheet rolls, best used to signify difference between attack and "alt" version of attack<br />
<br />
=== Attack Notes ===<br />
:These settings are global and will apply to '''ALL''' attack rolls.<br />
<br />
:*'''Melee Attack Notes''', '''Ranged Attack Notes''', '''CMB Notes''', and '''Attack Notes'''<br />
:*'''Header Images:''' Show small, icon-sized images with attack rolls. Images will be set according to Settings>Header Image.<br />
:*'''Use Simple Template''': default template formatting will not be used. This option may be better for text-readers.<br />
<br />
=== Extra Damage or Attack Modifiers ===<br />
<br />
:These settings are global and will applied to '''ALL''' attack's full macro text and added to the normal attack and damage rolls. <br />
:Extra Damage fields are ⒝ Evaluated at roll time in chat. Queries allowed. '''MUST''' put <nowiki>[[ brackets ]]</nowiki> around rolls.<br />
<br />
:To show the Attack 'Add-to-roll' Macros section; goto '''⛭ Settings|Sheet Configuration|Advanced|Display 'add-to-roll' rolltime fields'''.<br />
:Attack and Damage type fields are ⒞ Evaluated at roll time in chat. Queries allowed must evaluate to number. No <nowiki>[[ brackets ]]</nowiki> needed.<br />
<br />
=== Dual Wield ===<br />
[[File:PF Dual Wield.jpg|300px|thumbnail|right|Dual Wield]]<br />
:To show the Dual Wield section, go to '''⛭ Settings|Sheet Configuration|Attacks|Use Dual Wield'''.<br />
<br />
==== To setup a dual wield attack ====<br />
<br />
# copy and paste the exact '''Name''' of the attack, or the '''Row ID'''(found in '''IDs''' sub-section of each attack's row) for the the mainhand and offhand weapons into their appropriate fields as shown in the image. <br />
# Enter the mainhand and off hand penalties, <br />
# Enter number of attacks with the offhand <br />
# Enter the off hand damage multiplier (1/2 damage mod by default) This means it will subtract .5 of your STR mod for the offhand. <br />
# Press the '''Create''' button to generate a new "Dual Wield" attack. <br />
<br />
:If successful this new attack row appears at the end/bottom of attacks and the two Name/ID fields below will clear.<br />
<br />
==== When changes occur ==== <br />
If penalties, number of attacks, or offhand damage multiplier change, <br />
# enter the new penalties, number of attacks, and damage modifier, and <br />
# press '''Update'''. This will update all existing ''dual wield'' attacks.<br />
<br />
=== Macro Options ===<br />
:'''Extra Damage'''<br />
:include additional damage modifiers to '''ALL''' attacks.<br />
:*Extra Non-Crit and Crit Dmg: macro-text (Evaluated at roll time in chat. Queries allowed. Must put [[brackets]] around rolls.)<br />
:*Type of Non-Crit and Crit Dmg: text entry<br />
<br />
:'''Attack 'Add-to-Roll' Macros'''<br />
:To show/hide, go to '''⛭ Settings|Sheet Configuration|Advanced|Display 'add-to-roll' rolltime fields'''<br />
:include additional attack/damage modifiers to '''ALL''' attacks.<br />
:*Add to Melee, Ranged, and CMB '''Attack Roll''': macro-text (Evaluated at roll time in chat. Queries allowed. Must evaluate to number. No [[brackets]] needed.)<br />
:*Add to Melee, Ranged, and CMB '''Dmg Roll''': macro-text (Evaluated at roll time in chat. Queries allowed. Must evaluate to number. No [[brackets]] needed.)<br />
<br />
=== Attacks ===<br />
[[File:PF Weapon.jpg|600px|thumbnail|right|Weapon/Attack Example]]<br />
: Use the <span style="font-family: pictos; background-color: #fff; border: 1px solid #000; border-radius: 2px; padding: 2px 3px 2px 3px; color: #000;">&</span> button to create a new repeating attack or the <span style="font-family: pictos; background-color: #fff; border: 1px solid #000; border-radius: 2px; padding: 2px 3px 2px 3px; color: #000;">W</span> button to modify(rearrange or delete)an existing attack. <br />
<br />
: You can also create attacks directly from other sections of the sheet; Abilities(repeating entry>Attack and Damage>Create Atk), Spells(repeating entry>Attack and Damage>Create Atk), and Inventory(repeating entry>Weapon Attributes>Create Atk). <br />
<br />
:You can roll an Attack by using an attack's sheet roll button, drag/drop the attack's button to the macro quick bar, or using the sheet roll button's name from within a macro.<br />
<br />
:* '''Enh''' - Enhancement: used to show a weapon's [http://www.d20pfsrd.com/basics-ability-scores/glossary#TOC-Enhancement-Bonus enhancement bonus](magical modifiers) e.g.(+2 Long Sword; you would enter "2" in the Enhance field) This bonus modifier is applied to both ATK and DMG.<br />
:* '''Mwk''' - is the weapon [http://paizo.com/pathfinderRPG/prd/equipment.html#masterwork-weapons Masterwork]? (note: all "enhanced" weapons are masterwork so use check MWK. The sheet's math will keep from stacking bonuses.)<br />
:* '''Name''' - enter the type of weapon here.<br />
:* '''Attack Mods''' - Macro-text field for Attack modifiers added in addition to Enh. (Evaluated at edit time, must evaluate to number. No queries. Extended Expressions allowed.)<br />
:* '''Val''' - auto-calculated value from Attack Mod<br />
:* '''ATK Type''' - Attack Type: Melee, Alt Melee, Ranged, Alt Ranged, CMB, or Alt CMB. (note: although not seen, buffs may be in effect in regards to the attack type.)<br />
<br />
:* '''Attack(Total-ATTACK)''': auto-calculated from all modifiers that apply. '''total-attack''' will change as adjustments are made to Enhance, MWK, Attack Mods, as well as changes to either Melee, Ranged, or CMB as they apply.<br />
<br />
::'''Formula; @{total-attack}''' <code>( [[ @{selected|proficiency} + (((@{selected|enhance} + [[ @{selected|masterwork} ]]) + abs(@{selected|enhance} - [[ @{selected|masterwork} ]])) / 2) + [[ @{selected|attack} ]] + [[ @{selected|attk-effect-total-other} ]] + [[ @{selected|attack-type} ]] + [[ @{selected|armor-proficiency} ]] )</code><br />
<br />
:* '''Vs.''' - select a specific type of defense.<br />
:* '''Crit''' - the '''lowest''' number necessary to make a [http://paizo.com/pathfinderRPG/prd/combat.html#critical-hits critical hit] as determined by the weapons tables.<br />
:* '''Mult''' - Multiplier: the number of times damage with usual modifiers are rolled if a crit is confirmed.<br />
:* '''+Crit''' - add a bonus to Crit Confirm rolls for this attack<br />
:* '''+Crit''' - shows additional bonus being applied<br />
:* '''Dice''' - how many? e.g.(1)<br />
:* '''Die''' - what type of die? e.g.(d8)<br />
:* '''DMG Mods''' - Macro-text for damage bonuses in addition to Enh. (Evaluated at edit time, must evaluate to number. No queries. Extended Expressions allowed.)<br />
:* '''Val''' - auto-calculated value from Damage Mod<br />
:* '''Mult''' - Damage ability modifier: .5, 1.5, 2, etc, can leave blank to represent 1. e.g. Two-handed attack of 1.5<br />
:* '''DMG Ability''' - normally this is STR for melee attacks, however there may be Feats\Traits\other that may substitute another ability modifier.<br />
:* '''Max''' - maximum STR mod allowed. Use for strength-based ranged weapons such as a composite bow.<br />
<br />
:* '''Dmg(Total-DAMAGE)''': auto-calculated. You can see this number change as adjustments are made to Enhance, Damage Mods, Damage Ability(including adjustment to that ability).<br />
<br />
::'''Formula; @{total-damage}''' <code>(@{selected|enhance} + [[ @{selected|damage} ]] + [[ @{selected|dmg-effect-total-other} ]] + [[ @{selected|buff_DMG-total} ]] + [[ @{selected|damage-ability} ]])</code><br />
<br />
:* '''Type''' - B for bludgeoning, P for piercing, or S for slashing<br />
:* '''Reach''' - shown for non-ranged weapons.<br />
:* '''Range''' - normal range(no penalty) in feet, used for ranged weapons.<br />
:* '''Ammo''' - enter number of items. e.g.(arrows, bolts, sling bullets, etc.)<br />
:* '''Group''' - name used to to group/organize Attacks menu button. You can use this if you do not want to categorize an attack under the default Melee/Ranged/CMB groups. Monsters that are automatically parsed have groups such as "Full Attack 1, Full Attack 2" etc.<br />
:* '''Proficiency''' - are you proficient with this weapon?<br />
:* '''Uses Size''' - use weapon size adjustment '''⛭ Settings|Sheet Configuration|Attacks|Adjust damage based on size'''<br />
:* '''Default Size''' - weapon size used to automatically adjust attack/damage. '''⛭ Settings|Sheet Configuration|Attacks|Adjust damage based on size'''<br />
:* '''Notes''' - enter additional notes including inline rolls for additional effects.<br />
<br />
==== Additional Attack Options ====<br />
:*'''Extra Damage'''<br />
:To show/hide the Extra Damage sub-section, go to '''⛭ Settings|Sheet Configuration|Advanced|Display 'add-to-roll' rolltime fields'''<br />
:** '''Extra non-Crit Dmg''': Apply Extra non-crit and/or crit damage as an inline roll e.g. <nowiki>[[ 1d6 ]]</nowiki>, a macro, a straight mod or even a query. Give the Type/Description of the extra damage. (Evaluated at roll time in chat. Queries allowed. Must put [[brackets]] around rolls.)<br />
:** '''Extra Crit Dmg''': Apply Extra crit damage as an inline roll e.g. <nowiki>[[ 1d6 ]]</nowiki>, a macro, a straight mod or even a query. Give the Type/Description of the extra damage. (Evaluated at roll time in chat. Queries allowed. Must put [[brackets]] around rolls.)<br />
<br />
:* '''Iterative Attacks''': Include up to 8 additional iterative attacks. These attacks will be included in @{iterative_attacks} You can give each additional attack a custom name. The default Attack Mod values account for the normal cumulative penalty of (-5) per additional attack. Macro-text can be edited for each iterative attack.<br />
<br />
:*'''Add-to-Roll Macros'''<br />
:To show/hide, go to '''⛭ Settings|Sheet Configuration|Advanced|Display 'add-to-roll' rolltime fields'''<br />
:**'''Add-to-Attack macro''': Evaluated at roll time in chat. Queries allowed. Must evaluate to number. No [[brackets]] needed.<br />
:**'''Add-to-Damage macro''': Evaluated at roll time in chat. Queries allowed. Must evaluate to number. No [[brackets]] needed.<br />
<br />
:* '''Macro Text''' <br />
:To show/hide, go to '''⛭ Settings|Sheet Configuration|Advanced|Display Roll templates for customization'''<br />
:Add additional Attack and/or Damage. Use an inline roll e.g. <nowiki>[[ 1d6 ]]</nowiki> ('''note:''' double brackets are not required), macro, a straight modifier or even a query. You can also modify the '''Full Macro''' text here to customize the attack's button roll. (Evaluated at roll time in chat. Queries allowed. Must evaluate to number. No [[brackets]] needed.)<br />
<br />
:*'''ID''' - A Unique Identification number associated with this item and it's attributes. Highlight, copy/paste into macros that include repeating attribute. e.g.(<code>@{selected|repeating_weapon_-ka2abgz9u85y56brghu_name}</code>) Using id's within your repeating attributes will target the appropriate attribute regardless of rearranging the repeating rows.<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Abilities</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Abilities.jpg|300px|thumbnail|Pathfinder Abilities]]<br />
=== Feat Calculations ===<br />
'''Feats by Level''', '''Racial''', '''Class Bonus''', '''Misc Bonus''', '''Total Feats'''<br />
<br />
=== Psionic Information ===<br />
[[File:PF Psionics.JPG|300px|thumbnail|right|Psionic Information]]<br />
:optional feature '''(⛭ Settings|Rule Options|Pathfinder Psionics|)'''<br />
<br />
=== Kineticist Burn ===<br />
[[File:PF Kineticist burn.JPG|300px|thumbnail|right|Kineticist Burn]]<br />
:optional feature '''(⛭ Settings|Rule Options|Occult Adventures|Use Kineticist Burn)'''<br />
<br />
=== Abilities List ===<br />
:Abilities now use a single repeating section consisting of subcategories; Class Features, Feats, Traits, Special Attacks, Special Abilities, Spell-like Abilities, SQ(Special Qualities), Misc., as well as subtypes; Ex(Extraordinary), Sp(Spell-like ability), and Su(Supernatural).<br />
<br />
If you have enabled [[Pathfinder_Character_Sheet#Pathfinder_Mythic_Adventures|Mythic Adventures]] '''(⛭ Settings|Rule Options|Display/Enable Mythic Adventures Character Sheet Items)''', you will also see the Mythic Abilities tab as well. New abilities will be assigned a subcategory based on the '''Rule''' selected.<br />
<br />
'''NOTE:''' Older sheets that had the original lists(Class Features, Feats, Racial Traits, Traits) can now be "Merged" into the new abilities using '''⛭ Settings|Sheet Configuration|Lists'''. After verifying that all abilities have been added to the new abilities section use the "Delete All"(trashcan icon) found at the top of each repeating section to delete the old lists.<br />
<br />
'''NOTE:''' The fields detailed under Class Features below are common to all Ability subcategories but some will only be shown depending on other field selections.<br />
<br />
==== Class Features ====<br />
:special abilities that are specific to a given class.<br />
<br />
*'''Show''' - determines whether the ability will be included with the "Abilities" menu button.<br />
*'''Rule''' - select the subcategory the best describes the ability. '''Used to filter/sort abilities by the appropriate tab.'''<br />
*'''Source''' - Race/class basis. Defaults to the Total Character level.<br />
*'''Name''' - Name of the class feature\ability<br />
*'''Type''' - Select the type of ability if applicable Ex(Extraordinary), Sp(Spell-like ability), or Su(Supernatural)<br />
*'''Short Description''' - This text will be sent to chat. ('''NOTE:''' it is useful to include inline rolls within the '''Short Description''' field. You can also insert url's)<br />
*'''Freq''' - Select how often this ability is available.<br />
*'''Max''' - auto-calculated abilities that can only be used a limited number of times per day.<br />
*'''Max Calculation''' - Enter macro text. Used for determining the "Max" attribute. e.g. (@{class-0-level}+1)<br />
*'''Description''' - output to chat when using the sheet roll.<br />
:*'''Level Basis''' - subsection used to determine DC<br />
::*'''Custom''' - Display extra fields for advanced customization, such as columns marked 'user defined'.<br />
::*'''CL''' - Effective Caster/character Level: use for effects, if Sp then for caster level checks and concentration.<br />
::*'''Ability''' - DC Ability basis: usually CHA for spellcasting ability, CON for poison, breathweapon, or other damage abilities.<br />
::*'''DC Basis''' - Base for calculation of DC and effects, defaults to one half level / hit dice<br />
::*'''Save''' - save type<br />
::*'''DC''' - 10 + Ability score modifier + DC basis level<br />
<br />
:*'''Range''' - subsection used to determine Range and/or Duration if applicable.<br />
::*'''CL''' - Level/HD<br />
::*'''Range''' - type of range if applicable<br />
::*'''Custom #''' - Number ( for 'Per Level' or 'Number'), or special range desc ('line' or 'cone')<br />
::*'''Range''' - based off of range type and custom # macro<br />
::*'''Duration''' - amount of time if applicable<br />
::*'''Category''' - Custom category such as spell school or other user defined.<br />
<br />
:*'''Attack and Damage''' - subsection used to create an attack from an ability. Fill in the appropriate attack/damage info and use the "Create Attack" button to create a new attack.<br />
::*'''Create Attack''' - Create a new attack based on this weapon.<br />
::*'''Attack Type''' - Touch, Ranged Touch/Ray, CMB, Alt-Touch, Alt-Ranged/Ray, Alt-CMB<br />
::*'''Targets/Area/Effect''' - Target, Area, or Effect<br />
::*'''Damage''' - macro (⒝ Evaluated at roll time in chat Queries allowed Must put <nowiki>[[brackets]]</nowiki> around rolls)<br />
::*'''Damage Type''' - ie fire, cold, energy, etc.<br />
<br />
:*'''Macro Text''' - You can modify the macro text here to customize the sheet roll.<br />
:*'''ID''' - A Unique Identification number associated with this item and it's attributes. Can be used within a macro to target a specific repeating attribute. e.g.(<code>@{selected|repeating_class-ability_-ka2abgz9u85y56brghu_name}</code>)<br />
<br />
==== Feats ====<br />
:Feats are abilities not necessarily tied to your race, class, or skill.<br />
::'''Feats by Level'''(auto-calculated from [[Pathfinder_Character_Sheet#Classes|Class Section]]), '''Racial Bonus'''(racial trait), '''Class Bonus'''(class feature/ability), '''Misc Bonus''', and '''Total Feats'''<br />
<br />
==== Traits ====<br />
:'''Racial''': special abilities due to a character's race. <br />
:'''Character''': special abilities not tied to race or class. Introduced in the Advanced Player's Guide.<br />
<br />
==== Special Attacks ====<br />
:most often used by monsters<br />
<br />
==== Special Abilities ====<br />
:most often used by monsters<br />
<br />
==== Spell-like Abilities ====<br />
:most often used by monsters<br />
<br />
==== SQ ====<br />
:Special Qualities most often used by monsters<br />
<br />
==== Misc ====<br />
:Monster Rule and any abilities that do not fit any other subcategory.<br />
<br />
==== Types ====<br />
<br />
===== EX =====<br />
:Extraordinary Abilities.<br />
<br />
===== SP =====<br />
:Spell-Like Abilities<br />
<br />
===== SU =====<br />
:Supernatural Abilities<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Skills</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Skills.jpg|300px|thumbnail|Pathfinder Skills]]<br />
<br />
=== Skill Rank Totals ===<br />
:'''Standard Skill System'''<br />
:Skills ranks are determined by the information provided on the Class Information. It is important to verify the Class Information is correct to ensure Max Skill Ranks are accurate.<br />
<br />
:'''Extra Ranks''' - Allows for the customization of additional skill ranks.<br />
*'''Skill Misc''' - enter modifiers/penalty to be added to Max Skill Ranks. Macro-text field.(⒜ Evaluated at edit time, must evaluate to number No queries Extended Expressions allowed)<br />
*'''Mod''' - auto-calculated from Skill Misc.<br />
*'''Misc''' - enter modifiers/penalty to be added to Max Skill Ranks.<br />
<br />
*'''Max Skill Ranks''' - auto-calculated from Max Ranks (determined by Class Information) and any Extra Ranks added.<br />
*'''Total Skill Ranks''' - auto-calculated of current Ranks used.<br />
*'''Ranks Remaining''' - auto-calculated<br />
<br />
:'''Unchained Skill System'''<br />
:The Unchained Skill systems for Background/Adventure and Consolidated Skills can be enabled from the Configuration page. Additional Skill tabs will be displayed.<br />
[[File:PF_Unchained_Skills.jpg|300px|thumbnail|Pathfinder Unchained Skills]]<br />
*'''Max Adventure Skill Ranks''' - auto-calculated from Max Ranks as determined by Class Information and any Extra Ranks added.<br />
*'''Total Adventure Skill Ranks''' - auto-calculated of current Adventure Ranks used.<br />
*'''Adventure Ranks Remaining''' - auto-calculated<br />
*'''Move Adventure to Background''' - auto-calculated. Any number of Adventure Ranks can be traded for an equal number of Background Ranks, but not vice versa.<br />
*'''Background Ranks Remaining''' - auto-calculated<br />
*'''Total Background Skill Ranks''' - auto-calculated of current Background Ranks used.<br />
<br />
=== Skill Options ===<br />
[[File:PF skill options.JPG|center|Skill Options]]<br />
:*'''<span style="color:#c00;">Show more fields</span>''' - must be checked to show advanced fields.<br />
:*'''Enforce Requires Training?''': Skills that are marked RT(requires training) that '''DO NOT''' include ranks will not be shown by the Skillbook button. Rolls made from the sheet without ranks that are marked RT will also include a "Skill is untrained" message with the roll.<br />
:*'''Skill Notes''': include Skill notes with rolls.<br />
:*'''Include Skill Totals?''': Include each Skill's total with the Skillbook menu.<br />
:*'''Number of''' craft, perform, profession skills to show:<br />
:*'''Number of''' Misc skills to show:<br />
:*'''Enable take 10 or 20 Options?''': This will add a query asking for a normal 1d20 roll, take 10, take 20, or a Custom roll.<br />
::*'''Custom Roll''': macro-text (⒞ Evaluated at roll time in chat Queries allowed Must evaluate to number No <nowiki>[[brackets]]</nowiki> needed)<br />
:*'''Add Skill Bonus Macro?''': Include macro with skill checks (Yes or Custom)<br />
::*'''Skill Bonus Macro''': (⒞ Evaluated at roll time in chat Queries allowed Must evaluate to number No <nowiki>[[brackets]]</nowiki> needed)<br />
<br />
=== Skill Notes ===<br />
:Use the text field in this section to make notes concerning skills. e.g.(the Rangers class ability Track: adds half his level (minimum 1) to Survival skill checks made to follow tracks. ) To make the note appear when you roll a skill check, use the <code>@{Skill-notes}</code> attribute in the macro text, e.g. <code>{{Notes=@{Skill-notes} }}</code>.<br />
<br />
<br />
=== Skills ===<br />
*'''Show more fields''' - check to show advanced fields<br />
<br />
:Use the All Skills tab for the standard skill system. Toggle the optional Unchained Skills from the [[https://wiki.roll20.net/Pathfinder_Character_Sheet#Configuration Configuration Tab]]. Additional Skill tabs will be shown if using the Unchained Skills system. Adventure/Background and Consolidated.<br />
<br />
:You can use the Skills sheet roll buttons in your ability macros. e.g.(to activate the Acrobatics skill check, you would include <code>%{selected|Acrobatics-Check}</code> in your macro. You may drag and drop these buttons to the macro quick bar as well.<br />
<br />
:'''Sheet rolls''' for Skill checks:<code>%{selected|Acrobatics-Check}, %{selected|Appraise-Check}, %{selected|Bluff-Check}, etc.</code><br />
* '''Skill''' - name of the skill.<br />
* '''Total''' - auto-calculated row total.<br />
* '''asterisk after skill''' - denotes this skill modified by size (Stealth and Fly)<br />
* '''CS''' - Class skill? If checked, an additional +3 is added when skill has at least 1 rank.<br />
* '''Ranks''' - the number of ranks set<br />
* '''Ability''' - select a primary ability modifier.<br />
* '''Race''' - enter modifiers/penalty for Race.<br />
* '''Trait''' - enter modifiers/penalty for Trait.<br />
* '''Feat''' - enter modifiers/penalty for Feat.<br />
* '''Item''' - enter modifiers/penalty for Item.<br />
* '''Misc Macro''' - enter modifiers/penalty for miscellaneous. Macro-text field. (⒜ Evaluated at edit time, must evaluate to number No queries Extended Expressions allowed)<br />
* '''Mod''' - auto-calculated from Misc Macro.<br />
* '''Buff'' - auto-calculated modifiers/penalty for Ability-based skill buff (other buffs and conditions not shown).<br />
* '''RT''' - requires training if checked.<br />
* '''Note''' - note to display when skill rolled<br />
* '''Macro''' - macro-text to enable per-skill macro customization. (sent to roll template)<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Spells</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Spells.jpg|300px|thumbnail|Pathfinder Spells]]<br />
To show the Spells tab, enable from '''⛭ Settings|Sheet Configuration|Spells|Uses Spells'''<br />
<br />
=== Spellcasting Classes ===<br />
:*'''Has multiple spellcasting classes''' - check to show all three spell caster class tabs<br />
<br />
:Enter up to 3 Caster classes(spell class 0, 1, and 2). Each tab represents a different caster class. '''Note:''' Although there are three separate tabs for different caster classes, all spells are entered as a single list, separated by their levels 0-9. Spell classes are not tied to the order classes are listed on the Classes Information section. Use the Class, Name, and CL fields to establish an appropriate class.<br />
<br />
*'''Show more fields''' - check to show advanced fields<br />
<br />
=== Level and Caster Ability ===<br />
<br />
==== Spell Casting Class and Level ====<br />
*'''Caster level Check''' - Sheet roll used for [http://www.d20pfsrd.com/magic#TOC-Caster-Level Caster Level] Checks. To activate from within a macro, use <code>%{selected|Spell-Class-0-CL-Check}</code> or you drag and drop to the macro quick bar.<br />
*'''Caster level''' - effective caster level based off of Sync Class field.<br />
*'''Sync Class''' - Use the dropdown to pick a class from the class grid on the Classes page, if you do so it will keep the class name and level in sync with the Classes page.<br />
*'''Class Name''' - Enter the "spell-casting" class's name if you did not use the dropdown to the left. (Class name and level is still user editable for backward compatibility purposes).<br />
*'''Base Level''' - Enter '''CL'''(caster level) of the spell-casting class. If the level here is not greater than 1, then no automated calculation will occur on the Spells page, as the sheet will assume the character does not have spellcasting ability.<br />
*'''Misc''' - Miscellaneous modifiers to caster level.<br />
*'''Buffs''' and '''Condition''' - Buff and conditional modifiers to caster level. Note these will be applied to all spellcasting classes if you have more than one.<br />
<br />
==== Spell Ranges ====<br />
: auto-calculated ranges; Close(25 + 5/2 levels), Med(100 + 10/level), Long(400 + 40/level)<br />
<br />
==== Roll Adjustments ====<br />
*'''Spell Penetration Bonus''' - modifier to apply to spell penetration rolls (caster level rolls to overcome spell resistance). This will be printed in the Caster level check sheet roll. (⒜ Evaluated at edit time, must evaluate to number No queries Extended Expressions allowed)<br />
*'''Cast Defensively Bonus''' - concentration bonus when casting defensively<br />
<br />
==== Spell Casting Ability ====<br />
*'''Concentration Check''' - Sheet roll<br />
*'''Total''' - total CC bonus<br />
*'''Ability''' - primary ability<br />
*'''Mod''' - modifiers to caster level.<br />
*'''Caster level''' - effective caster level based off of Sync Class field.<br />
*'''Misc''' - Miscellaneous modifiers to caster level.<br />
<br />
=== Spell Points ===<br />
: enabled from '''⛭ Settings|Sheet Configuration|Spells|Uses Spell points'''<br />
<br />
=== Spells Notes===<br />
:*'''Spells Notes'''<br />
:*'''Caster Level Notes'''<br />
:*'''Concentration Notes'''<br />
<br />
=== Spells Per Day ===<br />
*'''Casting Type'''<br />
:'''Spontaneous''': indicates a spontaneous caster. Click this to display spells known column.<br />
:'''Prepared''': indicates a prepared caster<br />
:'''Show only prepared spells in the spellbook menu''': this will hide all un-prepared spells in the Spellbook command output. On prepared casters, spells with a positive number in uses are considered 'prepared', uses represents the number of times memorized and usable that are left<br />
:'''Always show spells marked 'domain' in spellbook menu''': On hybrid that use a mix of prepared and spontaneous spells, this allows the domain checkbox to be used to indicate spontaneous spells that are always available Domain can be used for Mysteries, Spirit Magic, etc<br />
:'''Total spells manually''': # left is no longer auto-calculated<br />
'''Note:''' Fields shown depend on Casting Type.'''Spontaneous/Prepared'''<br />
*'''Save DC''' - auto-calculated based off of your primary stat.<br />
*'''Level''' - spell levels 0-9 as well as the alternate '''SP'''([http://www.d20srd.org/srd/variant/magic/spellPoints.htm spell points])<br />
*'''# Used''' - use this column to manually keep track of spells cast.<br />
*'''Spells/Day''' - spells from class description table.<br />
*'''Base Spells/Day''' - spells from class description table.<br />
*'''Bonus Spells''' - primary ability bonus<br />
*'''User Defined''' - used in Spells/Day total<br />
*'''Spells Known''' - class dependent, use Spells known table from class description.<br />
*'''Total Spells''' - <br />
*'''User Defined''' - miscellaneous<br />
<br />
=== Domains / SubDomains / Bloodlines / Patrons / Schools ===<br />
:Enter additional Spell Class information related to your Class<br />
:'''Name''', '''Type''', '''Bonus''', '''Opposition''', '''Effect'''<br />
<br />
=== Spell Roll Options ===<br />
:Toggle which spell attributes are included when a spell is rolled.<br />
[[File:PF_Spell_Roll_Options.jpg|700px|center|Spell Roll Options.]]<br />
<br /><br />
Spell options will not be shown with the roll template if their attributes do not include values. <br />
<br />
A Casting Time of "1 standard action" will not be shown since this is the default value for most spells.<br />
<br />
=== Spells Lists ===<br />
*'''<span style="color:#c00;">Show more fields</span>''' - check to show advanced fields<br />
<br />
:Spells can be added and entered manually, or you can use the Pathfinder Compendium to drag/drop spells and have them auto-populate attribute values. Spells will be automatically sorted by their level. Sort spells by their level by using an appropriate tab. Repeating rows can be rearranged and/or deleted using the "Modify" button.<br />
<br />
* '''Prepped''' - Indicates the number of prepared spells remaining<br />
* '''Name''' - Name that your spell is commonly known by.<br />
* '''Class''' - List the caster class the spell is derived from. Class 0, Class 1, Class 2.(input caster class in the top portion of the spell tab)<br />
* '''Level''' - enter the spells level<br />
* '''DC''' - Difficulty Class. This can be adjusted per/spell using the Misc sub-section.<br />
* '''School''' - [http://paizo.com/pathfinderRPG/prd/magic.html#spell-descriptions School(Subschool)] of magic if any.<br />
* '''SR''' - Is this spell affected by [http://paizo.com/pathfinderRPG/prd/magic.html#spell-resistance Spell Resistance](special defensive ability)<br />
* '''Save Effect''' - Usually a harmful spell allows a target to make a [http://paizo.com/pathfinderRPG/prd/magic.html#saving-throw saving throw] to avoid some or all of the effect. List the Saving Throw required and list the effect of a successful save. Such as Negates, Partial, Half, None, Disbelief.<br />
* '''Range''' - Select a Range. Blank(range not applicable), Close, Medium, Long, Touch, Personal, See Text(custom range), Number(flat number), Per Level(level based) and Cannot Parse(it's complicated).<br />
* '''Custom Range''' - flat number or macro-text<br />
* '''Range''' - actual range in feet<br />
* '''Targets/Area/Effect''' - Aiming at a [http://paizo.com/pathfinderRPG/prd/magic.html#aiming-a-spell Target] to indicate Target(s), an Effect, or an Area of Effect. AoE could consist of cone, radius, or line and the total distance of the effect in feet. e.g.(30' Cone)<br />
* '''Duration''' - A spell's [http://paizo.com/pathfinderRPG/prd/magic.html#duration duration] entry tells you how long the magical energy of the spell lasts. Timed Duration, Instantaneous, Permanent, and Concentration are common.<br />
* '''Casting Time''' - Most spells have a [http://paizo.com/pathfinderRPG/prd/magic.html#casting-time casting time] of 1 standard action. Others take 1 round or more, while a few require only a swift action.<br />
* '''Components''' - A spell's [http://paizo.com/pathfinderRPG/prd/magic.html#components components] explain what you must do or possess to cast the spell. Verbal(V), Somatic(S), Material(M), Focus(F), Divine Focus(DF)<br />
<br />
==== Misc ====<br />
:*'''Meta Magic''' - checkbox to show spell slot field to differentiate slot from spell level.<br />
:*'''Domain''' - reference-only checkbox to indicate if a domain spell<br />
:*'''Mythic''' - reference-only checkbox to indicate spell is mythic. You will only see this checkbox if Mythic options are enabled on the Config page.<br />
:*'''CL Mod''' - Caster Level modifier<br />
:*'''CL''' - Caster Level<br />
:*'''DC Mod''' - Difficulty Class modifier<br />
:*'''Spell Pen Mod''' - Spell Penetration modifier<br />
:*'''SP''' - total Spell Penetration<br />
:*'''Conc Misc''' - Concentration modifier<br />
:*'''Conc''' - total Concentration<br />
<br />
==== Description ==== <br />
:This is the spells descriptor. It will be seen in chat when using the sheet rolls. Use inline rolls for variable effects. You can even add url's. e.g.(Wail of the Banshee -http://paizo.com/pathfinderRPG/prd/spells/wailOfTheBanshee.html#wail-of-the-banshee) Please be considerate of other players and don't include the entire [http://paizo.com/pathfinderRPG/prd/ PFSRD] in the description.<br />
<br />
==== Macro Text ====<br />
:You can modify the macro text here to customize the output from the repeating section button.<br />
<br />
==== Attack and Damage ==== <br />
:subsection used to create an attack from an ability. Fill in the appropriate attack/damage info and use the "Create Attack" button to create a new attack.<br />
:*'''Create Attack''' - Create a new attack based on this weapon.<br />
:*'''Attack Type''' - <br />
:*'''Targets/Area/Effect''' - <br />
:*'''Damage''' - macro (⒝ Evaluated at roll time in chat Queries allowed Must put <nowiki>[[brackets]]</nowiki> around rolls)<br />
:*'''Damage Type''' - ie fire, cold, energy, etc.<br />
<br />
==== ID ==== <br />
:A Unique Identification number associated with this item and it's attributes. Can be used within a macro to target a specific repeating attribute. e.g.(<code>@{selected|repeating_spells_-ka2abgz9u85y56brghu_name}</code>)<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Equipment</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Items.jpg|300px|thumbnail|Pathfinder Items]]<br />
<br />
=== Currency ===<br />
:"Show me the colour of your money." [http://paizo.com/pathfinderRPG/prd/equipment.html Character wealth/currency]. '''CP'''(copper), '''SP'''(silver), '''GP'''(gold), and '''PP'''(platinum)<br />
:Currency is split into '''Carried Currency''' (included in encumbrance) and '''Other Currency''' (wealth in a bag of holding, in a bank, at home, etc.).<br />
<br />
=== Carried Weight ===<br />
:Encumbrance is auto-calculated from carried currency, worn equipment, and carried equipment. An item must have at least a quantity/charge of "1" before it will be accounted for it's weight. Encumbrance can be changed in '''⛭ Settings|Sheet Configuration|Encumbrance'''<br />
<br />
*'''Currency''' - auto-calculated from Carried Currency section.<br />
*'''Carried Equipment''' - total of carried equipment.<br />
*'''Misc''' - enter weight for other items of encumbrance.<br />
*'''Total''' - auto-calculated total weight carried.<br />
<br />
=== Current Load ===<br />
:The current load (Light, Medium, or Heavy) is auto-calculated based off of total carried weight and STR and will affect other areas of the sheet.<br />
<br />
=== Loads and Lift ===<br />
:Use this section for [http://paizo.com/pathfinderRPG/prd/additionalRules.html Carrying Capacity] rules.<br />
*'''STR Bonus''' - Additional bonus to Strength score for carrying capacity only.<br />
*'''Misc''' - Miscellaneous bonus added to load values.<br />
*'''Multiplier''' - The amount that load values will be multiplied. e.g. Ant Haul<br />
*'''Size''' - Modifier based on Size(includes Legs) as set within Characters Details.<br />
*'''Total''' - Total load multiplier.<br />
<br />
*'''Light''' - At this weight of carried equipment or less, the character is unencumbered.<br />
*'''Medium''' - Over the light load and up to this weight, the character is moderately encumbered.<br />
*'''Heavy''' - Over the medium load and up to this weight, the character is heavily encumbered.<br />
<br />
*'''Above Head''' - A character can lift as much as his maximum load over his head.<br />
*'''Off-Ground''' - A character can lift as much as double his maximum load off the ground, but he or she can only stagger around with it.<br />
*'''Drag & Push''' - A character can generally push or drag along the ground as much as five times his maximum load.<br />
<br />
=== Worn Equipment ===<br />
:This section is used for worn(slotted) items. Sheet rolls will show the item name and any description given from inventory. e.g.(Name:<code>@{worn-Belt}</code> Description:<code>@{worn-Belt-description}</code>) <br />
Add items to a slot using the "Location" selector from any given equipment item.<br />
*'''Slot''' - location<br />
*'''Name''' - name of item.<br />
<br />
=== Equipment ===<br />
:Add all your character's possessions from here.<br />
*'''<span style="color:#c00;">Show more fields</span>''' - check to show advanced fields<br />
<br />
*'''Weapon, Armor/Shield, Ammo, Consumable, Charged, Magic, Gear, Other 1, Other 2, All, Carried, Not Carried'''<br />
:Equipment will be sub-categorized by according to the Equipment Type.<br />
<br />
:*'''Name''' - Name of the item.<br />
:*'''Short Description''' - This is a text entry that will show in chat. (note: it is useful to include inline rolls within the Short Description field. You can also insert url's)<br />
:*'''Equipment Type''' - sub-category that best describes the item. Used to sort equipment into the various sub-categories.<br />
:*'''Location''' - selector for carried or not carried. Carried items will be used for encumbrance.<br />
:*'''Qty''' - You must have a quantity of at least 1 for an item to have weight and value. If the item is a "container" ie quiver, you can use the Max field to track the contents.<br />
<br />
The '''<span style="color:#c00;">Show more fields</span>''' checkbox at the top of the section must be checked to reveal '''Max, Wt, Hard, HP, Max,''' and '''Value'''.<br />
<br />
:*'''Max''' - current number of similar items held within the item. ie a quiver of arrows/bolts. If Max > 1, the item is considered to be a "container" at which point weight and value will only be based off of Qty="1" regardless if Qty > 1. If you have multiple "containers" of the same type, add them as additional items. <br />
:*'''Wt''' - item weight. Used with quantity to determine encumbrance<br />
:*'''Hard''' - item hardness<br />
:*'''HP''' - item Hit Points<br />
:*'''Max''' - item Max Hit Points<br />
:*'''Value''' - item monetary value<br />
<br />
::*'''Armor Attributes'''<br />
:::*'''Set Armor''' - use to create/update Armor on defenses page<br />
:::*'''Set Shield''' - use to create/update Shield on defenses page<br />
:::*'''AC Bonus''' - from armor/shield table<br />
:::*'''Enh''' - enhancement bonus<br />
:::*'''Max Dex''' - from armor/shiled table<br />
:::*'''ACP''' - from armor/shield table<br />
:::*'''Spell Fail''' - from armor/shield table<br />
:::*'''Armor or Shield Type''' - from armor/shield table<br />
:::*'''Proficiency''' - are you proficient with this armor/shield<br />
<br />
::*'''Weapon Attributes'''<br />
:::*'''Create Attack''' - use to create an attack on Attacks page<br />
:::*'''Attack Type''' - Attack Type: Melee, Alt Melee, Ranged, Alt Ranged, CMB, or Alt CMB. (note: although not seen, buffs may be in effect in regards to the attack type.)<br />
:::* '''Enh''' - Enhancement: used to show a weapon's [http://www.d20pfsrd.com/basics-ability-scores/glossary#TOC-Enhancement-Bonus enhancement bonus](magical modifiers) e.g.(+2 Long Sword; you would enter "2" in the Enhance field) This bonus modifier is applied to both ATK and DMG.<br />
:::*'''Mwk''' - is the weapon [http://paizo.com/pathfinderRPG/prd/equipment.html#masterwork-weapons Masterwork]? (note: all "enhanced" weapons are masterwork so use check MWK. The sheet's math will keep from stacking bonuses.)<br />
:::*'''Dice''' - how many? e.g.(1)<br />
:::*'''Die''' - what type of die? e.g.(d8)<br />
:::*'''Dmg Mods''' - Macro-text for damage bonuses in addition to Enh. (Evaluated at edit time, must evaluate to number. No queries. Extended Expressions allowed.)<br />
:::*'''Crit''' - the '''lowest''' number necessary to make a [http://paizo.com/pathfinderRPG/prd/combat.html#critical-hits critical hit] as determined by the weapons tables.<br />
:::*'''Mult''' - Multiplier: the number of times damage with usual modifiers are rolled if a crit is confirmed.<br />
:::*'''Range(')''' - normal range(no penalty) in feet, used for ranged weapons.<br />
:::*'''Type''' - B for bludgeoning, P for piercing, or S for slashing<br />
:::*'''Default size''' - weapon size used to automatically adjust attack/damage. '''⛭ Settings|Sheet Configuration|Attacks|Adjust damage based on size'''<br />
:::*'''Extra non-crit Dmg''' - Apply Extra non-crit and/or crit damage as an inline roll e.g. <nowiki>[[ 1d6 ]]</nowiki>, a macro, a straight mod or even a query. Give the Type/Description of the extra damage. (Evaluated at roll time in chat. Queries allowed. Must put [[brackets]] around rolls.)<br />
:::*'''Type''' - description of extra damage<br />
:::*'''Extra crit Dmg''' - Apply Extra crit damage as an inline roll e.g. <nowiki>[[ 1d6 ]]</nowiki>, a macro, a straight mod or even a query. Give the Type/Description of the extra damage. (Evaluated at roll time in chat. Queries allowed. Must put [[brackets]] around rolls.)<br />
:::*'''Type''' - description of extra damage <br />
:::*'''Prof''' - are you proficient with this weapon? <br />
<br />
::*'''Description''' - use this field for longer text.<br />
::*'''Macro Text''' - You can modify the macro text here to customize the output from the repeating section button.<br />
::*'''ID''' - A Unique Identification number associated with this item and it's attributes. Can be used within a macro to target a specific repeating attribute. e.g.(<code>@{selected|repeating_item_-ka2abgz9u85y56brghu_name}</code>)<br />
:Totals for Weight, HP, HP Max, and Value is shown at the bottom of the Inventory section.<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Custom</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
:Create custom macrotext-based attributes. Hovering over each field will reveal the attribute's name. User defined fields allow you to "name" the section.<br />
: ie @{customa1-name} and @{customa1}<br />
: Each sub-section covers the different types of macro-text needed.<br />
<br />
=== Evaluate at edit time custom number attributes ===<br />
:⒜ Evaluated at edit time, must evaluate to number, No queries, Extended Expressions allowed<br />
<br />
=== Evaluate at roll time custom number attributes ===<br />
:⒞ Evaluated at roll time in chat Queries allowed, Must evaluate to number,<nowiki>[[brackets]]</nowiki> '''not''' needed <br />
: These can be used to create numbers that can be added to other queries. There is little difference between these and section (a), except <br />
# You cannot use max and min.<br />
# You can use Queries such as ?{Yes or no|Y,1|N,0}<br />
<br />
=== Evaluate at roll time custom attributes ===<br />
:⒝ Evaluated at roll time in chat Queries allowed Must put <nowiki>[[brackets]]</nowiki> around rolls<br />
<br />
=== Custom Rolls ===<br />
:⒟ Sent to chat. Use these to create rolls that you can call from macros. You can use roll templates by following the guidelines below, or by copying one of the rolls on the sheet and editing it.<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Notes</blockquote> ==<br />
:Create notes. Hovering over each field will reveal the attribute's name. User defined fields allow you to "name" the section.<br />
:e.g. @{customn1-name} and @{customn1}<br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">NPC</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Npc.jpg|200px|thumbnail|Pathfinder NPC]]<br />
<br />
You can use the '''NPC''' page to quickly add statblock information. '''Details''', '''Defense''', '''Offense''', '''Tactics''', '''Statistics''', and '''Special Abilities'''.<br />
<br />
The NPC section should look similar to the rest of the character sheet, but there are some key differences that need to be acknowledged.<br />
<br />
*Other than NPC-specific sheet rolls, most of the '''Attributes''' are shared with the rest of the sheet. Mouse-over sheet rolls and data fields, attributes with "NPC" in their name are only used within the NPC page. You may need to adjust ability/token macros to access any "NPC-only" attributes. <br />
*By default, all sheet rolls from the '''NPC''' page are whispered to the GM only. To change whisper settings go to ('''⛭ Settings|Sheet Configuration|Roll Configuration''')<br />
*NPC repeatable attacks use the same attributes as PC attacks, except the macro-text is NPC-specific.<br />
<br />
=== Monster statblock input section ===<br />
[[File:PF monster parser.png|150px|thumbnail|Pathfinder: Monster statblock import]]<br />
:You can drag and drop monsters directly from the Pathfinder Compendium and have the appropriate attribute fields automatically populated. Open the "Monster statblock input section" and drag and drop a monster's name from the compendium bestiary from the sidebar. After the statblock has been input, you can review values and make adjustments if needed(normally only necessary if you experience any issues after attempting an import). [http://i.imgur.com/5e4zqw1.gif See animated demo.] Once you are satisfied with the values, use the "Parse" button to migrate the statblock to the Pathfinder sheet. <br />
<br />
('''NOTE:''' the parsing process can take some time depending on the complexity of the statblock. If you attempt to drag/drop from the compendium over the top of a previous import, duplication of values will result and cause issues. Only parse once.)<br />
<br />
=== Cut and Paste from other resource statblock parsing ===<br />
:To parse a statblock as a Plus user without the API Companion, paste each line into the fields in the '''Monster statblock input section'''. Each field is roughly in the same order as lines in a PRD or SRD statblock. ''Do not paste the line label at beginning'' (hp, vision, Init, etc)<br />
<br />
:Paste the entire Spells Known or Spell-like-Abilities into the appropriate textbox, do not remove line breaks.<br />
<br />
:Note if Spells Prepared is filled in, that will be used. Otherwise Spells Known will be used. The sheet will not use both if both are filled in.<br />
<br />
:Pro accounts can use the [https://github.com/Roll20-Pathfinder-Character-Sheet/Companion-Script API PFCompanion] as well to paste monsters directly into chat and parse them into a sheet.<br />
<br />
=== Details ===<br />
:Name, CR(Challenge Rating), XP, Alignment, Size, Default Size, Type(sub-type), Undead, Gender, Class(es), Level, Initiative Roll, Vision/Senses, Perception Roll, Aura<br />
<br />
:'''Sheet Roll''' for NPC Initiative:<code>%{selected|NPC-Initiative-Roll}</code><br />
:'''Sheet Roll''' for NPC Perception:<code>%{selected|NPC-Perception-Check}</code><br />
<br />
=== Defense ===<br />
:'''AC''': (Touch, Flat-Footed, Armor, Shield, Deflect, DEX, Dodge, Natural, Size, Misc, Temp, Penalty)<br />
:'''HP''': (Max, HD-Num, HD, HD-Misc, HD-Temp, NL(non-lethal), NPC HP Formula, Heal Conditions)<br />
:'''Saves''': ('''Fort''', Fort-misc, '''Ref''', Ref-misc, '''Will''', Will-misc, Save Notes)<br />
:'''Defensive Abilities''': Weaknesses, Damage Resistances, Resistances, Immunities, SR<br />
:'''Special Qualities''': are included with Abilities<br />
<br />
:'''Sheet Rolls''' for NPC Saving Throws: <code>%{selected|NPC-Fort-Save}, <code>%{selected|NPC-Ref-Save}, %{selected|NPC-Will-Save}</code><br />
<br />
=== Offense ===<br />
:'''Speed, Space and Reach''': (Base, Encumbered, Mult, Run, Burrow, Climb, Fly, Maneuverability, Swim, Misc, Speed Notes, Space, Reach, Reach Notes)<br />
:'''Attacks''': (see [[Pathfinder_Character_Sheet#Attacks|Attacks]])<br />
:'''Spell-Like Abilities''': are included with Abilities<br />
:'''Spells''': (see [[Pathfinder_Character_Sheet#Spells|Spells]])<br />
<br />
=== Tactics ===<br />
:Before Combat, During Combat, Morale, Base Statistics, Combat Gear, Other Gear<br />
<br />
=== Statistics ===<br />
:(STR, DEX, CON, INT, WIS, CHA) sheet rolls, BAB, CMB sheet roll, CMB-misc, CMD, CMD-Misc, CMD-notes, Languages<br />
:'''Feats''': are included with Abilities<br />
:'''Skills''': Very basic grid for rolls or to quickly add a misc modifier. For more control; (see [[Pathfinder_Character_Sheet#Skills|Skills]]) Skill Options, Skill Notes<br />
:'''Sheet Rolls''' for NPC Skills: <code>%{selected|NPC-Acrobatics-Check}, %{selected|NPC-Appraise-Check}, %{selected|NPC-Bluff-Check}, etc.</code><br />
<br />
=== Ecology ===<br />
:Environment, Organization, Treasure<br />
<br />
=== Special Abilities ===<br />
:(see [[Pathfinder_Character_Sheet#Abilities|Abilities]])<br />
:'''Description''': use for general monster description. This field is used for text that is found in a statblock before the monster's name.<br />
</div></div><br />
<br clear=all><br />
<br />
== <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Footer</blockquote> ==<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF Footer.jpg|300px|thumbnail|Pathfinder Footer]]<br />
===Macro-text Field Key===<br />
:There are numerous macro-text enabled fields on the sheet. Depending on how the field's value will be processed, it is important to use the proper format to prevent errors. Each of these fields will include a superscript letter denoting the format required. Use this key as a guide when entering data.<br />
<br />
:::⒜ Evaluated at edit time. Must evaluate to number. No queries or rolls. Extended Expressions allowed. Must use ID number to refer to row value. Can refer to ⒜ expressions or number attributes only.<br />
<br />
:::⒝ Evaluated at roll time. May output string or number. Queries and rolls allowed. Must put <nowiki>[[brackets]]</nowiki> around rolls. Can refer to ⒜,⒝,⒞ expressions.<br />
<br />
:::⒞ Evaluated at roll time. Must evaluate to number. Queries and rolls allowed. <nowiki>[[brackets]]</nowiki> automatically placed around expression. Can refer to ⒜ or ⒞ expressions or number attributes only (or ⒝ if it evaluates to a number).<br />
<br />
:::⒟ The actual roll. Sent to chat. Evaluated at roll time. Can refer to any of the above expressions ⒜,⒝,⒞.<br />
<br />
===Sheet Credits=== <br />
:Typically, other than Sam M.(the original PF sheet author), the names of the most recent and/or currently active sheet authors are noted here. Thanks to all the volunteers along the way.<br />
===Version=== <br />
:Date and version number can be found here.<br />
===Links=== <br />
:Questions, feedback, looking for help, want to help?, etc.<br />
</div></div><br />
<br clear=all><br />
<br />
= <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Settings</blockquote> =<br />
<div class="toccolours mw-collapsible"><br />
<div class="mw-collapsible-content"><br />
[[File:PF_Config.jpg|300px|thumbnail|Pathfinder Settings:Sheet Configuration]]<br />
<br />
The '''⛭ Settings''' page allows you to customize various features found on the Pathfinder sheet. New characters start with the '''Settings''' page open. Many sections and features can only be enabled from the Settings page. For example, the Spells tab/page will remain hidden unless '''⛭ Settings|Sheet Configuration|Spells|Uses Spells''' is enabled.<br />
<br />
== Sheet Configuration ==<br />
=== Accessibility ===<br />
: Sheet rolls will use a simplified roll template. Header images will not be used and formatting will be simplified. Better option for text-based reading apps.<br />
:*'''Use Attack Simple Template''': attack-based rolls (pf_attack)<br />
:*'''Use Spell Simple Template''': spell-based rolls (pf_spell)<br />
:*'''Use Other Simple Templates''': all other sheet rolls<br />
<br />
=== Font/Background ===<br />
: Choose a font and background image used for this character. These options do not affect roll templates.<br />
<br />
=== Pages ===<br />
:*'''Is NPC or Monster''': this setting is used to determine NPC/Monster specific rules and will show/hide various sections of the sheet, such as the NPC page. You will see a large Monster/NPC banner across the top of the sheet if this option is enabled. ('''note''': there are numerous attributes shared between the PC and NPC section of the sheet. You may need to use the PC section of the sheet although you are editing an NPC/monster.)<br />
<br />
=== Buffs ===<br />
:*'''Use buff bonus types and stacking''': if enabled, buffs will automatically apply stacking rules.<br />
<br />
=== Spells ===<br />
:*'''Uses Spells''': this option will show the Spells tab/page.<br />
:*'''Use Spell Points''': shows additional sub-section on the Spells page for "Spell Points".<br />
<br />
=== Lists ===<br />
If you are using a newer version of the Pathfinder sheet '''v1.x+''' and creating a new character, it's recommended that you leave these '''unchecked'''. This section determines which Original Ability lists are shown. The "original" lists are those Ability lists that existed with older versions of the sheet. If checked, you will also see the option to '''"Merge"''' old lists to the newer Abilities list. Once an older list has been '''merged''', you can use the Trashcan (Delete Abilities) option at the top of each repeating list to delete all of the older abilities. You should verify that your old abilities have been properly migrated before using the delete abilities option. <br />
:*''''Use Separate Traits List'''<br />
:*''''Use Separate Racial Traits List'''<br />
:*''''Use Separate Feats List'''<br />
:*''''Use Separate Class Features List'''<br />
:*''''Use Separate Spell-like Abilities List'''<br />
<br />
=== Attacks ===<br />
:*'''Display Alt Ranged attack type''': shows an alternate Ranged modifier<br />
:*'''Display Alt CMB attack type''': shows an alternate CMB modifier<br />
:*'''Adjust damage based on size''': additional fields, Use Size and Default Size(weapon's size as compared to Size from the Core character details section) will be displayed on each attack. Damage dice will be adjusted automatically.<br />
:*'''Use Dual Wield (BETA)''': shows a Dual Wield section on the Attacks page.<br />
<br />
=== Encumbrance ===<br />
:*'''Encumbrance based on''': selects how encumbrance will be handled, including Armor Check Penalty and Max Dex. Defaults to "Armor, Shield & Load". Selecting "Load only" or "Ignore Encumbrance" will force ACP="0" and Max Dex="99" on the Defenses|Armor Penalties.<br />
:*'''Uses Dwarf Encumbrance Rules''': this option is automatically enabled if you enter "Dwarf" for Race. Speed will not be modified based on armor or encumbrance.<br />
<br />
=== Hit Points ===<br />
:*'''Auto-calc hp''': automatically calculate hp. Based off of total Level and HD<br />
:*'''Use max hp for first level/HD''': Use max hit points for first level. Racial hit dice are considered 'first' if character has both racial and class hit dice.<br />
:*'''Update curr HP when max HP changes''': When Max hp changes, updates current hit points by same amount.<br />
<br />
=== Defenses ===<br />
:*'''Do not lose DEX when Flat-Footed'''': If checked, AC will not auto adjust when a condition is checked that causes loss of DEX to AC, except for immobilizing conditions.<br />
:*'''Use Level/HD for CMD instead of BAB'''': ie Combat Feats; Improved Armor Focus, Improved Shield Focus<br />
:*'''Allow AC and CMD to use different ability scores'''': If checked, CMD could use different ability in 2nd dropdown than AC uses. For instance, DEX for AC and INT for CMD, instead of DEX or WIS for both.<br />
<br />
=== Advanced ===<br />
:Use these options to show/hide more advanced features. ie Full Macro-text, attack/damage macros, custom columns on Spells/Day, etc.<br />
:*'''Display user defined and misc fields''': Display extra fields for advanced customization, such as columns marked 'user defined'.<br />
:*'''Display roll templates for customization''': Display macro fields for customizing roll template rolls.<br />
:*'''Display 'add-to-roll' rolltime fields''': Display Advanced fields to add to rolls. These will add to any 1d20 roll. Evaluated at roll-time, so queries may be used. Each requires '0' as default, and [[]] around rolls.<br />
<br />
=== Roll Configuration ===<br />
:Set whisper options for PC and NPC sheet rolls. "Public rolls" will not be whispered while "Whisper GM" will only be seen by the player and the GM.<br />
:*'''NPC''': sheet rolls made from the NPC page.<br />
:*'''PC''': sheet rolls made from the PC pages.<br />
:*'''Show both roll menu buttons for Monsters/NPCs''': Display both sets of menu buttons at top of page: for PC-Whisper and NPC-Whisper. Allows more flexibility in making a roll public or not.<br />
:*'''Stat Rolls''': Defense stats and future stat-based menu button rolls.<br />
:*'''Round Corners on non-simple template''': use rounded corners on regular roll templates<br />
:*'''Heading background and outlines''': apply a color to roll templates<br />
<br />
== Rule Options ==<br />
[[File:PF_Rules_Options.jpg|300px|thumbnail|Pathfinder Settings:Rules Options]]<br />
==== Core Rule Options ====<br />
:*'''Set to PFS config settings''': Pathfinder Society option that enables auto-calc hp and Prestige and Fame points(displays a sub-section on the Core page as well).<br />
:*'''Use Prestige and Fame Points''': displays a sub-section on the Core page.<br />
:*'''Use Hero Points''': displays a sub-section on the Core page.<br />
<br />
=== Pathfinder Unchained ===<br />
: enable alternative Pathfinder Unchained options.<br />
:*'''Display/Enable Unchained Skills''': displays only Background/Adventure or Consolidated skills on the Skills page and automatically adjusts total skill rank calculations as needed.<br />
:*'''Background Skills''': splits skills into Adventure, Background and All.<br />
:*'''Consolidated Skills''': shows only a Consolidated skills list<br />
:*'''Display Wound Thresholds''': In the wound thresholds variant, a character divides her hit point total into four quarters, and takes penalties whenever she's not in her top quarter.<br />
:*'''Has Endurance Feat''': Endurance affects wounds by changing the penalty.<br />
:*'''Gritty Mode''': Gritty mode doubles penalties.<br />
<br />
<br />
=== Pathfinder Mythic Adventures ===<br />
:*'''Display/Enable Mythic Adventures Character Sheet Items''': Toggle alternative ruleset items found for Pathfinder Mythic Adventures. This will reveal a sub-section on the Abilities page (Mythic Information and Mythic Power) as well as reveal additional sub-tabs under Abilities(Mythic Abilities).<br />
<br />
=== Pathfinder Psionics ===<br />
:*'''Display/Enable Psionics Character Sheet Items''': displays a Psionics sub-section on the Abilities page.<br />
<br />
=== Occult Adventures ===<br />
:*'''Use Kineticist Burn''': displays a '''Kineticist''' sub-section on the '''Abilities''' page. This allows you to set up Burn value plus a series of dropdowns to create kinetic blast attack entries.<br />
:*'''Show Spell Points for Phrenic Pool or Mesmerist Tricks''' Option for showing Spell Points on the '''Spells''' page for Phrenic Pool or Mesmerist Tricks<br />
<br />
=== Horror Adventures ===<br />
:*'''Enable Horror Adventures''': displays a Sanity sub-section on the Defenses page.<br />
<br />
== Header Images ==<br />
[[File:PF_Header_Images.jpg|300px|thumbnail|Pathfinder Settings:Header Images]]<br />
: Add small iconic images to each roll template. Images are optional and are disabled by default. All macros on the sheet now include a defined key for <code>{{header_image=@{header_image-'''X'''}}</code> Where '''X''' is the name of the appropriate roll template. You may also substitute an image directly into the header as well for a custom macro. '''ie''' <code>{{header_image=[name](www.url.com)}}</code><br />
<br />
* '''None''' - images will not be used for the roll template. This is the default setting.<br />
* '''Default''' - roll templates will use images that have been included in the sheet.<br />
* '''Custom''' - roll templates will use the image as provided by the URL field. Since these images are added to the header of your roll templates, it is best to keep them iconic in size. Smaller than 50px is recommended.<br />
* '''URL''' - insert a link for the image used by the Custom option.<br />
<br />
== HeroLab Character import ==<br />
Allows you to import character data from a Hero Lab character into the character sheet.<br />
<br />
=== Instructions ===<br />
# Export JSON data. There are two ways to do this, and you only need to do '''one''' of these:<br />
## Save the character as a JSON file.<br />
### Download and install Leigh M.'s [http://lonedwarf.com/roll20/Roll20PathfinderExporter_v1_1.hl Hero Lab Pathfinder Exporter plug-in] for Hero Lab. There have been reports of this plugin causing the Mac OS X version of Hero Lab to crash when attempting to save using it; if you experience this, you will have to use the second method.<br />
### From Hero Lab, open the File menu and choose "Save Custom Output".<br />
### Select "Roll20 Pathfinder" and "Current Hero Only", then click Output.<br />
### Open the HTM file in a text editor and copy the entire contents.<br />
## Save the character as an XML file, and convert to JSON.<br />
### From Hero Lab, open the File menu and choose "Save Custom Output".<br />
### Select "Generate XML File" and "Current Hero Only", then click Output.<br />
### Open the XML file in a text editor and copy the entire contents. '''Do not copy the XML from Internet Explorer'''; doing so will also copy the '+' and '-' buttons next to the XML nodes, '''which will cause errors in the process.''' You '''must''' use a plain-text editor such as Notepad or [https://notepad-plus-plus.org/ Notepad++].<br />
### Open [http://codebeautify.org/xmltojson CodeBeautify's XML to JSON converter] in your web browser.<br />
### Paste the XML data into the left hand field labelled "Xml Input".<br />
### Click the "XML to JSON" button in the center of the window.<br />
### Copy '''all''' of the data from the "Result: XML to JSON" field on the right.<br />
# Paste JSON data into the character sheet.<br />
## Open the Settings page on the character sheet.<br />
## Expand the section titled "HeroLab Character Import"<br />
## Paste the JSON into the text field<br />
## Click anywhere outside of the text field (so that the web browser knows you're done editing it)<br />
If the process worked correctly, after a few moments the character sheet will clear the HL Import text field; at this point, the sheet may still be unresponsive for a few minutes as it updates the data that was imported. The more data that is imported, the longer the sheet may be unresponsive; this is especially true for characters with a large number of imported spells.<br />
<br />
Instead of saving a character as an XML file from Hero Lab, you can also get access to the XML by extracting the portfolio file as if it were a ZIP file. Simply rename the file extension from .por to .zip, and extract it as any other ZIP file. The XML files will be located under the "statblock_xml" folder. This will allow you to import characters and creatures from portfolio files even if you don't own all the data packages that were used to create it, or without owning Hero Lab at all.<br />
<br />
=== Known Issues ===<br />
* The sheet may not be able to properly identify whether something is a racial trait, a class feature, or other. You can reassign the category after importing, and future imports will not change a manual assignment.<br />
* The sheet currently does not import attacks. Weapons should be imported into your inventory with the appropriate weapon attributes (except for attack type, i.e. melee, ranged, etc). You can quickly create an attack for a weapon by finding it in your inventory, setting the "Attack Type" under "Weapon Attributes", then clicking the "Create Atk" button. You may need to adjust the resulting Attack on the Attacks page to add modifiers such as Weapon Focus or Weapon Training (in "Attack mods" and/or "Dmg mods"), as well as setting which ability modifier to use for damage.<br />
<br />
== Roll Template Info ==<br />
* '''Roll Template Info''': This section can be used to examine each roll template's functionality used on the Pathfinder sheet. Examples of defined properties/keys are given for each roll template. Use the macro text field to modify the macro and see the results by making a sheet roll. You can always reset macro-text fields by deleting all text and closing/re-opening the sheet.<br />
<br />
== Migrations ==<br />
:It '''IS NOT''' recommended to use this section unless instructed to by sheet developers.<br />
:This section shows migrations(conversions of old attributes/features to newer ones) that have been successfully completed or that character creation was done after a given feature set(no migration necessary).<br />
<br />
:'''Macros''' - If you are having problems with one particular macro, make the macro text fields visible from '''⛭ Settings|Sheet Configuration|Display roll templates for customization'''. Then click in the particular attack or skill, select all, and delete the macro. Click out of the field somewhere else, and the field will fill in with the default macro.<br />
<br />
:If you are having problems with many macros, uncheck the appropriate box below and hit the recalc button. This will reset all macros of the particular type. '''Note:''' You may lose customization's<br />
<br />
:'''prior to v1.0'''<br />
::Class skill checkboxes, Dmg Multiplier, Spell Ranges, NPC Settings, Copy duplicate fields, Worn Equipment, Misc hp field, Misc skill point field, Ability list flags, Items Default Values, Features default values, Attacks default values<br />
<br />
:'''v1.01 - 1.58'''<br />
::Linked attacks, Skill take 10 dropdown,<br />
<br />
:'''v1.65'''<br />
::Damage and check buffs, Ability and Attack Type dropdowns, Skill calc speed, Fatigued Conditions, Attack bonus dropdowns, Profession Skills<br />
<br />
== Spell Migrations ==<br />
: Shows spell migration handling of older/deprecated attributes and macros.<br />
: If spell migrations have been completed, verify by checking the spells listed on the Spells page, you may safely delete older spells listed under Spells Migration.<br />
: Old and New Spell id's are listed if you need update older ability macros.<br />
</div></div><br />
<br clear=all><br />
<br />
= <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Roll Templates</blockquote> =<br />
<div class="toccolours mw-collapsible"><br />
<br />
<div class="mw-collapsible-content"><br />
<br />
[[Roll_Templates|Roll templates]] use a combination of html, css, and macro commands to format output to chat. While the HTML, CSS and sheet-roll button macros are written into the sheet, GM's and player's can utilize custom macros either within the macro-text of found within the sheet or from ability macros used outside of the sheet. There are currently 6 different templates written into the Pathfinder sheet: pf_ability, pf_attack, pf_block, pf_defense, pf_generic, and pf_spell.<br />
<br><br><br />
Roll templates must declare the roll template used ie '''&{template:<template name>}''' and follow the syntax '''{{<propertyname>= <value>}}''' Property names that are defined within the roll template will follow the formatting and logic as given in the template. Regardless if a property has been defined, all roll templates on the sheet include the '''allProps()''' helper function which allows any '''{{<key>=<value>}}''' entry to be included in the macro's output. Undefined keys are usually given a new row with formatting determined by the exact template used. Use the Roll Template Info section located on the [[https://wiki.roll20.net/Pathfinder_Character_Sheet#Configuration Configuration Tab]] of the sheet to explore the various roll template functionality.<br><br><br />
<br />
=== Common Properties ===<br />
The properties listed below are common to all roll templates used on the sheet.<br />
{| class="wikitable"<br />
|-<br />
! Property/Key !! Description/Examples<br />
|-<br />
| <nowiki>{{character_name}}</nowiki>|| The Character's name. ie <nowiki>{{character_name=@{character_name}}}</nowiki><br />
|-<br />
| <nowiki>{{character_id}}</nowiki>|| Character's sheet. Hyperlinks the character_name property to open the character's sheet directly from chat. ie <nowiki>{{character_id=@characer_id}}</nowiki><br />
|-<br />
| <nowiki>{{name}}</nowiki>|| Name of the roll being made. ie <nowiki>{{name=Acrobatics}}</nowiki> or <nowiki>{{name=@{repeating_feat_X_name}}}</nowiki><br />
|-<br />
| <nowiki>{{name_link}}</nowiki>|| URL hypertext used with the name property. ie <nowiki>{{name_link=http://www.foo.com}}</nowiki><br />
|-<br />
| <nowiki>{{header_image}}</nowiki>|| Used to insert small iconic image into the header. See([[Pathfinder_Character_Sheet#Header_Images|Header Images]]) ie <nowiki>{{header_image=header_image-pf_spell}}</nowiki><br />
|-<br />
| <nowiki>{{subtitle}}</nowiki>|| The subtitle property adds a row below the header. <nowiki>{{subtitle=~ Melee Attack ~}}</nowiki><br />
|-<br />
| <nowiki>{{color}}</nowiki>|| The color property sets the background color of the header and border. <br />
Color options can be changed from '''<nowiki>⛭ Settings|Sheet Configuration|Roll Configuration|Heading background and outlines</nowiki>'''. <br />
<br />
<nowiki>{{color=@{rolltemplate_color}}}</nowiki> <br />
<br />
Color value names recognized('''case sensitive''') are:"white, grey, darkgrey, pink, darkpink, red, darkred, orange, darkorange, yellow, darkyellow, green, darkgreen, teal, darkteal, cyan, darkcyan, azure, darkazure, blue, darkblue, purple, darkpurple, violet, darkviolet". An empty value(no color specified) will default to "black".<br />
|-<br />
|<nowiki>@{toggle_accessible_flag}</nowiki>|| Used to toggle "simplified/regular" roll template.<br />
|-<br />
|<nowiki>@{toggle_rounded_flag}</nowiki>|| Used to toggle "rounded corners/square corners" on the roll template. Enabling rounded corners adds changes <nowiki>{{rounded=}}</nowiki> to <nowiki>{{rounded=rounded}}</nowiki> in the macro which applies the rounded border style to the roll template's output.<br />
|-<br />
|<nowiki>{{font}}</nowiki>|| Used to apply font preferences to the sheet and roll templates. Color options can be changed from '''<nowiki>⛭ Settings|Sheet Configuration|Roll Configuration|Font/Background</nowiki>'''<br />
<br />
<br />
<nowiki>@{apply_specfont_chat}@{use_specfont}</nowiki><br />
<br />
Font value names recognized('''case sensitive''') are: Lucida Grande/Arial, Verdana, Comic Sans, Segoe UI, Lucida Sans Unicode, Fantasy, Copperplate, Script<br />
|}<br />
<br />
=== pf_ability Properties ===<br />
The properties below are specific to abilities.<br />
<br />
{| class="wikitable"<br />
|-<br />
! Property/Key !! Description/Examples<br />
|-<br />
| <nowiki>{{rule_category}}</nowiki>|| Shows the Ability subcategory. ie <nowiki>{{rule_category=@{rule_category}}}</nowiki><br />
|-<br />
| <nowiki>{{source}}</nowiki>|| Shows source of the Ability. ie <nowiki>{{source=@{class-name}}}</nowiki><br />
|-<br />
| <nowiki>{{is_sp}}</nowiki>|| Flag for spell-like ability. Shows additional spell-related rows. ie <nowiki>{{is_sp=@{is_sp}}}</nowiki><br />
|-<br />
| <nowiki>{{hasspellrange}}</nowiki>|| Shows additional range-related rows. ie <nowiki>{{hasspellrange=@{range_pick}}}</nowiki><br />
|-<br />
| <nowiki>{{spell_range}}</nowiki>|| Shows range info. ie <nowiki>{{spell_range=^{@{range_pick}}}}</nowiki><br />
|-<br />
| <nowiki>{{casterlevel}}</nowiki>|| Shows CL. ie <nowiki>{{casterlevel=[[@{casterlevel}]]}}</nowiki><br />
|-<br />
| <nowiki>{{spell_level}}</nowiki>|| Shows Spell level. ie <nowiki>{{spell_level=[[@{spell_level}]]}}</nowiki><br />
|-<br />
| <nowiki>{{hasposrange}}</nowiki>|| Range. ie <nowiki>{{hasposrange=@{hasposrange}}}</nowiki><br />
|-<br />
| <nowiki>{{custrange}}</nowiki>|| Shows Custom Range info. ie <nowiki>{{custrange=@{range}}}</nowiki><br />
|-<br />
| <nowiki>{{range}}</nowiki>|| Shows numeric Range. ie <nowiki>{{range=[[@{range_numeric}]]}}</nowiki><br />
|-<br />
| <nowiki>{{save}}</nowiki>|| Shows Save description. ie <nowiki>{{save=@{save}}}</nowiki><br />
|-<br />
| <nowiki>{{savedc}}</nowiki>|| Shows Save DC. ie <nowiki>{{save=@{savedc}}}</nowiki><br />
|-<br />
| <nowiki>{{hassr}}</nowiki>|| Flag for SR. ie <nowiki>{{hassr=@{abil-sr}}}</nowiki><br />
|-<br />
| <nowiki>{{sr}}</nowiki>|| Shows SR info. ie <nowiki>{{sr=^{@{abil-sr}}}}</nowiki><br />
|-<br />
| <nowiki>{{hasfrequency}}</nowiki>|| Flag for frequency. ie <nowiki>{{hasfrequency=@{hasfrequency}}}</nowiki><br />
|-<br />
| <nowiki>{{frequency}}</nowiki>|| Shows Frequency info. ie <nowiki>{{frequency=^{@{frequency}}}}</nowiki><br />
|-<br />
| <nowiki>{{next_cast=}}</nowiki>|| Shows more Frequency info. ie <nowiki>{{next_cast=@{rounds_between}}}</nowiki><br />
|-<br />
| <nowiki>{{hasuses}}</nowiki>|| Flag for uses info. ie <nowiki>{{hasuses=@{hasuses}}}</nowiki><br />
|-<br />
| <nowiki>{{uses}}</nowiki>|| Current uses. ie <nowiki>{{uses=@{used}}}</nowiki><br />
|-<br />
| <nowiki>{{uses_max}}</nowiki>|| Shows Max info. ie <nowiki>{{uses_max=@{used|max}}}</nowiki><br />
|-<br />
| <nowiki>{{cust_category}}</nowiki>|| ie <nowiki>{{cust_category=@{cust-category}}}</nowiki><br />
|-<br />
| <nowiki>{{concentration}}</nowiki>|| ie <nowiki>{{concentration=[[@{Concentration-mod}]]}}</nowiki><br />
|-<br />
| <nowiki>{{damage}}</nowiki>|| Shows damage(inline roll) ie <nowiki>{{damage=@{damage-macro-text}}}</nowiki><br />
|-<br />
| <nowiki>{{damagetype}}</nowiki>|| Shows damage type. ie <nowiki>{{damagetype=@{damage-type}}}</nowiki><br />
|-<br />
| <nowiki>{{hasattack}}</nowiki>|| Flag for Attack info. ie <nowiki>{{hasattack=@{hasattack}}}</nowiki><br />
|-<br />
| <nowiki>{{attacktype}}</nowiki>|| Shows Attack type. ie <nowiki>{{attacktype=^{@{abil-attacktypestr}}}}</nowiki><br />
|-<br />
| <nowiki>{{targetarea}}</nowiki>|| Shows targeted area info. ie <nowiki>{{targetarea=@{targets}}}</nowiki><br />
|-<br />
| <nowiki>{{duration}}</nowiki>|| Shows Duration info. ie <nowiki>{{duration=@{duration}}}</nowiki><br />
|-<br />
| <nowiki>{{shortdesc}}</nowiki>|| Shows Short Description text. ie <nowiki>{{shortdesc=@{short-description}}}</nowiki><br />
|-<br />
| <nowiki>{{description}}</nowiki>|| Shows Description text. ie <nowiki>{{description=@{description}}}</nowiki><br />
|-<br />
| <nowiki>{{deafened_note}}</nowiki>|| Shows Defeaned condition note. ie <nowiki>{{deafened_note=@{SpellFailureNote}}}</nowiki><br />
|-<br />
|}<br />
'''pf_ability default macro-text:'''<br><br />
<nowiki>&{template:pf_ability} @{toggle_accessible_flag} @{toggle_rounded_flag} {{color=@{rolltemplate_color}}} {{header_image=@{header_image-pf_ability}}} {{character_name=@{character_name}}} {{character_id=@{character_id}}} {{subtitle=^{@{rule_category}}}} {{name=@{name}}} {{rule_category=@{rule_category}}} {{source=@{class-name}}} {{is_sp=@{is_sp}}} {{hasspellrange=@{range_pick}}} {{spell_range=^{@{range_pick}}}} {{casterlevel=[[@{casterlevel}]]}} {{spell_level=[[@{spell_level}]]}} {{hasposrange=@{hasposrange}}} {{custrange=@{range}}} {{range=[[@{range_numeric}]]}} {{save=@{save}}} {{savedc=[[@{savedc}]]}} {{hassr=@{abil-sr}}} {{sr=^{@{abil-sr}}}} {{hasfrequency=@{hasfrequency}}} {{frequency=^{@{frequency}}}} {{next_cast=@{rounds_between}}} {{hasuses=@{hasuses}}} {{uses=@{used}}} {{uses_max=@{used|max}}} {{cust_category=@{cust-category}}} {{concentration=[[@{Concentration-mod}]]}} {{damage=@{damage-macro-text}}} {{damagetype=@{damage-type}}} {{hasattack=@{hasattack}}} {{attacktype=^{@{abil-attacktypestr}}}} {{targetarea=@{targets}}} {{duration=@{duration}}} {{shortdesc=@{short-description}}} {{description=@{description}}} {{deafened_note=@{SpellFailureNote}}}</nowiki><br />
<br />
=== pf_attack Properties ===<br />
The properties defined in the pf_attack roll template make use of logic(roll helpers) to determine which rolls should be displayed. For example, crit_confirm and crit_damage will only be shown if an attack is a threat. @{macro_options} is used by the sheet to enable the toggling of notes related to attacks and contains the properties for @{melee_notes}, @{ranged_notes}, @{cmb_notes}, and @{attack_notes}.<br />
<br><br />
'''&{template:pf_attack}'''<br />
{| class="wikitable sortable"<br />
|-<br />
! Property/Key !! Description/Examples<br />
|-<br />
| <nowiki>{{attack}}</nowiki>|| Attack roll <nowiki>{{attack=[[ 1d20cs>[[ @{selected|repeating_weapon_$0_crit-target} ]] + @{selected|repeating_weapon_$0_attack_macro} ]]}}</nowiki><br />
|-<br />
| <nowiki>{{damage}}</nowiki>|| Damage <nowiki>{{damage=[[@{selected|repeating_weapon_$0_damage-dice-num}d@{selected|repeating_weapon_$0_damage-die} + @{selected|repeating_weapon_$0_damage_macro}]]}}</nowiki><br />
|-<br />
| <nowiki>{{crit_confirm}}</nowiki>|| Crit confirmation if attack was a threat <nowiki>{{crit_confirm=[[ 1d20 + @{selected|repeating_weapon_$0_attack_macro} + [[ @{selected|repeating_weapon_$0_crit_conf_mod} ]] ]]}}</nowiki><br />
|-<br />
| <nowiki>{{crit_damage}}</nowiki>|| Crit damage if Crit was confirmed <nowiki>{{crit_damage=[[ [[ @{selected|repeating_weapon_$0_damage-dice-num} * (@{selected|repeating_weapon_$0_crit-multiplier} - 1) ]]d@{selected|repeating_weapon_$0_damage-die} + ((@{selected|repeating_weapon_$0_damage_macro}) * [[ @{selected|repeating_weapon_$0_crit-multiplier} - 1 ]]) ]]}}</nowiki><br />
|-<br />
| <nowiki>{{attack2}},{{attack3}},{{attack3}},{{attack4}},{{attack5}},{{attack6}},{{attack7}},{{attack8}}</nowiki>|| Additional **iterative attacks**. Note: iterative attacks are toggled from within the repeating weapon/attack <nowiki>{{attack2=[[ 1d20cs>[[ @{crit-target} ]] + [[ @{attack_macro} + @{iterative_attack2_value} ]] [iterative] ]]}}</nowiki><br />
|-<br />
| <nowiki>{{damage1}},{{damage2}},{{damage3}},{{damage4}},{{damage5}},{{damage6}},{{damage7}},{{damage8}}</nowiki>|| Damage for **iterative attacks**. <nowiki>{{damage2=[[ @{damage-dice-num}d@{damage-die} + @{damage_macro} ]]}}</nowiki><br />
|-<br />
| <nowiki>{{crit_confirm2}},{{crit_confirm3}},{{crit_confirm4}},{{crit_confirm5}},{{crit_confirm6}},{{crit_confirm7}},{{crit_confirm8}}</nowiki>|| Crit confirmation for **iterative attacks**. <nowiki>{{crit_confirm2=[[ 1d20 + [[ @{attack_macro} + @{iterative_attack2_value} ]] [iterative] + [[ @{crit_conf_mod} ]] ]]}}</nowiki><br />
|-<br />
| <nowiki>{{crit_damage2}},{{crit_damage3}},{{crit_damage4}},{{crit_damage5}},{{crit_damage6}},{{crit_damage7}},{{crit_damage8}}</nowiki>|| Crit damage for **iterative attacks**. <nowiki>{{crit_damage2=[[ [[ @{damage-dice-num} * [[ @{crit-multiplier} - 1 ]] ]]d@{damage-die} + ((@{damage_macro}) * [[ @{crit-multiplier} - 1 ]]) ]]}}</nowiki><br />
|-<br />
| <nowiki>{{precision_dmg21}},{{precision_dmg31}},{{precision_dmg41}},{{precision_dmg51}},{{precision_dmg61}},{{precision_dmg71}},{{precision_dmg81}}</nowiki>|| Precision damage for **iterative attacks**. <nowiki>{{precision_dmg21=@{precision_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{precision_dmg22}},{{precision_dmg32}},{{precision_dmg42}},{{precision_dmg52}},{{precision_dmg62}},{{precision_dmg72}},{{precision_dmg82}}</nowiki>|| Precision damage 2 for **iterative attacks**. <nowiki>{{precision_dmg22=@{global_precision_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{critical_dmg21}},{{critical_dmg31}},{{critical_dmg41}},{{critical_dmg51}},{{critical_dmg61}},{{critical_dmg71}},{{critical_dmg81}}</nowiki>|| Critical damage 1 for **iterative attacks**. <nowiki>{{critical_dmg21=@{critical_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{critical_dmg22}},{{critical_dmg32}},{{critical_dmg42}},{{critical_dmg52}},{{critical_dmg62}},{{critical_dmg72}},{{critical_dmg82}}</nowiki>|| Critical damage 2 for **iterative attacks**. <nowiki>{{critical_dmg22=@{global_critical_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{attack2name}},{{attack3name}},{{attack4name}},{{attack5name}},{{attack6name}},{{attack7name}},{{attack8name}}</nowiki>|| Attack Name for **iterative attacks**. <nowiki>{{attack2name=@{iterative_attack2_name}}}</nowiki><br />
|-<br />
| <nowiki>{{type}}</nowiki>|| Weapon damage type <nowiki>{{type=@{type}}}</nowiki><br />
|-<br />
| <nowiki>{{weapon_notes}}</nowiki>|| Weapon Notes Note: toggled from within the repeating weapon/attack.</nowiki><br />
|-<br />
| <nowiki>{{melee_notes}}</nowiki>|| Melee Notes Note: toggled from within the repeating weapon/attack. Toggled from within the Macro Options.</nowiki><br />
|-<br />
| <nowiki>{{ranged_notes}}</nowiki>|| Ranged Notes Note: toggled from within the repeating weapon/attack. Toggled from within the Macro Options.</nowiki><br />
|-<br />
| <nowiki>{{cmb_notes}}</nowiki>|| CMB Notes Note: toggled from within the repeating weapon/attack. Toggled from within the Macro Options.</nowiki><br />
|-<br />
| <nowiki>{{attack_notes}}</nowiki>|| Attack Notes Note: Toggled from within the Macro Options.</nowiki><br />
|-<br />
| <nowiki>{{vs}}</nowiki>|| Versus: toggled from within the repeating weapon/attack. <nowiki>{{vs=@{vs}}}</nowiki><br />
|-<br />
| <nowiki>{{vs@{vs}}}</nowiki>|| Versus defensive option: toggled from within the repeating weapon/attack. <nowiki>{{vs@{vs}=@{vs}}}</nowiki><br />
|-<br />
| <nowiki>{{precision_dmg1}}</nowiki>|| Precision damage 1: toggled from within the Macro Options. <nowiki>{{precision_dmg1=@{global_precision_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{precision_dmg1_type}}</nowiki>|| Precision damage 1 type: toggled from within the repeating weapon/attack. <nowiki>{{precision_dmg1_type=@{precision_dmg_type}}}</nowiki><br />
|-<br />
| <nowiki>{{precision_dmg2}}</nowiki>|| Precision damage 2: toggled from within the Macro Options. <nowiki>{{precision_dmg2=@{global_precision_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{precision_dmg2_type}}</nowiki>|| Precision damage 2 type: toggled from within the Macro Options. <nowiki>{{precision_dmg2_type=@{global_precision_dmg_type}}}</nowiki><br />
|-<br />
| <nowiki>{{critical_dmg1}}</nowiki>|| Critical damage 1: toggled from within the repeating weapon/attack. <nowiki>{{critical_dmg1=@{critical_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{critical_dmg1_type}}</nowiki>|| Critical damage 1 type: toggled from within the repeating weapon/attack. <nowiki>{{critical_dmg1_type=@{critical_dmg_type}}}</nowiki><br />
|-<br />
| <nowiki>{{critical_dmg2}}</nowiki>|| Critical damage 2: toggled from within the Macro Options. <nowiki>{{critical_dmg2=@{global_critical_dmg_macro}}}</nowiki><br />
|-<br />
| <nowiki>{{critical_dmg2_type}}</nowiki>|| Critical damage 2 type: toggled from within the Macro Options. <nowiki>{{critical_dmg2_type=@{global_critical_dmg_type}}}</nowiki><br />
|-<br />
| <nowiki>{{description}}</nowiki>|| Weapon Description will be the last item shown on the template. <nowiki>{{description=@{repeating_weapon_$0_description}}}</nowiki><br />
|}<br />
'''pf_attack example:'''<br><br />
<nowiki>@{selected|PC-whisper} &{template:pf_attack} @{selected|toggle_attack_accessible} @{selected|toggle_rounded_flag}{{color=@{selected|rolltemplate_color}}} {{character_name=@{selected|character_name}}} {{character_id=@{selected|character_id}}} {{subtitle}} {{name=@{selected|repeating_weapon_$0_name}}} {{attack=[[ 1d20cs>[[ @{selected|repeating_weapon_$0_crit-target} ]] + @{selected|repeating_weapon_$0_attack_macro} ]]}} {{damage=[[@{selected|repeating_weapon_$0_damage-dice-num}d@{selected|repeating_weapon_$0_damage-die} + @{selected|repeating_weapon_$0_damage_macro}]]}} {{crit_confirm=[[ 1d20 + @{selected|repeating_weapon_$0_attack_macro} + [[ @{selected|repeating_weapon_$0_crit_conf_mod} ]] ]]}} {{crit_damage=[[ [[ @{selected|repeating_weapon_$0_damage-dice-num} * (@{selected|repeating_weapon_$0_crit-multiplier} - 1) ]]d@{selected|repeating_weapon_$0_damage-die} + ((@{selected|repeating_weapon_$0_damage_macro}) * [[ @{selected|repeating_weapon_$0_crit-multiplier} - 1 ]]) ]]}} {{type=@{selected|repeating_weapon_$0_type}}} {{weapon_notes=@{selected|repeating_weapon_$0_notes}}} @{selected|repeating_weapon_$0_iterative_attacks} @{selected|repeating_weapon_$0_macro_options} {{vs=@{selected|repeating_weapon_$0_vs}}} {{vs@{selected|repeating_weapon_$0_vs}=@{selected|repeating_weapon_$0_vs}}} {{precision_dmg1=@{selected|repeating_weapon_$0_precision_dmg_macro}}} {{precision_dmg1_type=@{selected|repeating_weapon_$0_precision_dmg_type}}} {{precision_dmg2=@{selected|global_precision_dmg_macro}}} {{precision_dmg2_type=@{selected|global_precision_dmg_type}}} {{critical_dmg1=@{selected|repeating_weapon_$0_critical_dmg_macro}}} {{critical_dmg1_type=@{selected|repeating_weapon_$0_critical_dmg_type}}} {{critical_dmg2=@{selected|global_critical_dmg_macro}}} {{critical_dmg2_type=@{selected|global_critical_dmg_type}}}</nowiki><br />
<br />
=== pf_block Properties ===<br />
Used for Class Abilities, Feats, Inventory, Racial Traits, Traits<br />
<br><br />
'''&{template:pf_block}'''<br />
{| class="wikitable"<br />
|-<br />
! Property/Key !! Description/Examples<br />
|-<br />
| <nowiki>{{=}}</nowiki>|| All text entered after the "=" will be included in the output. <nowiki>{{=Best used for blocks of text.}}</nowiki><br />
|-<br />
| <nowiki>{{description}}</nowiki>|| Description will be the last item shown on the template. <nowiki>{{description = @{repeating_class-ability_0_short-description}}}</nowiki><br />
|}<br />
'''pf_block example:'''<br><br />
<nowiki>&{template:pf_block} {{header_image=header_image-pf_block}} {{character_name=@{character_name}}} {{character_id=@{character_id}}} {{name=@{repeating_feat_0_name}}} {{description = @{repeating_feat_0_short-description}}}</nowiki><br />
<br />
=== pf_defense Properties ===<br />
Properties defined in the pf_defense roll template are used primarily to toggle the notes shown when a Saving Throw is made. @{save_options} is used by the sheet to enable the toggling of notes related to defense and contains the attributes for @{dr_notes}, @{resistances_notes}, @{immunities_notes}, @{weaknesses_notes}, @{sr_notes}, @{armor_notes}, @{save_notes}, @{cmd_notes}, and @{defense-notes}.<br />
<br><br />
'''&{template:pf_defense}'''<br />
{| class="wikitable sortable"<br />
|-<br />
! Property/Key !! Description/Examples<br />
|-<br />
| <nowiki>{{dr_notes}}</nowiki>|| Damage Resistance notes. <nowiki>{{dr_notes=@{DR}}}</nowiki><br />
|-<br />
| <nowiki>{{resistances_notes}}</nowiki>|| Resistance notes. <nowiki>{{resistances_notes=@{resistances}}}</nowiki><br />
|-<br />
| <nowiki>{{immunities_notes}}</nowiki>|| Immunities notes. <nowiki>{{immunities_notes=@{immunities}}}</nowiki><br />
|-<br />
| <nowiki>{{weaknesses_notes}}</nowiki>|| Weaknesses notes. <nowiki>{{weaknesses_notes=@{weaknesses}}}</nowiki><br />
|-<br />
| <nowiki>{{sr_notes}}</nowiki>|| Spell Resistance notes. <nowiki>{{sr_notes=@{SR}}}</nowiki><br />
|-<br />
| <nowiki>{{armor_notes}}</nowiki>|| Armor notes. <nowiki>{{armor_notes=@{Armor-notes}}}</nowiki><br />
|-<br />
| <nowiki>{{save_notes}}</nowiki>|| Save notes. <nowiki>{{save_notes=@{Save-notes}}}</nowiki><br />
|-<br />
| <nowiki>{{cmd_notes}}</nowiki>|| CMD notes. <nowiki>{{cmd_notes=@{cmd-notes}}}</nowiki><br />
|-<br />
| <nowiki>{{defense_notes}}</nowiki>|| Defense notes. <nowiki>{{defense_notes=@{defense-notes}}}</nowiki><br />
|}<br />
'''pf_defenses example:'''<br><br />
<nowiki>&{template:pf_defense} {{header_image=header_image-pf_defense}} {{character_name=@{character_name}}} {{character_id=@{character_id}}} {{name=Fortitude}} {{Save=[[ 1d20 + [[ @{Fort} ]] ]]}} @{save_options}</nowiki><br />
<br />
=== pf_generic Properties ===<br />
Used for Ability checks, Initiative, Spell Failure Check, Skills, Concentration Check, Caster Level Check.<br />
<br><br />
'''&{template:pf_generic}'''<br />
{| class="wikitable"<br />
|-<br />
! Property/Key !! Description/Examples<br />
|-<br />
| <nowiki>{{lefttext_X}}</nowiki>|| Adds a row of left aligned text. Where X is a row number 1thru10.<nowiki>{{lefttext_1=Some left aligned text}}}</nowiki><br />
|-<br />
| <nowiki>{{righttext_X}}</nowiki>|| Adds a row of right aligned text. Where X is a row number 1thru10.<nowiki>{{righttext=Some right aligned text}}</nowiki><br />
|-<br />
| <nowiki>{{description}}</nowiki>|| Description will be the last item shown on the template. <nowiki>{{description=@{description}}}</nowiki><br />
|}<br />
'''pf_generic example:'''<br><br />
<nowiki>&{template:pf_generic} {{header_image=header_image-pf_generic}} {{character_name=@{character_name}}} {{character_id=@{character_id}}} {{name=Acrobatics}} {{Check=[[ 1d20 + [[ @{Acrobatics} ]] ]]}}</nowiki><br />
<br />
=== pf_spell Properties ===<br />
The properties below are used for spell macros. If a value is not given for a property, nothing will be displayed. @{spell_options} is used to toggle spell attributes on the sheet and includes all pf_spell specific properties. Note: The examples given below are for a repeating spell, level 0, row 0. These values will change based on the spell level and row of the repeating item.<br />
<br><br />
'''&{template:pf_spell}'''<br />
{| class="wikitable sortable"<br />
|-<br />
! Property/Key !! Description/Examples<br />
|-<br />
| <nowiki>{{school}}</nowiki>|| School of magic. <nowiki>{{school=@{repeating_lvl-0-spells_0_school}}}</nowiki><br />
|-<br />
| <nowiki>{{level}}</nowiki>|| Casting Class and spell level <nowiki>{{@{repeating_lvl-0-spells_X_spellclass} [[ @{repeating_lvl-0-spells_X_spell_level} ]]}}</nowiki><br />
|-<br />
| <nowiki>{{casting_time}}</nowiki>|| Casting Time <nowiki>{{casting_time=@{repeating_lvl-0-spells_0_cast-time}}}</nowiki><br />
|-<br />
| <nowiki>{{components}}</nowiki>|| Components Used <nowiki>{{components=@{repeating_lvl-0-spells_0_components}}}</nowiki><br />
|-<br />
| <nowiki>{{range}}</nowiki>|| Range <nowiki>{{range=@{repeating_lvl-0-spells_0_range}}}</nowiki><br />
|-<br />
| <nowiki>{{targets}}</nowiki>|| Targets <nowiki>{{targets=@{repeating_lvl-0-spells_0_targets}}}</nowiki><br />
|-<br />
| <nowiki>{{duration}}</nowiki>|| Duration of spell <nowiki>{{duration}=@{repeating_lvl-0-spells_0_duration}}}</nowiki><br />
|-<br />
| <nowiki>{{saving_throw}}</nowiki>|| Save info <nowiki>{{saving_throw=@{repeating_lvl-0-spells_0_save}}}</nowiki><br />
|-<br />
| <nowiki>{{dc}}</nowiki>|| Difficulty Check for spell class 0 (can be toggled within the repeating spell) <nowiki>{{dc=[[ @{spellclass-0-level-0-savedc} + [[ @{repeating_lvl-0-spells_0_DC-mod} ]] ]]}}</nowiki><br />
|-<br />
| <nowiki>{{dc1}}</nowiki>|| Difficulty Check for spell class 1 (can be toggled within the repeating spell) <nowiki>{{dc1=[[ @{spellclass-1-level-0-savedc} + [[ @{repeating_lvl-1-spells_0_DC-mod} ]] ]]}}</nowiki><br />
|-<br />
| <nowiki>{{dc2}}</nowiki>|| Difficulty Check for spell class 2 (can be toggled within the repeating spell) <nowiki>{{dc2=[[ @{spellclass-2-level-0-savedc} + [[ @{repeating_lvl-2-spells_0_DC-mod} ]] ]]}}</nowiki><br />
|-<br />
| <nowiki>{{sr}}</nowiki>|| Spell Resistance <nowiki>{{sr=@{repeating_lvl-0-spells_0_sr} }}</nowiki><br />
|-<br />
| <nowiki>{{attack}},{{attack2}}</nowiki>|| Used for spell-based attacks. Note: Attacks must be added to your spell macro to be used. Spell-based attacks will utilize the pf_attack roll template. ie <nowiki>{{attack=[[1d20cs>20]]}}</nowiki> <br />
|-<br />
| <nowiki>{{crit_confirm}},{{crit_confirm2}}</nowiki>|| Use with the attack property. ie <nowiki>{{crit_confirm=[[1d20]]}}</nowiki><br />
|-<br />
| <nowiki>{{damage}}, {{damage2}}</nowiki>|| Use with the attack property. ie <nowiki>{{damage=[[ 1d6+[[ {5,@{selected|spellclass-0-level-total}}kl1]] ]]}}</nowiki><br />
|-<br />
| <nowiki>{{crit_damage}},{{crit_damage2}}</nowiki>|| Use with the attack property. ie <nowiki>{{crit_damage=+[[1d6]]}}</nowiki><br />
|-<br />
| <nowiki>{{description}}</nowiki>|| Spell description will be the last item shown on the template. "'''Description:'''" will be included with the output. <nowiki>{{description=@{repeating_lvl-0-spells_0_description}}}</nowiki><br />
|}<br />
'''pf_spell example:'''<br><br />
<nowiki>@{selected|PC-whisper} &{template:pf_spell} @{selected|toggle_spell_accessible} @{selected|toggle_rounded_flag} {{color=@{selected|rolltemplate_color}}} {{header_image=@{selected|header_image-pf_spell}}} {{character_name=@{selected|character_name}}} {{character_id=@{selected|character_id}}} {{subtitle}} {{deafened_note=@{selected|SpellFailureNote}}} {{name=@{selected|repeating_lvl-0-spells_$0_name}}} {{school=@{selected|repeating_lvl-0-spells_$0_school}}} {{level=@{selected|spellclass-0-name} [[ @{selected|spellclass-0-level-total} ]]}} {{casting_time=@{selected|repeating_lvl-0-spells_$0_cast-time}}} {{components=@{selected|repeating_lvl-0-spells_$0_components}}} {{range=@{selected|repeating_lvl-0-spells_$0_range}}} {{target=@{selected|repeating_lvl-0-spells_$0_targets}}} {{duration=@{selected|repeating_lvl-0-spells_$0_duration}}} {{saving_throw=@{selected|repeating_lvl-0-spells_$0_save}}} {{dc=[[ @{selected|spellclass-0-level-0-savedc} + [[ @{selected|repeating_lvl-0-spells_$0_DC-mod} ]] ]]}} {{sr=@{selected|repeating_lvl-0-spells_$0_sr}}} {{casterlevel=}}{{casterlevel_chk=[[ 1d20 + 3 ]]}}{{spellPen=}}{{Concentration=}}{{Concentration_chk=[[ 1d20 + 6 ]]}}{{cast_def=}}{{cast_defDC=[[ 15 ]]}} {{spell_description=@{selected|repeating_lvl-0-spells_$0_description}}} {{spells_notes=@{selected|spell-class-0-spells-notes}}}{{spelldamage=}}{{spelldamagetype=}}</nowiki><br />
</div></div><br />
<br clear=all/><br />
<br />
= <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Macros</blockquote> =<br />
<div class="toccolours mw-collapsible"><br />
<br />
<div class="mw-collapsible-content"><br />
<br />
[[Macros]] can be used to greatly enhance the usability and customization of this already powerful character sheet. Please add any Pathfinder Character Sheet specific macros or other macros that might be beneficial to Pathfinder players to this section of the guide.<br />
<br />
==== General Use Macros ====<br />
These macros while geared toward Pathfinder, may work in other rpg's as well.<br />
<br />
*An excellent guide for Pathfinder macros: [[Macros_-_Pathfinder_Examples|Macros - Pathfinder Examples]]<br />
*General Roll - <code>@{selected|character_name} rolls a [[1d20+?{modifier?|0}]] for ?{reason?|none}.</code><br />
<br />
==== Fallthrough Condition Macros ====<br />
These macros use conditional modifiers that fall through from one macro to the next.<br />
<br />
*An attack action using a flank and a sneak attack:<br />
<code>?{Flank?|1} ?{Sneak Attack?|1}<br />
#attack</code><br />
* The #attack macro (assume 3 SA dice):<br />
<code>[[1d20 + (?{Flank?|1} * 2)]] to hit for [[1d6 + @{selected|STR-mod}]] damage and [[(?{Sneak Attack?|1} * 3)d6]] Sneak Attack damage.</code><br />
<br />
==== Macros to call sheet functions ====<br />
Here are examples of using the Pathfinder sheet buttons or fields in your macros. These can also be placed in the Custom Rolls (d) section of the Custom page.<br />
<br />
===== Saving Throws =====<br />
<pre style="overflow:auto; width:auto;">Fort: [[1d20+@{selected|fort}]] Reflex: [[1d20+@{selected|ref}]] Will: [[1d20+@{selected|will}]]</pre><br />
<br />
===== Skill Check =====<br />
<pre style="overflow:auto; width:auto;">Perception: [[1d20+@{selected|Perception}]]</pre><br />
<br />
===== Initiative =====<br />
<code>@{selected|character_name}'s Initiative is [[((1d20 + @{selected|init}) + (0.01 * @{selected|init})) &{tracker}]]</code><br />
<br />
<br />
===== Channel Positive Energy Query =====<br />
<br />
// Channel energy v undead, level calculated for damage dice, DC calculated = 10 + 1/2 the cleric's level + the cleric's Charisma mod<br />
// Heal Living, level calculated for heal<br />
<pre style="overflow:auto; width:auto;">&amp;{template:pf_spell}{{header_image=@{header_image-pf_spell}}} {{character_name=@{selected|character_name}}} {{character_id=@{selected|character_id}}} {{subtitle=?{channels positive energy|Undead, Screams "I CAST THEE BACK TO THE VOID" and thrust forward his holy symbol &amp;#125;&amp;#125;&amp;#123;&amp;#123channels positive energy &amp;#125;&amp;#125;&amp;#123;&amp;#123Area:30ft radius:centered on the cleric&amp;#125&amp;#125;&amp;#123;&amp;#123Damage to undead: [[ ((.5* @{selected|spellclass-0-level-total}-1)d6 + 1d6) ]]&amp;#125&amp;#125;&amp;#123;&amp;#123DC [[floor(@{selected|spellclass-0-level-total}/2) + 10 + [[ @{selected|CHA-mod} ]]]] - Vs Will Save - 1/2 damage &amp;#125&amp;#125;| Living,"Pharasma heals thee" and thrust forward his holy symbol &amp;#125;&amp;#125;&amp;#123;&amp;#123channels positive energy &amp;#125;&amp;#125;&amp;#123;&amp;#123Area:30ft radius:centered on the cleric&amp;#125&amp;#125;&amp;#123;&amp;#123 Heals the living: [[ ((.5*@{selected|spellclass-0-level-total}-1)d6 + 1d6) ]]&amp;#125&amp;#125;| } }}</pre><br />
<br />
<br />
===== Cure Spells Query =====<br />
<br />
// Cure spell Macro - DC will save v undead<br />
// Cure Light wounds - 1d8 points of damage +1 point per caster level (maximum +5) and DC calculated<br />
// Cure Moderate wounds - 2d8 points of damage +1 point per caster level (maximum +10) and DC calculated<br />
// Cure Serious wounds - 3d8 points of damage +1 point per caster level (maximum +15) and DC calculated<br />
// Cure Critical wounds - 4d8 points of damage +1 point per caster level (maximum +20) and DC calculated<br />
// Cure Light Mass - 1d8 points of damage +1 point per caster level (maximum +5), DC, range per level, number of targets calculated<br />
// Wand of Cure Light<br />
<pre style="overflow:auto; width:auto;">&amp;{template:pf_spell}{{header_image=@{header_image-pf_spell}}}{{character_name=@{selected|character_name}}}{{character_id=@{selected|character_id}}}{{name=?{Cure Spell|Cure Light,Cure Light Wounds &amp;#125;&amp;#125; &amp;#123;&amp;#123;@{target|character_name} Heals =[[ floor(1.5*(1d8+{5&amp;#44; @{selected|spellclass-0-level-total}&amp;#125;kl1)) ]] HP &amp;#125;&amp;#125; {{Undead: Will Save DC [[ 10 + 1 + [[ @{selected|WIS-mod} ]]]]- Half Damage&amp;#125;&amp;#125;|Cure Moderate, Cure Moderate Wounds&amp;#125;&amp;#125; &amp;#123;&amp;#123;@{target|character_name} Heals =[[ floor(1.5*(2d8+{5&amp;#44; @{selected|spellclass-0-level-total}&amp;#125;kl1)) ]] HP &amp;#125;&amp;#125; {{Undead: Will Save DC [[10 + 2 + [[ @{selected|WIS-mod} ]]]]- Half Damage&amp;#125;&amp;#125;|Cure Serious, Cure Serious Wounds&amp;#125;&amp;#125; &amp;#123;&amp;#123;@{target|character_name} Heals =[[ floor(1.5*(3d8+{5&amp;#44; @{selected|spellclass-0-level-total}&amp;#125;kl1)) ]] HP &amp;#125;&amp;#125; {{Undead: Will Save DC [[10 + 3 + [[ @{selected|WIS-mod} ]]]]- Half Damage&amp;#125;&amp;#125;|Cure Critical, Cure Critical Wounds&amp;#125;&amp;#125; &amp;#123;&amp;#123;@{target|character_name} Heals =[[ floor(1.5*(4d8+{5&amp;#44; @{selected|spellclass-0-level-total}&amp;#125;kl1)) ]] HP &amp;#125;&amp;#125; {{Undead: Will Save DC [[10 + 4 + [[ @{selected|WIS-mod} ]]]]- Half Damage&amp;#125;&amp;#125;|Cure Light Mass,Cure Light Wounds Mass &amp;#125;&amp;#125;{{Range: [[25 + (5*floor(0.5*@{selected|spellclass-0-level-total})) ]]ft&amp;#125;&amp;#125; {{Target[[@{selected|spellclass-0-level-total}]]: no two of which can be 30ft apart &amp;#125;&amp;#125;&amp;#123;&amp;#123; Heals =[[ floor(1.5*(2d8+{25&amp;#44; @{selected|spellclass-0-level-total}&amp;#125;kl1)) ]] HP &amp;#125;&amp;#125; {{Undead: Will Save DC [[10 + 5 + [[ @{selected|WIS-mod} ]]]]- Half Damage&amp;#125;&amp;#125; |Wand of Cure Light,Use his Wand of Cure Light Wounds&amp;#125;&amp;#125; &amp;#123;&amp;#123; @{target|character_name} Heals =[[1d8+5]] HP } }}</pre><br />
<br />
<br />
===== All Skills Query =====<br />
<pre style="overflow:auto; width:auto;">&{template:pf_generic} {{character_name=@{selected|character_name}}} {{name=Skill Check}} {{?{Choose a Skill(* training not required)| <br />
*Acrobatics (+@{selected|Acrobatics}), [Acrobatics](http://www.d20pfsrd.com/skills/acrobatics) =[[ 1d20+ [[ @{selected|Acrobatics} ]] ]] | <br />
*Appraise (+@{selected|Appraise}),[Appraise](http://www.d20pfsrd.com/skills/appraise)=[[ 1d20+ [[ @{selected|Appraise} ]] ]] | <br />
*Artistry (+@{selected|Artistry}), [Artistry](http://www.d20pfsrd.com/skills/background-skills#TOC-Artistry-Int-) @{selected|Artistry-name}=[[ 1d20+ [[ @{selected|Artistry} ]] ]] | <br />
*Bluff (+@{selected|Bluff}), [Bluff](http://www.d20pfsrd.com/skills/bluff)=[[ 1d20+ [[ @{selected|Bluff} ]] ]] | <br />
*Climb (+@{selected|Climb}), [Climb](http://www.d20pfsrd.com/skills/climb)=[[ 1d20+ [[ @{selected|Climb} ]] ]] | <br />
*Craft @{selected|Craft-name} (+@{selected|Craft}), [Craft](http://www.d20pfsrd.com/skills/craft) @{selected|Craft-name}=[[ 1d20+ [[ @{selected|Craft} ]] ]] | <br />
*Diplomacy (+@{selected|Diplomacy}), [Diplomacy](http://www.d20pfsrd.com/skills/diplomacy)=[[ 1d20+ [[ @{selected|Diplomacy} ]] ]] | <br />
Disable Device (+@{selected|Disable-Device}), [Disable Device](http://www.d20pfsrd.com/skills/disable-device)=[[ 1d20+ [[ @{selected|Disable-Device} ]] ]] | <br />
*Disguise (+@{selected|Disguise}), [Disguise](http://www.d20pfsrd.com/skills/disguise)=[[ 1d20+ [[ @{selected|Disguise} ]] ]] | <br />
*Escape Artist (+@{selected|Escape-Artist}), [Escape Artist](http://www.d20pfsrd.com/skills/escape-artist)=[[ 1d20+ [[ @{selected|Escape-Artist} ]] ]] | <br />
*Fly (+@{selected|Fly}), [Fly](http://www.d20pfsrd.com/skills/fly)=[[ 1d20+ [[ @{selected|Fly} ]] ]] | <br />
Handle Animal (+@{selected|Handle-Animal}), [Handle Animal](http://www.d20pfsrd.com/skills/handle-animal)=[[ 1d20+ [[ @{selected|Handle-Animal} ]] ]] | <br />
*Heal (+@{selected|Heal}), [Heal](http://www.d20pfsrd.com/skills/acrobatics)=[[ 1d20+ [[ @{selected|Heal} ]] ]] | <br />
*Intimidate (+@{selected|Intimidate}), [Intimidate](http://www.d20pfsrd.com/skills/intimidate)=[[ 1d20+ [[ @{selected|Intimidate} ]] ]] | <br />
Knowledge Arcana (+@{selected|Knowledge-Arcana}), [Knowledge Arcana](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Arcana} ]] ]] | <br />
Knowledge Dungeoneering (+@{selected|Knowledge-Dungeoneering}), [Knowledge Dungeoneering](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Dungeoneering} ]] ]] | <br />
Knowledge Engineering (+@{selected|Knowledge-Engineering}), [Knowledge Engineering](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Engineering} ]] ]] | <br />
Knowledge Geography (+@{selected|Knowledge-Geography}), [Knowledge Geography](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Geography} ]] ]] | <br />
Knowledge History (+@{selected|Knowledge-History}), [Knowledge History](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-History} ]] ]] | <br />
Knowledge Local (+@{selected|Knowledge-Local}), [Knowledge Local](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Local} ]] ]] | <br />
Knowledge Nature (+@{selected|Knowledge-Nature}), [Knowledge Nature](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Nature} ]] ]] | <br />
Knowledge Nobility (+@{selected|Knowledge-Nobility}), [Knowledge Nobility](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Nobility} ]] ]] | <br />
Knowledge Planes (+@{selected|Knowledge-Planes}), [Knowledge Planes](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Planes} ]] ]] | <br />
Knowledge Religion (+@{selected|Knowledge-Religion}), [Knowledge Religion](http://www.d20pfsrd.com/skills/knowledge)=[[ 1d20+ [[ @{selected|Knowledge-Religion} ]] ]] | <br />
Linguistics (+@{selected|Linguistics}),[Linguistics](http://www.d20pfsrd.com/skills/linguistics)=[[ 1d20+ [[ @{selected|Linguistics} ]] ]] | <br />
Lore @{selected|Lore-name} (+@{selected|Lore}), [Lore](http://www.d20pfsrd.com/skills/acrobatics)(@{selected|Lore-name})=[[ 1d20+ [[ @{selected|Lore} ]] ]] | <br />
*Perception (+@{selected|Perception}),[Perception](http://www.d20pfsrd.com/skills/perception)=[[ 1d20+ [[ @{selected|Perception} ]] ]] | <br />
*Perform @{selected|Perform-name} (+@{selected|Perform}), [Perform](http://www.d20pfsrd.com/skills/perform) (@{selected|Perform-name})=[[ 1d20+ [[ @{selected|Perform} ]] ]] | <br />
Profession @{selected|Profession-name} (+@{selected|Profession}), [Profession](http://www.d20pfsrd.com/skills/profession) (@{selected|Profession-name})=[[ 1d20+ [[ @{selected|Profession} ]] ]] | <br />
*Ride (+@{selected|Ride}),[Ride](http://www.d20pfsrd.com/skills/ride)=[[ 1d20+ [[ @{selected|Ride} ]] ]] | <br />
*Sense Motive (+@{selected|Sense-Motive}),[Sense Motive](http://www.d20pfsrd.com/skills/sense-motive)=[[ 1d20+ [[ @{selected|Sense-Motive} ]] ]] | <br />
Sleight of Hand (+@{selected|Sleight-of-Hand}), [Sleight of Hand](http://www.d20pfsrd.com/skills/sleight-of-hand)=[[ 1d20+ [[ @{selected|Sleight-of-Hand} ]] ]] | <br />
Spellcraft (+@{selected|Spellcraft}), [Spellcraft](http://www.d20pfsrd.com/skills/spellcraft)=[[ 1d20+ [[ @{selected|Spellcraft} ]] ]] | <br />
*Stealth (+@{selected|Stealth}),[Stealth](http://www.d20pfsrd.com/skills/stealth)=[[ 1d20+ [[ @{selected|Stealth} ]] ]] | <br />
*Survival (+@{selected|Survival}), [Survival](http://www.d20pfsrd.com/skills/survival)=[[ 1d20+ [[ @{selected|Survival} ]] ]] | <br />
*Swim (+@{selected|Swim}),[Swim](http://www.d20pfsrd.com/skills/swim)=[[ 1d20+ [[ @{selected|Swim} ]] ]] | <br />
Use Magic Device (+@{selected|Use-Magic-Device}), [Use Magic Device](http://www.d20pfsrd.com/skills/use-magic-device)=[[ 1d20+ [[ @{selected|Use-Magic-Device} ]] ]]<br />
}}}<br />
</pre><br />
<br />
<br />
==== Equation Field Macros ====<br />
Here are examples of equations to implement some common Pathfinder feats and class abilities. These use equation fields on the sheet,<br />
which have labels with superscripts of ⒜, ⒝, ⒞, or ⒟. Look at the sheet's footer for an explanation of what each type of field accepts as input. <br />
<br />
For some sections of the sheet you'll need to make these fields visible by clicking '''<span style="color:#c00">Show More Fields</span>''' (usually found near the top of each repeating section) <br />
<br />
For '''"Add to Roll"''' fields, enable from settings using '''⛭ Settings|Sheet Configuration|Advanced|Display 'add-to-roll' rolltime fields'''.<br />
<br />
To modify the actual '''Macro Text''' of an attack, enable from settings using '''⛭ Settings|Sheet Configuration|Advanced|Display roll templates for customization'''.<br />
<br />
===== Bane =====<br />
<br />
Use the "Add to Roll" fields on your attack.<br />
<br />
===== Bleed =====<br />
:Damage insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Bleed?|No,0|yes,1}*[[ @{class-0-level} ]] ]]</pre><br />
<br />
===== Favored Enemy =====<br />
<br />
Use the "Add to Roll" fields on your attack.<br />
<br />
:Attack insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Favored Enemy?|No, 0|Yes, 2} ]]</pre><br />
<br />
:Damage insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Favored Enemy?|No, 0|Yes, 2} ]]</pre><br />
<br />
Adjust bonus upward by +2 if choosing the same favored enemy at higher levels (10th, 15th, and 20th) This macro could also be added to any appropriate Skill checks macrotext as well.<br />
<br />
===== Haste =====<br />
<br />
I'd recommend making a buff for the AC, Attack, and Ref save bonuses from haste. You can do this manually or use the "Common Buff" selector to automatically create the necessary adjustments for Haste. Haste also gives you "...one extra attack with one natural or manufactured weapon.". This can be accomplished by replacing all the left curly braces, " {{ " in the iterative attack with " ?{Haste|No,|Yes,{{} " The query only controls whether or not the haste attack is shown.<br />
[[File:PF haste query.png|200px|thumbnail|center]]<br />
<br />
===== Manyshot =====<br />
Use the '''Macro-text''' section of the attack. Change it from this:<br />
<pre style="overflow:auto; width:auto;">@{PC-whisper} &{template:pf_attack} @{toggle_attack_accessible} @{toggle_rounded_flag} {{color=@{rolltemplate_color}}} {{character_name=@{character_name}}} {{character_id=@{character_id}}} {{subtitle}} {{name=@{name}}} {{attack=[[ 1d20cs>[[ @{crit-target} ]] + @{attack_macro} ]]}} {{damage=[[@{damage-dice-num}d@{damage-die} + @{damage_macro}]]}} {{crit_confirm=[[ 1d20 + @{attack_macro} + [[ @{crit_conf_mod} ]] ]]}} {{crit_damage=[[ [[ @{damage-dice-num} * (@{crit-multiplier} - 1) ]]d@{damage-die} + ((@{damage_macro}) * [[ @{crit-multiplier} - 1 ]]) ]]}} {{type=@{type}}} {{weapon_notes=@{notes}}} @{iterative_attacks} @{macro_options} {{vs=@{vs}}} {{vs@{vs}=@{vs}}} {{precision_dmg1=@{precision_dmg_macro}}} {{precision_dmg1_type=@{precision_dmg_type}}} {{precision_dmg2=@{global_precision_dmg_macro}}} {{precision_dmg2_type=@{global_precision_dmg_type}}} {{critical_dmg1=@{critical_dmg_macro}}} {{critical_dmg1_type=@{critical_dmg_type}}} {{critical_dmg2=@{global_critical_dmg_macro}}} {{critical_dmg2_type=@{global_critical_dmg_type}}} {{attack1name=@{iterative_attack1_name}}}</pre><br />
<br />
to this:<br />
<pre style="overflow:auto; width:auto;">@{PC-whisper} &{template:pf_attack} @{toggle_attack_accessible} @{toggle_rounded_flag} {{color=@{rolltemplate_color}}} {{character_name=@{character_name}}} {{character_id=@{character_id}}} {{subtitle}} {{name=@{name}}} {{attack=[[ 1d20cs>[[ @{crit-target} ]] + @{attack_macro} ]]}} {{damage=[[ [[@{damage-dice-num}*2]]d@{damage-die} + @{damage_macro}*2]]}} {{crit_confirm=[[ 1d20 + @{attack_macro} + [[ @{crit_conf_mod} ]] ]]}} {{crit_damage=[[ [[ @{damage-dice-num} * (@{crit-multiplier} - 1) ]]d@{damage-die} + ((@{damage_macro}) * [[ @{crit-multiplier} - 1 ]]) ]]}} {{type=@{type}}} {{weapon_notes=@{notes}}} @{iterative_attacks} @{macro_options} {{vs=@{vs}}} {{vs@{vs}=@{vs}}} {{precision_dmg1=@{precision_dmg_macro}}} {{precision_dmg1_type=@{precision_dmg_type}}} {{precision_dmg2=@{global_precision_dmg_macro}}} {{precision_dmg2_type=@{global_precision_dmg_type}}} {{critical_dmg1=@{critical_dmg_macro}}} {{critical_dmg1_type=@{critical_dmg_type}}} {{critical_dmg2=@{global_critical_dmg_macro}}} {{critical_dmg2_type=@{global_critical_dmg_type}}} {{attack1name=@{iterative_attack1_name}}}</pre><br />
<br />
Make sure you have the "display roll templates for customization" '''⛭ Settings|Sheet Configuration|Advanced|Display roll templates for customization''' enabled and that you don't have the sheet in compact view [[Pathfinder_Character_Sheet#Mode|Mode]] (the left hand button at the very top of the sheet next to the pathfinder logo).<br />
<br />
'''NOTE''' the changes within macro above: {{damage=[[ [[@{damage-dice-num}*2]]d@{damage-die} + @{damage_macro}*2]]}}<br />
<br />
If you want to do Manyshot as a query, simply replace that "*2" above with "*?{Manyshot|No,1|Yes,2}".<br />
<br />
===== Misfire =====<br />
To set misfire for guns, if it is greater than 1, you can set it up as a "critical fail" on rolls of 2 or less, or 3 or less, etc. To do this we have to use the '''Macro-text''' section of the attack. Search for the 1d20 attack roll there (and also in every iterative attack used):<br />
<br />
<pre style="overflow:auto; width:auto;">{{attack=[[ 1d20cs>[[ @{crit-target} ]] + @{attack_macro} ]]}}</pre><br />
<br />
If your misfire is at 2, change it to this:<br />
<pre style="overflow:auto; width:auto;">{{attack=[[ 1d20cf<2cs>[[ @{crit-target} ]] + @{attack_macro} ]]}}</pre><br />
<br />
If at 3 then use <pre>cf<3</pre>, etc<br />
<br />
If you keep firing before clearing, you can add a query like this to add extra damage if your gun misfired (note this is not tested):<br />
<pre style="overflow:auto; width:auto;">{{attack=[[ 1d20cf<[[ ?{Jammed?|Y,2|N,0} + 2 ]]cs>[[ @{crit-target} ]] + @{attack_macro} ]]}}</pre><br />
<br />
You can also put [[ ?{Jammed?|Y,2|N,0} + 2 ]] that query in the 2nd ("b" macros) or 3rd ("c" macros) section on the '''Custom''' page, and reference it in the roll, so if it changes you only have to change it in one place:<br />
<pre style="overflow:auto; width:auto;">{{attack=[[ 1d20cf<[[ @{customb1} ]]cs>[[ @{crit-target} ]] + @{attack_macro} ]]}}</pre><br />
<br />
Make sure you have "Display roll templates" enabled from '''⛭ Settings|Sheet Configuration|Advanced|Display roll templates for customization''' and that you don't have the sheet in compact view [[Pathfinder_Character_Sheet#Mode|Mode]] (the left hand button at the very top of the sheet next to the pathfinder logo). That will allow you to view the macro text for the attack.<br />
<br />
===== Point Blank Shot =====<br />
<br />
Use the "Add to Roll" fields on your attack.<br />
<br />
:Attack insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Target within 30 ft?|No, 0|Yes, 1} ]]</pre><br />
<br />
===== Power Attack, Deadly Aim =====<br />
<br />
These two are the same, Deadly Aim is the Power Attack of ranged attacks. Use the "Add to Roll" fields on your attack. It will then ask you if you are power attacking when you attack, and will apply the penalties/bonuses based on your response.<br />
[https://s3.amazonaws.com/files.d20.io/images/36603044/BU_qkeJ4nmQc-LYD8USx8w/original.gif?1501096523 Animated demo]<br />
<br />
:Attack insert Macro:<br />
<pre style="overflow:auto; width:auto;">-[[ ?{Power Attack or Deadly Aim?|Yes,1|No,0}*(1+floor(@{bab}/4)) ]]</pre><br />
<br />
:Damage insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Power Attack or Deadly Aim?|Yes,1|No,0}*(1+floor(@{bab}/4))*2 ]]</pre><br />
or two-handed(not applicable for Deadly Aim):<br />
<pre style="overflow:auto; width:auto;">[[ ?{Power Attack or Deadly Aim?|Yes,1|No,0}*(1+floor(@{bab}/4))*3 ]]</pre><br />
<br />
===== Rapid Shot =====<br />
<br />
Use the "Add to Roll" fields on your attack.<br />
<br />
:Attack insert Macro:<br />
<pre style="overflow:auto; width:auto;">?{Rapid Shot?|No,0|Yes,-2}</pre><br />
<br />
Iterative section<br />
You can use the same as the haste technique, but it would require a second dropdown <br />
<pre style="overflow:auto; width:auto;">?{Rapid Shot add attack?|No,|Yes,{{}</pre><br />
<br />
===== Sneak Attack=====<br />
:Damage insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Sneak?|No,0|yes,1}*[[ [[ ceil((@{class-0-level}) / 2) ]]d6 ]] ]]</pre><br />
<br />
:Attack insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Bane?|No,0|yes,2} ]]</pre><br />
<br />
:Damage insert Macro:<br />
<pre style="overflow:auto; width:auto;">[[ ?{Bane?} + ?{Bane?}d6 ]]</pre><br />
<br />
===== Vital Strike =====<br />
<br />
"Extra Damage" on each attack row that applies:<br />
<br />
<pre style="overflow:auto; width:auto;">[[(?{Vital Strike?|Y,1|N,0}*@{damage-dice-num})d@{damage-die}]]</pre><br />
<br />
<br />
'''Please add more macros.'''<br />
<br />
= <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Old Announcements</blockquote> =<br />
<div class="toccolours mw-collapsible"><br />
<br />
<div class="mw-collapsible-content"><br />
<br />
: These announcements may be beneficial for anyone migrating from a very old sheet.<br />
<br />
'''v1.7x'''<br />
*Updated formulas for some of the common buffs<br />
*Fixed damage dice incorrect on resize!<br />
*Added Misc skills to Consolidated skillset<br />
*Ability and Skill Check buff now applies to Initiative<br />
*Fixed item parsing on drag compendium item to sheet<br />
*Fixed currency weight not applying correctly to encumbrance<br />
*Fixed spell used totals<br />
*Fixed Spell Penetration roll when clicking spell button<br />
*Item name change of slotted item now changes worn item grid<br />
<br />
<br />
'''v1.6X (beta)'''<br />
*BONUS TYPES and stacking! in new buffs list. Turn on in settings.<br />
*All 'misc' number entries converted to macro fields.<br />
*Kineticist Support! Spell and pool point support. More colors<br />
*Notes added to rolls based on current conditions or buffs<br />
*Dual wield: now use attack name instead of ID to generate<br />
*Globally hide this announcement using Apply Default Settings at bottom of Roll 20's ⛭My Settings page (chat area at right).<br />
*FASTER!<br />
<br />
<br />
'''v1.58'''<br />
*Fix damage dice when moving between small and medium.<br />
*Fixed bug causing max dex to be flagged even when not applied (if not using dex to AC)<br />
*Fixed ranged dmg appearance, Forum thread link, size label in attack list<br />
*Stacking bonus types and API companion coming check out Beta campaign (link in footer) to test<br />
<br />
<br />
'''v1.57'''<br />
*Add Encumbered as condition status<br />
*Fixed bug causing max dex to be flagged even when not applied (if not using dex to AC)<br />
*Fixed ranged dmg appearance, Forum thread link, size label in attack list<br />
*Stacking bonus types and API companion coming check out Beta campaign (link in footer) to test<br />
<br />
<br />
'''v1.56'''<br />
*Fix sickened damage adjustment<br />
*Buff bonus types and API companion coming check out Beta campaign (link in footer) to test<br />
<br />
<br />
'''v1.55'''<br />
*FIX SKILLS (again)<br />
*Fix ability damage multiplier on attack rows<br />
*Fix spells linked to attacks<br />
*Fix monster "plus x" damage parsing<br />
*Update NPC page ability list<br />
*Announcements hidden by default on new sheets<br />
*UPCOMING CHANGE: remove @{ and } from dropdown values, so they will only be strings, EXCEPT for the repeating_ability. This was necessary to:<br />
**Stop looping behavior when using API to set values<br />
**Improve ability of macros to determine if an attack is melee, ranged, etc<br />
**This may impact your macros or may not. Please test your macros against the beta site.<br />
<br />
<br />
'''v1.54'''<br />
*Fix to melee damage buff not applying without hitting recalc<br />
*Fix to nonlethal hp resetting on level drain<br />
*Fix to @{size_display} stuck on medium<br />
*Fix to spell class calculations when spell class not set<br />
*Fix to spell-attack-type reference in spells<br />
*Fix to buffs writing NaN and undefined<br />
<br />
<br />
'''v1.53'''<br />
*Fix to skills not rolling.<br />
*Fix to initiative and size buffs<br />
*Fix to skill size adjustment not resetting when set to default. Added @{size_display} back and translated<br />
*Fix to default encumbrance and font (in default campaign settings)<br />
*Fix Melee attack and damage properly. +melee copied to +cmb, +dmg copied to +ranged_dmg for existing buffs between 1.2 and 1.3<br />
*Armor, Shield, Natural Armor buffs hidden due to continued development in beta changing how they work.<br />
*Attack row size dropdown corrected: now can implement Strong Jaw or Improved Natural Attack or change the size of any attack without changing the size of the character.<br />
<br />
<br />
'''v1.52'''<br />
*API Companion beta available! Try beta version: https://github.com/Roll20-Pathfinder-Character-Sheet/Companion-Script<br />
*NEW BUFFS: Speed, Initiative, Size, CMB, Ranged Damage, Armor, Shield, Natural Armor, Flat Footed AC. (bonus *types* and stacking coming soon)<br />
*TWO WEAPON FIGHTING dual wield on ⛭ (Settings) page to display new fields just above Attacks list.<br />
*Offhand damage multiplier and number of attacks fixed<br />
*Create attack from equipment fixed - does not create empty attack<br />
*Drag and drop equipment fixed<br />
*More macro fields exposed for customization<br />
*Dual wield attacks improved: hide invalid fields, add extra damage field for rake/rend,etc<br />
*Fix when 'all buff rows' deleted then buff totals deleted too<br />
*Show more fields checkboxes added locally not only one global field<br />
*MERGE buttons on ⛭ (Settings) page to eliminate old lists of class abilites, feats, traits, etc.<br />
*Horror Adventures on ⛭ (Settings) page to display Sanity on Defenses page below saves.<br />
*If you experience locking please report your computer, operating system, and browser and version to http://tinyurl.com/PF-Thread<br />
<br />
<br />
'''1.42'''<br />
*Merge 5 old lists into new Ability list, to do click Merge buttons in ⛭ (Settings)<br />
*Delete buttons (#) added to every list to mass delete all items in list. <br />
*Note for tabbed list (equipment, abilities, spells) this deletes all items no matter what tab you are on<br />
*GMs can now Update all sheets from 'Experimental' section of Settings in game. Note it's experimental so do so on a copy of your campaign first.<br />
*Attack damage dice adjust based on size! Check Adjust damage based on size in Settings to try it out!<br />
*Fix to auto-calculated hit points, Pin AC penalty, Equation macros allow "|max"<br />
*Defense stats have custom whisper<br />
<br />
<br />
'''1.20'''<br />
*Settings page: added setting to turn update curr hp when max hp changes on or off<br />
*Fix to "critical" wounds turning on<br />
*Fix to spell totals for spontaneous casters<br />
*Fix to monster parsing: engulf, swallow whole, constrict, and hitpoints<br />
<br />
<br />
'''1.19'''<br />
*Now hp updates when updating max hp again<br />
*Fix to attacks menus<br />
*Fix skill stealth-trait field<br />
*Fix to spell-notes<br />
*Fixes to NPC parsing:<br />
*CMD and CMB npc parsing<br />
*Fix fly and stealth npc import take size into account<br />
*Additional default settings<br />
*To re-upgrade from a backup of v.74:<br />
*Attack and skill macros will not reset if you re-upgrade backup of v.74<br />
*Fix to npc upgrade from v.74 will not overwrite any class hp or levels<br />
<br />
<br />
'''v1.18'''<br />
*Click ⛭ Settings button next to Pathfinder logo to toggle Settings page.<br />
*Check Display roll templates for customization on Settings page to customize rolls.<br />
*Check Use Spell Points on Settings page if you use spell points.<br />
*Monster hp and hit dice found in Class and Race grid. Monsters now use PC fields.<br />
*Check Show both roll menu buttons for Monsters/NPCs to display NPC buttons on top even when on PC pages<br />
*Click the mode button to enter expanded mode if fields are not found<br />
*Extra calculated numbers available on Notes page for point pools, or for use in tokens bars, etc<br />
*Attack and skill macros will not reset if you re-upgrade backup of v.74<br />
*Extra hit points in PC racial hp fixed.<br />
*Hard reset @{init} to try to fix GroupInit bug.<br />
*Hover text over top menu buttons fixed<br />
*Spell menu now keeps custom list order<br />
*Fixes to spell menu ignoring options<br />
*Spell per day section easier to use. Added 'manually track totals' checkbox<br />
*Slight of Hand no longer appears twice. Text under checkboxes in line. 'vs other' fixed in rolls.<br />
<br />
<br />
'''v1.17'''<br />
* New Abilities section on it's own tab - special abilities tabs, linked attacks, pf_ability roll template.<br />
* New Hero Lab character importer - import Hero Lab characters using an XML to json file.<br />
* New Inventory section- sub-type tabs, link armor/shield to defense, link weapons to attacks, slot placement for worn items.<br />
* New NPC/Monster parser - drag/drop from the compendium's bestiary to the NPC page "Monster Statblock Import Section" and hit the parse button... be patient, some of the more complex stat-blocks will require more time.<br />
* New Settings/Configuration features added;<br />
** Uses Spells - shows spell-related sections<br />
** Lists - shows original ability lists for Traits, Racial Traits, Feats, Class Features, and SLA's. Included to help transition into the updated Abilities list.<br />
** Attacks - Display Alternate Attack types(Alt Ranged and ALT CMB)<br />
** Encumbrance - encumbrance-based-on and dwarf-specific rules<br />
** Hit Points - auto HP and max at 1st lvl/HD<br />
** Defenses - keep DEX when flat-footed, vary ability type for AC and CMB, use HD for CMB<br />
** Advanced - display user-defined fields, roll template macro-text, add to 1d20 rolls(resolved at 'roll-time')<br />
** Roll Configurations - show both PC and NPC menu buttons (choose whether to make a whispered roll or not)<br />
** Rule Options - show additional features including PFS, Unchained, Mythic, and Psionics.<br />
** Header images - additional header images added<br />
** Hero Lab Character Import<br />
* New Sheet Mode button. - Expanded mode(full editing) or Compact mode(important fields only)<br />
* Added Sheet default settings options - "Is NPC" is currently the only option, more to come.<br />
* Added Skill option to use custom rolls.<br />
* Added Spells linked to an attack.<br />
* Additional Menu Buttons for all important rolls with separate macros for PC and NPC with a configuration option to show both sets.<br />
* New Notes page - create custom macros, rolls or add notes.<br />
<br />
<br />
'''v .74''' <br />
* Favored class hit points now add correctly.<br />
<br />
* New sheet version coming soon! Check out the changes at https://app.roll20.net/join/801350/kEQ72w<br />
<br />
* GMs please IMPORT your NPCs and monsters to the beta campaign at https://app.roll20.net/join/801350/kEQ72w and report any issues you have on the forums at https://app.roll20.net/forum/post/4484041/pathfinder-feedback-needed<br />
<br />
* '''INVENTORY PAGE CHANGING:''' see Beta link in footer. Armor set on inventory page. One list for equipment instead of 2.<br />
<br />
* CREATURE PARSING in v1.00 see ''beta link'' in footer<br />
<br />
* Fixes for .71: Craft and other fill-in-the-name skills now update totals properly.<br />
<br />
* '''TAKE OUR SURVEY:''' https://www.surveymonkey.com/r/BL797KV<br />
<br />
* '''LASTPASS USERS NOTE:''' LastPass is still interfering with some Roll20 sheets. If you are experiencing degraded performance try disabling LastPass.<br />
<br />
* Fixes for .72: Buff check updates skills without hitting refresh. Damage mod applies correctly. Fixes to attack and damage not appearing in rolls. Recalc will finish. Requires Training no longer removes skill submenus from skill menu.<br />
<br />
* Thank you for your survey feedback. New changes are coming to simply the sheet making it much easier to use.<br />
<br />
* v .73 updates; '''total skill points''' now correct when multiclassed and Intelligence < 10<br />
<br />
* More expand and collapsible areas added to Attack Grid, Class Grid, Spellcaster class fields to hide complexity not needed by simpler characters.<br />
<br />
* Attack macrobook has base Melee, Ranged, and CMB buttons at top. Spellbook has Concentration and Casterlevel check buttons at top.<br />
<br />
* Spellbook, Skill'book', attacks, ability checks added above top menu. All can be dragged to macro bar.<br />
<br />
* Non-English speakers, please assist with translating this sheet. Details at the 'help translate' link in the footer.<br />
<br />
* Skillbook button available on the skills page. Displays skill choices in chat area. Drag it to macro bar like other buttons.<br />
<br />
* GMs NOTE: NPC CHANGES COMING in v.70 of this sheet. Please do the following: Preview changes at the beta site (link in post at 'feedback' link in footer at bottom of this sheet). View the changes and give us feedback<br />
<br />
* IMPORT A MONSTER FROM YOUR CAMPAIGN to observe changes. Make sure your macros still work.<br />
<br />
* Drag a monster from the compendium and report any bugs at the feedback link below.<br />
<br />
* GMs, ensure IS NPC is checked on all monster sheets. See beta link in footer.<br />
<br />
* IF YOU USED SKILL TAKE 10 or TAKE 20 or INVESTIGATOR DICE DROP-DOWN You must reset it by changing the dropdown values and changing them back.<br />
<br />
* Damage bonus fixed. Other fixes found at this link: http://tinyurl.com/PF-Thread<br />
<br />
* Attacks now have 'insert' macros that allow you to add a macro to the attack roll and damage roll. Each attack has 3 insert macros: one per attack, one per attack type (melee/ ranged / CMB) and one global.<br />
<br />
* Also are new macros for extra damage. One per attack and one global each of: non critical (sneak attack, flame weapon, etc), and critical only (flaming burst weapon, bleeding critical, etc)<br />
<br />
* Sheet has attempted to update your attack macros. If one does not work, and you have not customized it, simply delete the macro for that row and click in another field. This will reset the macro. Repeat for iterative attacks if necessary.<br />
<br />
* Spells now have a spontaneous / prepared switch in the 'Spells Per Day' section per class.<br />
<br />
* Skill options added to Take 10 or Take 20 to skill rolls, and to add Investigator dice to rolls.<br />
<br />
* Spell book and attack macros now available. Above the list of attacks and list of spells are buttons. Click these and the list of available spells or attacks shows up in the chat area. Click the spell or attack and it will perform the roll you chose. You can also drag these buttons to your macro bar or call them from macros.<br />
<br />
* Many bug fixes.<br />
<br />
* New screen-reader friendly roll templates have been added. Check the Use Simple Templates checkbox on the Config tab, Roll Template section, or add an attribute called toggle_accessible_flag and set it to {{accessible=true}}.<br />
<br />
* All spell IDs have changed. You must update your macros. After updating macros you must go to the config tab and delete spells with old IDs.<br />
<br />
* Attack and damage effects on the Attacks tab have been migrated to the Buffs section.<br />
<br />
* Buffs have been changed to repeating sections. Names of buff totals have not changed.<br />
<br />
* New Psionic ability sections have been added based on Psionics Unlimited<br />
<br />
* The ☷ button will split a repeating section into two columns. The ☰ will change it back to one column.<br />
<br />
* Rolltemplate backgrounds can be assigned colors. Choose a color on the config tab in the RollTemplate section.<br />
<br />
* Buttons within repeating sections can now be dragged to the macro quick bar. To learn the id/name of a button, drag/drop it to the macro quick bar, use the button, click in chat and hit the UP arrow. Each repeating row now includes the row ID.<br />
<br />
* All ability macros that utilize repeating attributes must be edited to include "$". e.g. @{repeating_foo_X_...} should be renamed @{repeating_foo_$X_...} where "X" is the row of the repeating section.<br />
<br />
* For macro calls to button rolls in repeating rows, you must do the above ($) and you must add "_roll" to the end. For attacks, add "-roll".<br />
<br />
* For existing characters/NPC's, if you do not see Version > 0 listed (top-right corner of sheet), use the Refresh Button to force a refresh of all auto-calculated attributes. This should only need to be done once and could take up to 10s.<br />
<br />
* If the sheet has been recalculated and you still have empty auto-calculated fields, you may have to toggle (change attribute value(s)) of sub-component attributes to help generate a value for the empty fields.<br />
<br />
* Weapon notes and header images can now be set independently from within the attack Options. You may have to clear @{macro_options} (located within Options) if you receive a missing attribute error.<br />
<br />
* Weapon notes and header images can now be set independently from within the attack Options. You may have to clear @{macro_options} (located within Options) if you receive a missing attribute error.<br />
<br />
</div></div><br />
<br />
<br clear=all><br />
<br />
= <blockquote style="background-color:#000;color:#FFF;text-align:center;margin:-2px;">Procedures and How-Tos</blockquote> =<br />
<div class="toccolours mw-collapsible"><br />
<br />
<div class="mw-collapsible-content"><br />
<br />
This section details common step by step procedures.<br />
<br />
== Character Creation Walk-thru ==<br />
:Simple guide for creating a character using the Pathfinder Sheet.<br />
<br />
== Add a custom icon to rolls ==<br />
:Let's assume you have the icon you want to use (you have to make it small and preferably transparent, say a 35X35 transparent png. Our roll template in this example is black so our icon is white.). You can tweak your icon, resize, change color etc. using GIMP, paint.net or any other image editing software (avoid MSPaint!). Upload your icon to an imgur account or any image hosting site at your disposition.<br />
<br />
In this case, the icon has been uploaded to imgur. We'll use a character named Remi who has a Bite attack for this example. <br />
<br />
Now for some step by step stuff:<br />
<br />
1. Make sure header images are ticked on in your macro options:<br />
<br />
[[File:Pf icon tut 01.jpeg|480px|thumbnail|center]]<br />
<br />
2. Alright, let's take Remi's bite attack:<br />
<br />
We have our image, located at http://imgur.com/goY8rhr.png (Don't forget that '.png' at the end of the url! If the file extension isn't present, a link to the image with what you set your icon name to will appear instead of the icon.).<br />
<br />
Now to change your attack icon you will use this macro string: <br />
{{header_image=[name](url)}}<br />
<br />
The name part can be anything, let's make it 'Bite', and in place of url, let's paste our image location so our macro string becomes:<br />
<br />
{{header_image=[Bite](http://imgur.com/goY8rhr.png)}}<br />
<br />
3. Now to place this string! We go to the attacks tab of the character sheet and locate Remi's Bite, expand it, than expand the 'Macro Text' link:<br />
[[File:Pf icon tut 02.jpeg|480px|thumbnail|center]]<br />
<br />
Scroll to the end of the text, then paste the macro string with the image url at the end, like so, making sure there is a space between the string you pasted and the previous string:<br />
<br />
[[File:Pf icon tut 03.jpeg|480px|thumbnail|center]]<br />
<br />
4. Test your attack!<br />
<br />
[[File:Pf icon tut 04.jpeg|480px|thumbnail|center]]<br />
<br />
If you want to do it on skills, it's the exact same thing, simply find the macro text box for the skill, prepare your header image string like you did for the bite attack and paste it at the end of the box like so:<br />
<br />
[[File:Pf icon tut 05.jpeg|480px|thumbnail|center]]<br />
<br />
And since you put the request for the new image in the macro field linked to the roll button of the sheet, the macros you make using the attacks will still pull that request for the header image and you should still get the image if you use a macro button.<br />
<br />
Taken from original Community forum post: https://app.roll20.net/forum/post/3866049/pathfinder-easy-tutorial-for-custom-icons-for-attacks-checks-etc<br />
</div></div><br />
<br clearall><br />
[[Category:Guides]]<br />
[[Category:Character Sheet Documentation]]<br />
[[Category:User content]]</div>92730https://wiki.roll20.net/Mod:Script_IndexMod:Script Index2016-03-20T22:22:20Z<p>92730: /* System */</p>
<hr />
<div>{{pro only}}<br />
<br />
<div style="float:left;margin-right:15px">__TOC__</div><br />
{{apibox}}<br />
<br />
<br />
The '''API Script Index''' is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the [https://github.com/Roll20/roll20-api-scripts API GitHub Repository] and follow the instructions in the README.md file at the bottom of the page.<br />
<br />
<br clear="both"><br />
<br />
== Scripts By Category ==<br />
<br />
=== General Purpose Scripts ===<br />
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.<br />
<br />
==== Combat Scripts ====<br />
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.<br />
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.<br />
* [[Script:Initiative Tracker|Initiative Tracker]] -- Round counter and status effect manager with optional announcements to chat.<br />
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.<br />
* [[Script:TrackerJacker|TrackerJacker]] -- Graphical turnorder tracker, as well as status/condition marker tracking<br />
* [[Script:Turn Marker|Turn Marker]] -- Round counter and a moving marker that shows who's turn it is.<br />
<br />
==== Tokens - Conditions / Status / Health ====<br />
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.<br />
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects<br />
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking<br />
* [[Script:Conditions and Status Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.<br />
* [[Script:Flight|Flight]] -- Mark how high tokens are flying<br />
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically<br />
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.<br />
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens<br />
* [[Script:Temp HP and Status|Temp HP and Status]] -- Temp hit point manager and bloodied/dying/dead status markers.<br />
* [[Script:Toggle Status|Toggle Status]] -- Toggle status marker on/off, and update character attribute to match<br />
<br />
==== Tokens - Movement, Rotation, and Size ====<br />
Scripts which are triggered by or change the location of tokens should generally be placed in this category.<br />
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.<br />
* [[Script:Change_Token_Image|Change Token Image]] -- Changes displayed image for tokens based on rollable table.<br />
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page<br />
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.<br />
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.<br />
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated<br />
* [[Script:Random Depth|Random Depth]] -- Randomly adjusts the depth of selected tokens.<br />
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.<br />
* [[Script:Size Lock|Size Lock]] -- Toggles a state which reverts any size changes automatically.<br />
* [[Script:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.<br />
* [[Script:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.<br />
* [[Script:Table Token Sizer|Table Token Sizer]] -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.<br />
* [[Script:Token Path|Token Path]] -- Tracks movement of the token at the top of tracker, displaying its path (and distance traveled) for the round.<br />
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.<br />
* [[Script:Twins|Twins]] -- Links two tokens so that they mirror each other across pages.<br />
<br />
==== Lighting and Revealing ====<br />
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.<br />
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later<br />
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer<br />
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.<br />
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.<br />
* [[Script:Walls|Walls]] -- Builds dynamic lighting walls with an exported SVG path file.<br />
<br />
==== Characters - Equipment ====<br />
Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.<br />
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.<br />
* [[Script:Ammunition Tracker|Ammunition Tracker]] -- A bunch of commands to track ammunition.<br />
* [[Script:Inventory Manager|Inventory Manager]] -- Inventory Management<br />
<br />
==== Characters - Attributes ====<br />
Manipulate one or more characters' attributes. Anything that is system-specific should be placed in the system's category below; this section is for system-agnostic attribute manipulation.<br />
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.<br />
* [[Script:Manual Attribute|Manual Attribute]] -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.<br />
<br />
==== Generators ====<br />
Content generation can extend the reach of your campaign while minimizing the GM's prep time.<br />
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles.<br />
* [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images.<br />
* [[Script:Tile|Tile]] -- Create tiled arrays of graphics on the map layer.<br />
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.<br />
<br />
==== Roleplay ====<br />
Scripts which attempt to make the game more immersive belong in this category.<br />
* [[Script:Animation|Animation]] -- Create and display animations.<br />
* [[Script:Languages|Languages]] -- Allows characters & GMs to create and speak any language. This is a rework of What Did He Say<br />
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.<br />
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting<br />
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions<br />
<br />
==== System ====<br />
Scripts in this category are a bit more ''meta'' than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.<br />
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.<br />
* [[Script:cron|cron]] -- Schedule (possibly recurring) commands to run at some point in the future.<br />
* [[Script:emas|emas]] -- Provides player !emas and !as commands.<br />
* [[Script:Extended Expressions|Extended Expressions]] -- Extended roll expression syntax, supporting conditionals, variable references, bitwise operators, and more.<br />
* [[Script:HiddenRolls|HiddenRolls]] -- Various types of roll hiding (unmodified roll only, final result only, only show to GM).<br />
* [[Script:Is Greater|Is Greater]] -- Trivial little script to check if the first value is greater than the second and report it to chat.<br />
* [[Script:Map Lock|Map Lock]] -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.<br />
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.<br />
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.<br />
* [[Script:Move Players|Move Players]] -- Allows macros to move the player ribbon for players.<br />
* [[Script:Object Properties|Object Properties]] -- Get and set properties of API objects.<br />
* [[Script:Page Size|Page Size]] -- Resizes page, optionally moving and/or scaling its contents.<br />
* [[Script:RollStats|RollStats]] -- Track and display roll statistics.<br />
* [[Script:StateBrowser|StateBrowser]] -- View/modify the contents of the state object.<br />
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution<br />
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.<br />
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.<br />
* [[Script:TokenSync|TokenSync]] -- Synchronize changes to token with other tokens that represent the same character<br />
* [[Script:Weighted Dice|Weighted Dice]] -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)<br />
<br />
=== Game Specific Scripts ===<br />
Scripts that deal with ''specific'' rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.<br />
<br />
Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).<br />
<br />
==== 13th Age ====<br />
* [[Script:Escalation|Escalation]] -- Simple Escalation Die handling script, using the new custom entries with formulae.<br />
<br />
==== BASH! Ultimate Edition ====<br />
* [[Script:Dice (BASH!)|Dice]] -- Rolls the Bash UE Dice format with exploding.<br />
<br />
==== d6 System ====<br />
The "d6 System" includes a number of games from [[wikipedia:West End Games|West End Games]] which utilize the same (or very similar) game mechanics. Scripts which are more specific to a single game than the system as a whole should be categorized there.<br />
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic.<br />
<br />
==== d20 System ====<br />
The "d20 System" includes Dungeons & Dragons and the games it spawned which utilize the same (or very similar) game mechanics. Scripts which are more specific to D&D or one of its spinoffs than the system as a whole should be categorized there.<br />
* [[Script:Announce Roll|Announce Roll]] -- Prints an extra announcement of a critical or fumble to the chat when using /roll<br />
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal.<br />
<br />
==== Cypher System ====<br />
* [[Script:Cypher_System_Sheet|Cypher System Sheet]] -- Enables the applying of stat cost, recovery roll advance, auto calculation of PC state and damage track in the Cypher System Sheet, from the roll template or sheet buttons, for both the [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystem "English"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystemFrench "French"] versions.<br />
<br />
==== Dogs in the Vineyard ====<br />
* [[Script:Dice in the Vineyard|Dice in the Vineyard]] -- Dice tracker for Dogs in the Vineyard. Stacks poker-chip-styled roll tokens in defined areas for characters to spend.<br />
<br />
==== Dungeons & Dragons 4e ====<br />
* [[Script:Use Power|Use Power]] -- A script for instrumenting and tracking the use of encounter and daily powers.<br />
<br />
==== Dungeons & Dragons 5e ====<br />
* [[Script:Monster Hit Dice (D&D 5e)|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet<br />
* [[Script:Spell Level (D&D 5e)|Spell Level]] --<br />
<br />
==== Edge of the Empire ====<br />
* [[Script:Dice Roller (Edge of the Empire)|Dice Roller]] -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game<br />
<br />
==== Exalted, Second Edition ====<br />
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.<br />
<br />
==== FATE ====<br />
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.<br />
<br />
==== Numenera ====<br />
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.<br />
* [[Script:Numenera_Natha|Numenera Natha]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].<br />
<br />
==== Pathfinder ====<br />
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks<br />
* [[Script:Skillbook|Skillbook]] -- Generate token action to put API buttons for skills in chat window<br />
* [[Script:HL-Import|HL-Import]] -- Import characters from Hero Lab via XML<br />
<br />
==== Ryuutama ====<br />
* [[Script:Ryuutama Token Status Markers|Ryuutama Token Status Markers]]<br />
* [[Script:Ryuutama Skill Check Totaler|Ryuutama Skill Check Totaler]]<br />
<br />
==== Savage Worlds ====<br />
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number<br />
<br />
==== Trail of Cthulhu ====<br />
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.<br />
<br />
==== Vampire: The Masquerade, 20th Anniversary Edition ====<br />
* [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.<br />
<br />
==== Zombie Dice ====<br />
* [[Script:Zombie Dice|Zombie Dice]] -- Rolls canceling Zombie Dice<br />
<br />
=== Utility Scripts ===<br />
These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.<br />
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )<br />
* [[Script:Command Shell|Command Shell]] -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.<br />
* [[Script:GM Code|GM Code]] -- Generates a unique code to authenticate the GM.<br />
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event<br />
* [[Script:IsGM Auth Module|IsGM Auth Module]] -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.<br />
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings<br />
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments<br />
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.<br />
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.<br />
<br />
=== Special Thanks ===<br />
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API script index.<br />
<br />
[[Category:API|Script Index]]</div>92730https://wiki.roll20.net/Mod:Script_IndexMod:Script Index2016-03-20T22:22:08Z<p>92730: /* Tokens - Conditions / Status / Health */</p>
<hr />
<div>{{pro only}}<br />
<br />
<div style="float:left;margin-right:15px">__TOC__</div><br />
{{apibox}}<br />
<br />
<br />
The '''API Script Index''' is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the [https://github.com/Roll20/roll20-api-scripts API GitHub Repository] and follow the instructions in the README.md file at the bottom of the page.<br />
<br />
<br clear="both"><br />
<br />
== Scripts By Category ==<br />
<br />
=== General Purpose Scripts ===<br />
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.<br />
<br />
==== Combat Scripts ====<br />
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.<br />
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.<br />
* [[Script:Initiative Tracker|Initiative Tracker]] -- Round counter and status effect manager with optional announcements to chat.<br />
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.<br />
* [[Script:TrackerJacker|TrackerJacker]] -- Graphical turnorder tracker, as well as status/condition marker tracking<br />
* [[Script:Turn Marker|Turn Marker]] -- Round counter and a moving marker that shows who's turn it is.<br />
<br />
==== Tokens - Conditions / Status / Health ====<br />
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.<br />
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects<br />
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking<br />
* [[Script:Conditions and Status Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.<br />
* [[Script:Flight|Flight]] -- Mark how high tokens are flying<br />
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically<br />
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.<br />
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens<br />
* [[Script:Temp HP and Status|Temp HP and Status]] -- Temp hit point manager and bloodied/dying/dead status markers.<br />
* [[Script:Toggle Status|Toggle Status]] -- Toggle status marker on/off, and update character attribute to match<br />
<br />
==== Tokens - Movement, Rotation, and Size ====<br />
Scripts which are triggered by or change the location of tokens should generally be placed in this category.<br />
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.<br />
* [[Script:Change_Token_Image|Change Token Image]] -- Changes displayed image for tokens based on rollable table.<br />
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page<br />
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.<br />
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.<br />
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated<br />
* [[Script:Random Depth|Random Depth]] -- Randomly adjusts the depth of selected tokens.<br />
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.<br />
* [[Script:Size Lock|Size Lock]] -- Toggles a state which reverts any size changes automatically.<br />
* [[Script:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.<br />
* [[Script:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.<br />
* [[Script:Table Token Sizer|Table Token Sizer]] -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.<br />
* [[Script:Token Path|Token Path]] -- Tracks movement of the token at the top of tracker, displaying its path (and distance traveled) for the round.<br />
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.<br />
* [[Script:Twins|Twins]] -- Links two tokens so that they mirror each other across pages.<br />
<br />
==== Lighting and Revealing ====<br />
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.<br />
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later<br />
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer<br />
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.<br />
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.<br />
* [[Script:Walls|Walls]] -- Builds dynamic lighting walls with an exported SVG path file.<br />
<br />
==== Characters - Equipment ====<br />
Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.<br />
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.<br />
* [[Script:Ammunition Tracker|Ammunition Tracker]] -- A bunch of commands to track ammunition.<br />
* [[Script:Inventory Manager|Inventory Manager]] -- Inventory Management<br />
<br />
==== Characters - Attributes ====<br />
Manipulate one or more characters' attributes. Anything that is system-specific should be placed in the system's category below; this section is for system-agnostic attribute manipulation.<br />
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.<br />
* [[Script:Manual Attribute|Manual Attribute]] -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.<br />
<br />
==== Generators ====<br />
Content generation can extend the reach of your campaign while minimizing the GM's prep time.<br />
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles.<br />
* [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images.<br />
* [[Script:Tile|Tile]] -- Create tiled arrays of graphics on the map layer.<br />
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.<br />
<br />
==== Roleplay ====<br />
Scripts which attempt to make the game more immersive belong in this category.<br />
* [[Script:Animation|Animation]] -- Create and display animations.<br />
* [[Script:Languages|Languages]] -- Allows characters & GMs to create and speak any language. This is a rework of What Did He Say<br />
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.<br />
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting<br />
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions<br />
<br />
==== System ====<br />
Scripts in this category are a bit more ''meta'' than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.<br />
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.<br />
* [[Script:cron|cron]] -- Schedule (possibly recurring) commands to run at some point in the future.<br />
* [[Script:emas|emas]] -- Provides player !emas and !as commands.<br />
* [[Script:Extended Expressions|Extended Expressions]] -- Extended roll expression syntax, supporting conditionals, variable references, bitwise operators, and more.<br />
* [[Script:HiddenRolls|HiddenRolls]] -- Various types of roll hiding (unmodified roll only, final result only, only show to GM).<br />
* [[Script:Is Greater|Is Greater]] -- Trivial little script to check if the first value is greater than the second and report it to chat.<br />
* [[Script:Map Lock|Map Lock]] -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.<br />
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.<br />
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.<br />
* [[Script:Move Players|Move Players]] -- Allows macros to move the player ribbon for players.<br />
* [[Script:Object Properties|Object Properties]] -- Get and set properties of API objects.<br />
* [[Script:Page Size|Page Size]] -- Resizes page, optionally moving and/or scaling its contents.<br />
* [[Script:RollStats|RollStats]] -- Track and display roll statistics.<br />
* [[Script:StateBrowser|StateBrowser]] -- View/modify the contents of the state object.<br />
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution<br />
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.<br />
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.<br />
* [[Script:Weighted Dice|Weighted Dice]] -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)<br />
<br />
=== Game Specific Scripts ===<br />
Scripts that deal with ''specific'' rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.<br />
<br />
Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).<br />
<br />
==== 13th Age ====<br />
* [[Script:Escalation|Escalation]] -- Simple Escalation Die handling script, using the new custom entries with formulae.<br />
<br />
==== BASH! Ultimate Edition ====<br />
* [[Script:Dice (BASH!)|Dice]] -- Rolls the Bash UE Dice format with exploding.<br />
<br />
==== d6 System ====<br />
The "d6 System" includes a number of games from [[wikipedia:West End Games|West End Games]] which utilize the same (or very similar) game mechanics. Scripts which are more specific to a single game than the system as a whole should be categorized there.<br />
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic.<br />
<br />
==== d20 System ====<br />
The "d20 System" includes Dungeons & Dragons and the games it spawned which utilize the same (or very similar) game mechanics. Scripts which are more specific to D&D or one of its spinoffs than the system as a whole should be categorized there.<br />
* [[Script:Announce Roll|Announce Roll]] -- Prints an extra announcement of a critical or fumble to the chat when using /roll<br />
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal.<br />
<br />
==== Cypher System ====<br />
* [[Script:Cypher_System_Sheet|Cypher System Sheet]] -- Enables the applying of stat cost, recovery roll advance, auto calculation of PC state and damage track in the Cypher System Sheet, from the roll template or sheet buttons, for both the [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystem "English"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystemFrench "French"] versions.<br />
<br />
==== Dogs in the Vineyard ====<br />
* [[Script:Dice in the Vineyard|Dice in the Vineyard]] -- Dice tracker for Dogs in the Vineyard. Stacks poker-chip-styled roll tokens in defined areas for characters to spend.<br />
<br />
==== Dungeons & Dragons 4e ====<br />
* [[Script:Use Power|Use Power]] -- A script for instrumenting and tracking the use of encounter and daily powers.<br />
<br />
==== Dungeons & Dragons 5e ====<br />
* [[Script:Monster Hit Dice (D&D 5e)|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet<br />
* [[Script:Spell Level (D&D 5e)|Spell Level]] --<br />
<br />
==== Edge of the Empire ====<br />
* [[Script:Dice Roller (Edge of the Empire)|Dice Roller]] -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game<br />
<br />
==== Exalted, Second Edition ====<br />
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.<br />
<br />
==== FATE ====<br />
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.<br />
<br />
==== Numenera ====<br />
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.<br />
* [[Script:Numenera_Natha|Numenera Natha]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].<br />
<br />
==== Pathfinder ====<br />
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks<br />
* [[Script:Skillbook|Skillbook]] -- Generate token action to put API buttons for skills in chat window<br />
* [[Script:HL-Import|HL-Import]] -- Import characters from Hero Lab via XML<br />
<br />
==== Ryuutama ====<br />
* [[Script:Ryuutama Token Status Markers|Ryuutama Token Status Markers]]<br />
* [[Script:Ryuutama Skill Check Totaler|Ryuutama Skill Check Totaler]]<br />
<br />
==== Savage Worlds ====<br />
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number<br />
<br />
==== Trail of Cthulhu ====<br />
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.<br />
<br />
==== Vampire: The Masquerade, 20th Anniversary Edition ====<br />
* [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.<br />
<br />
==== Zombie Dice ====<br />
* [[Script:Zombie Dice|Zombie Dice]] -- Rolls canceling Zombie Dice<br />
<br />
=== Utility Scripts ===<br />
These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.<br />
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )<br />
* [[Script:Command Shell|Command Shell]] -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.<br />
* [[Script:GM Code|GM Code]] -- Generates a unique code to authenticate the GM.<br />
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event<br />
* [[Script:IsGM Auth Module|IsGM Auth Module]] -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.<br />
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings<br />
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments<br />
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.<br />
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.<br />
<br />
=== Special Thanks ===<br />
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API script index.<br />
<br />
[[Category:API|Script Index]]</div>92730https://wiki.roll20.net/Script:TokenSyncScript:TokenSync2016-03-20T22:21:40Z<p>92730: Created page with "<div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"> <span style="text-align:center;dis..."</p>
<hr />
<div><div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"><br />
<span style="text-align:center;display:block;font-size:1.4em">API Script</span><br />
<span style="font-variant:small-caps">'''Author:''' {{user profile|92730|James W.}}, {{user profile|104025|The Aaron}} </span><br><br />
{{script version|1.60}}<br><br />
{{script lastmodified date| 2016-3-13}}<br><br />
<span style="font-variant:small-caps">'''Code:''' [https://github.com/SCPRedMage/roll20-api-scripts/blob/master/TokenSync/TokenSync.js TokenSync] </span><br><br />
<span style="font-variant:small-caps">'''Dependencies:''' None </span><br><br />
<span style="font-variant:small-caps">'''Conflicts:''' Unknown </span><br />
</div><br />
TokenSync is a script to synchronize changes to a token to all other tokens that represent the same character. Now you can set the tokens representing your PCs to always have the same status markers, for example. Just tell TokenSync which property (or properties) to synchronize, and any time that property changes on any token that represents that character changes, TokenSync will propagate that change to all other tokens that represent that character.<br />
<br />
=== Usage ===<br />
:'''!tokensync''' -- This is the interface command, with the following options:<br />
::{| class="wikitable"<br />
|-<br />
! Parameter !! Description<br />
|-<br />
| --help || Displays the help script.<br />
|-<br />
| --add property|| Adds the specified property to the list of properties that TokenSync will synchronize for the character the selected token represents; if you want to specify multiple properties, just separate them with a vertical bar ("&#124;").<br />
|-<br />
| --remove property|| Removes the specified property from the list of properties that TokenSync will synchronize for the character the selected token represents; if you want to specify multiple properties, just separate them with a vertical bar ("&#124;").<br />
|-<br />
| --removeall|| Removes all properties for the selected character from the sync list.<br />
|-<br />
| --forcesync|| Forces a synchronizes event to update all properties to match selected token; useful for forcing updates after calling an API script to change token properties.<br />
|}<br />
<br />
=== Properties that can be syncrhonized ===<br />
* imgsrc<br />
* bar1_link<br />
* bar2_link<br />
* bar3_link<br />
* width<br />
* height<br />
* rotation<br />
* layer<br />
* isdrawing<br />
* flipv<br />
* fliph<br />
* name<br />
* aura1_radius<br />
* aura2_radius<br />
* aura1_color<br />
* aura2_color<br />
* aura1_square<br />
* aura2_square<br />
* tint_color<br />
* statusmarkers<br />
* showname<br />
* showplayers_name<br />
* showplayers_bar1<br />
* showplayers_bar2<br />
* showplayers_bar3<br />
* showplayers_aura1<br />
* showplayers_aura2<br />
* light_radius<br />
* light_dimradius<br />
* light_otherplayers<br />
* light_hassight<br />
* light_angle<br />
* light_losangle<br />
* light_multiplier<br />
<br />
Note: imgsrc will only sync if the token was created from your library; basically, if [https://wiki.roll20.net/Script:Change_Token_Image ChangeTokenImage.js] can change the image, TokenSync can synchronize the change.<br />
<br />
=== API scripts ===<br />
Because API scripts making changes to a token doesn't result in change events, TokenSync won't automatically synchronize any token changes caused by an API script. To get around this, there are two options.<br />
* Manually force a sync event by calling "!tokensync --forcesync".<br />
* Update the API script to call an update ("tok" is token object with the updated properties, "property" is the property to synchronize; you can synchronize multiple properties by separating them with vertical bars):<br /><br /><br />
:if (!_.isUndefined(TokenSync))<br /><br />
::TokenSync.syncProperty(tok, property);<br /><br />
Since this checks to see if TokenSync is defined, it's safe to call this in other scripts, even if the user isn't using TokenSync.<br />
<br />
=== Changelog ===<br />
{{changelog version|1.6|2016-03-20|* More optimizations, courtesy of The Aaron}}<br />
{{changelog version|1.5|2016-03-17|* Refactored schema to simplify code}}<br />
{{changelog version|1.1|2016-03-17|* Added syncing new tokens, sync on represents change, remove deleted characters}}<br />
{{changelog version|1.0|2016-03-16|* Release}}</div>92730https://wiki.roll20.net/Mod:Script_IndexMod:Script Index2016-03-20T22:14:58Z<p>92730: /* Tokens - Conditions / Status / Health */</p>
<hr />
<div>{{pro only}}<br />
<br />
<div style="float:left;margin-right:15px">__TOC__</div><br />
{{apibox}}<br />
<br />
<br />
The '''API Script Index''' is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the [https://github.com/Roll20/roll20-api-scripts API GitHub Repository] and follow the instructions in the README.md file at the bottom of the page.<br />
<br />
<br clear="both"><br />
<br />
== Scripts By Category ==<br />
<br />
=== General Purpose Scripts ===<br />
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.<br />
<br />
==== Combat Scripts ====<br />
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.<br />
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.<br />
* [[Script:Initiative Tracker|Initiative Tracker]] -- Round counter and status effect manager with optional announcements to chat.<br />
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.<br />
* [[Script:TrackerJacker|TrackerJacker]] -- Graphical turnorder tracker, as well as status/condition marker tracking<br />
* [[Script:Turn Marker|Turn Marker]] -- Round counter and a moving marker that shows who's turn it is.<br />
<br />
==== Tokens - Conditions / Status / Health ====<br />
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.<br />
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects<br />
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking<br />
* [[Script:Conditions and Status Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.<br />
* [[Script:Flight|Flight]] -- Mark how high tokens are flying<br />
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically<br />
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.<br />
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens<br />
* [[Script:Temp HP and Status|Temp HP and Status]] -- Temp hit point manager and bloodied/dying/dead status markers.<br />
* [[Script:Toggle Status|Toggle Status]] -- Toggle status marker on/off, and update character attribute to match<br />
* [[Script:TokenSync|TokenSync]] -- Synchronize changes to token with other tokens that represent the same character<br />
<br />
==== Tokens - Movement, Rotation, and Size ====<br />
Scripts which are triggered by or change the location of tokens should generally be placed in this category.<br />
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.<br />
* [[Script:Change_Token_Image|Change Token Image]] -- Changes displayed image for tokens based on rollable table.<br />
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page<br />
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.<br />
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.<br />
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated<br />
* [[Script:Random Depth|Random Depth]] -- Randomly adjusts the depth of selected tokens.<br />
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.<br />
* [[Script:Size Lock|Size Lock]] -- Toggles a state which reverts any size changes automatically.<br />
* [[Script:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.<br />
* [[Script:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.<br />
* [[Script:Table Token Sizer|Table Token Sizer]] -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.<br />
* [[Script:Token Path|Token Path]] -- Tracks movement of the token at the top of tracker, displaying its path (and distance traveled) for the round.<br />
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.<br />
* [[Script:Twins|Twins]] -- Links two tokens so that they mirror each other across pages.<br />
<br />
==== Lighting and Revealing ====<br />
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.<br />
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later<br />
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer<br />
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.<br />
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.<br />
* [[Script:Walls|Walls]] -- Builds dynamic lighting walls with an exported SVG path file.<br />
<br />
==== Characters - Equipment ====<br />
Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.<br />
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.<br />
* [[Script:Ammunition Tracker|Ammunition Tracker]] -- A bunch of commands to track ammunition.<br />
* [[Script:Inventory Manager|Inventory Manager]] -- Inventory Management<br />
<br />
==== Characters - Attributes ====<br />
Manipulate one or more characters' attributes. Anything that is system-specific should be placed in the system's category below; this section is for system-agnostic attribute manipulation.<br />
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.<br />
* [[Script:Manual Attribute|Manual Attribute]] -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.<br />
<br />
==== Generators ====<br />
Content generation can extend the reach of your campaign while minimizing the GM's prep time.<br />
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles.<br />
* [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images.<br />
* [[Script:Tile|Tile]] -- Create tiled arrays of graphics on the map layer.<br />
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.<br />
<br />
==== Roleplay ====<br />
Scripts which attempt to make the game more immersive belong in this category.<br />
* [[Script:Animation|Animation]] -- Create and display animations.<br />
* [[Script:Languages|Languages]] -- Allows characters & GMs to create and speak any language. This is a rework of What Did He Say<br />
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.<br />
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting<br />
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions<br />
<br />
==== System ====<br />
Scripts in this category are a bit more ''meta'' than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.<br />
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.<br />
* [[Script:cron|cron]] -- Schedule (possibly recurring) commands to run at some point in the future.<br />
* [[Script:emas|emas]] -- Provides player !emas and !as commands.<br />
* [[Script:Extended Expressions|Extended Expressions]] -- Extended roll expression syntax, supporting conditionals, variable references, bitwise operators, and more.<br />
* [[Script:HiddenRolls|HiddenRolls]] -- Various types of roll hiding (unmodified roll only, final result only, only show to GM).<br />
* [[Script:Is Greater|Is Greater]] -- Trivial little script to check if the first value is greater than the second and report it to chat.<br />
* [[Script:Map Lock|Map Lock]] -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.<br />
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.<br />
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.<br />
* [[Script:Move Players|Move Players]] -- Allows macros to move the player ribbon for players.<br />
* [[Script:Object Properties|Object Properties]] -- Get and set properties of API objects.<br />
* [[Script:Page Size|Page Size]] -- Resizes page, optionally moving and/or scaling its contents.<br />
* [[Script:RollStats|RollStats]] -- Track and display roll statistics.<br />
* [[Script:StateBrowser|StateBrowser]] -- View/modify the contents of the state object.<br />
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution<br />
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.<br />
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.<br />
* [[Script:Weighted Dice|Weighted Dice]] -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)<br />
<br />
=== Game Specific Scripts ===<br />
Scripts that deal with ''specific'' rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.<br />
<br />
Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).<br />
<br />
==== 13th Age ====<br />
* [[Script:Escalation|Escalation]] -- Simple Escalation Die handling script, using the new custom entries with formulae.<br />
<br />
==== BASH! Ultimate Edition ====<br />
* [[Script:Dice (BASH!)|Dice]] -- Rolls the Bash UE Dice format with exploding.<br />
<br />
==== d6 System ====<br />
The "d6 System" includes a number of games from [[wikipedia:West End Games|West End Games]] which utilize the same (or very similar) game mechanics. Scripts which are more specific to a single game than the system as a whole should be categorized there.<br />
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic.<br />
<br />
==== d20 System ====<br />
The "d20 System" includes Dungeons & Dragons and the games it spawned which utilize the same (or very similar) game mechanics. Scripts which are more specific to D&D or one of its spinoffs than the system as a whole should be categorized there.<br />
* [[Script:Announce Roll|Announce Roll]] -- Prints an extra announcement of a critical or fumble to the chat when using /roll<br />
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal.<br />
<br />
==== Cypher System ====<br />
* [[Script:Cypher_System_Sheet|Cypher System Sheet]] -- Enables the applying of stat cost, recovery roll advance, auto calculation of PC state and damage track in the Cypher System Sheet, from the roll template or sheet buttons, for both the [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystem "English"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystemFrench "French"] versions.<br />
<br />
==== Dogs in the Vineyard ====<br />
* [[Script:Dice in the Vineyard|Dice in the Vineyard]] -- Dice tracker for Dogs in the Vineyard. Stacks poker-chip-styled roll tokens in defined areas for characters to spend.<br />
<br />
==== Dungeons & Dragons 4e ====<br />
* [[Script:Use Power|Use Power]] -- A script for instrumenting and tracking the use of encounter and daily powers.<br />
<br />
==== Dungeons & Dragons 5e ====<br />
* [[Script:Monster Hit Dice (D&D 5e)|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet<br />
* [[Script:Spell Level (D&D 5e)|Spell Level]] --<br />
<br />
==== Edge of the Empire ====<br />
* [[Script:Dice Roller (Edge of the Empire)|Dice Roller]] -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game<br />
<br />
==== Exalted, Second Edition ====<br />
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.<br />
<br />
==== FATE ====<br />
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.<br />
<br />
==== Numenera ====<br />
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.<br />
* [[Script:Numenera_Natha|Numenera Natha]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].<br />
<br />
==== Pathfinder ====<br />
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks<br />
* [[Script:Skillbook|Skillbook]] -- Generate token action to put API buttons for skills in chat window<br />
* [[Script:HL-Import|HL-Import]] -- Import characters from Hero Lab via XML<br />
<br />
==== Ryuutama ====<br />
* [[Script:Ryuutama Token Status Markers|Ryuutama Token Status Markers]]<br />
* [[Script:Ryuutama Skill Check Totaler|Ryuutama Skill Check Totaler]]<br />
<br />
==== Savage Worlds ====<br />
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number<br />
<br />
==== Trail of Cthulhu ====<br />
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.<br />
<br />
==== Vampire: The Masquerade, 20th Anniversary Edition ====<br />
* [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.<br />
<br />
==== Zombie Dice ====<br />
* [[Script:Zombie Dice|Zombie Dice]] -- Rolls canceling Zombie Dice<br />
<br />
=== Utility Scripts ===<br />
These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.<br />
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )<br />
* [[Script:Command Shell|Command Shell]] -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.<br />
* [[Script:GM Code|GM Code]] -- Generates a unique code to authenticate the GM.<br />
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event<br />
* [[Script:IsGM Auth Module|IsGM Auth Module]] -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.<br />
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings<br />
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments<br />
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.<br />
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.<br />
<br />
=== Special Thanks ===<br />
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API script index.<br />
<br />
[[Category:API|Script Index]]</div>92730https://wiki.roll20.net/Mod:Script_IndexMod:Script Index2016-03-20T22:01:25Z<p>92730: /* Tokens - Conditions / Status / Health */</p>
<hr />
<div>{{pro only}}<br />
<br />
<div style="float:left;margin-right:15px">__TOC__</div><br />
{{apibox}}<br />
<br />
<br />
The '''API Script Index''' is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the [https://github.com/Roll20/roll20-api-scripts API GitHub Repository] and follow the instructions in the README.md file at the bottom of the page.<br />
<br />
<br clear="both"><br />
<br />
== Scripts By Category ==<br />
<br />
=== General Purpose Scripts ===<br />
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.<br />
<br />
==== Combat Scripts ====<br />
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.<br />
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.<br />
* [[Script:Initiative Tracker|Initiative Tracker]] -- Round counter and status effect manager with optional announcements to chat.<br />
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.<br />
* [[Script:TrackerJacker|TrackerJacker]] -- Graphical turnorder tracker, as well as status/condition marker tracking<br />
* [[Script:Turn Marker|Turn Marker]] -- Round counter and a moving marker that shows who's turn it is.<br />
<br />
==== Tokens - Conditions / Status / Health ====<br />
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.<br />
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects<br />
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking<br />
* [[Script:Conditions and Status Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.<br />
* [[Script:Flight|Flight]] -- Mark how high tokens are flying<br />
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically<br />
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.<br />
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens<br />
* [[Script:Temp HP and Status|Temp HP and Status]] -- Temp hit point manager and bloodied/dying/dead status markers.<br />
* [[Script:Toggle Status|Toggle Status]] -- Toggle status marker on/off, and update character attribute to match<br />
* [[Script:ToggleSync|ToggleSync]] -- Synchronize changes to token with other tokens that represent the same character<br />
<br />
==== Tokens - Movement, Rotation, and Size ====<br />
Scripts which are triggered by or change the location of tokens should generally be placed in this category.<br />
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.<br />
* [[Script:Change_Token_Image|Change Token Image]] -- Changes displayed image for tokens based on rollable table.<br />
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page<br />
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.<br />
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.<br />
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated<br />
* [[Script:Random Depth|Random Depth]] -- Randomly adjusts the depth of selected tokens.<br />
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.<br />
* [[Script:Size Lock|Size Lock]] -- Toggles a state which reverts any size changes automatically.<br />
* [[Script:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.<br />
* [[Script:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.<br />
* [[Script:Table Token Sizer|Table Token Sizer]] -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.<br />
* [[Script:Token Path|Token Path]] -- Tracks movement of the token at the top of tracker, displaying its path (and distance traveled) for the round.<br />
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.<br />
* [[Script:Twins|Twins]] -- Links two tokens so that they mirror each other across pages.<br />
<br />
==== Lighting and Revealing ====<br />
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.<br />
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later<br />
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer<br />
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.<br />
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.<br />
* [[Script:Walls|Walls]] -- Builds dynamic lighting walls with an exported SVG path file.<br />
<br />
==== Characters - Equipment ====<br />
Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.<br />
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.<br />
* [[Script:Ammunition Tracker|Ammunition Tracker]] -- A bunch of commands to track ammunition.<br />
* [[Script:Inventory Manager|Inventory Manager]] -- Inventory Management<br />
<br />
==== Characters - Attributes ====<br />
Manipulate one or more characters' attributes. Anything that is system-specific should be placed in the system's category below; this section is for system-agnostic attribute manipulation.<br />
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.<br />
* [[Script:Manual Attribute|Manual Attribute]] -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.<br />
<br />
==== Generators ====<br />
Content generation can extend the reach of your campaign while minimizing the GM's prep time.<br />
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles.<br />
* [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images.<br />
* [[Script:Tile|Tile]] -- Create tiled arrays of graphics on the map layer.<br />
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.<br />
<br />
==== Roleplay ====<br />
Scripts which attempt to make the game more immersive belong in this category.<br />
* [[Script:Animation|Animation]] -- Create and display animations.<br />
* [[Script:Languages|Languages]] -- Allows characters & GMs to create and speak any language. This is a rework of What Did He Say<br />
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.<br />
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting<br />
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions<br />
<br />
==== System ====<br />
Scripts in this category are a bit more ''meta'' than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.<br />
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.<br />
* [[Script:cron|cron]] -- Schedule (possibly recurring) commands to run at some point in the future.<br />
* [[Script:emas|emas]] -- Provides player !emas and !as commands.<br />
* [[Script:Extended Expressions|Extended Expressions]] -- Extended roll expression syntax, supporting conditionals, variable references, bitwise operators, and more.<br />
* [[Script:HiddenRolls|HiddenRolls]] -- Various types of roll hiding (unmodified roll only, final result only, only show to GM).<br />
* [[Script:Is Greater|Is Greater]] -- Trivial little script to check if the first value is greater than the second and report it to chat.<br />
* [[Script:Map Lock|Map Lock]] -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.<br />
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.<br />
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.<br />
* [[Script:Move Players|Move Players]] -- Allows macros to move the player ribbon for players.<br />
* [[Script:Object Properties|Object Properties]] -- Get and set properties of API objects.<br />
* [[Script:Page Size|Page Size]] -- Resizes page, optionally moving and/or scaling its contents.<br />
* [[Script:RollStats|RollStats]] -- Track and display roll statistics.<br />
* [[Script:StateBrowser|StateBrowser]] -- View/modify the contents of the state object.<br />
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution<br />
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.<br />
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.<br />
* [[Script:Weighted Dice|Weighted Dice]] -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)<br />
<br />
=== Game Specific Scripts ===<br />
Scripts that deal with ''specific'' rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.<br />
<br />
Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).<br />
<br />
==== 13th Age ====<br />
* [[Script:Escalation|Escalation]] -- Simple Escalation Die handling script, using the new custom entries with formulae.<br />
<br />
==== BASH! Ultimate Edition ====<br />
* [[Script:Dice (BASH!)|Dice]] -- Rolls the Bash UE Dice format with exploding.<br />
<br />
==== d6 System ====<br />
The "d6 System" includes a number of games from [[wikipedia:West End Games|West End Games]] which utilize the same (or very similar) game mechanics. Scripts which are more specific to a single game than the system as a whole should be categorized there.<br />
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic.<br />
<br />
==== d20 System ====<br />
The "d20 System" includes Dungeons & Dragons and the games it spawned which utilize the same (or very similar) game mechanics. Scripts which are more specific to D&D or one of its spinoffs than the system as a whole should be categorized there.<br />
* [[Script:Announce Roll|Announce Roll]] -- Prints an extra announcement of a critical or fumble to the chat when using /roll<br />
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal.<br />
<br />
==== Cypher System ====<br />
* [[Script:Cypher_System_Sheet|Cypher System Sheet]] -- Enables the applying of stat cost, recovery roll advance, auto calculation of PC state and damage track in the Cypher System Sheet, from the roll template or sheet buttons, for both the [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystem "English"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystemFrench "French"] versions.<br />
<br />
==== Dogs in the Vineyard ====<br />
* [[Script:Dice in the Vineyard|Dice in the Vineyard]] -- Dice tracker for Dogs in the Vineyard. Stacks poker-chip-styled roll tokens in defined areas for characters to spend.<br />
<br />
==== Dungeons & Dragons 4e ====<br />
* [[Script:Use Power|Use Power]] -- A script for instrumenting and tracking the use of encounter and daily powers.<br />
<br />
==== Dungeons & Dragons 5e ====<br />
* [[Script:Monster Hit Dice (D&D 5e)|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet<br />
* [[Script:Spell Level (D&D 5e)|Spell Level]] --<br />
<br />
==== Edge of the Empire ====<br />
* [[Script:Dice Roller (Edge of the Empire)|Dice Roller]] -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game<br />
<br />
==== Exalted, Second Edition ====<br />
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.<br />
<br />
==== FATE ====<br />
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.<br />
<br />
==== Numenera ====<br />
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.<br />
* [[Script:Numenera_Natha|Numenera Natha]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].<br />
<br />
==== Pathfinder ====<br />
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks<br />
* [[Script:Skillbook|Skillbook]] -- Generate token action to put API buttons for skills in chat window<br />
* [[Script:HL-Import|HL-Import]] -- Import characters from Hero Lab via XML<br />
<br />
==== Ryuutama ====<br />
* [[Script:Ryuutama Token Status Markers|Ryuutama Token Status Markers]]<br />
* [[Script:Ryuutama Skill Check Totaler|Ryuutama Skill Check Totaler]]<br />
<br />
==== Savage Worlds ====<br />
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number<br />
<br />
==== Trail of Cthulhu ====<br />
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.<br />
<br />
==== Vampire: The Masquerade, 20th Anniversary Edition ====<br />
* [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.<br />
<br />
==== Zombie Dice ====<br />
* [[Script:Zombie Dice|Zombie Dice]] -- Rolls canceling Zombie Dice<br />
<br />
=== Utility Scripts ===<br />
These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.<br />
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )<br />
* [[Script:Command Shell|Command Shell]] -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.<br />
* [[Script:GM Code|GM Code]] -- Generates a unique code to authenticate the GM.<br />
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event<br />
* [[Script:IsGM Auth Module|IsGM Auth Module]] -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.<br />
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings<br />
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments<br />
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.<br />
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.<br />
<br />
=== Special Thanks ===<br />
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API script index.<br />
<br />
[[Category:API|Script Index]]</div>92730https://wiki.roll20.net/Mod:Script_IndexMod:Script Index2016-03-20T22:00:38Z<p>92730: /* Tokens - Conditions / Status / Health */</p>
<hr />
<div>{{pro only}}<br />
<br />
<div style="float:left;margin-right:15px">__TOC__</div><br />
{{apibox}}<br />
<br />
<br />
The '''API Script Index''' is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the [https://github.com/Roll20/roll20-api-scripts API GitHub Repository] and follow the instructions in the README.md file at the bottom of the page.<br />
<br />
<br clear="both"><br />
<br />
== Scripts By Category ==<br />
<br />
=== General Purpose Scripts ===<br />
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.<br />
<br />
==== Combat Scripts ====<br />
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.<br />
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.<br />
* [[Script:Initiative Tracker|Initiative Tracker]] -- Round counter and status effect manager with optional announcements to chat.<br />
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.<br />
* [[Script:TrackerJacker|TrackerJacker]] -- Graphical turnorder tracker, as well as status/condition marker tracking<br />
* [[Script:Turn Marker|Turn Marker]] -- Round counter and a moving marker that shows who's turn it is.<br />
<br />
==== Tokens - Conditions / Status / Health ====<br />
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.<br />
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects<br />
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking<br />
* [[Script:Conditions and Status Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.<br />
* [[Script:Flight|Flight]] -- Mark how high tokens are flying<br />
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically<br />
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.<br />
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens<br />
* [[Script:Temp HP and Status|Temp HP and Status]] -- Temp hit point manager and bloodied/dying/dead status markers.<br />
* [[Script:Toggle Status|Toggle Status]] -- Toggle status marker on/off, and update character attribute to match<br />
<br />
==== Tokens - Movement, Rotation, and Size ====<br />
Scripts which are triggered by or change the location of tokens should generally be placed in this category.<br />
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.<br />
* [[Script:Change_Token_Image|Change Token Image]] -- Changes displayed image for tokens based on rollable table.<br />
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page<br />
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.<br />
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.<br />
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated<br />
* [[Script:Random Depth|Random Depth]] -- Randomly adjusts the depth of selected tokens.<br />
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.<br />
* [[Script:Size Lock|Size Lock]] -- Toggles a state which reverts any size changes automatically.<br />
* [[Script:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.<br />
* [[Script:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.<br />
* [[Script:Table Token Sizer|Table Token Sizer]] -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.<br />
* [[Script:Token Path|Token Path]] -- Tracks movement of the token at the top of tracker, displaying its path (and distance traveled) for the round.<br />
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.<br />
* [[Script:Twins|Twins]] -- Links two tokens so that they mirror each other across pages.<br />
<br />
==== Lighting and Revealing ====<br />
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.<br />
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later<br />
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer<br />
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.<br />
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.<br />
* [[Script:Walls|Walls]] -- Builds dynamic lighting walls with an exported SVG path file.<br />
<br />
==== Characters - Equipment ====<br />
Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.<br />
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.<br />
* [[Script:Ammunition Tracker|Ammunition Tracker]] -- A bunch of commands to track ammunition.<br />
* [[Script:Inventory Manager|Inventory Manager]] -- Inventory Management<br />
<br />
==== Characters - Attributes ====<br />
Manipulate one or more characters' attributes. Anything that is system-specific should be placed in the system's category below; this section is for system-agnostic attribute manipulation.<br />
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.<br />
* [[Script:Manual Attribute|Manual Attribute]] -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.<br />
<br />
==== Generators ====<br />
Content generation can extend the reach of your campaign while minimizing the GM's prep time.<br />
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles.<br />
* [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images.<br />
* [[Script:Tile|Tile]] -- Create tiled arrays of graphics on the map layer.<br />
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.<br />
<br />
==== Roleplay ====<br />
Scripts which attempt to make the game more immersive belong in this category.<br />
* [[Script:Animation|Animation]] -- Create and display animations.<br />
* [[Script:Languages|Languages]] -- Allows characters & GMs to create and speak any language. This is a rework of What Did He Say<br />
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.<br />
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting<br />
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions<br />
<br />
==== System ====<br />
Scripts in this category are a bit more ''meta'' than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.<br />
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.<br />
* [[Script:cron|cron]] -- Schedule (possibly recurring) commands to run at some point in the future.<br />
* [[Script:emas|emas]] -- Provides player !emas and !as commands.<br />
* [[Script:Extended Expressions|Extended Expressions]] -- Extended roll expression syntax, supporting conditionals, variable references, bitwise operators, and more.<br />
* [[Script:HiddenRolls|HiddenRolls]] -- Various types of roll hiding (unmodified roll only, final result only, only show to GM).<br />
* [[Script:Is Greater|Is Greater]] -- Trivial little script to check if the first value is greater than the second and report it to chat.<br />
* [[Script:Map Lock|Map Lock]] -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.<br />
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.<br />
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.<br />
* [[Script:Move Players|Move Players]] -- Allows macros to move the player ribbon for players.<br />
* [[Script:Object Properties|Object Properties]] -- Get and set properties of API objects.<br />
* [[Script:Page Size|Page Size]] -- Resizes page, optionally moving and/or scaling its contents.<br />
* [[Script:RollStats|RollStats]] -- Track and display roll statistics.<br />
* [[Script:StateBrowser|StateBrowser]] -- View/modify the contents of the state object.<br />
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution<br />
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.<br />
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.<br />
* [[Script:Weighted Dice|Weighted Dice]] -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)<br />
<br />
=== Game Specific Scripts ===<br />
Scripts that deal with ''specific'' rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.<br />
<br />
Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).<br />
<br />
==== 13th Age ====<br />
* [[Script:Escalation|Escalation]] -- Simple Escalation Die handling script, using the new custom entries with formulae.<br />
<br />
==== BASH! Ultimate Edition ====<br />
* [[Script:Dice (BASH!)|Dice]] -- Rolls the Bash UE Dice format with exploding.<br />
<br />
==== d6 System ====<br />
The "d6 System" includes a number of games from [[wikipedia:West End Games|West End Games]] which utilize the same (or very similar) game mechanics. Scripts which are more specific to a single game than the system as a whole should be categorized there.<br />
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic.<br />
<br />
==== d20 System ====<br />
The "d20 System" includes Dungeons & Dragons and the games it spawned which utilize the same (or very similar) game mechanics. Scripts which are more specific to D&D or one of its spinoffs than the system as a whole should be categorized there.<br />
* [[Script:Announce Roll|Announce Roll]] -- Prints an extra announcement of a critical or fumble to the chat when using /roll<br />
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal.<br />
<br />
==== Cypher System ====<br />
* [[Script:Cypher_System_Sheet|Cypher System Sheet]] -- Enables the applying of stat cost, recovery roll advance, auto calculation of PC state and damage track in the Cypher System Sheet, from the roll template or sheet buttons, for both the [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystem "English"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystemFrench "French"] versions.<br />
<br />
==== Dogs in the Vineyard ====<br />
* [[Script:Dice in the Vineyard|Dice in the Vineyard]] -- Dice tracker for Dogs in the Vineyard. Stacks poker-chip-styled roll tokens in defined areas for characters to spend.<br />
<br />
==== Dungeons & Dragons 4e ====<br />
* [[Script:Use Power|Use Power]] -- A script for instrumenting and tracking the use of encounter and daily powers.<br />
<br />
==== Dungeons & Dragons 5e ====<br />
* [[Script:Monster Hit Dice (D&D 5e)|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet<br />
* [[Script:Spell Level (D&D 5e)|Spell Level]] --<br />
<br />
==== Edge of the Empire ====<br />
* [[Script:Dice Roller (Edge of the Empire)|Dice Roller]] -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game<br />
<br />
==== Exalted, Second Edition ====<br />
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.<br />
<br />
==== FATE ====<br />
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.<br />
<br />
==== Numenera ====<br />
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.<br />
* [[Script:Numenera_Natha|Numenera Natha]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].<br />
<br />
==== Pathfinder ====<br />
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks<br />
* [[Script:Skillbook|Skillbook]] -- Generate token action to put API buttons for skills in chat window<br />
* [[Script:HL-Import|HL-Import]] -- Import characters from Hero Lab via XML<br />
<br />
==== Ryuutama ====<br />
* [[Script:Ryuutama Token Status Markers|Ryuutama Token Status Markers]]<br />
* [[Script:Ryuutama Skill Check Totaler|Ryuutama Skill Check Totaler]]<br />
<br />
==== Savage Worlds ====<br />
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number<br />
<br />
==== Trail of Cthulhu ====<br />
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.<br />
<br />
==== Vampire: The Masquerade, 20th Anniversary Edition ====<br />
* [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.<br />
<br />
==== Zombie Dice ====<br />
* [[Script:Zombie Dice|Zombie Dice]] -- Rolls canceling Zombie Dice<br />
<br />
=== Utility Scripts ===<br />
These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.<br />
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )<br />
* [[Script:Command Shell|Command Shell]] -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.<br />
* [[Script:GM Code|GM Code]] -- Generates a unique code to authenticate the GM.<br />
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event<br />
* [[Script:IsGM Auth Module|IsGM Auth Module]] -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.<br />
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings<br />
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments<br />
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.<br />
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.<br />
<br />
=== Special Thanks ===<br />
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API script index.<br />
<br />
[[Category:API|Script Index]]</div>92730https://wiki.roll20.net/Script:SkillbookScript:Skillbook2016-03-20T21:59:26Z<p>92730: </p>
<hr />
<div><div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"><br />
<span style="text-align:center;display:block;font-size:1.4em">API Script</span><br />
<span style="font-variant:small-caps">'''Author:''' {{user profile|92730|James W.}} </span><br><br />
{{script version|1.10}}<br><br />
{{script lastmodified date| 2016-3-20}}<br><br />
<span style="font-variant:small-caps">'''Code:''' [https://github.com/Roll20/roll20-api-scripts/blob/master/Pathfinder%20Skillbook/Skillbook.js Skillbook] </span><br><br />
<span style="font-variant:small-caps">'''Dependencies:''' None </span><br><br />
<span style="font-variant:small-caps">'''Conflicts:''' Unknown </span><br />
</div><br />
<br />
Skillbook will whisper the player a template with buttons for each of a character's skills, so players can quickly roll skill checks without having to open their character sheets. These buttons use the macros listed on the character sheet, so any changes to the macros or the skill modifiers on the sheet will work with these buttons.<br />
<br />
Note that Craft, Lore, Perform, and Profession skills, as well as the "misc" skills at the bottom of the sheet, will only be added to "skillbook" if the names are filled in; changes to the names won't require rerunning the script, but filling in new names will.<br />
<br />
Alternatively, you can have Skillbook generate a token action to whisper the skillbook to any player who can control the character. This script is hard-coded to put this token action into a character ability named "Skills"; if a character already has an ability with that name, it will overwrite that ability. If you wish to keep that character ability, be sure to rename it first.<br />
<br />
=== Use ===<br />
To receive a whisper with the skillbook in it:<br />
# Select a token that represents the character<br />
# Type "!skillbook" into the chat window<br />
<br />
To create a token action for the skillbook:<br />
# Select a token that represents the character or characters to generate token actions for<br />
# Type "!skillbook --createability" into the chat window<br />
<br />
=== Changelog ===<br />
{{changelog version|1.5|2016-03-20|* Switched to directly whispering the skillbooks instead of making token actions, to avoid chat spamming other players}}<br />
{{changelog version|1.11|2016-03-14|* Fixed bug with empty skill names}}<br />
{{changelog version|1.10|2016-03-13|* Updated to work with beta sheet that includes multiple Artistry and Lore skills}}<br />
{{changelog version|1.00|2016-03-13|* Release}}</div>92730https://wiki.roll20.net/Script:SkillbookScript:Skillbook2016-03-20T21:56:49Z<p>92730: </p>
<hr />
<div><div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"><br />
<span style="text-align:center;display:block;font-size:1.4em">API Script</span><br />
<span style="font-variant:small-caps">'''Author:''' {{user profile|92730|James W.}} </span><br><br />
{{script version|1.10}}<br><br />
{{script lastmodified date| 2016-3-13}}<br><br />
<span style="font-variant:small-caps">'''Code:''' [https://github.com/Roll20/roll20-api-scripts/blob/master/Pathfinder%20Skillbook/Skillbook.js Skillbook] </span><br><br />
<span style="font-variant:small-caps">'''Dependencies:''' None </span><br><br />
<span style="font-variant:small-caps">'''Conflicts:''' Unknown </span><br />
</div><br />
<br />
Skillbook will whisper the player a template with buttons for each of a character's skills, so players can quickly roll skill checks without having to open their character sheets. These buttons use the macros listed on the character sheet, so any changes to the macros or the skill modifiers on the sheet will work with these buttons.<br />
<br />
Note that Craft, Lore, Perform, and Profession skills, as well as the "misc" skills at the bottom of the sheet, will only be added to "skillbook" if the names are filled in; changes to the names won't require rerunning the script, but filling in new names will.<br />
<br />
Alternatively, you can have Skillbook generate a token action to whisper the skillbook to any player who can control the character. This script is hard-coded to put this token action into a character ability named "Skills"; if a character already has an ability with that name, it will overwrite that ability. If you wish to keep that character ability, be sure to rename it first.<br />
<br />
=== Use ===<br />
To receive a whisper with the skillbook in it:<br />
# Select a token that represents the character<br />
# Type "!skillbook" into the chat window<br />
<br />
To create a token action for the skillbook:<br />
# Select a token that represents the character or characters to generate token actions for<br />
# Type "!skillbook --createability" into the chat window<br />
<br />
=== Changelog ===<br />
{{changelog version|1.5|2016-03-20|* Switched to directly whispering the skillbooks instead of making token actions, to avoid chat spamming other players}}<br />
{{changelog version|1.11|2016-03-14|* Fixed bug with empty skill names}}<br />
{{changelog version|1.10|2016-03-13|* Updated to work with beta sheet that includes multiple Artistry and Lore skills}}<br />
{{changelog version|1.00|2016-03-13|* Release}}</div>92730https://wiki.roll20.net/Script:SkillbookScript:Skillbook2016-03-20T21:55:52Z<p>92730: </p>
<hr />
<div><div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"><br />
<span style="text-align:center;display:block;font-size:1.4em">API Script</span><br />
<span style="font-variant:small-caps">'''Author:''' {{user profile|92730|James W.}} </span><br><br />
{{script version|1.10}}<br><br />
{{script lastmodified date| 2016-3-13}}<br><br />
<span style="font-variant:small-caps">'''Code:''' [https://gist.github.com/SCPRedMage/9f96ab1bb11270b25871 Skillbook] </span><br><br />
<span style="font-variant:small-caps">'''Dependencies:''' None </span><br><br />
<span style="font-variant:small-caps">'''Conflicts:''' Unknown </span><br />
</div><br />
<br />
Skillbook will whisper the player a template with buttons for each of a character's skills, so players can quickly roll skill checks without having to open their character sheets. These buttons use the macros listed on the character sheet, so any changes to the macros or the skill modifiers on the sheet will work with these buttons.<br />
<br />
Note that Craft, Lore, Perform, and Profession skills, as well as the "misc" skills at the bottom of the sheet, will only be added to "skillbook" if the names are filled in; changes to the names won't require rerunning the script, but filling in new names will.<br />
<br />
Alternatively, you can have Skillbook generate a token action to whisper the skillbook to any player who can control the character. This script is hard-coded to put this token action into a character ability named "Skills"; if a character already has an ability with that name, it will overwrite that ability. If you wish to keep that character ability, be sure to rename it first.<br />
<br />
=== Use ===<br />
To receive a whisper with the skillbook in it:<br />
# Select a token that represents the character<br />
# Type "!skillbook" into the chat window<br />
<br />
To create a token action for the skillbook:<br />
# Select a token that represents the character or characters to generate token actions for<br />
# Type "!skillbook --createability" into the chat window<br />
<br />
=== Changelog ===<br />
{{changelog version|1.5|2016-03-20|* Switched to directly whispering the skillbooks instead of making token actions, to avoid chat spamming other players}}<br />
{{changelog version|1.11|2016-03-14|* Fixed bug with empty skill names}}<br />
{{changelog version|1.10|2016-03-13|* Updated to work with beta sheet that includes multiple Artistry and Lore skills}}<br />
{{changelog version|1.00|2016-03-13|* Release}}</div>92730https://wiki.roll20.net/Script:HL-ImportScript:HL-Import2016-03-14T03:51:00Z<p>92730: Created page with "<div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"> <span style="text-align:center;dis..."</p>
<hr />
<div><div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"><br />
<span style="text-align:center;display:block;font-size:1.4em">API Script</span><br />
<span style="font-variant:small-caps">'''Author:''' {{user profile|92730|James W.}} </span><br><br />
{{script version|0.50}}<br><br />
{{script lastmodified date| 2016-3-13}}<br><br />
<span style="font-variant:small-caps">'''Code:''' [https://gist.github.com/SCPRedMage/146f80c4776e2304ebd6 HL-Import] </span><br><br />
<span style="font-variant:small-caps">'''Dependencies:''' None </span><br><br />
<span style="font-variant:small-caps">'''Conflicts:''' Unknown </span><br />
</div><br />
<br />
HL-Import will import a character to the Pathfinder character sheet from Hero Lab, via XML converted to JSON. Any XML to JSON converter will work, but XML attributes need to have an underscore ("_") added to the beginning of their names, and be aware that some converters may drop the "class" XML nodes under the "classes" node, which will prevent classes (and all related items) from being imported. The script was tested with the XML to JSON converter on CodeBeautify.org, and it is recommended that you use this converter.<br />
<br />
=== Usage ===<br />
# Export the character (or characters) as an XML file in Hero Lab (File -> Save Custom Output, choose "Generate XML File").<br />
# Open the XML file in your favorite text editor that isn't WordPad, MS Word, or any other word processor (I recommend [https://notepad-plus-plus.org/ Notepad++]) and copy the entire contents (Ctrl-A, then Ctrl-C, for the shortcut-impaired).<br />
# Go to [http://codebeautify.org/xmltojson CodeBeautify.org's XML to JSON converter], and convert the XML to JSON (paste the XML into the field on the left, set the result mode to "text", click "XML to JSON", then copy the text from the text field on the right).<br />
# Paste the JSON text into the GM Notes on a token you intend to use for the FIRST character in the XML file (if you're importing more than one).<br />
# Repeat steps 1-4 on new tokens, if you want to import multiple files at once.<br />
# Select the token (or tokens), type "!hl-import" into the chat window, and press enter.<br />
=== What the script (currently) does ===<br />
The script will look for a character object with the same name as the character it's importing from Hero Lab; if it finds one, it'll import to that character, otherwise it will create a new character with that name. It will do this for all of the characters in the import, including any "minions" attached to a character, such as familiars and animal companions; the first character in each XML file will be set to "represent" with the token used for the import.<br />
<br />
=== Currently imported ===<br />
* Name (obviously)<br />
* Ability scores<br />
* Feats<br />
* Traits<br />
* Classes, including levels<br />
* Current XP<br />
* Favored class (only if manually set, and only the name)<br />
* BAB<br />
* Skills (situational modifiers get added to the macro as new template lines)<br />
* Saving throws<br />
* Max Dex Bonus<br />
* Armor Check Penalty<br />
* Arcane Spell Failure<br />
* Hit dice (HD > class levels, it gets dumped into the level for class #5)<br />
* Spell caster classes<br />
* Spells (from currently memorized, known, and spellbook)<br />
* Size<br />
* Languages<br />
* DR<br />
* Resistances<br />
* Immunities<br />
* Weaknesses<br />
* Senses (low-light, darkvision, scent, etc)<br />
* Challenge Rating<br />
* XP award (what the character's CR is worth)<br />
* Personal details, including: player name, deity, race, alignment, gender, age, height, weight, hair, eye, and skin color<br />
=== Currently NOT imported ===<br />
* Class features<br />
* Racial traits<br />
* AC<br />
* Items<br />
* Attacks<br />
* Flaws<br />
* Type/subtypes<br />
* Hero points<br />
* Token sight properties (eventually it will automatically set darkvision/low-light vision)<br />
* Undoubtedly a bunch of stuff I've forgotten<br />
=== Known issues (some are script issues, some are character sheet issues) ===<br />
* You'll almost certainly need to manually recalc the character after importing<br />
* Spellclasses will be set to the appropriate class from the Classes tab, but it won't populate the "name", and it won't populate the caster level until you manually change the class' level on the Classes tab (not even a recalc will fix this).<br />
* Since it isn't actually specified in the XML, the script will make its best guess as to which ability score a spellclass uses (but only if it hasn't already been set).<br />
* Bonus spells don't seem to populate until you change the ability mod it uses to something else and back again.<br />
=== Other notes ===<br />
* Importing feats will attempt to find an existing feat on the sheet with the same name; if found, it'll overwrite that feat, instead of making a new one<br />
* If it finds multiple feats with the same name, it will append how many times you've taken it at the end of the name; this does not effect feats that have you select weapons (since the weapon name is listed as part of the feat name), but will apply to feats like Extra Rogue Talent.<br />
* Likewise, importing spells will attempt to find a spell with the same name, level, and spellclass.<br />
* Importing class features, racial traits, and items will work the same way (once they're added), so you should be able to re-import over existing characters with minimal duplication.<br />
* Stats like HP, base save bonuses, BAB, etc., aren't listed per-class in the XML, so the script will dump it all into the first class on the sheet.<br />
* Before importing skills, the script will delete all skill-related attributes; this includes any changes to skill macros. If you have custom skill macros you wish to keep, back them up first.<br />
* Currently the script won't clear the GM notes on the token, but future versions will. The characters I'm testing this with end up being thousands of lines of JSON, which causes a bit of lag when opening the token's properties. There will be a debug mode that disables this.<br />
<br />
=== Changelog ===<br />
{{changelog version|0.50|2016-03-13|* Release}}</div>92730https://wiki.roll20.net/Script:SkillbookScript:Skillbook2016-03-14T03:38:54Z<p>92730: Created page with "<div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"> <span style="text-align:center;dis..."</p>
<hr />
<div><div style="float: {{{1|right}}}; width: 200px; padding: 5px; border: 1px solid #777; margin: 0 15px 15px 15px; background-color: #efefef;"><br />
<span style="text-align:center;display:block;font-size:1.4em">API Script</span><br />
<span style="font-variant:small-caps">'''Author:''' {{user profile|92730|James W.}} </span><br><br />
{{script version|1.10}}<br><br />
{{script lastmodified date| 2016-3-13}}<br><br />
<span style="font-variant:small-caps">'''Code:''' [https://gist.github.com/SCPRedMage/9f96ab1bb11270b25871 Skillbook] </span><br><br />
<span style="font-variant:small-caps">'''Dependencies:''' None </span><br><br />
<span style="font-variant:small-caps">'''Conflicts:''' Unknown </span><br />
</div><br />
<br />
Skillbook will generate a token action that will put a template with buttons for each of a character's skills into the chat log, so players can quickly roll skill checks without having to open their character sheets. These buttons use the macros listed on the character sheet, so any changes to the macros or the skill modifiers on the sheet will work with these buttons.<br />
<br />
Note that Craft, Lore, Perform, and Profession skills, as well as the "misc" skills at the bottom of the sheet, will only be added to "skillbook" if the names are filled in; changes to the names won't require rerunning the script, but filling in new names will.<br />
<br />
This script is hard-coded to put this token action into a character ability named "Skills"; if a character already has an ability with that name, it will overwrite that ability. If you wish to keep that character ability, be sure to rename it first.<br />
<br />
=== Use ===<br />
Select the token (or tokens) that represent the characters you want to generate skillbooks for, then type "!skillbook" into the chat window. If you ever need to re-generate the skillbook (such as when a character fills in a skill name that was blank the first time around), just do that again, and it'll overwrite the existing token action.<br />
<br />
=== Changelog ===<br />
{{changelog version|1.10|2016-03-13|* Updated to work with beta sheet that includes multiple Artistry and Lore skills}}<br />
{{changelog version|1.00|2016-03-13|* Release}}</div>92730https://wiki.roll20.net/Mod:Script_IndexMod:Script Index2016-03-14T03:31:26Z<p>92730: /* Pathfinder */</p>
<hr />
<div>{{pro only}}<br />
<br />
<div style="float:left;margin-right:15px">__TOC__</div><br />
{{apibox}}<br />
<br />
<br />
The '''API Script Index''' is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the [https://github.com/Roll20/roll20-api-scripts API GitHub Repository] and follow the instructions in the README.md file at the bottom of the page.<br />
<br />
<br clear="both"><br />
<br />
== Scripts By Category ==<br />
<br />
=== General Purpose Scripts ===<br />
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.<br />
<br />
==== Combat Scripts ====<br />
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.<br />
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.<br />
* [[Script:Initiative Tracker|Initiative Tracker]] -- Round counter and status effect manager with optional announcements to chat.<br />
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.<br />
* [[Script:TrackerJacker|TrackerJacker]] -- Graphical turnorder tracker, as well as status/condition marker tracking<br />
* [[Script:Turn Marker|Turn Marker]] -- Round counter and a moving marker that shows who's turn it is.<br />
<br />
==== Tokens - Conditions / Status / Health ====<br />
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.<br />
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects<br />
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking<br />
* [[Script:Conditions and Status Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.<br />
* [[Script:Flight|Flight]] -- Mark how high tokens are flying<br />
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically<br />
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.<br />
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens<br />
* [[Script:Temp HP and Status|Temp HP and Status]] -- Temp hit point manager and bloodied/dying/dead status markers.<br />
<br />
==== Tokens - Movement, Rotation, and Size ====<br />
Scripts which are triggered by or change the location of tokens should generally be placed in this category.<br />
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.<br />
* [[Script:Change_Token_Image|Change Token Image]] -- Changes displayed image for tokens based on rollable table.<br />
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page<br />
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.<br />
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.<br />
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated<br />
* [[Script:Random Depth|Random Depth]] -- Randomly adjusts the depth of selected tokens.<br />
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.<br />
* [[Script:Size Lock|Size Lock]] -- Toggles a state which reverts any size changes automatically.<br />
* [[Script:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.<br />
* [[Script:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.<br />
* [[Script:Table Token Sizer|Table Token Sizer]] -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.<br />
* [[Script:Token Path|Token Path]] -- Tracks movement of the token at the top of tracker, displaying its path (and distance traveled) for the round.<br />
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.<br />
* [[Script:Twins|Twins]] -- Links two tokens so that they mirror each other across pages.<br />
<br />
==== Lighting and Revealing ====<br />
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.<br />
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later<br />
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer<br />
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.<br />
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.<br />
* [[Script:Walls|Walls]] -- Builds dynamic lighting walls with an exported SVG path file.<br />
<br />
==== Characters - Equipment ====<br />
Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.<br />
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.<br />
* [[Script:Ammunition Tracker|Ammunition Tracker]] -- A bunch of commands to track ammunition.<br />
* [[Script:Inventory Manager|Inventory Manager]] -- Inventory Management<br />
<br />
==== Characters - Attributes ====<br />
Manipulate one or more characters' attributes. Anything that is system-specific should be placed in the system's category below; this section is for system-agnostic attribute manipulation.<br />
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.<br />
* [[Script:Manual Attribute|Manual Attribute]] -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.<br />
<br />
==== Generators ====<br />
Content generation can extend the reach of your campaign while minimizing the GM's prep time.<br />
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles.<br />
* [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images.<br />
* [[Script:Tile|Tile]] -- Create tiled arrays of graphics on the map layer.<br />
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.<br />
<br />
==== Roleplay ====<br />
Scripts which attempt to make the game more immersive belong in this category.<br />
* [[Script:Animation|Animation]] -- Create and display animations.<br />
* [[Script:Languages|Languages]] -- Allows characters & GMs to create and speak any language. This is a rework of What Did He Say<br />
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.<br />
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting<br />
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions<br />
<br />
==== System ====<br />
Scripts in this category are a bit more ''meta'' than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.<br />
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.<br />
* [[Script:cron|cron]] -- Schedule (possibly recurring) commands to run at some point in the future.<br />
* [[Script:emas|emas]] -- Provides player !emas and !as commands.<br />
* [[Script:Extended Expressions|Extended Expressions]] -- Extended roll expression syntax, supporting conditionals, variable references, bitwise operators, and more.<br />
* [[Script:HiddenRolls|HiddenRolls]] -- Various types of roll hiding (unmodified roll only, final result only, only show to GM).<br />
* [[Script:Is Greater|Is Greater]] -- Trivial little script to check if the first value is greater than the second and report it to chat.<br />
* [[Script:Map Lock|Map Lock]] -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.<br />
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.<br />
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.<br />
* [[Script:Move Players|Move Players]] -- Allows macros to move the player ribbon for players.<br />
* [[Script:Object Properties|Object Properties]] -- Get and set properties of API objects.<br />
* [[Script:Page Size|Page Size]] -- Resizes page, optionally moving and/or scaling its contents.<br />
* [[Script:RollStats|RollStats]] -- Track and display roll statistics.<br />
* [[Script:StateBrowser|StateBrowser]] -- View/modify the contents of the state object.<br />
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution<br />
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.<br />
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.<br />
* [[Script:Weighted Dice|Weighted Dice]] -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)<br />
<br />
=== Game Specific Scripts ===<br />
Scripts that deal with ''specific'' rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.<br />
<br />
Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).<br />
<br />
==== 13th Age ====<br />
* [[Script:Escalation|Escalation]] -- Simple Escalation Die handling script, using the new custom entries with formulae.<br />
<br />
==== BASH! Ultimate Edition ====<br />
* [[Script:Dice (BASH!)|Dice]] -- Rolls the Bash UE Dice format with exploding.<br />
<br />
==== d6 System ====<br />
The "d6 System" includes a number of games from [[wikipedia:West End Games|West End Games]] which utilize the same (or very similar) game mechanics. Scripts which are more specific to a single game than the system as a whole should be categorized there.<br />
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic.<br />
<br />
==== d20 System ====<br />
The "d20 System" includes Dungeons & Dragons and the games it spawned which utilize the same (or very similar) game mechanics. Scripts which are more specific to D&D or one of its spinoffs than the system as a whole should be categorized there.<br />
* [[Script:Announce Roll|Announce Roll]] -- Prints an extra announcement of a critical or fumble to the chat when using /roll<br />
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal.<br />
<br />
==== Cypher System ====<br />
* [[Script:Cypher_System_Sheet|Cypher System Sheet]] -- Enables the applying of stat cost, recovery roll advance, auto calculation of PC state and damage track in the Cypher System Sheet, from the roll template or sheet buttons, for both the [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystem "English"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystemFrench "French"] versions.<br />
<br />
==== Dogs in the Vineyard ====<br />
* [[Script:Dice in the Vineyard|Dice in the Vineyard]] -- Dice tracker for Dogs in the Vineyard. Stacks poker-chip-styled roll tokens in defined areas for characters to spend.<br />
<br />
==== Dungeons & Dragons 4e ====<br />
* [[Script:Use Power|Use Power]] -- A script for instrumenting and tracking the use of encounter and daily powers.<br />
<br />
==== Dungeons & Dragons 5e ====<br />
* [[Script:Monster Hit Dice (D&D 5e)|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet<br />
* [[Script:Spell Level (D&D 5e)|Spell Level]] --<br />
<br />
==== Edge of the Empire ====<br />
* [[Script:Dice Roller (Edge of the Empire)|Dice Roller]] -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game<br />
<br />
==== Exalted, Second Edition ====<br />
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.<br />
<br />
==== FATE ====<br />
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.<br />
<br />
==== Numenera ====<br />
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.<br />
* [[Script:Numenera_Natha|Numenera Natha]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].<br />
<br />
==== Pathfinder ====<br />
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks<br />
* [[Script:Skillbook|Skillbook]] -- Generate token action to put API buttons for skills in chat window<br />
* [[Script:HL-Import|HL-Import]] -- Import characters from Hero Lab via XML<br />
<br />
==== Ryuutama ====<br />
* [[Script:Ryuutama Token Status Markers|Ryuutama Token Status Markers]]<br />
* [[Script:Ryuutama Skill Check Totaler|Ryuutama Skill Check Totaler]]<br />
<br />
==== Savage Worlds ====<br />
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number<br />
<br />
==== Trail of Cthulhu ====<br />
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.<br />
<br />
==== Vampire: The Masquerade, 20th Anniversary Edition ====<br />
* [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.<br />
<br />
==== Zombie Dice ====<br />
* [[Script:Zombie Dice|Zombie Dice]] -- Rolls canceling Zombie Dice<br />
<br />
=== Utility Scripts ===<br />
These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.<br />
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )<br />
* [[Script:Command Shell|Command Shell]] -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.<br />
* [[Script:GM Code|GM Code]] -- Generates a unique code to authenticate the GM.<br />
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event<br />
* [[Script:IsGM Auth Module|IsGM Auth Module]] -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.<br />
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings<br />
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments<br />
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.<br />
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.<br />
<br />
=== Special Thanks ===<br />
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API script index.<br />
<br />
[[Category:API|Script Index]]</div>92730