Difference between revisions of "Script:wfrp2e-api"
From Roll20 Wiki
Timothy S. (Talk | contribs) (Created page with "==WFRP2E API by Havoc== This set of functions and roll templates support many common features found in a WFRP2E game. Some items are customizable to your particular game. ===...") |
Timothy S. (Talk | contribs) (Initial formatting per Roll20 documentation.) |
||
| Line 1: | Line 1: | ||
| − | == | + | {{script overview |
| + | |name=wfrp2e-api | ||
| + | |author={{user profile|5047|Paul "Havoc" Stein}} | ||
| + | |version=1.0 | ||
| + | |lastmodified=2017-05-07 | ||
| + | |code=The Darkness is Closing In | ||
| + | |dependencies={{api repository link|splitArgs}} | ||
| + | |conflicts=None}} | ||
| + | |||
This set of functions and roll templates support many common features found in a WFRP2E game. Some items are customizable to your particular game. | This set of functions and roll templates support many common features found in a WFRP2E game. Some items are customizable to your particular game. | ||
| − | |||
Havoc has provided templates for many Combat, Parry, Success, Failure, and Magic rolls, including Ulric's Fury, Initiative, and Fortune Re-rolls. All executable from the character sheet, calculated automatically or performed from the roll template! | Havoc has provided templates for many Combat, Parry, Success, Failure, and Magic rolls, including Ulric's Fury, Initiative, and Fortune Re-rolls. All executable from the character sheet, calculated automatically or performed from the roll template! | ||
| − | === | + | == Syntax == |
| + | While specific functions are accessible from the chat session, all are best used from the character sheet and not otherwise supported. | ||
| + | |||
| + | == Installation and Configuration == | ||
| + | Copy the script's code, available from the menu on the right and stored at Roll20's [https://github.com/Roll20/roll20-api-scripts API GitHub Repository]. Paste the code into a new script in your campaign's [[API:Use_Guide#The_Script_Editor|API Script Editor]]. Save the new script and it will be available inside your campaign. | ||
| + | |||
| + | == Script Use == | ||
The API may be customized from the Campaign Settings to suit your play style or home rules. Particularly, one can customize Combat, Parry and Skill '''critical''' Success and Failure "break points" or turn them off all together. Find the following sections in the API script and edit per the comments or to suit your needs: | The API may be customized from the Campaign Settings to suit your play style or home rules. Particularly, one can customize Combat, Parry and Skill '''critical''' Success and Failure "break points" or turn them off all together. Find the following sections in the API script and edit per the comments or to suit your needs: | ||
| Line 18: | Line 31: | ||
var critFailSkill = 96; //set to 101 to turn off crit failure | var critFailSkill = 96; //set to 101 to turn off crit failure | ||
</pre> | </pre> | ||
| + | |||
| + | == Changelog == | ||
| + | {{changelog version|1.|2017-05-07|* Initial repos submission}} | ||
Revision as of 20:50, 7 May 2017
Version: 1.0
Last Modified: 2017-05-07
Code: The Darkness is Closing In
Dependencies: splitArgs
Conflicts: None
This set of functions and roll templates support many common features found in a WFRP2E game. Some items are customizable to your particular game.
Havoc has provided templates for many Combat, Parry, Success, Failure, and Magic rolls, including Ulric's Fury, Initiative, and Fortune Re-rolls. All executable from the character sheet, calculated automatically or performed from the roll template!
Contents |
Syntax
While specific functions are accessible from the chat session, all are best used from the character sheet and not otherwise supported.
Installation and Configuration
Copy the script's code, available from the menu on the right and stored at Roll20's API GitHub Repository. Paste the code into a new script in your campaign's API Script Editor. Save the new script and it will be available inside your campaign.
Script Use
The API may be customized from the Campaign Settings to suit your play style or home rules. Particularly, one can customize Combat, Parry and Skill critical Success and Failure "break points" or turn them off all together. Find the following sections in the API script and edit per the comments or to suit your needs:
var critSucCombat = 1; //set to 0 to turn off crit success var critFailCombat = 96; //set to 101 to turn off crit failure ... var critSucParry = 1; //set to 0 to turn off crit success var critFailParry = 96; //set to 101 to turn off crit failure ... var critSucSkill = 1; //set to 0 to turn off crit success var critFailSkill = 96; //set to 101 to turn off crit failure
Changelog
v1. (2017-05-07)
- Initial repos submission
