Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Script:wfrp2e-api"

From Roll20 Wiki

Jump to: navigation, search
(Corrected links.)
m
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
 
{{script overview
 
{{script overview
 
|name=wfrp2e-api
 
|name=wfrp2e-api
|author={{user profile|55273|Paul "Havoc" Stein}}
+
|author={{user profile|5047|Paul "Havoc" Stein}}
 
|version=1.0
 
|version=1.0
 
|lastmodified=2017-05-07
 
|lastmodified=2017-05-07
 
|code=wfrp2e-api
 
|code=wfrp2e-api
|dependencies={{https://github.com/timothystone/roll20-api-scripts/tree/master/splitArgs|splitArgs}}
+
|dependencies={{api repository link|splitArgs}}
 
|conflicts=None}}
 
|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.
+
The '''WFRP 2E Actions (Havoc)''' API is a set of functions and roll templates to support many common features found in a '''Warhammer Fantasy Roleplay 2E''' 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!
Line 34: Line 34:
 
== Changelog ==
 
== Changelog ==
 
{{changelog version|1.|2017-05-07|* Initial repos submission}}
 
{{changelog version|1.|2017-05-07|* Initial repos submission}}
 +
<br>
 +
<br>
 +
[[Category:WFRP]]

Latest revision as of 15:12, 17 June 2020

API ScriptAuthor: Paul "Havoc" Stein
Version: 1.0
Last Modified: 2017-05-07
Code: wfrp2e-api
Dependencies: splitArgs
Conflicts: None

The WFRP 2E Actions (Havoc) API is a set of functions and roll templates to support many common features found in a Warhammer Fantasy Roleplay 2E 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

[edit] Syntax

While specific functions are accessible from the chat session, all are best used from the character sheet and not otherwise supported.

[edit] 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.

[edit] 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

[edit] Changelog

v1. (2017-05-07)

  • Initial repos submission