Weapon and Armour Databases
' + +'for AttackMaster v'+version+' and later
' + +'' + +'
New in this Help Handout
' + +'- '
+ +'
- New Armour that affects Rogue skills by GM-definable amounts ' + +'
' + +'[General DB Help]' + +'[Item Inheritance]' + +'
2. Weapon & Ammunition Databases
' + +'Weapon databases are all character sheets that have names that start with MI-DB-Weapon (though in fact, weapons can be in any database starting with MI-DB- if desired), and can have anything put at the end, though those with version numbers of the form v#.# as part of the name will be ignored. Ammunition databases are similar, with the root database MI-DB-Ammo.
' + +'As previously stated, each weapon definition has 3 (or 4) parts in the database (see Section 1): an Ability Macro with a name that is unique and matches the weapon, an Attribute with the name of the Ability Macro preceded by "ct-", a listing in the database character sheet of the ability macro name separated by \'|\' along with other weapons, and sometimes Attributes defining powers given by, or spells stored on the item. The quickest way to understand these entries is to examine existing entries. Do extract the root databases and take a look (but remember to delete them after exploring the items in them, so as not to slow the system down unnecessarily).
' + +'Note: The DM creating new weapons does not need to worry about anything other than the Ability Macro in the database, as running the AttackMaster or MagicMaster -check-db MI-DB-Weapons command will update all other aspects of the database appropriately for all databases that have a name starting with or including \'MI-DB-Weapons\', as long as the Specs and Data fields are correctly defined. Use the parameter \'MI-DB-Ammo\' to check and update the ammunition databases. Running the command -check-db with no parameters will check and update all databases.
' + +'Ability macros can be added to a database just by using the [+Add] button at the top of the Abilities column in the Attributes and Abilities tab of the Database Character Sheet, and then using the edit "pencil" icon on the new entry to open it for editing. Ability macros are standard Roll20 functionality and not dependent on the API. Refer to the Roll20 Help Centre for more information.
' + +'Here are some examples:
' + +'Longsword
' + +'&{template:RPGMweapon}{{name=Longsword}} {{subtitle=Sword}}{{Speed=[[5]]}} {{Size=Medium}}{{Weapon=1-handed melee long-blade}}Specs=[Longsword,Melee,1H,Long-blade]{{To-hit=+0 + Str bonus}}ToHitData=[w:Longsword, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:5]{{Attacks=1 per round + level & specialisation, Slashing}}{{Damage=+0, vs SM:1d8, L:1d12, + Str bonus}}DmgData=[w:Longsword, sb:1, +:0, SM:1d8, L:1d12]{{desc=This is a normal sword. The blade is sharp and keen, but nothing special.}}
' + +'The ability specification for this Longsword uses a Roll20 Roll Template, in this case defined in the RPGMaster Library (see the help handout for the Library to review the specifications of this template), but any Roll Template you desire can be used. The entries in the Roll Template itself can be anything you desire, giving as much or as little information as you want. However, the important elements for the APIs are those highlighted. Each of these elements are inserted between the elements of the Roll Template, meaning they will not be seen by the player when the macro is run. Generally spaces, hyphens and underscores in the data elements are ignored, and case is not significant. Each element is described below:
' + +'Specs = [Type, Class, Handedness, Weapon Group]' + +'
The Specs section describes what weapon type and proficiency groups this weapon belongs to. These fields must be in this order. This format is identical for all database items, whether in these databases or others used by the Master series of APIs.
' + +'| Type | is the type of the weapon, often the same as the ability macro name without magical plusses. |
| Class | is one of Melee, Ranged, or Ammo (preceded by \'Innate-\' if the weapon does not require proficiency). |
| Handedness | is #H, where # is the number of hands needed to wield the weapon. |
| Weapon Group | is the group of related weapons that the weapon belongs to. |
ToHitData = [w:Longsword, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:5]' + +'
The ToHitData section specifies the data relating to an attack with the weapon. These fields can be in any order.
' + +'| w: | <text> the name to display for attacks with this weapon |
| sb: | <0/1> strength bonus flag - specifies if the strength bonus is applicable to the To-Hit roll |
| +: | <[+/-]#> the magical attack bonus/penalty - an integer of any size |
| n: | <#[/#]> the basic number of attacks per round: the API will modify to account for specialisation and level |
| ch: | <1-20> the roll for a Critical Hit, shown in the API with a green border to the attack AC achieved |
| cm: | <1-20> the roll for a Critical Miss, shown in the API with a red border to the attack AC achieved |
| sz: | |
| ty: | |
| sp: | <#> the speed of the weapon in segments |
| r: | <[+/-/=]# [/#/#/#] > the range or range modifier of the weapon. Ranged weapons use PB / S / M / L |
The number of attacks per round, n:, can be an integer or a fraction such as 3/2 meaning 3 attacks every 2 rounds. If using the InitMaster API the Tracker will have the correct number of entries for the Character relating to the number of attacks in the current round.
' + +'The range for the weapon, r:, can be a single integer (representing the range of a melee weapon or simple ranged weapon) or a range modifier, starting with +, -, or =. The range modifier will amend the range of the ammo for a ranged weapon - ranged weapons vary their range with the ammo used. The weapon can use that range or modify it. Ranged weapon range modifiers can be of the form [[+/-]#/][+/-]#/[+/-]#/[+/-]# which will add or subtract a different modifier for each range ([Point Blank] / Short / Medium / Long - Point Blank range is optional)
' + +'DmgData = [w:Longsword, sb:1, +:0, SM:1d8, L:1d12]' + +'
The DmgData section specifies the data relating to the damage done by the weapon, and relates to melee weapons only (not ranged weapons). These fields can be in any order.
' + +'| w: | <text> the name to display for damage calculations for this weapon |
| sb: | <0/1> strength bonus flag - specifies if the strength bonus is applicable to the Damage roll |
| +: | <[+/-]#> the magical damage bonus/penalty - an integer of any size |
| sm: | |
| l: |
There are other optional fields that can be specified for To-Hit and/or Dmg data: see Section 4 below for complete details of all possible values.
' + +'' + +'
Bastardsword+1
' + +'&{template:RPGMweapon}{{name=Bastard Sword+1}}{{subtitle=Magic Sword}}{{Speed=[[5]]}}{{Size=Medium}}{{Weapon=1 or 2-handed melee long blade}}Specs=[Bastard-Sword,Melee,1H,Long-blade],[Bastard-Sword,Melee,2H,Long-blade]{{To-hit=+1 + Str Bonus}}ToHitData=[w:Bastard Sword+1, sb:1, +:1, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:6,rc:uncharged],[w:Bastard Sword 2H+1, sb:1, +:1, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:8,,rc:uncharged]{{Attacks=1 per round + specialisation & level, Slashing}}{{Damage=+1, 1-handed SM:1d8 L:1d12, 2-handed SM:2d4 L:2d8}}DmgData=[w:Bastard Sword+1,sb:1,+:1,SM:1d8,L:1d12],[w:Bastard Sword 2H+1,sb:1,+:1,SM:2d4,L:2d8]{{desc=This is a normal magical sword. The blade is sharp and keen, and is a +[[1]] magical weapon at all times.}}
' + +'The Bastardsword can be used either single handed or two handed with different to-hit and damage outcomes. This can be represented in the macro as shown here, with multiple specification sections. When using the AttackMaster API !attk --weapon command to take the Bastardsword in hand, choosing 1 hand (either left or right) will use the 1-handed specifications, and choosing to take it in Both Hands will use the 2-handed specifications.
' + +'All the field definitions are the same as for the Longsword example above, but there are (in this case) two sets of data for each section, the first set for 1-handed, the second set for 2-handed (as defined by the handedness entry in the Specs section data sets.
' + +'' + +'
Longbow
' + +'&{template:RPGMweapon}{{name=Longbow}}{{subtitle=Bow}}{{Speed=[[8]]}}{{Size=Medium}}{{Weapon=Ranged 2-handed Bow}}Specs=[Longbow,Ranged,2H,Bow]{{To-hit=+0 + Dex Bonus}}ToHitData=[w:Longbow,sb:0,db:1,+:0,n:2,ch:20,cm:1,sz:L,ty:P,sp:8]{{Attacks=Piercing, 2 per round}}{{desc=This is a normal longbow. The wood is polished, the string taut, but nothing special.}}
' + +'A ranged weapon like a Longbow uses the same data section definitions as melee weapons except for the following additions and differences.
' + +'ToHitData=[w:Longbow,sb:0,db:1,+:0,n:2,ch:20,cm:1,sz:L,ty:P,sp:8]' + +'
The To-Hit section has an extra option:
' + +'| db: | <0/1> dexterity bonus flag - specifies if the dexterity bonus is applicable to the To-Hit roll. |
| r: | the range data is not provided because this weapon does not modify the range of its ammo, but could be provided if required. |
There is no DmgData section, as damage is defined by the ammo.
' + +'' + +'
Shortbow of Targeting
' + +'&{template:RPGMweapon}{{name=Shortbow of Targeting}}{{subtitle=Bow}}{{Speed=7/6/5/3}}{{Size=Medium}}{{Weapon=2-handed ranged bow }}Specs=[Shortbow,Ranged,2H,Bow],[Shortbow,Ranged,2H,Bow],[Shortbow,Ranged,2H,Bow],[Shortbow,Ranged,2H,Bow]{{To-hit=Dexterity bonus + 0 charges = normal bow
'
+ +'1 charge = +1 to hit
'
+ +'2 charges = +2 to hit
'
+ +'3 charges = +4 to hit}}ToHitData=[w:Shortbow +0,sb:0,db:1,+:0,n:2,ch:20,cm:1,sz:M,ty:P,sp:7,c:0,rc:recharging],[w:Shortbow +1,sb:0,db:1,+:1,n:2,ch:20,cm:1,sz:M,ty:P,sp:6,c:1,rc:recharging],[w:Shortbow +2,sb:0,db:1,+:2,n:2,ch:20,cm:1,sz:M,ty:P,sp:5,c:2,rc:recharging],[w:Shortbow +4,sb:0,db:1,+:4,n:2,ch:20,cm:1,sz:M,ty:P,sp:3,c:3,rc:recharging],{{Attacks=2 per round, no increases, Piercing}}{{desc=This shortbow has a charged magical targeting sight which incorporates a zoom dial. Increasing the zoom uses more magical charges, but improves the attack roll: 1 charge = +1, 2 charges = +2 and 3 charges = +4. Extra charges also speed up the bow as it is easier to draw the shot. The zoom can be returned to zero, and the bow shot as a notrmal shortbow.
'
+ +'Once all charges are expended, the bow continues to operate as a normal bow, and the charges will be regained after a long rest.}}
This ranged weapon has magical capabilities which require charges to be expended, though it can be used as a normal weapon without expending any charges. The database definition uses the multiple attack specifications as per the Bastardsword above, but this time to create additional rows in the Attack menu with different attack speeds and damage values that use different charges.
' + +'| c: | # | The number of charges expended by an attack. Defaults to 1, and does not apply to uncharged items |
When shown in the Attack menu, any version of the weapon which requires more charges than it currently has will be gray, and will not be selectable for an attack.
' + +'' + +'
Flight-Arrow+2 (Ammunition Database)
' + +'&{template:RPGMammo}{{name=Flight Arrow+2}}{{subtitle=Magic Weapon}}{{Speed=As per bow}}{{Size=Small}}Specs=[Flight-Arrow,Ammo,1H,Arrow],[Flight-Arrow,Ammo,1H,Arrow]{{Ammo=+2,
'
+ +'**Warbow** vs. SM:1d8, L:1d8,
'
+ +'**Other Bows** vs. SM:1d6, L:1d6, Piercing}}AmmoData=[w:Flight Arrow+2, st:Bow, sb:1, +:2, SM:1d6, L:1d6],[w:Warbow Flight Arrow+2, t:warbow, sb:1, +:2, SM:1d8,L:1d8]{{Range=PB:30, others vary by bow
'
+ +'**Shortbow:**
'
+ +'S:50, M:100, L150,
'
+ +'**Longbow:**
'
+ +'S:60, M:120, L:210,
'
+ +'**Warbow:**
'
+ +'S90, M:160, L:250,
'
+ +'**Composite Sbow:**
'
+ +'S:50, M:100, L:180,
'
+ +'**Composite Lbow:**
'
+ +'S:70, M:140, L:210}}RangeData=[t:longbow, +:2, r:3/6/12/21],[t:shortbow, +:2, r:3/5/10/15],[t:warbow, +:2, r:3/9/16/25],[t:compositelongbow, +:2, r:3/7/14/21],[t:compositeshortbow, +:2, r:3/5/10/18]{{desc=A magical Flight Arrow of very fine quality}}
Ammo has a different specification, as the To-Hit data sections are obviously part of the ranged weapon data. Instead it provides data on which weapons this can be ammo for, and what ranges it has for each. To determine this, it uses the weapon type and group-type set in the weapon Specs section.
' + +'AmmoData=[w:Flight Arrow+2, st:Bow, sb:1, +:2, SM:1d6, L:1d6],[w:Warbow Flight Arrow+2, t:warbow, sb:1, +:2, SM:1d8,L:1d8]' + +'
The AmmoData section is mostly the same as the DmgData sections (order of fields is immaterial and spaces, hyphens and underscores ignored in type and supertype names), but repeated data sets relate to the data for different types of weapon, and in addition:
' + +'| t: | |
| st: |
RangeData=[t:longbow, +:2, r:3/6/12/21],[t:shortbow, +:2, r:3/5/10/15],[t:warbow, +:2, r:3/9/16/25], [t:compositelongbow, +:2, r:3/7/14/21],[t:compositeshortbow, +:2, r:3/5/10/18],[st:bow, +:2, r:3/5/10/15]' + +'
The RangeData section has one or more data sets relating to weapons that result in different ranges. The range specifications can have 3 or 4 parts: if 4, the first is for Point Blank range which is only relevant for specialists; the remaining 3 are always short, medium & long ranges. The ranges are normally specified as they are in the Player\'s Handbook, with 1 representing 10 etc. However, if the Short range is specified as 10 or greater, or the ranges are preceeded by \'=\' (e.g. r:=5/10/20), the ranges will be taken as literal and not multiplied by 10.
' + +'Self-ammoed weapons e.g. Warhammer
' + +'&{template:RPGMweapon}{{name=Warhammer}}{{subtitle=Hammer/Club}} {{Speed=[[4]]}}{{Size=Medium}}{{Weapon=1-handed melee or thrown club}}Specs=[Warhammer,Melee,1H,Clubs],[Warhammer,Ranged,1H,Clubs]{{To-hit=+0 + Str & Dex bonus}}ToHitData=[w:Warhammer, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:B, r:5, sp:4],[ w:Warhammer, sb:1, db:1, +:0, n:1, ch:20, cm:1, sz:M, ty:B, sp:4]{{Attacks=1 per round + level & specialisation, Bludgeoning}}{{Damage=+0, vs SM:1d4+1, L:1d4, + Str bonus}}DmgData=[ w:Warhammer, sb:1, +:0, SM:1+1d4, L:1d4][]{{Ammo=+0, vs SM:1d4+1, L:1d4, + Str bonus}}AmmoData=[w:Warhammer,t:Warhammer,st:Throwing-club,sb:1,+:0,SM:1+1d4,L:1d4]{{Range=S:10, M:20, L:30}}RangeData=[t:Warhammer,+:0,r:1/2/3]{{desc=This is a normal warhammer. The blade is sharp and keen, but nothing special.}}
' + +'A melee weapon that can also be thrown, and is its own ammunition, is termed a "self-ammoed" weapon. Its definition combines the data elements of both melee weapons, ranged weapons and ammunition.
' + +'Specs=[Warhammer,Melee,1H,Clubs],[Warhammer,Ranged,1H,Clubs]' + +'
Has two Specs data sets, one as a melee weapon and one as a ranged weapon.
' + +'ToHitData=[w:Warhammer, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:B, r:5, sp:4],[ w:Warhammer, sb:1, db:1, +:0, n:1, ch:20, cm:1, sz:M, ty:B, sp:4]' + +'
ToHitData also has two sets of data, each of which relates to the corresponding Specs set.
' + +'DmgData=[ w:Warhammer, sb:1, +:0, SM:1+1d4, L:1d4],[]' + +'
DmgData does have two data sets, but the one corresponding to the ranged data is empty, as this data is in the Ammo data set.
' + +'AmmoData=[w:Warhammer,t:Warhammer,st:Throwing-club,sb:1,+:0,SM:1+1d4,L:1d4]' + +'
There is only 1 Ammo data set, as it only relates to the one weapon, itself.
' + +'RangeData=[t:Warhammer,+:0,r:1/2/3]' + +'
And only 1 Range data set, as it only relates to itself.
' + +'Important Note: Magical self-Ammoed / Thrown weapons must only have the magical bonus (or penalty for cursed items) defined in the AmmoData +: attribute. This will be added both to the To-Hit calculation and to the Damage calculation. The ToHitData +: attribute should be set to +:0 or not specified at all (defaults to 0) as otherwise the To-Hit calculation will gain both a plus from the ToHit data and also from the AmmoData. This is equivalent to having a separate ranged weapon (such as a bow) with +:0 (the normal state) firing magical ammunition (such as Flight Arrow+1).
' + +'Reusable, returning, breaking and modifying ammo
' + +'Some ammunition (and also Self-ammoed weapons) behave differently to normal ammo when used: some breaks and cannot be retrieved (e.g. glass arrows), others magically return to the thrower\'s hand, and yet others change state when used (such as an unfolding net). These types of ammunition use the reuse attribute in their AmmoData section:
' + +'| ru: | [-]# | Defines the reusability or altering state of the ammunition |
|---|
The reuse attribute can take the following values:
' + +'| Value | Example | Description |
|---|---|---|
| -2 | Staff-Spear | The ammunition and weapon will be deleted from all weapon tables when thrown as a ranged weapon, representing a non-returning magically charged thrown weapon, only recovered by using again as a magic item |
| -1 | Glass Arrow | The ammunition will break on use, and is not recoverable |
| 0 | Flight Arrow | The default value. The ammunition will behave normally, reducing by 1 on use, and recoverable if the DM agrees |
| 1 | Whelm (magic Warhammer) | The ammunition quantity does not reduce with use. The ammo magically returns by itself |
| 2 | Spitting Snake Venoms | The ammunition is one of several possible for the weapon, but when one is used it becomes the only type available, not reducing, while the others all become 0 quantity |
| 3 | Net (Folded to Unfolded) | The ammunition has two or more states. The selected ammo will reduce by 1 and the other states will increase by 1 |
' + +'
Making a 1-Handed Weapon able to be 2-Handed
' + +'Generally, it is not worth wielding the average 1-Handed weapon with both hands - you gain no advantage and lose use of the other hand. Clearly, there are some exceptions like a Basterd Sword which is designed to be used as either 1-handed or 2-handed and gains extra damage from doing so.
' + +'However: certain 1-handed weapons gain benefits when a character has proficiency in the Two-Hander Fighting Style, and perhaps with other (custom) fighting styles the DM chooses to set up. However, those without these proficiencies should not gain benefit from 2-handed use of these weapons. To achieve this outcome, these weapons need to be specified in a particular fashion in the Weapons Database. Here is an example:' + +'Battle Axe
' + +'&{template:RPGMweapon}{{name=Battle Axe}} {{subtitle=Axe}} {{Speed=[[7]]}} {{Size=Medium}} {{Weapon=1-handed melee axe}} Specs=[Battle-Axe,Melee,1H,Axe],[Battle-Axe,Melee,2H,Axe] {{To-hit=+0 + Str Bonus}} ToHitData=[w:Battle Axe,sb:1,+:0,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:7,rc:uncharged] {{Attacks=1 per round + specialisation & level, Slashing}} {{Damage=+0, SM:1d8, L:1d12 + Str Bonus}} DmgData=[w:Battle Axe,sb:1,+:0,SM:1d8,L:1d12] {{desc=A standard Battle Axe of good quality, but nothing special}}
' + +'Here it can be seen that there are two data sets specified for the Specs field and only one data set specified for the ToHitData. Doing this tells the APIs that this weapon can be taken in both hands, but generally will not gain any different advantages. If a Character is proficient or specialised in Two-Hander Fighting Style, however, the APIs will see that this is a 1-handed weapon held in both hands, and allocate it the correct benefits. But only certain weapons gain these benefits, so only certain weapons in the database should be set up this way.
' + +'Dancing Weapons
' + +'Only one dancing weapon is defined in the Dungeon Master\'s Guide, the "Sword of Dancing". However, with RPGMaster APIs, any weapon can be made to dance including ranged weapons:
' + +'Longsword of Dancing
' + +'&{template:RPGMweapon}{{title=Longsword of Dancing}} {{subtitle=Magical Sword}}{{Speed=[[5]]}} {{Size=Medium}}WeapData=[d:+1/4]{{Weapon=Dancing 1-handed melee long-blade}}Specs=[Longsword,Melee,1H,Long-blade]{{To-hit=+1/2/3/4 on sequential rounds + Str bonus}}ToHitData=[w:Longsword of Dancing, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:5]{{Attacks=1 per round + level & specialisation, Slashing}}{{Damage=+1/2/3/4 on sequential rounds, vs SM:1d8, L:1d12, + Str bonus}}DmgData=[w:Longsword, sb:1, +:0, SM:1d8, L:1d12]{{desc=This is a very special sword. It is etched with dramatic battle scenes, almost balletic in grace and poise.}}
' + +'This weapon will automatically be identified as a "dancing weapon" when taken In-hand using the Attk Menu > Change Weapon dialog. The necessary data attribute to be placed in the WeapData section is shown below:
' + +'| d: | [+/-]# [|#] | Defines the change in magical plus per round, optionally followed by a pipe and number of dancing rounds (defaults to 4) |
|---|
Such a weapon must be held in-hand (and presumably used to attack) for a number of rounds before it will dance, with the magical plus of the weapon changing by a defined amount each round (which can be positive, zero or negative). Once that number of rounds has passed, the weapon will automatically start dancing, and the player will be presented with the Change Weapon dialog to select a new weapon to take in hand. The dancing weapon will automatically be given an initiative roll each round while dancing, the magical plus will be reset to that defined for the first round in the specification and will again increment round on round. Once the number of rounds has again passed, the weapon will stop dancing: the player will need to take the weapon in-hand again to restart the sequence.
' + +'Note: the magical plus of the weapon on the first round in the sequence will always be that specified by the +:# attribute incremented by the dancing increment from the d:[+/-]# attribute. Thus a ToHitData and DmgData entru of +:0 and a WeapData specification of d:+1/4 will result in the first round plus being +1.
' + +'Dancing weapons work by using Effects managed by the RoundMaster API, which needs to be loaded for them to work. This weapon definition will automatically create the required effects for RoundMaster to use (using the !rounds --dancer command), which will work in a standard way, following the approach for a "Sword of Dancing" defined in the DMG. If you want a specialised dancing weapon using a different approach, you will need to define your own dancing weapon effects using the information in the Effects Database Help handout.
' + +'Artifact sword
' + +'&{template:RPGMweapon}{{name=Jim the Sun Blade
'
+ +'Intelligent, Neutral}}{{subtitle=Magic Sword}}{{Speed=[[3]]}}WeapData=[w:Jim the Sun Blade,ns:5][cl:PW,w:Jims-Locate-Object,sp:100,lv:6,pd:1],[cl:PW,w:Jims-Find-Traps,sp:5,lv:6,pd:2],[cl:PW,w:Jims-Levitation,sp:2,lv:1,pd:3],[cl:PW,w:Jims-Sunlight,sp:3,lv:6,pd:1],[cl:PW,w:Jims-Fear,sp:4,lv:6,pd:2]{{Size=Special (feels like a Shortsword)}}{{Weapon=1 or 2 handed melee Long or Short blade}}Specs=[Bastard-sword|Short-sword,Melee,1H,Long-blade|Short-blade],[Bastard-sword|Short-sword,Melee,1H,Long-blade|Short-blade],[Bastard-sword,Melee,2H,Long-blade],[Bastard-sword,Melee,2H,Long-blade]{{To-hit=+2, +4 vs Evil + Str Bonus}}ToHitData=[w:Jim +2,sb:1,+:2,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3],[w:Jim vs Evil+4,sb:1,+:4,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3],[w:Jim 2H +2,sb:1,+:2,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3],[w:Jim 2H vs Evil+4,sb:1,+:4,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3]{{Attacks=1 per round}}{{Damage=+2, +4 vs Evil, + 1-handed SM:1d8 L:1d12, 2-handed SM:2d4 L:2d8}}DmgData=[w:Jim+2,sb:1,+:2,SM:1d8,L:1d12],[w:Jim vs Evil+4,sb:1,+:4,SM:2d4,L:2d8],[w:Jim 2H +2,sb:1,+:2,SM:1d8,L:1d12],[w:Jim 2H vs Evil+4,sb:1,+:4,SM:2d4,L:2d8]{{desc=An intelligent weapon: A Sun Blade called Jim (DMs Guide Page 185). It is Neutral. It needs its owner to be proficient with either a Short or Bastard Sword or promise to get such proficiency as soon as possible. It cannot be used by someone who is not proficient. It requires its owner to be Neutral on at least one of its axis, and may not be Evil. NG LN CN and of cause true N are all ok. Abilities:
'
+ +'**1:** It is +2 normally, or +4 against evil creatures, and does Bastard sword damage.
'
+ +'**2:** It feels and react as if it is a short sword and uses short sword striking time.
'
+ +'**3:** [Locate Object](!magic --mi-power @{selected|token_id}|Jims-Locate-Object|Jim-the-Sun-Blade|6) at [[6]]th Level in 120\' radius (1x day).
'
+ +'**4:** [Detect traps](!magic --mi-power @{selected|token_id}|Jims-Find-Traps|Jim-the-Sun-Blade|6) of large size in 10\' radius (2xday).
'
+ +'**5:** [Levitation](!magic --mi-power @{selected|token_id}|Jims-Levitation|Jim-the-Sun-Blade|1) 3x a day for 1 turn (cast at 1st Level).
'
+ +'**6:** [Sunlight](!magic --mi-power @{selected|token_id}|Jims-Sunlight|Jim-the-Sun-Blade|6) Once a day, upon command, the blade can be swung vigorously above the head, and it will shed a bright yellow radiance that is like full daylight. The radiance begins shining in a 10-foot radius around the sword-wielder, spreading outward at 5 feet per round for 10 rounds thereafter, creating a globe of light with a 60-foot radius. When the swinging stops, the radiance fades to a dim glow that persists for another turn before disappearing entirely.
'
+ +'**7:** It has a special purpose namely Defeat Evil.
'
+ +'**8:** On hitting an Evil being it causes [Fear](!magic --mi-power @{selected|token_id}|Jims-Fear|Jim-the-Sun-Blade|6) for 1d4 rounds (unless saving throw is made). It can do this **twice a day** when the wielder desires.
'
+ +'**9:** It speaks Common and its name is Jim. It will talk to the party.
'
+ +'**10:** It has an ego of 16 and is from Yorkshire.
'
+ +'**11:** It will insist on having a Neutral wielder. (See Intelligent weapons on page 187 in DMG).
'
+ +'**12:** If picked by a player, it will be keen to become the players main weapon.
'
+ +'**13:** If picked up by a player who is not Neutral it will do them 16 points of damage}}
An artefact such as an intelligent sword with powers introduces data sets that specify the powers that the artefact has and how often they can be used. These match the API Buttons with calls to the MagicMaster API to enact the powers.
' + +'WeapData=[w:Jim the Sun Blade,ns:5][cl:PW,w:Jims-Locate-Object,sp:100,lv:6,pd:1],[cl:PW,w:Jims-Find-Traps,sp:5,lv:6,pd:2],[cl:PW,w:Jims-Levitation,sp:2,lv:1,pd:3],[cl:PW,w:Jims-Sunlight,sp:3,lv:6,pd:1],[cl:PW,w:Jims-Fear,sp:4,lv:6,pd:2]
' + +'The WeapData data sets can be used to define the powers that an artefact has (or stored spells - see MagicMaster API for more information on spell storing)
' + +'1st data set:
' + +'| w: | <text> The name of the weapon (not currently used) |
| ns: | <#> The number of spells or powers for which the specifications follow |
Subsequent data sets:
' + +'| cl: | < MU / PR / PW > The type of data: MU=Wizard, PR=Priest, PW=Power |
| w: | <text> Name of the spell or power: must be the same as the corresponding database definition |
| sp: | <#> Speed of the spell/power casting in segments (1/10ths of a round) |
| lv: | <#> The level at which the artefact will cast the spell/power (if omitted will use character\'s level) |
| pd: | <-1 / #> Number per day, or -1 for "use at will" |
Execute command when taking in-hand or sheathing a weapon
' + +'&{template:RPGMwandSpell}{{title=Rod of Alertness}}Specs=[Rod of Alertness,Melee,1H,Clubs],[Rod of Alertness,Wand,1H,Conjuration-Summoning]{{splevel=Footman\'s Mace/Rod}}WeapData=[w:Rod of Alertness,wt:10,on:\\api;modattr --charid @{selected|character_id} --fb-public --fb-header @{selected|character_name} acts faster! --fb-content _CHARNAME_ improves their initiative rolls by 1 --init-mod|-1,off:\\api;modattr --charid @{selected|character_id} --fb-public --fb-header @{selected|character_name} acts more slowly --fb-content _CHARNAME_\'s initiative rolls return to normal --init-mod|+1 ]{{school=Conjuration/Summoning}}ToHitData=[w:Rod of Alertness,sb:1,+:1,n:1,ch:20,cm:1,sz:M,ty:B,r:5,sp:10,rc:uncharged]{{components=M}}DmgData=[w:Rod of Alertness,sb:1,+:1,SM:1+1d6,L:1d6]{{Time=[[10]]}}WandData=[w:Rod of Alertness,wt:10,sp:10,rc:uncharged,loc:left hand|right hand]{{range=Special}}{{duration=Special}}{{aoe=Special}}{{save=Special}}{{effects=This magical rod is indistinguishable from a footman\'s mace +1. It has eight flanges on its macelike head. The rod bestows +1 to the possessor\'s die roll for being *surprised*, and in combat the possessor gains -1 on initiative die rolls. If it is grasped firmly, the rod enables the character to ...
'
+ +'the rest of the specification of this item is not important here
Another pair of attributes that can be included in the 1st WeapData data set specify simple commands to execute when the weapon is taken "in-hand" or "sheathed" using the Change Weapon menu. Only simple commands can be specified this way which do not include any multi-line commands or Roll20 macro calls (for more complex actions when taking in-hand or sheathing weapons, see the [Effects Database Help] for the "-inhand" and "-sheathed" event macros). The example above changes the wielder\'s initiative modifier by an improvement of 1 when the Rod of Alertness is taken in-hand, using the Chat Set Attr API !modattr command, and then reduces it back by 1 when the Rod is sheathed.
' + +'| on: | <command> | A simple command that can be expressed on a single line, executed when the weapon is taken "in-hand" using the Change Weapon menu |
| off: | <command> | A simple command that can be expressed on a single line, executed when the weapon is "sheathed" (replaced with a different item) using the Change Weapon menu |
Execute a command on attack or doing damage
' + +'As with executing a command when drawing or sheathing a weapon, simple commands which do not include multiple lines or Roll20 macro calls can be included in the ToHitData specification for attack commands, in the DmgData specification for melee weapon damage commands, and in the AmmoData specification for ranged weapon damage commands.
' + +'| cmd: | <command> | A simple command that can be expressed on a single line, execution occuring at a point determined by which data set the tag is in |
A typical use of such a command is in the ToHitData or DmgData of a weaponised spell:
' + +'&{template:RPGMspell}{{title=@{selected|Casting-name} casts Wither as a level @{selected|Casting-Level} caster}}{{splevel=Level 7 Priest}}{{school=Necromancy (Reversable)}}{{sphere=Necromantic}}Specs=[Wither,Innate-Melee|PRspellL7,1H,Necromancy]{{components=V,S,M}}{{range=Touch attack}}{{time=[[1]] round}}{{duration=Permanent}}{{aoe=Creature Touched}}ToHitData=[w:Wither,sp:1,sb:0,ty:SPB,r:5,msg:A successful hit withers the member or organ touched ceasing to function in 1 round and dropping off into dust in \\lbrak;2d4 turns\\rbrak;\\lpar;!rounds ~~target single¦`{selected¦token_id}¦@{target¦Who\'s member will wither?¦token_id}¦Wither¦[\\lbrak;10*2d4\\rbrak;]¦-1¦Touched limb / member / organ is withering and turning to dust¦back-pain\\rpar;,cmd:!attk ~~blank-weapon `{selected¦token_id}¦Wither¦silent]{{save=None}}DmgData=[w:Wither,sb:0,SM:0,L:0,msg:A successful hit withers the member or organ touched ceasing to function in 1 round and dropping off into dust in \\lbrak;2d4 turns\\rbrak;\\lpar;!rounds ~~target single¦`{selected¦token_id}¦@{target¦Who\'s member will wither?¦token_id}¦Wither¦[\\lbrak;10*2d4\\rbrak;]¦-1¦Touched limb / member / organ is withering and turning to dust¦back-pain\\rpar;]{{reference=PHB p234}}SpellData=[w:Wither,lv:7,sp:1,gp:0.1,cs:VSM,sph:Necromantic]{{Use=Take the spell in-hand when casting, and attack with it. Called shots attract penalties to hit.}}{{effects=Causes the member or organ touched to cease functioning in one round, dropping off into dust in 2d4 turns. Creatures must be touched for the harmful effect to occur.}}{{materials=A prayer device and unholy water}}
' + +'In this case, the command !attk --blank-weapon @{selected|token_id}|Wither|silent is included in the ToHitData specification and removes the spell as a weapon as soon as the caster attacks, whether successful or not. If this command had, instead, been included in the DmgData specification, the spell would have remained a usable weapon until the touch was successful and the damage done.
' + +'New Configurable Items and the Query Attribute
' + +'It is possible to create weapon (and armour) definitions at have configurable elements, set when the item is first added to a container or a character. This is achieved using the query: attribute in the "WeapData" or "ACdata" section of the item. An example of its use is the Magical Javelin which uses a query to ask what magical plus that armour might grant, including negative / cursed values.
' + +'Magical Javelin
' + +'&{template:RPGMweapon}{{prefix=^^weaponMagic#2^^}}{{title=Javelin}}{{name=^^weaponMagic#0^^}}Specs=[Javelin,Melee,1H,Spears], [Javelin,Melee,2H,Spears], [Javelin,Ranged,1H,Throwing-Spears]{{}}WeapData=[w:Javelin, query:weaponMagic=How magical is this weapon?|+0%%0/ |-4%%-4/Cursed |-3%%-3/Cursed |-2%%-2/Cursed |-1%%-1/Cursed |0%%0/ |+1%%1/ |+2%%2/ |+3%%3/ |+4%%4/, st:Javelin, +:^^weaponMagic#1^^, rc:^^weaponMagic#2^^]{{}}ToHitData=[w:Javelin^^weaponMagic#0^^, +:^^weaponMagic#1^^, sb:1, n:1, ch:20, cm:1, sz:M, ty:P, r:5, sp:4],[w:Javelin 2H^^weaponMagic#0^^, +:^^weaponMagic#1^^, sb:1, n:1, ch:20, cm:1, sz:M, ty:P, r:5, sp:4],[w:Javelin^^weaponMagic#0^^, +:0, sb:1, db:1, n:1, ch:20, cm:1, sz:M, ty:P, sp:4]{{}}DmgData=[w:Javelin^^weaponMagic#0^^, +:^^weaponMagic#1^^, sb:1, SM:1d4, L:1d4],[w:Javelin 2H^^weaponMagic#0^^, +:^^weaponMagic#1^^, sb:1, SM:1d6, L:1d6, msg:Does double damage if set against charge],[]{{}}AmmoData=[w:Javelin^^weaponMagic#0^^, +:^^weaponMagic#1^^, t:Javelin, st:Spear, sb:1, SM:1d4, L:1d4]{{}}RangeData=[t:Javelin, +:^^weaponMagic#1^^, r:2/2/4/6]{{}}%{MI-DB|Weapon-Info}{{}} %{MI-DB|Magical-Weapon-Info}{{subtitle=^^weaponMagic#2^^ Spear}} {{subtitle=Spear}} {{Speed=[[4]]}} {{Size=Medium}} {{Weapon=1-or 2-handed ^^weaponMagic#2^^ melee or thrown spear}} {{To-hit=^^weaponMagic#0^^ + Str Bonus}}{{Attacks=1 per round + level & specialisation, Piercing}}{{Damage=^^weaponMagic#0^^, 1H vs SM:1d4, L:1d4, 2H vs SM:1d6, L:1d6 + Str bonus}} {{Ammo=^^weaponMagic#0^^, vs SM:1d4, L:1d4 + Str bonus}} {{Range=PB:20 S:20 M:40 L:60}} {{Looks Like=Javelins are classified as light spears, suitable for melee or missile combat, usable either on horseback or on foot. Javelins may be used either one- or two-handed, and like the harpoon, there is no difference in speed factor between the two styles.}} {{desc=This is an exceptional Javelin. It is light and has a sharp point, and might be special in some way or other.}}
' + +'The query: attribute in the WeapData section defines the questions that will be asked in standard Roll20 Roll Queries. In this case, a question about the magical bonus (or penalty) is asked using the following format:
' + +'result-tag=query question|option 1 text%%value 1.1/value 1.2/.../value 1.n|option 2 text%%value 2.1/value 2.2/.../value 2.n|...%%.../.../...|option j text%%value j.1/value j.2/.../value j.n' + +'
Multiple queries can be concatinated, separated by \'$$\'. Each query posts the option texts in a list. The selected option will then provide the values that substitute dynamic attributes in the data section, which are specified with the syntax ^^result-tag#n^^ where \'n\' is the value index - index 0 is the option text itself. Using the Magical Javelin example, selecting a cursed weapon penalty of -2 replace the following dynamic attributes:
| w:Javelin^^weaponMagic#0^^ | w:Javelin-2 |
|---|---|
| +:^^weaponMagic#1^^ | +:-2 |
| rc:^^weaponMagic#2^^ | rc:Cursed |
In fact, there are three pre-defined weapon queries that can be used after the query: attribute that will save some typing:
' + +'| Attribute | Resolves to |
|---|---|
| query:weaponPlus | query:weaponPlus=How magical is this weapon?|+0%%0/|+1%%1/|+2%%2/|+3%%3/|+4%%4/ |
| query:weaponMagic | query:weaponMagic=How magical is this weapon?|+0%%0/|-4%%-4/Cursed|-3%%-3/Cursed|-2%%-2/Cursed|-1%%-1/Cursed|0%%0/|+1%%1/|+2%%2/|+3%%3/|+4%%4/ |
| query:weaponCurse | query:weaponCurse=How cursed is this weapon?|-0%%0/Cursed/|-1%%-1/Cursed|-2%%-2/Cursed|-3%%-3/Cursed|-4%%-4/Cursed |
| query:swordType | swordType=What type of sword?|Longsword%%M/S/5/1d8/1d12/M/S/5/1d8/1d12|Broadsword%%M/S/5/2d4/1+1d6/M/S/5/2d4/1+1d6|Bastard-Sword%%M/S/6/1d8/1d12/M/S/8/2d4/2d8|Khopesh%%M/S/9/2d4/1d6/M/S/9/2d4/1d6|Shortsword%%S/P/3/1d6/1d8/S/P/3/1d6/1d8|Scimitar%%M/S/5/1d8/1d8/M/S/5/1d8/1d8|Two-Handed-Sword%%L/S/10/0/0/L/S/10/1d10/3d6] |
Thus the query: attribute in the example could have been shortened to "query:weaponMagic,".
' + +'The Specs specification cannot use query variables. Thus, as the weapon type can vary if using the swordType pre-defined query shortcut (or a similar construct) there is an alternative approach to specifying the weapon type (and supertype if needed) by using the \'t:\' and \'st\' attributes in the ToHitData section. Each of these can be followed by a literal string defining the type or, more usefully, a query variable (e.g. t:^^swordType#0^^):
' + +'| t: | Define the type of weapon for determination of proficiency |
|---|---|
| st: | Define the tight weapon-group of weapon for determination of related weapon proficiency |
These attributes override the values given for the 1st and 4th fields in the Specs section.
' + +'' + +'
Updated 3. Armour Databases
' + +'Armour databases are all character sheets that have names that start with MI-DB-Armour (as with weapons, this can be in any database starting with MI-DB- if desired), and can have anything put at the end, though those with version numbers of the form v#.# as part of the name will be ignored.
' + +'As previously stated and as per the weapon and ammunition databases, each armour definition has 3 parts in the database (see Section 1): the Ability Macro, the ct- attribute, and the listing (and occasionally attributes for powers and spells). The quickest way to understand these entries is to examine existing entries. Do extract to the root databases and take a look (but remember to delete them after examination and use the --check-db command to re-index the databases).
' + +'Note:The DM creating new armour entries does not need to worry about anything other than the Ability Macro in the database, as running the !attk --check-db MI-DB-Armour or !magic --check-db MI-DB-Armour command will update all other aspects of the database appropriately for all databases that have a name starting with or including \'MI-DB-Armour\', as long as the Specs and Data fields are correctly defined. Running the command -check-db with no parameters will check and update all databases.
' + +'Here are some examples:
' + +'Chain Mail
' + +'&{template:RPGMarmour}{{title=Chain Mail }}{{subtitle=Armour}}Specs=[Chain Mail,Armour,0H,Mail]{{}}ACData=[a:Chain Mail, st:Mail, t:Chain-Mail, +S:2, +P:0, +B:-2, +:0, ac:5, sz:L, rc:single-uncharged, qty:1, wt:40, loc:body, rac:Chain Mail, ppa:-25, ola:-10, rta:-10, msa:-15, hsa:-15, dna:-5, cwa:-25, rla:0, lla:0]{{}}%{MI-DB|Armour-Info}{{Armour=Chain Mail}}{{AC=[[5]] vs all attacks}}{{Looks Like=This armor is made of interlocking metal rings.}}{{hide1=Chain mail is always worn with a layer of quilted fabric padding underneath to prevent painful chafing and to cushion the impact of blows. Several layers of mail are normally hung over vital areas. The links yield easily to blows, absorbing some of the shock. Most of the weight of this armor is carried on the shoulders and it is uncomfortable to wear for long periods of time.}}{{desc=Good, sturdy, well made chain but nothing special}}
' + +'The ability specification for this suit of Chain Mail uses a Roll20 Roll Template, in this case defined by the loaded RPGMaster Library. The entries in the Roll Template itself can be anything you desire, giving as much or as little information as you want. However, the important elements for the AttackMaster API are those highlighted. Each of these elements are inserted between the elements of the Roll Template, meaning they will not be seen by the player when the macro is run. Generally spaces, hyphens and underscores in the data elements are ignored, and case is not significant. Each element is described below:
' + +'Specs=[Chain Mail,Armour,0H,Mail]' + +'
The Specs section of the specification has exactly the same format as for weapons and ammunition (and indeed all database items). See section 9 for the definition of the fields.
' + +'Note:The armour Type (the 1st parameter) and Group-Type (the 4th parameter) are used to determine if the character is of a class that can use the armour. Currently implemented types are listed in Section 4.
' + +'Note: Armour that fits on the body generally does not take any hands to hold, and so the third field, Handedness, is set to \'0H\'.
' + +'ACData=[a:Chain Mail, t:Chain-Mail, st:Mail, ac:5, +:0, +S:2, +P:0, +B:-2, sz:L, wt:40, qty:1, rc:single-uncharged, loc:body, rac:Chain Mail, ppa:-25, ola:-10, rta:-10, msa:-15, hsa:-15, dna:-5, cwa:-25, rla:0, lla:0]]' + +'
The Armour Class Data (ACData) section holds data specific to the armour. As with other data sections, fields can be in any order, and spaces, hyphens, underscores and case are ignored.
' + +'| a: | < text > the name of the armour to be displayed. Often the same as the Ability. | |||||||||||||||||||||||||||
| t: | < armour-type > The specific armour type, often the same as the first parameter of the Specs section. | |||||||||||||||||||||||||||
| st: | < group-type > the supertype of the armour, often the same as the fourth parameter of the Specs section. | |||||||||||||||||||||||||||
| ac: | <[-]#> the base armour class (excluding magical bonuses) for this type of armour. | |||||||||||||||||||||||||||
| +: | <[+/-]#> the magical bonus or penalty of the armour (defaults to 0 if not supplied). | |||||||||||||||||||||||||||
| +s: | <[-/+]#> The magical adjustment specifically against slashing damage. | |||||||||||||||||||||||||||
| +p: | <[-/+]#> The magical adjustment specifically against piercing damage. | |||||||||||||||||||||||||||
| +b: | <[-/+]#> The magical adjustment specifically against bludgeoning damage. | |||||||||||||||||||||||||||
| +m: | <[-/+]#> The adjustment that the armour gives vs. missiles and ammunition of ranged weapons. | |||||||||||||||||||||||||||
| db: | <[0/1]> A 1 means dexterity AC bonus combines with armour, 0 means armour prevents dexterity bonus from applying. | |||||||||||||||||||||||||||
| sz: | <[T/S/M/L/H]> The size of the item (not necessarily indicating its fit). | |||||||||||||||||||||||||||
| wt: | <#> The weight of the item in lbs (could be considered kg - or any measure - if everything is the same). | |||||||||||||||||||||||||||
| qty: | < # > Default quantity that is normally added to a character sheet. | |||||||||||||||||||||||||||
| rc: | ||||||||||||||||||||||||||||
| loc: | < Location > The location on a charater where the item is stored. | |||||||||||||||||||||||||||
| rac: | < Thievish armour type > New The name to use for armour type on the Rogue Skills Table. | |||||||||||||||||||||||||||
| ppa: | <[-/+]#> New The penalty/benefit wearing this armour gives to picking pockets. | |||||||||||||||||||||||||||
| ola: | <[-/+]#> New The penalty/benefit wearing this armour gives to opening locks. | |||||||||||||||||||||||||||
| rta: | <[-/+]#> New The penalty/benefit wearing this armour gives to find/remove traps. | |||||||||||||||||||||||||||
| msa: | <[-/+]#> New The penalty/benefit wearing this armour gives to moving silently. | |||||||||||||||||||||||||||
| hsa: | <[-/+]#> New The penalty/benefit wearing this armour gives to hiding in shadows. | |||||||||||||||||||||||||||
| dna: | <[-/+]#> New The penalty/benefit wearing this armour gives to detecting noise. | |||||||||||||||||||||||||||
| cwa: | <[-/+]#> New The penalty/benefit wearing this armour gives to climbing walls. | |||||||||||||||||||||||||||
| rla: | <[-/+]#> New The penalty/benefit wearing this armour gives to reading languages. | |||||||||||||||||||||||||||
| lla: | <[-/+]#> New The penalty/benefit wearing this armour gives to ledgend lore. | |||||||||||||||||||||||||||
| Melee | Melee weapon which strikes while in hand |
| Ranged | Weapon that causes damage when thrown or with ammunition |
| Innate-Melee or Innate-Ranged | Weapons that do not get a proficiency penalty. |
| Ammo | Ammunition for a ranged weapon of a specific Type or Group-Type |
| Magic | A magical attack from a magic item power or function |
4.1(c) Weapon Handedness
' + +'| 0H | A weapon that does not take a hand (e.g. spike on helm) |
| 1H | A weapon that is 1-handed, such as a short sword |
| 2H | A weapon that takes 2 hands to wield, such as a longbow |
| 3H | A weapon that takes 3 hands... |
| 4H | Etc (e.g. a siege weapon that needs 2 people to operate it) |
| ... | ... |
' + +'
4.1(d) Weapon Group-Types
' + +'Weapon Group-Types determine related weapons for weapon proficiency, and whether it can be used by a Character of a specific class. The APIs use the definitions in the AD&D2e Fighter\'s Handbook section on \'Tight Groups\', extended to cover certain additional weapons and weapon types. Those implemented so far for the Weapon databases are:
' + +'| Arrow | Club | Great-Blade | Long-Blade | Short-Blade | Whip |
| Axe | Crossbow | Hook | Medium-Blade | Sling | |
| Blowgun | Dart | Horeshoes | Pick | Spear | |
| Bow | Fencing-Blade | Innate | Polearm | Staff | |
| Bullet | Flail | Lance | Quarrel | Throwing-Blade |
Types and Group-Types that can be used by various Character Classes are defined in the Class-DB class database for each class type:
' + +'| Warrior | Any |
| Fighter | Any |
| Ranger | Any |
| Paladin | Any |
| Beastmaster | Any |
| Barbarian | Any |
| Defender | "axe", "club", "flail", "long-blade", "fencing-blade", "medium-blade", "short-blade", "polearm" |
| Wizard | (all types) "dagger", "staff", "dart", "knife", "sling" |
| Priest / Cleric | "club", "mace", "hammer", "staff" |
| Druid | "club", "sickle", "dart", "spear", "dagger", "scimitar", "sling", "staff" |
| Healer | "club", "quarterstaff", "mancatcher", "sling" |
| Priest of Life | "club", "quarterstaff", "mancatcher", "sling" |
| Priest of War | Any |
| Priest of Light | "dart", "javelin", "spear" |
| Priest of Knowledge | "sling", "quarterstaff" |
| Shaman | "long-blade", "medium-blade", "short--blade", "blowgun", "club", "staff", "shortbow", "horsebow", "hand-xbow" |
| Rogue / Thief | "club", "short-blade", "dart", "hand-xbow", "lasso", "shortbow", "sling", "broadsword", "longsword", "staff" |
| Bard | Any |
| Assassin | Any |
' + +'
4.1(e) Armour Types
' + +'There is an infinite list of armour types: generally the type is the armour name without any reference to magical plusses, so the Type of Plate-Mail+2 is Plate-Mail. This Type is used to check for types of armour that can be worn by various classes.
' + +'' + +'
4.1(f) Armour Item-Classes
' + +'| Armour | Any type of armour that does not need to be held to work |
|---|---|
| Shield | A barrier that is held in hand(s) and defends against one or more attacks from the front |
' + +'
4.1(g) Armour Handedness
' + +' 0H Armour and Shields that are not held in the hand (e.g. a Buckler or a Helm)
'
+ +' 1H Generally a type of Shield that must be held in a hand
'
+ +' 2H Armour and Shields that use two hands, and/or prevent use of those hands for other things
'
+ +' 3H Generally siege engines that shield against attacks... (not yet implemented)
'
+ +' ... etc.
' + +'
4.1(h) Armour Group-Types
' + +'Armour Types and Group Types determine whether the armour can be used by various Character Classes. Restrictions are defined in the Class-DB classes database (see the relevant database handout):
' + +'| Warrior | Any |
| Fighter | Any |
| Ranger | Any |
| Paladin | Any |
| Beastmaster | Any |
| Barbarian | "padded", "leather", "hide", "brigandine", "ring-mail", "scale-mail", "chain-mail", "shield", "ring", "magic-item","cloak" |
| Defender | Any |
| Wizard (all types) | "magic-item", "ring", "cloak" |
| Priest / Cleric | Any |
| Druid | "leather", "padded", "hide", "wooden-shield", "magic-item", "ring", "cloak" |
| Healer | Any |
| Priest of Life | Any |
| Priest of War | Any |
| Priest of Light | "studded-leather", "ring-mail", "chain-mail", "shield", "ring", "magic-item", "cloak" |
| Priest of Knowledge | "magic-item", "ring", "cloak" |
| Shaman | "padded", "leather", "hide", "brigandine", "ring-mail", "scale-mail", "chain-mail", "splint-mail", "banded-mail", "shield", "ring", "magic-item", "cloak" |
| Rogue / Thief | Any |
| Bard | "padded", "leather", "hide", "brigandine", "ring-mail", "scale-mail", "chain-mail", "ring", "magic-item", "cloak" |
| Assassin | Any |
' + +'
4.2 Data Sections
' + +'| Field | ' + +'Format | ' + +'Default Value | ' + +'Description | ' + +'Can be used in | ' + +'|||||
|---|---|---|---|---|---|---|---|---|---|
| ToHit Data | '
+ +' Dmg Data | '
+ +' Ammo Data | '
+ +' Range Data | '
+ +' Weapon Data | '
+ +' AC Data | '
+ +' ||||
| w: | < text > | \'-\' | Name to be displayed | X | X | X | |||
| w: | < text > | \'-\' | Name of spell or power | X | |||||
| a: | < text > | \'-\' | Name to be displayed | X | |||||
| t: | < text > | \'\' | Type | X | X | X | X | ||
| st: | < text > | \'\' | Group Type (aka Tight-Group) | X | X | X | X | ||
| sb: | 0 / 1 | 0 | Strength Bonus | X | X | X | |||
| db: | 0 / 1 | 1 | Dexterity Bonus | X | X | ||||
| +: | [ + / - ] # | 0 | Magical adjustment | X | X | X | X | X | |
| +m: | [ + / - ] # | 0 | Missile attack adjustment | X | |||||
| +s: | [ + / - ] # | 0 | Slashing damage adjustment | X | |||||
| +p: | [ + / - ] # | 0 | Piercing damage adjustment | X | |||||
| +b: | [ + / - ] # | 0 | Bludgeoning damage adjustment | X | |||||
| n: | # [ / # ] | 1 | Attacks per round | X | |||||
| d: | [ + / - ] # [ | # ] | \'\' | Dancing increment / duration | X | |||||
| dp: | # | 0 | Dancing proficiency adjustment | X | |||||
| ch: | 1 - 20 | 20 | Critical Hit roll value | X | |||||
| cm: | 1 - 20 | 1 | Critical Miss roll value | X | |||||
| sz: | [ t / s / m / l / h ] | \'\' | Size of item | X | X | X | |||
| r: | [# /] # / # / # | \'\' | Range | X | X | ||||
| r: | [+/-]# [ / [+/-]# / [+/-]# / [+/-]# ] | 0 | Range Modifier | X | |||||
| ty: | SPB any combination | \'\' | Type of damage | X | |||||
| sp: | [-]# | 0 | Speed in segments (1/10 round) | X | X | ||||
| c: | # | 1 | Charges used for attack (charged weapons only) | X | |||||
| c: | # | 0 | Charges used if hit (charged weapons only) | X | |||||
| pre: | 0 / 1 | 0 | Gets auto pre-Initiative attack | X | |||||
| on: | < cmd > | \'\' | Cmd to execute when taken in-hand | X | |||||
| off: | < cmd > | \'\' | Cmd to execute when sheathed | X | |||||
| qty: | # | 0 | Maximum possible qty of Items | X | X | X | |||
| ru: | [-]# | 0 | Reusability of ammunition | X | |||||
| sm: | dice roll format | 0 | Damage roll for Small & Medium opponents | X | X | ||||
| l: | dice roll format | 0 | Damage roll for Large & Huge opponents | X | X | ||||
| msg: | < text > | \'\' | Message to display with attk/dmg | X | X | X | |||
| ac: | [-]# | \'\' | Armour class | X | |||||
| wt: | # | 1 | Weight of item in lbs | X | X | ||||
| ns: | # | 0 | Number of spells & powers defined for item | X | X | ||||
| cl: | MU / PR / PW | \'\' | Type of spell or power | X | |||||
| pd: | -1 / # | 1 | Number per day (power only) | X | |||||
| rc: | Charged / Uncharged / Rechargeable / Recharging / Self-charging / Cursed / Charged-Cursed / Recharging-Cursed / Self-charging-Cursed | Uncharged | Initial charged and Cursed status of item when found | X | X | ||||
| rac: | < text > | Armor name | Thievish armour name | X | |||||
| ppa: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s pick pocket skill | X | |||||
| ola: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s open locks skill | X | |||||
| rta: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s find/remove traps skill | X | |||||
| msa: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s moving silently skill | X | |||||
| hsa: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s hide in shadows skill | X | |||||
| dna: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s detect noise skill | X | |||||
| cwa: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s detect noise skill | X | |||||
| rla: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s read languages skill | X | |||||
| lla: | <[-/+]#> | 0 | Penalty / benefit to rogue\'s ledgend lore skill | X | |||||
| lv: | # | 1 | Level at which spell/power is cast | X | |||||
| lv: | #:# | 1 | Min:Max level at which weapon/ammo can be used | X | X | ||||
| clv: | #:# | 1 | Min:Max caster level at which weapon/ammo can be used | X | X | ||||
| mulv: | #:# | 1 | Min:Max wizard level at which weapon/ammo can be used | X | X | ||||
| prlv: | #:# | 1 | Min:Max priest level at which weapon/ammo can be used | X | X | ||||
| pw: | Power | \' \' | Power cast by this attack (Magic class only) | X | |||||
| desc: | < text > | \' \' | Power/spell/MI macro to display (Magic class only) | X | |||||
| cmd: | < text > | \' \' | Command to send to chat | X | X | X | |||
' + +'
4.3 Character Sheet data fields
' + +'As stated in section 7, the Character Sheet field mapping to the API script can be altered using the definition of the fields object. You can find the complete mapping for all APIs in the RPGMaster series, with an explanation of each, in a separate document.
' + +'', + }, + SpellsDatabase_Help:{name:'Spells Database Help', + version:1.33, + avatar:'https://s3.amazonaws.com/files.d20.io/images/257656656/ckSHhNht7v3u60CRKonRTg/thumb.png?1638050703', + bio:'Spell & Power Database Help
' + +'for MagicMaster v'+version+' and later
' + +'' + +'[General DB Help]' + +'
2. Spells and Powers Databases
' + +'Spells/Powers databases have names that start with
' + +' Wizard Spells: MU-Spells-DB-[added name]
'
+ +' Priest Spells: PR-Spells-DB-[added name]
'
+ +' Powers: Powers-DB-[added name]
Those with version numbers of the form v#.# as part of the name will be ignored.
' + +'As previously stated, each spell or power definition has 3 parts in the database (see Section 1): an Ability Macro with a name that is unique and matches the spell or power, an Attribute with the name of the Ability Macro preceded by "ct-", and a listing in the database character sheet of the ability macro name separated by \'|\' along with others of the same level in the spell book of the level of the spell or power. The quickest way to understand these entries is to examine existing entries. Do extract the root databases using the !magic --extract-db command, and take a look (but remember to delete it after viewing to speed things up, and then reindex the databases using !magic --check-db)
' + +'Note: The DM creating new spells and powers does not need to worry about anything other than the Ability Macro in the database, as running the command --check-db will update all other aspects of the database appropriately for all databases, as long as the Specs and Data fields are correctly defined. Use the name of the particular database as a parameter to check and update just that database. Running the command --check-db with no parameters will check and update all databases.
' + +'Ability macros can be added to a database just by using the [+Add] button at the top of the Abilities column in the Attributes and Abilities tab of the Database Character Sheet, and then using the edit "pencil" icon on the new entry to open it for editing. Ability macros are standard Roll20 functionality and not dependent on the API. Refer to the Roll20 Help Centre for more information.
' + +'2.1 Simple Spells
' + +'The Ability Macro for a spell may look something like this:
' + +'Sleep
' + +'&{template:RPGMspell}{{title=@{selected|casting-name} casts Sleep as a level @{selected|casting-level} caster}}{{splevel=Level 1 Wizard}}{{school=Enchantment/Charm}}Specs=[Sleep,MUspellL1,1H,Enchantment-Charm]{{range=90 ft}}{{components=V, S, M}}{{duration=[[5*({10,@{selected|casting-level}}kl1)]] Rounds}}{{time=1}}{{aoe=[30ft Cube](!rounds --aoe @{selected|token_id}|square|feet|90|30||dark)}}{{save=None}}{{damage=[Sleep them](!rounds --target area|@{selected|token_id}|@{target|Select who to sleep|token_id}|Sleep|[[5*({10,@{selected|casting-level}}kl1)]]|-1|Snoring away, shake to awaken|sleepy)}}SpellData=[w:Sleep,lv:1,sp:1,gp:0.01,cs:VSM]{{effects=Up to [2d4](!\ \/r 2d4) Hit Dice of creatures with 4 HD or less are put to sleep beginning with the lowest HD creatures in the Area of Effect.}}{{materials=a pinch of fine sand, rose petals, or a live cricket.}}
' + +'The ability specification for this Sleep spell uses a Roll20 Roll Template, in this case provided by the RPGMaster Library (see the documentation for the RPGMaster Library for specifications of this Roll Template), but any Roll Template you desire can be used. The entries in the Roll Template itself can be anything you desire, giving as much or as little information as you want. However, the important elements for the MagicMaster API are those highlighted. In red, two API buttons grant the player access to run RoundMaster API commands to show the Area of Effect of the spell, and then to mark affected tokens with a "Sleepy" status.
' + +'Each of the elements important to the database are inserted between the elements of the Roll Template, meaning they will not be seen by the player when the macro is run. Generally spaces, hyphens and underscores in the data elements are ignored, and case is not significant. Each element is described below:' + +'Specs = [Type, Class, Handedness, Spell School]' + +'
The Specs section describes what spell type and school this spell belongs to. These fields must be in this order. This format is identical for all database items, whether in these databases or others used by the Master series of APIs. Where there are multiple answers for a field, separate each by \'|\'. Note: Only A-Z, a-z, 0-9, hyphen/minus(-), plus(+), equals(=) point(.) and vertical bar(|) are allowed. Replace any forward slash with hyphen.
' + +'| Type | the type of the spell, often the same as the ability macro name. |
|---|---|
| Class | one of MUSpellL#, PRSpellL#, or Power, where # is replaced by the spell level number. |
| Handedness | #H, where # is the number of hands needed to cast the spell - i.e. does it have a somatic component. |
| Spell School | the group of related spells that the spell belongs to. |
SpellData=[w:Sleep,lv:1,sp:1,gp:1,cs:VSM]' + +'
The SpellData section specifies the data relating to the use of the spell. These fields can be in any order.
' + +'| w: | <text> | the name of the spell |
|---|---|---|
| sph: | <text> | the sphere of a priest spell (not used for wizard spells) |
| lv: | <#> | the level of the spell |
| sp: | <[-]# or dice roll spec> | the casting time in segments for the spell. Can be >10 e.g. 20 for 2 rounds, or negative, or even a dice roll |
| gp: | <#[.#]> | the cost of the material components of the spell in GP: fractions converted to SP & CP |
| cs: | <VSM> | the component of the spell (Verbal, Somatic, Material) - can be any combination |
The casting time (or speed) sp: can be negative, meaning it gives a negative modifier to individual initiative (if InitMaster API is being used). It can also be greater than 10 segments, meaning it takes longer than 1 Round to cast. Multiply the number of Rounds it will take to cast by 10, or the number of Turns it will take to cast by 100 (if using the InitMaster API the rounds will be automatically counted down and the spell actually cast in the appropriate round, unless the casting is interrupted). It can also be a dice roll specification, which will be rolled at the point that a character selects the spell, power or item to use in a particular round, which means the speed can vary from round to round. E.g. under AD&D2e rules, potions are always of this nature (see the AD&D2e DMG p141).
' + +'The cost of material components, gp:, is deducted from the Caster\'s money on their Character Sheet each time the spell is cast. The GM is informed of the spell being cast, by whom, and how much money it cost and how much money the Caster has left for each casting.
' + +'The components of the spell, cs:, is currently not used and is for future expansion capabilities.
' + +'2.2 Spells that need "To Hit"
' + +'A more complex spell that needs the caster to hit the target with an attack roll, also known as a weaponised spell, might look something like this:
' + +'&{template:RPGMspell}{{title=@{selected|Casting-name} casts
'
+ +'Spiritual Hammer
as a level @{selected|Casting-Level} caster}}Specs=[Spiritual-Hammer,Innate-Melee|PRspellL2,1H,Evocation],[Spiritual-Hammer,Innate-Melee,1H,Clubs],[Spiritual-Hammer,Innate-Melee,1H,Clubs]{{splevel=Level 2 Priest}}ToHitData=[w:Spiritual Hammer+1,prlv:1:6,+:1,sb:0,n:1,ch:20,cm:1,sz:T,ty:B,sp:3],[w:Spiritual Hammer+2,prlv:7:12,+:2,sb:0,n:1,ch:20,cm:1,sz:T,ty:B,sp:2],[w:Spiritual Hammer+3,prlv:13,+:3,sb:0,n:1,ch:20,cm:1,sz:T,ty:B,sp:1]{{school=Invocation}}{{sphere=Combat}}DmgData=[w:Spiritual Hammer+1,sb:0,+:1,sm:1+1d4,l:1d4],[w:Spiritual Hammer+2,sb:0,+:2,sm:1+1d4,l:1d4],[w:Spiritual Hammer+3,sb:0,+:3,sm:1+1d4,l:1d4]{{components=V,S,M}}weapData=[on:\\api;rounds --target caster|@{selected|token_id}|Spiritual-Hammer|\\lbrak;\\lbrak;3+@{selected|Casting-Level}\\rbrak;\\rbrak;|-1|Magical weapon in direction facing requires concentration|archery-target,off:\\api;!rounds --removetargetstatus @{selected|token_id}|Spiritual-Hmmer]{{time=[[5]]}}{{range=[[10*@{selected|Casting-Level}]] yards}}{{duration=[[3+@{selected|Casting-Level}]] rounds}}{{aoe=Special}}{{save=None}}{{reference=PHB p207}}{{damage=SM [1d4+1](!
/r 1d4+1) or L [1d4](!
/r 1d4) +[[{{(ceil(@{selected|Casting-Level}/6)),3}kl1}]]}}{{damagetype=Bludgeoning}}SpellData=[w:Spiritual-Hammer,lv:2,sp:5,gp:2,cs:VSM,sph:Combat]{{effects=Base Thac0 same as caster [[@{selected|thac0-base}]] without strength bonus plus magical plus of +[[{{(ceil(@{selected|Casting-Level}/6)),3}kl1}]]. Damage is plus magical bonus but no others.}}{{materials=A normal war hammer (cost 2gp) hurled towards opponent, which disappears as spell is cast.}}{{use=Take the Spiritual Hammer in-hand using the *Change Weapon* menu for the duration of the spell, and use it to attack opponents. It will disappear when the duration expires or you *Change Weapon* to another weapon.}}
This spell definition combines the elements of spell database specification and those of a weapon specification. The Specs data now includes the Innate-Melee weapon classification as well as the spell type and level, and as well as the SpellData there are weapon ToHitData and DmgData entries. In addition to the explanation here, please refer to the Weapon and Armour Database Help for more information on these sections.
' + +'In this case, there are multiple repeating datasets in each data section: there are three possible variants of the Spiritual Hammer depending on the caster\'s level. The version to be selected is determined using the level specification attribute in the ToHitData section, in this case using "prlv", but there are four alternatives:
' + +'| lv: | Min : Max | The minimum and maximum level of character (both optional) |
|---|---|---|
| clv: | Min : Max | The minimum and maximum level of spell caster, class based on last spell cast (both optional) |
| mulv: | Min : Max | The minimum and maximum level of wizard spell caster for this weapon (both optional) |
| prlv: | Min : Max | The minimum and maximum level of priest spell caster for this weapon (both optional) |
In each case, the minimum and maximum are separated by a colon, and either can be left out meaning there is no minimum or no maximum. Wizard and Priest spell casters include those other classes that can cast those spells, at their particular level of spell casting compitence: e.g. a 10th level Ranger is a 2nd level Priest spell caster. If the appropriate value for the caster of the spell falls within the range specified, then that weapon dataset will result in creation of a line in the appropriate weapon tables.
' + +'If a spell has these weapon datasets included, and is currently memorised, it will appear in the weapon lists on the Change Weapon menu. Also, if this spell is cast, the Change Weapon menu will appear automatically after the spell description in the Chat window, ready to take the spell "in-hand" as a weapon and attack with it. Whichever way the Change Weapon menu appears, choosing the spell as a weapon will always mark the spell as having been cast. The spell-weapon will remain in-hand until the weapon is changed or the !attk --blank-weapon command is used which might, for instance, be included in the custom attack macro template (e.g. for Chromatic Orb) or in a spell end-effect (e.g. as in the Spiritual-Hammer-end Effect macro).
' + +'Other spells may not persist beyond the first attack with the spell, or perhaps after the first successful attack: this is often the case with spells that require the caster to "touch" an unwilling target.
' + +'&{template:RPGMspell}{{title=@{selected|Casting-name} casts
Cause Blindness or Deafness
as a level @{selected|Casting-Level} caster}}{{splevel=Level 3 Priest (reversable)}}{{school=Abjuration}}{{sphere=Necromantic}}Specs=[Cause-Blindness-or-Deafness,Innate-Melee|PRspellL3,1H,Abjuration],[Cause-Blindness-or-Deafness,Innate-Melee|PRspellL3,1H,Abjuration]{{components=V,S}}ToHitData=[w:Cause Blindness,sp:10,r:5,touch:1],[w:Cause Deafness,sp:10,r:5,touch:1]{{time=[[10]]}}DmgData=[w:Cause Blindness,sm:0,l:0,cmd:!rounds ~~target single¦`{selected¦token_id}¦`{target¦Which creature is the victim?¦token_id}¦Blindness¦99¦0¦Blinded and suffer -4 penalty to attacks and AC and +2 penalty to initiative¦bleeding-eye],[w:Cause Deafness,sm:0,l:0,cmd:!rounds ~~target single¦`{selected¦token_id}¦`{target¦Which creature is the victim?¦token_id}¦Deafness¦99¦0¦Deafened and suffer +1 penalty to initiative as well as other effects¦bleeding-eye]{{range=Touch}}{{duration=Permanent}}{{aoe=1 creature}}{{save=Negates}}{{reference=PHB p209 (reverse Cure Blindness or Deafness)}}SpellData=[w:Cause-Blindness-or-Deafness,lv:3,sp:10,gp:0,cs:VS,sph:Necromantic]{{use=Take the spell in-hand using the *change weapon* dialog, then use the *attack* action to select which effect and attack a target}}{{effects=Requires a successful touch (successful attack roll) on the victim. If the victim rolls a successful saving throw, the effect is negated. If the saving throw is failed, a non-damaging magical blindness or deafness results.
A *deafened* creature can react only to what it can see or feel, and suffers a -1 penalty to surprise rolls, a +1 penalty to its initiative rolls, and a 20% chance of spell failure for spells with verbal components. A *blinded* creature suffers a -4 penalty to its attack rolls, a +4 penalty to its Armor Class, and a +2 penalty to its initiative rolls.}}
The ToHitData, DmgData, or AmmoData specifications can include the data tag touch:
' + +'| touch: | [ 0 / 1 ] | The spell expires if touch:1 is used (defaults to 0 if not specified) |
|---|
If the touch:1 data tag and value is included in the ToHitData (whether a melee touch spell or a ranged attack spell) the spell will expire and be removed as an available attack on the first attack with the spell. If the touch:1 is included in the DmgData (for melee touch spells) or AmmoData (for ranged attack spells) the spell will remain available as an attack until a successful attack is made and damage or an effect occurs: this works whether or not using targeted attacks or otherwise, with non-targeted attacks expiring if either the S/m or L damage buttons are selected on the AC Hit dialog.
' + +'Executing commands when attacking or doing damage
' + +'Sometimes a spell will need some command to be executed when an attack is made, either only when the attack is successful or when any attack is attempted. The above example of the Cause Blindness or Deafness spell is also an example of a spell using a command on a successful attack. It uses the cmd: data tag:
' + +'| cmd: | cmd-string | A command to be executed when the magical attack is made, encoded with the standard and extended RPGMaster escape sequences |
|---|
If the cmd:cmd-string data tag and value is included in the ToHitData specification then the command specified will execute automatically whenever the spell is used to do an attack, whether successful or not. If the cmd:cmd-string is included in the DmgData or AmmoData specifications the command will execute only when an attack is successful.
' + +'2.3 Simple Powers
' + +'The Ability Macro for a Power may look something like this:
' + +'Turn Undead
' + +'&{template:RPGMspell}{{title=@{selected|token_name} attempts to Turn Undead as a level @{selected|pr-casting-level} @{selected|class3}}} {{splevel=Power}} {{school=Necromancy}}Specs=[Turn-Undead,Power,1H,Necromancy]{{components=V,S}}{{time=[[10]]}}{{range=0}}{{duration=Until broken}}{{aoe=Undead within line of sight}}{{save=See turning table}}{{reference=PHB p103}}{{damage=[Turn It](!rounds --target area|@{selected|token_id}|@{target|Select undead|token_id}|Turned|99|0|Turned undead, flee if free-willed, stand aside if controlled|screaming)}}SpellData=[w:Turn Undead, sp:10, cs:VS]{{effects=**Remember that Paladins turn as a Priest of 2 levels lower.**
'
+ +'Attempting to turn counts as an action, requiring one round and occurring during the character\'s turn in the initiative order (thus, the undead may get to act before the character can turn them). The mere presence of the character is not enough--a touch of drama from the character is important. Speech and gestures are important, so the character must have his hands free and be in a position to speak. However, turning is not like spellcasting and is not interrupted if the character is attacked during the attempt.
'
+ +'To resolve a turning attempt, look on Table 61. Cross-index the Hit Dice or type of the undead with the level of the character (two levels lower for a paladin). If there is a number listed, roll 1d20. If the number rolled is equal to or greater than that listed, the attempt is successful. If the letter "T" (for "turned") appears, the attempt is automatically successful without a die roll. If the letter "D" (for "dispel") is given, the turning utterly destroys the undead. A dash (--) means that a priest or paladin of that level cannot turn that type of undead. A successful turn or dispel affects 2d6 undead. If the undead are a mixed group, the lowest Hit Dice creatures are turned first.
'
+ +'Only one die is rolled regardless of the number of undead the character is attempting to turn in a given round. The result is read individually for each type of undead.}}{{material=The Priest\'s holy symbol}}
Essentially, Powers are just Spells by another name, that can be cast multiple times per day, and are innate to the Character\'s class, or to a creature. The specification is, therefore, almost identical to a spell. In the author\'s campaigns, Powers do not consume material components and therefore do not cost money to use (except in rare circumstances) hence there being no gp: specification (it defaults to 0gp), but other DMs can add material costs for Powers if desired. Powers are all 1 level, hence no lv: specification.
' + +'' + +'
7. Specs & Data field values
' + +'Below are lists of the current possible values for the item database Ability macro sections.
' + +'7.1 Specs sections
' + +'Specs=[Type, Item-Class, Handedness, Group-Type]' + +'
There are no default settings for any of the Specs data fields. All must be explicitly specified.
' + +'7.1(a) Spell Types
' + +'There is an infinite list of spell types: generally the type is the spell name.
' + +'7.1(b) Spell Item-Classes
' + +'| MUSpellL# | A Wizard spell with the Level specified as a number |
|---|---|
| PRSpellL# | A Priest spell with the Level specified as a number |
| Power | A Power |
7.1(c) Spell Handedness
' + +'0H A spell/power that does not take a hand (there is no Somatic component)
'
+ +'1H A spell/power that requires only 1 hand to cast (most spells are like this)
'
+ +'2H A spell/power that requires 2 hands to cast (perhaps a scroll must be held)
'
+ +'3H A spell/power that takes 3 hands... perhaps more than 1 caster together?
'
+ +'4H Etc No currently programmed spells use more than 2 hands
'
+ +'... ...
7.1(d) Spell/Power Schools
' + +'From MagicMaster v2.048 onwards, Spell Schools are specified by Class in the Class-DB definitions and, depending on the API configuration set with the --config command, will be checked by the system or otherwise. Those implemented so far for the Spells databases are:
' + +'Abjuration, Alteration, Conjuration-Summoning, Enchantment-Charm, Divination, Illusion-Phantasm, Invocation-Evocation, Necromancy.
' + +'Note that the \'/\' in School names have been replaced by hyphens. It is also allowed to use just one half of any hyphenated school name where appropriate. If a spell or power is of more than one school, separate each with a vertical bar character \'|\'
' + +'' + +'
7.2 Data Sections
' + +'Definitions for Data Section field types for Weapons & Armour can be found in the AttackMaster API documentation. Below are the definitions for Spell, Power & other Magical Item types.
' + +'Note: Always refer to the database specification definitions in other sections above for detailed information on the use of these Field specifiers. Not all specifiers have an obvious use.
' + +'| Field | ' + +'Format | ' + +'Default Value | ' + +'Description | ' + +'Can be used in | ' + +'|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Spell Data | '
+ +' Potion Data | '
+ +' Scroll Data | '
+ +' Wand Data | '
+ +' Staff Data | '
+ +' Rod Data | '
+ +' Ring Data | '
+ +' Misc Data | '
+ +' ToHit Data | '
+ +' AC Data | '
+ +' ||||
| w: | < text > | \'-\' | Name to be displayed | X | X | X | X | X | X | X | X | X | |
| w: | < text > | \'\' | Name of spell or power (Not case sensitive) | X | |||||||||
| +: | [ + / - ] # | 0 | Magical adjustment | X | X | X | X | X | X | ||||
| n: | # [ / # ] | 1 | Attacks per round | X | X | X | X | X | |||||
| st: | \' \' | \'\' | Item type to display | X | X | X | X | X | X | X | X | ||
| sz: | [ t / s / m / l / h ] | \'\' | Size of item | X | X | X | X | X | X | X | |||
| sp: | [-]# or Dice Roll spec | 0 | Speed in segments (1/10 round) | X | X | X | X | X | X | X | X | X | |
| wt: | # | 1 | Weight of item in lbs | X | X | X | X | X | X | ||||
| rules: | [+/-][rule] | ... | 0 | Save / Check rules | X | X | X | X | X | X | ||||
| svXXX: | [=][+/-]# | 0 | Save / Check mod | X | X | X | X | X | X | ||||
| on: | command | \'\' | Cmd to execute when worn | X | X | X | X | ||||||
| off: | command | \'\' | Cmd to execute when removed | X | X | X | X | ||||||
| ns: | # | 0 | Number of stored spells & powers defined for item | X | X | X | X | X | X | X | |||
| w: | < text > | \'-\' | Name of stored spell or power (Not case sensitive) | X | X | X | X | X | X | X | |||
| cl: | MU / PR / PW | \'\' | Type of stored spell or power | X | X | X | X | X | X | X | |||
| lv: | # | 1 | Level at which spell/power is cast | X | X | X | X | X | X | ||||
| pd: | -1 / # | 1 | Number per day (power only) | X | X | X | X | X | X | ||||
| rc: | Charged / Uncharged / Rechargeable / Recharging / Self-chargeable / Cursed / Charged-Cursed / Recharging-Cursed / Self-chargeable-Cursed | Uncharged | Initial charged and Cursed status of item when found (Can be changed by DM using -gm-only-mi command once added to Character Sheet) Not case sensitive | X | X | X | X | X | X | X | X | X | |
| c: | # | 1 | The number of charges expended by using a charged magic item. Uncharged items always use 0 charges | X | X | X | X | X | X | X | X | X | |
| desc: | [MU-/PR-/PW-/MI-]name | \' \' | Power or Spell to display | X | X | ||||||||
| msg: | < text > | \' \' | Attack message | X | X | ||||||||
| cmd: | Command | \' \' | Attack API command | X | X | ||||||||
| learn: | [ 0 | 1 ] | 0 | Learnable stored spells | X | X | ||||||||
' + +'
7.3 Character Sheet data fields
' + +'The Character Sheet field mapping to the API script can be altered using the definition of the fields object, the definition for which can be found at the top of the game-version-specific RPGMaster Library API for the game-version you are using. You can find the complete mapping for all APIs in the RPGMaster series, with an explanation of each, in a separate document - ask the Author for a copy.
' + +'Magic Item Database Help
' + +'for MagicMaster v'+version+' and later
' + +'' + +'
New in this Help Handout
' + +'- '
+ +'
- New Items that affect Rogue skills ' + +'
- New Items that affect AC, Thac0, Damage and/or HP ' + +'
Note: Help for Spells & Powers has been split out to its own help handout.
' + +'2. Magic Item Databases
' + +'Magic Item databases have names such as
' + +'Magic Items: MI-DB-[added name]
' + +'And can have anything put at the end, though those with version numbers of the form v#.# as part of the name will be ignored.
' + +'As previously stated and as for other magic, each magic item definition has 3 parts in the database (see Section 1): an Ability Macro with a name that is unique and identifies the magic item, an Attribute with the name of the Ability Macro preceded by "ct-", and a listing in the database character sheet of the ability macro name separated by \'|\' along with others of the same magic item type, which is one of: Potion, Scroll, Rod/Stave/Wand, Weapon, Armour, Ring, Miscellaneous, and also DM Only magic items. The quickest way to understand these entries is to examine existing entries. Do extract a root database using the !magic --extract-db command and take a look (but remember to delete it after viewing to speed things up, and then reindex the databases using !magic --check-db)
' + +'Note: The DM creating new magic items does not need to worry about anything other than the Ability Macro in the database, as running the command --check-db will update all other aspects of the database appropriately for all databases, as long as the Specs and Data fields are correctly defined. Use the name of the particular database as a parameter to check and update just that database. Running the command --check-db with no parameters will check and update all databases.
' + +'Ability macros can be added to a database just by using the [+Add] button at the top of the Abilities column in the Attributes and Abilities tab of the Database Character Sheet, and then using the edit "pencil" icon on the new entry to open it for editing. Ability macros are standard Roll20 functionality and not dependent on the API. Refer to the Roll20 Help Centre for more information.
' + +'2.1 Simple Magic Items
' + +'The Ability Macro may look something like this:
' + +'Oil-of-Etherealness
' + +'&{template:RPGMpotion}{{title=Oil of Etherealness}} {{splevel=Oil}} {{school=Alteration}}Specs=[Oil of Etherealness,Potion,1H,Alteration]{{components=M}}{{time=[[3]] rounds after application}} PotionData=[sp:30,rc:charged]{{range=User}}{{duration=4+1d4 turns}} {{aoe=User}} {{save=None}} {{healing=[Become Ethereal](!rounds --target single|@{selected|token_id}|@{target|Select a target|token_id}|Oil-of-Etherealness|[[10*(4+1d4)]]|-1|Ethereal|Ninja-mask)}}{{effects=This potion is actually a light oil that is applied externally to clothes and exposed flesh, conferring etherealness. In the ethereal state, the individual can pass through solid objects in any direction - sideways, upward, downward - or to different planes. The individual cannot touch non-ethereal objects.
'
+ +'The oil takes effect three rounds after application, and it lasts for 4+1d4 turns unless removed with a weak acidic solution prior to the expiration of its normal effective duration. It can be applied to objects as well as creatures. One potion is sufficient to anoint a normal human and such gear as he typically carries (two or three weapons, garments, armor, shield, and miscellaneous gear). Ethereal individuals are invisible.}}{{materials=Oil}}
There is one new field in the data section (in this case called the PotionData section):
' + +'| rc: | <MI-type> | the recharging/curse type of the magic item. |
|---|
All magic items have a recharging/curse type: for details, see the --gm-edit-mi command in the MagicMaster API help documentation, section 4.1. If not supplied for a magic item definition, it defaults to uncharged. Generally, items in the database are not cursed-, but can have their type changed to cursed or some recharging cursed type when the DM stores them in a container or gives them to a Character using the --gm-edit-mi command.
' + +'2.2 Items that Protect
' + +'Items like a Ring of Protection or a Luck Blade protect the possessor by improving their saving throws and/or armour class.
' + +'Ring of Protection+2
' + +'&{template:RPGMring}&{template:RPGMring}{{name=Ring of Protection}}{{subtitle=Ring}}{{Speed=[[0]]}}{{Size=Tiny}}{{Immunity=None}}{{Protection=+[[2]] on AC}}Specs=[Ring of Protection,Protection Ring,1H,Abjuration-Protection]{{Saves=+[[2]] on saves}}ACData=[a:Ring of Protection+2,st:Ring,+:2,rules:-magic,sz:T,wt:0,svsav:2,w:Ring of Protection+2,sp:0,rc:uncharged,loc:left finger|right finger]{{Looks Like=A relatively plain ring made of some exotic metal. You are unable to distinguish it from any other ring by just looking at it...}}{{desc=A ring of protection improves the wearer\'s Armour Class value and saving throws versus all forms of attack. A ring +1 betters AC by 1 (say, from 10 to 9) and gives a bonus of +1 on saving throw die rolls. The magical properties of a ring of protection are cumulative with all other magical items of protection except as follows:
1. The ring does not improve Armour Class if magical armour is worn, although it does add to saving throw die rolls.
2. Multiple rings of protection operating on the same person, or in the same area, do not combine protection. Only one such ring—the strongest—functions, so a pair of protection rings +2 provides only +2 protection.}}
All items that protect that are not armour or shields have an item class of some type of protection-[item] specified as the second field of the Specs for the item. The [item] text can be anything you desire, e.g. in this case protection-ring, but only the most advantageous protection-[item] that the possessor has on them will operate. E.g. a protection-ring will work with a protection-cloak but not with another protection-ring.
' + +'Items that protect that have an effect on armour class must use the ACData section to specify their properties, otherwise the properties can be held in any other \'...data=\' specification. The Weapons & Armour Database Help handout has full specifications for ACData fields. The data field tags relevant to AC and saves are listed in the table below:
' + +'| +: | [+/-]# | The effect on armour class, + being beneficial, - being a penalty (ACData only). |
|---|---|---|
| rules: | rule [ | rule | rule | ...] | Rules specifying what item types / supertypes / classes this item will or will not work with (see below). |
| svXXX: | [=][+/-]# | The effect on various saving throws, specified by XXX, + being beneficial, - being a penalty. |
The rules: state conditions and which other items this item will or will not work with to improve armour class and/or saving throws. Each rule is separated by a \'|\' and preceeded by either \'+\' or \'-\'. The rules have the following meanings:
' + +'| +inHand | This item must be held in hand for them to work, using the Change Weapon dialog |
|---|---|
| +worn | (Saves only) This item must be of a usable type that can be worn by the class / race of the character - default for AC |
| -magic | (AC only) This item will not combine with magical armour |
| -shield | (AC only) This item will not combine with a shield of any type |
| -acall | (AC only) This item will not combine with any other armour (except that specified with a \'+\' - see below) |
| -[supertype] | (AC only) This item will not work with any other item of the supertype specified |
| +[supertype] | (AC only) This item will always work with any other item of the supertype specified, even if -acall rule has been specified |
| -[item class] | (Saves only) This item will not combine with any other item of the item class specified |
The svXXX: entries state the effect on saving throws and/or ability checks that this item has if the rules are met. For Saving Throw mods the \'XXX\' can be one of \'par\', \'poi\', \'dea\', \'pet\', \'pol\', \'bre\', \'spe\', or \'sav\' each referring to the first 3 letters of the saving throw affected (or \'sav\' for all saving throw mods); and for Attribute Check mods \'XXX\' can be \'str\', \'con\', \'dex\', \'int\', \'wis\', \'chr\', and \'atr\' each refering to each Character attribute (or \'atr\' for all attribute mods); or to change all mods of both types use \'all\'. Each svXXX: field tag is followed by a number which can be optionally preceeded by \'+\' (a beneficial improvement to the mod), \'-\' (a penalty to the mod), and/or \'=\' (the mod is set to the value - overrides other changes).
' + +'Note: Changing the Attribute mods will not affect the ability checks for open doors, bend bars, learn spells etc. These mods can only be adjusted manually using the appropriate button on the Attribute Check menu.
' + +'2.3 Items that change initiative
' + +'In a similar way to protection, items can affect initiative roles for a character. This can only be achieved automatically if using group or individual initiative:
' + +'Rod of Alertness
' + +'&{template:RPGMring}&{template:RPGMwandspell}{{title=Rod}}{{name= of Alertness}}specs=[Rod of Alertness,melee,1h,Clubs],[Rod of Alertness,magic,1h,clubs],[Rod of Alertness,magic,1h,clubs],[Rod of Alertness,magic,1h,clubs],[Rod of Alertness,magic,1h,clubs],[Rod of Alertness,magic,1h,clubs],[Rod of Alertness,magic,1h,clubs],[Rod of Alertness,magic,1h,clubs],[Rod of Alertness,Rod,1H,conjuration-summoning]{{splevel=Footman\'s mace/Rod}}weapdata=[w:Rod of Alertness,wt:10,st:Rod,init+:-1]{{school=Conjuration/Summoning}}tohitdata= ... ignore the rest for now...
All of the rod\'s protective functions require one charge. The animate object power require one additional charge, so, if all of the rod\'s protective devices are utilized at once, two charges are expended.
The rod can be recharged by a priest of 16th level or higher, as long as at least one charge remains in the rod when the recharging is attempted.}}{{use=Taking in hand as a weapon will improve initiative scores by 1 automatically. surprise bonus is manual, and allow use of the detection capabilities.
- selecting any of the detect buttons does not use a charge but will display the specifications of the spell and allow its effects to occur.
- when invoking alertness, the player should use the 120ft radius button to set the area of effect.
- selecting the light button should be used by the dm when alertness is triggered to point the cone of light in the right direction.
- the player should then select the 20ft radius button to show the aoe of the prayer
- then select the prayer spell button, which will expend a charge and allow the prayer effect markers to be set.
- selecting the [animate object] button will expend a charge and display the spell specs to allow it to have effect.}}
The weapdata specification includes the attribute init+:-1 which indicates that this item improves the initiative priority roll by 1 (i.e. subtracting 1 from the roll). This will be automatically applied while the item obeys the rules specified for it - see the description of the rules: data attribute in 2.3 above. If the rules are met or no rules are specified for the item, the effect on initiative rolls will apply as long as the item is on the character\'s item list (not in their backpack).
' + +'Another data attribute that modifies the initiative roll is the init*: attribute, which multiplies the attack actions each round for the possessing character (does not affect magic item use, spell casting or use of powers). a value above 1 increases attacks per round, and below 1 reduces those attacks.
' + +'2.4 Items that change Rogue skills
' + +'Items can also affect the scores required for a Rogue (or other character class) to perform various skills.
' + +'Fine Thieves Tools
' + +'&{template:RPGMitem}{{name=Fine Thieves Tools}}Specs=[Thieves Tools,Miscellaneous,0H,Tools]{{desc=This is a fine set of *Thieve\'s Tools*, with ivory handles and contained in a leather purse. You wonder what creature donated the ivory}}MiscData=[w:Fine Thieves Tools,gp:200,wt:1,ola:5,rta:5,rc:uncharged]{{}}
' + +'Each Rogue skill can be increased or decreased using the following data tags:
' + +'| ppa:[+/-]# | Adjustment to the pick pocket skill (# can be a calculation) |
|---|---|
| ola:[+/-]# | Adjustment to the open locks skill (# can be a calculation) |
| rta:[+/-]# | Adjustment to the find/remove traps skill (# can be a calculation) |
| msa:[+/-]# | Adjustment to the move silently skill (# can be a calculation) |
| hsa:[+/-]# | Adjustment to the hide in shadows skill (# can be a calculation) |
| dna:[+/-]# | Adjustment to the detect noise skill (# can be a calculation) |
| cwa:[+/-]# | Adjustment to the climb walls skill (# can be a calculation) |
| rla:[+/-]# | Adjustment to the read languages skill (# can be a calculation) |
| lla:[+/-]# | Adjustment to the legend lore skill (# can be a calculation) |
2.5 More Complex Items
' + +'Other magic items might use different structures, and be more complex:
' + +'Ring of Human Influence
' + +'&{template:RPGMring}{{name=Ring of Human Influence}}{{subtitle=Ring}}Specs=[Ring of Human Influence,Ring,1H,Enchantment-Charm]{{Speed=[[0]]}}RingData=[w:Ring of Human Influence,sp:3,rc:uncharged,loc:left finger|right finger,on:\\apisetattr --fb-from Magic Items --fb-header Ring of Human Influence - Put on --fb-content _CHARNAME_ chooses to put on the Ring of Human Influence and now has a Charisma of 18 vs Humans and Humanoids --name @{selected|character_name} --RoHI-chr|@{selected|charisma} --charisma|18,off:\\apiresetattr --fb-from Magic Items --fb-header Ring of Human Influence - Take off --fb-content _CHARNAME_ chooses to take off the ring and their Charisma returns to normal --name @{selected|character_name} --RoHI-chr --charisma|@{selected|RoHI-chr},ns:2],[cl:PW,w:Suggestion,sp:3,lv:12,pd:1],[cl:PW,w:MU-Charm-Person,sp:3,lv:12,pd:1]{{Size=Tiny}}{{Immunity=None}}{{desc=Has the effect of raising the wearer\'s Charisma to 18 on encounter reactions with humans and humanoids. The wearer can make a [*suggestion*](!magic --mi-power @{selected|token_id}|Suggestion|Ring-of-Human-Influence|12) to any human or humanoid (saving throw applies). The wearer can also [charm](!magic --mi-power @{selected|token_id}|Charm-Person|Ring-of-Human-Influence|12) up to 21 levels/Hit Dice of human/humanoids (saving throws apply) just as if he were using the wizard spell, *charm person*. The two latter uses of the ring are applicable but once per day. Suggestion or charm has an initiative penalty of +3.}}{{use=Putting on the ring using the Change Weapon function changes Charisma to 18, and taking it off returns Charisma to its previous value. If using InitiativeMaster Group or Individual Initiative, select Initiative for a Magic Item, then the Ring of Human Influence to get the right item speed. Cast the spells by Using the Ring as a Magic Item, then selecting the appropriate spell in the Effect description.}}
' + +'Here, as well as having API buttons to implement powers, the RingData entry specifies commands to execute when the ring is put on using the Change Weapon menu, and another when it is taken off, as well as other aspects of the ring\'s power - but ignore everything after the "ns:" for now.
' + +'| on: | Command string | A simple, single line command to execute on wearing the ring |
|---|---|---|
| off: | Command string | A simple, single line command to execute on taking off the ring |
New Pick: and Put: field tags
' + +'Other attributes that can work in a similar way execute commands when an item is "picked up" and added to a character or creature\'s items, and also when "put away" or passed on to another character, creature or container:
' + +'| pick: | Command string | A simple, single line command to execute on picking up the item |
|---|---|---|
| put: | Command string | A simple, single line command to execute on putting away the item |
2.6 Weaponised Items using variable charges
' + +'Some more complex items can be used as weapons that have different effects or damage depending on how many charges are expended:
' + +'Staff of Striking
' + +'&{template:RPGMwand}{{name=Staff of Striking}}Specs=[Staff of Striking|Quarterstaff,Rod|Melee,1H,Staff],[Staff of Striking|Quaretstaff,Melee,1H,Staff],[Staff of Striking|Quarterstaff,Melee,1H,Staff],[Staff of Striking,Rod,1H,Conjuration-Summoning|Animal]{{subtitle=Staff}}ToHitData=[w:Staff of Striking 1 charge,sb:1,+:3,n:1,ch:20,cm:1,sz:M,ty:SPB,r:5,sp:4,c:1,rc:rechargeable],[w:Staff of Striking 2 charges,sb:1,+:3,n:1,ch:20,cm:1,sz:M,ty:SPB,r:5,sp:4,c:2,rc:rechargeable],[w:Staff of Striking 3 charges,sb:1,+:3,n:1,ch:20,cm:1,sz:M,ty:SPB,r:5,sp:4,c:3,rc:rechargeable]{{Speed=[[4]]}}WandData=[qty:19+1d6]{{Size=Medium}}{{Weapon=1-handed melee oaken staff}}{{To-hit=+3, +Str Bonus}}{{Attacks=1 per round, magically the most favourable weapon type}}{{Damage= SM: 1d6, L:1d6, 1 charge: +3, 2 charges: +6, 3 charges: +9}}DmgData=[w:Staff of Striking 1 charge,sb:1,+:3,SM:1d6,L:1d6],[w:Staff of Striking 2 charges,sb:1,+:6,SM:1d6,L:1d6],[w:Staff of Striking 3 charges,sb:1,+:9,SM:1d6,L:1d6]{{Use=Melee weapon attack as normal, selecting the appropriate plus, which will deduct the number of charges automatically.}}{{desc=This oaken staff is the equivalent of a +3 magical weapon. (If the weapon vs. armor type adjustment is used, the staff of striking is treated as the most favorable weapon type vs. any armor.) It causes 1d6+3 points of damage when a hit is scored. This expends a charge. If two charges are expended, bonus damage is doubled (1d6+6); if three charges are expended, bonus damage is tripled (1d6+9). No more than three charges can be expended per strike. The staff can be recharged.}}
' + +'The Staff of Striking is a weapon that can do additional damage if more charges are expended. The database definition uses the multiple attack / damage fields (as specified and explained in the Weapon and Armour Database Help handout) which results in multiple entries for the weapon to appear in the weapons tables on the character sheet, and in the Attack menu. Each ToHitData definition has the \'c\' attribute to define how many charges are expended when that version of the weapon is used:
' + +'| c: | # | The number of charges expended when the respective attack is made. Applies only to weapons / magic items that have charges. If in ToHitData is deducted when an attack is made, or if in DmgData only applies if a hit is achieved & damage done. Defaults to 1 charge (ToHitData) or 0 (DmgData) if not specified. If this item is not a weapon and the c: is in the item Data specification, it determines how many charges are deducted when the item is used, defaulting to 1. If combined with the special recharging type of \'enable\' then charges will not be deducted, but the c:value will still be compared against the quantity/number of charges of the item and the use disabled if there are fewer charges available than required. |
|---|---|---|
| qty: | # or <dice spec> | The default quantity of charges the item will start with when added by the GM to a container. Can be a dice roll specification, in which case the number will be determined randomly with a dice roll. The GM can optionally alter this number when storing the item. |
When shown in the Attack menu, any version of the weapon which requires more charges than it currently has will be gray, and will not be selectable for an attack.
' + +'2.7 Magic Items that must be taken in-hand
' + +'Some magic items, especially Rods, Staves and Wands, must be taken in-hand like a weapon in order for their abilities to become fully available to the character by making an Attack action. The Rod of Smiting described above is a weapon of this nature, but others might have magical attacks as well as, or instead of melee or ranged attacks. Here is an example of one such device:
' + +'Wand of Frost
' + +'&{template:RPGMwand}{{title=Wand of Frost}}WandData=[w:Wand of Frost,wt:1,sp:2,c:0,rc:rechargeable,loc:left hand|right hand]{{splevel=Wand}}{{school=Evocation}}Specs=[Wand of Frost,Magic|Wand,1H,Evocation],[Wand of Frost,Magic|Wand,1H,Evocation],[Wand of Frost,Magic|Wand,1H,Evocation]{{components=V,M}}{{time=[[2]]}}{{range=Special}}ToHitData=[w:Ice Storm,desc:MU-Ice-Storm,lv:6,sp:2,c:1],[w:Wall of Ice,desc:MU-Wall-of-Ice,lv:6,sp:2,c:1],[w:Cone of Cold,desc:PW-WoF-Cone-of-Cold,lv:6,sp:2,c:2]{{duration=Special}}{{aoe=Special}}{{save=Special}}{{effects=A *frost* wand can perform three functions that duplicate wizard spells:
'
+ +'• *Ice storm:* A silvery ray springs forth from the wand and an ice (or sleet) storm occurs up to 60 feet away from the wand holder. This function requires one charge.
'
+ +'• *Wall of ice:* The silvery ray forms a wall of ice, six inches thick, covering a 600-squarefoot area (10\' x 60\', 20\' x 30\', etc.). Its initiative modifier is +2, and it uses one charge.
'
+ +'• *Cone of cold:* White crystalline motes spray forth from the wand in a cone with a 60-foot length and a terminal diameter of 20 feet. The initiative modifier is +2, and the effect lasts just one second. The temperature is -100 degrees F., and damage is 6d6, treating all 1s rolled as 2s (6d6, 12-36). The cost is two charges per use. Saving throw vs. wands is applicable.
'
+ +'The wand can function once per round, and may be recharged.}}{{materials=Wand}}{{Use=Take the wand in-hand using the *Change Weapon* dialogue in order to use its powers with the *Attack* action}}
This specification introduces a new item Specs class, "Magic", and one of a new range of ToHitData fields, "desc":
' + +'| Magic | The associated entries in the ToHitData will specify a magical attack, rather than a melee or ranged attack. There will not be a matching DmgData specification | |
|---|---|---|
| desc: | \' \' | The name of an ability macro describing the magical attack - this is a power, wizard or priest spell, or a magic item (even possibly this magic item) which will be displayed to the player when this magical attack is used. |
| lv: | <#> | The level at which the magic item casts any power or spell. The spell will have effects as if cast at this level when cast from the magic item. |
The power, spell or magic item name used with the desc: field tag will be searched for in all the appropriate databases. However, some exist in more than one context (e.g. Light is both a Wizard and a Priest spell). It is possible to specify where the specific description can be found by preceding the name with one of "PW-", "MU-", "PR-", or "MI-" for Power, Wizard spell, Priest spell, and Magic Item respectively. Specifying the type also speeds up the search.
' + +'There are other field tags that can be used with a Magic class ToHitData specification:
' + +'| pw: | \' \' | The name of a magic item power (with limited uses per day) to use as a magical attack, specified as per Section 4.1 below |
|---|---|---|
| msg: | \' \' | A message to display to the player when the magical attack is made, encoded with the standard and extended RPGMaster escape sequences |
| cmd: | \' \' | An API command to be executed when the magical attack is made, encoded with the standard and extended RPGMaster escape sequences |
Generally speaking, the cmd: and msg: tags can be used together instead of a desc: if there is no equivalent spell or power to display and only a simple status, timer or effect results from the magical attack. The pw: tag operates in an almost identical way to desc: but decrements the "per day" uses for the named power/spell (specified in the item data specification - see Section 4.1 below) each time it is used, which refresh after a Long Rest.
' + +'2.8 Hiding Magic Item Details
' + +'Sometimes, GMs want Players to have to discover the properties of magic items through quests, spell use, trial and error, or paying a high-level wizard to identify them. This is not always the case, and some groups may prefer for some or all items to reveal their nature on first examination. The database specification of an item allows for both approaches. An example of how to define an item to make it easy to hide its details is
' + +'Flask of Curses
' + +'&{template:RPGMitem}{{title=Flask}}{{name= of Curses}}{{subtitle=Magic Item}}Specs=[Flask of Curses,Miscellaneous,1H,Alteration]{{Speed=[[3]]}}MiscData=[w:Flask of Curses,st:Flask,wt:1,sp:3,qty:1,rc:charged]{{Size=S}}{{Looks Like=An ordinary flask of some type, containing a little liquid of some unidentifyable sort}}{{Use=The GM will tell you what happens when you use this item}}{{desc=This item looks like an ordinary beaker, bottle, container, decanter, flask, or jug. It has magical properties, but detection will not reveal the nature of the flask of curses. It may contain a liquid or it may emit smoke. When the flask is first unstoppered, a curse of some sort will be visited upon the person or persons nearby. After that, it is harmless. The type of curse is up to the DM}}{{GM Info=Hide this as some other jug, flask or bottle, using the GM\'s *Add Items* menu, and set *Reveal* to *on use*. Invent an imaginative curse to enact! Suggestions include the reverse of the priest\'s bless spell. Typical curses found on scrolls are recommended for use here as well. Or perhaps a monster could appear and attack all creatures in sight.}}
' + +'Four elements contribute to the "simple" approach to being able to hide the item details from the Player / Character:
' + +'- '
+ + '
- The splitting of the title & name of the definition: title is always displayed, and name is only added to the title when hidden details are made displayable by the GM. ' + + '
- The optional addition of the st: attribute in the MiscData specification, which specifies the name of the item displayed on buttons while details are hidden. If not specified, defaults to the item class. ' + + '
- The addition of the Looks Like tag which marks text that replaces the description while details are hidden and until the GM reveals the details. ' + + '
- The Hide item as other item function in the GM\'s Add Items dialog, which will be available for items that have the Looks Like tag, or for which the GM chooses another item to hide this one as.' + +'
The key element is the inclusion of the Looks Like text tag in the definition of the item. If an item has this tag, the GM\'s Add Items dialog will have the Hide Item as Item button enabled to hide the item as either what the st: data attribute specifies or (if not specified) the item class in the Specs specification of the item. However, if auto-hiding is set in the !magic --config options, an item with a Looks Like text tag will automatically be hidden in this way when added to any container. If a player character views or uses such a hidden item, they will see only the title and the Looks Like text and nothing else. The GM can either set the item to automatically reveal its "secrets" when the player character views the item, uses the item, or only when revealed manually by the GM. It is also possible for the GM to select to hide the item as a completely different item using the Add Items dialog. For full details see the --gm-edit-mi entry in the MagicMaster Help handout.
' + +'It is possible to define the hidden status and the revealing trigger set when the item is added to a character or container as part of the data of the item definition. The hide: data tag can take the following parameters - if it is not specified, the auto-hide configuration flag defines the hiding status:
' + +'| hide | Automatically hide the item regardless of the state of the auto-hide configuration flag |
|---|---|
| nohide | Do not hide the item regardless of the state of the auto-hide configuration flag |
The rev: data tag, which sets the trigger that will reveal a hidden item, can take the following values - if not defined, the reveal state is defined by the Reveal configuration flag:
' + +'| manual | Only reveal when the GM selects to do so using the [Add Item] dialog or the button shown on the item definition (to the GM only) |
|---|---|
| view | Reveal the hidden item\'s true nature when the player first views the item\'s description once they have it in their possession |
| use | Reveal the item\'s true nature when it is first used, but not if it is viewed before that |
2.9 Configurable Items and the Query Attribute
' + +'It is possible to create item definitions at have configurable elements, set when the item is first added to a container or a character. This is achieved using the query: attribute in the data section of the item. An example of its use is the Armour of Blending which uses a query to ask which type of armour it really is and what magical plus that armour might grant.
' + +'Armour of Blending
' + +'&{template:RPGMarmour} {{title=Armour}} {{name=of Blending}}{{subtitle=Armour}} {{Armour=Can be any armour type}} Specs=[Armor-of-Blending,Armour,0H,MagicItem] {{AC=Varies by armour type}} ACData=[a:Armor of Blending, query:armourType=What type of armour? |Banded Mail%%Mail/4/2/0/1/Banded Armor (Disguise) |Brigandine%%Brigandine/6/1/1/0/Brigandine Armor |Bronze Plate Mail%%Mail/4/2/0/-2/Bronze Plate Mail (Disguise) |Chain Mail%%Mail/5/2/0/-2/Chain Mail |Field Plate%%Plate/2/3/1/0/Field Plate (Disguise)|Full Plate%%Plate/1/4/3/0/Full Plate (Disguise)|Leather%%Leather/8/0/-2/0/Leather Armor|Plate Mail%%Mail/3/3/0/0/Plate Mail (Disguise)|Ring Mail%%Mail/7/1/1/0/Ring Mail |Scale Mail%%Mail/6/0/1/0/Scale Mail |Splint Mail%%Mail/4/0/1/2/Splint Mail (Disguise) |Studded Leather%%Leather/7/2/1/0/Studded Leather $$ armourPlus=What magical plus? |0%%0 |+1%%1 |+2%%2 |+3%%3 |+4%%4 |+5%%5 , qty:1, st:^^armourType#1^^, t:^^armourType#0^^, +S:^^armourType#3^^, +P:^^armourType#4^^, +B:^^armourType#5^^, +:^^armourPlus#1^^, ac:^^armourType#2^^, sz:L, wt:40, loc:body, rac:^^armourType#6^^] {{Speed=[[0]]}} {{Size=Large}} {{Immunity=None}} {{Saves=No effect}} {{Looks Like=A normal suit of some type of armour (DM to determine).}} {{Use=When storing this armour, the DM/player will be asked to state what type of armour it is and its magical plus (if any). It will then operate as chosen and can be passed from container to container without further input.}} {{desc=This appears to be a normal suit of magical armor (determine type and AC modifier normally, ignoring negative results). However, upon command (a command word can be assigned if the DM desires), the armor changes shape and form, assuming the appearance of a normal set of clothing. The armor retains all its properties (including weight) when disguised. Only a *true seeing* spell will reveal the true nature of the armor when disguised.}}
' + +'The query: attribute in the ACdata section defines the questions that will be asked in standard Roll20 Roll Queries. In this case, two separate questions are asked, each using the following format:
' + +'result-tag=query question|option 1 text%%value 1.1/value 1.2/.../value 1.n|option 2 text%%value 2.1/value 2.2/.../value 2.n|...%%.../.../...|option j text%%value j.1/value j.2/.../value j.n' + +'
Multiple queries can be concatinated, separated by \'$$\'. Each query posts the option texts in a list. The selected option will then provide the values that substitute dynamic attributes in the data section, which are specified with the syntax ^^result-tag#n^^ where \'n\' is the value index - index 0 is the option text itself. Using the Armour of Blending example, selecting an armour type of Plate Mail will replace the following dynamic attributes:
| t:^^armourType#0^^ | t:Plate Mail |
|---|---|
| st:^^armourType#1^^ | st:Mail |
| ac:^^armourType#2^^ | ac:3 |
| +S:^^armourType#3^^ | +S:3 |
| +P:^^armourType#4^^ | +P:0 |
| +B:^^armourType#5^^ | +B:0 |
| rac:^^armourType#6^^ | rac:Plate Mail (disguise) |
' + +'
3. Magic Items with Powers or Spell-Storing
' + +'Some magic items, especially artefacts and sentient items, can store spells and/or have powers similar to characters. MagicMaster supports magic items of this type to a degree, although there are inevitably exceptions that the DM will have to get creative in their development! These items use API buttons that call various MagicMaster commands to deliver their capabilities.
' + +'First to note is that items that have powers and spells use spell slots in the owning character\'s character sheet. These spell slots should not be used by characters in your campaign. If they are, errors might occur. By default, on the AD&D2E character sheet the system uses Wizard Level 14 spell slots for magic item powers, and Wizard Level 15 spell slots for spell-storing magic items. As standard AD&D2E only has spells up to level 9 this generally works without causing problems.
' + +'Next, in addition to the three standard elements of the Ability Macro, the \'ct-\' attribute and the listing, these items require a 4th element which specifies their powers and spells. These are:
' + +'| mi-muspells-[item-name]: | Wizard spells able to be stored in the magic item |
|---|---|
| mi-prspells-[item-name]: | Priest spells able to be stored in the magic item |
| mi-powers-[item-name]: | Powers able to be used by the magic item |
In each case the [item-name] is replaced by the Ability macro name (which is not case sensitive).
' + +'Note: The DM creating new spell storing or power wielding magic items does not need to worry about anything other than the Ability Macro in the database, as running the command --check-db will update all other aspects of the database appropriately for all databases, as long as the Specs and Data fields are correctly defined. Use the name of the particular database as a parameter to check and update just that database. Running the command --check-db with no parameters will check and update all databases.
' + +'When a spell-storing or power wielding magic item is added to a magic item bag or container using --edit-mi or --gm-edit-mi, these attributes are automatically added to the character sheet by the APIs and also they are parsed by the system and the spells and/or powers are created in the relevant spell books automatically. When such an item is found in a container by a character, or passed from character to character, all of the stored spells & powers are deleted from the old character and created in the new character. A character gaining such an item can use its spells and powers immediately.
' + +'3.1 Powerful Magic Item
' + +'Here is an example of a power wielding magic item:
' + +'Ring-of-Shooting-Stars
' + +'!setattr --silent --sel --casting-level|1 --casting-name|@{selected|token_name}\'s Ring of Shooting Stars
'
+ +'&{template:RPGMring}{{name=Ring of Shooting Stars}}{{subtitle=Ring}}Specs=[Ring of Shooting Stars,Ring,1H,Evocation]{{Speed=[[5]]}}RingData=[w:Ring of Shooting Stars,sp:5,rc:charged,ns:6], [cl:PW,w:MU-Dancing-Lights,sp:5,pd:12], [cl:PW,w:MU-Light,sp:5,pd:2], [cl:PW,w:RoSS-Ball-Lightning,sp:5,pd:1], [cl:PW,w:RoSS-Shooting-Stars,sp:5,pd:3], [cl:PW,w:Faerie-Fire,sp:5,pd:2], [cl:PW,w:RoSS-Spark-Shower,sp:5,pd:1] {{Size=Tiny}} {{Immunity=None}} {{Resistance=None}} {{Saves=None}} {{desc=This ring has two modes of operation - at night and underground - both of which work only in relative darkness.
'
+ +'***During night hours, under the open sky***, the shooting stars ring will perform the following functions:
'
+ +'- [*Dancing lights*](!magic --mi-power @{selected|token_id}|Dancing-Lights|Ring-of-Shooting-Stars|1) as spell (once per hour).
'
+ +'- [*Light*](!magic --mi-power @{selected|token_id}|Light|Ring-of-Shooting-Stars|1), as spell (twice per night), 120-foot range.
'
+ +'- [*Ball lightning*](!magic --mi-power @{selected|token_id}|RoSS-Ball-Lightning|Ring-of-Shooting-Stars|1), as power (once per night).
'
+ +'- [*Shooting stars*](!magic --mi-power @{selected|token_id}|RoSS-Shooting-Stars|Ring-of-Shooting-Stars|1), as power (special).
'
+ +'***Indoors at night, or underground***, the ring of shooting stars has the following properties:
'
+ +'[*Faerie fire*](!magic --mi-power @{selected|token_id}|PR-Faerie-Fire|Ring-of-Shooting-Stars|1) (twice per day) as spell
'
+ +'[*Spark shower*](!magic --mi-power @{selected|token_id}|RoSS-Spark-Shower|Ring-of-Shooting-Stars|1) (once per day) as power
'
+ +'Range, duration, and area of effect of functions are the minimum for the comparable spell unless otherwise stated. Casting time is 5}}
Note that the ability macro starts with a call to the ChatSetAttr API to set the casting-level to 1 and the name of the caster to be \< Character-name \>\'s Ring of Shooting Stars. Not strictly necessary, but a nice cosmetic.
' + +'The data section now includes repeating data sets, one for each of the powers that the item has:
' + +'RingData=[w:Ring of Shooting Stars,sp:5,rc:charged,ns:6], [cl:PW,w:MU-Dancing-Lights,sp:5,pd:12], …' + +'
The first data set is very similar to the standard magic item data, with the addition of the ns: field, and is then followed by a number of repeated data sets specifying each of the powers:
' + +'| ns: | <#> | The number of powers (or spells) that the item can wield or store |
|---|---|---|
| cl: | <MU/PR/PW> | The type of the power/spell specification: PW=power, MU=wizard spell, PR=priest spell |
| w: | <text> | The name of the power/spell - must be exactly the same as the database name (case ignored) optionally prefixed by a power type, one of \'PW-\', \'MU-\', \'PR-\', or \'MI-\' for Power, Wizard spell, Priest spell, or Magic Item |
| sp: | <[-/+]# / dice roll spec> | The speed or casting time of the power/spell in segments |
| pd: | <-1/#> | The available casts per day, or -1 for \'at will\' |
By running the --check-db command (see section 6 and the note above) these data sets are used to correctly set up the database with the powers wielded, so that when a Character receives this item, the Character also gains the powers to use through the item. If a power type prefix is included for one or more power name, the respective database is searched for a matching entry: thus a Wizard or Priest spell can be specified as a power without having to explicitly add a duplicate of it to a Powers Database. If no prefix is specified, the system will first search the Powers Databases (API-supplied and user-supplied) for a match and, if not found there, will then search the MU Spells Databases, the Priest Spells Databases, all Magic Items databases, and then the character sheet of the creature wielding the item power for a match, in that order. An error occurs if no matches are found anywhere.
' + +'Note: if a Character picks up two Power-wielding items with exactly the same item name (i.e. two copies of the same item) the results are unpredictable. This is best avoided. The GM can use the --gm-edit-mi menu to rename one or both items with a unique name to differentiate them: see the MagicMaster API documentation for details.
' + +'Feel free to just copy the specification for a Ring-of-Shooting-Stars in an extracted copy of the Rings database and save it to a new Ability Macro with a different name, and then alter the power names, speeds, and uses per day, as well as the API Button --mi-power commands and the other text, to form new power-wielding magic items. Also, the Ring does not have to have 6 powers - just remove or add one or more repeating data sets to reduce or increase the number of powers.
' + +'3.2 Spell Storing Magic Item
' + +'Here is an example of a spell-storing magic item:
' + +'Ring-of-Spell-Storing-HHSLS
' + +'&{template:RPGMring}{{name=Ring of Spell Storing with Haste x2, Slow, Light & Sleep}}{{subtitle=Ring}}Specs=[Ring of Spell Storing,Ring,1H,Conjuration-Summoning]{{Speed=[[5]] regardless of spell}}RingData=[w:Ring of Spell Storing HHSLS,sp:5,rc:uncharged,ns:5], [cl:MU,w:Haste,sp:5,lv:6], [cl:MU,w:Haste,sp:5,lv:6], [cl:MU,w:Slow,sp:5,lv:7], [cl:MU,w:Light,sp:5,lv:3], [cl:MU,w:Sleep,sp:5,lv:3] {{Size=Tiny}}{{Store spell=[Store Priest Spell](!magic --mem-spell MI-PR|@{selected|token_id})
'
+ +'[Store Wizard Spell](!magic --mem-spell MI-MU|@{selected|token_id})}}{{Cast spell=[View](!magic --view-spell mi-muspells|@{selected|token_id}) or [Cast](!magic --cast-spell MI|@{selected|token_id}) spells}}{{desc=A ring of spell storing contains 1d4+1 spells which the wearer can employ as if he were a spellcaster of the level required to use the stored spells. The class of spells contained within the ring is determined in the same fashion as the spells on scrolls (see "Scrolls"). The level of each spell is determined by rolling 1d6 (for priests) or 1d8 (for wizards). The number rolled is the level of the spell, as follows:
'
+ +'Priest: 1d6, if 6 is rolled, roll 1d4 instead.
'
+ +'Wizard: 1d8, if 8 is rolled, roll 1d6 instead.
'
+ +'Which spell type of any given level is contained by the ring is also randomly determined.
'
+ +'The ring empathically imparts to the wearer the names of its spells. Once spell class, level, and type are determined, the properties of the ring are fixed and unchangeable. Once a spell is cast from the ring, it can be restored only by a character of appropriate class and level of experience (i.e., a 12th-level wizard is needed to restore a 6th-level magical spell to the ring). Stored spells have a casting time of [[5]].}}
This is a specific version of a Ring of Spell Storing as the spells stored are specified in the macro. Alternatively, a blank Ring of Spell Storing is provided in the API Rings database. It is possible to use the --gm-edit-mi command menu to select this blank ring and use the facilities provided by the menu to add spells to this blank ring, and then rename it to reflect what the GM wants the ring to be. Again, see the MagicMaster API documentation for details.
' + +'The only new field in these data sets is:
' + +'| lv: | <#> | The level of the caster who cast the spell into the ring. The spell will have effects as if cast at this level when cast from the ring. |
|---|
The lv: field only specifies the level of the initial spell caster when the item is first found. Once owned and used, the level of the spell caster is recorded each time a spell is refreshed by casting into the item. As the item is then passed from one Character to another, or stored in a container and recovered later, the levels at which the spells were cast is retained. However, if the item is reloaded from the databases, or a duplicate of the item is placed by the DM and found by another character, that version of the item will have the spell caster levels from the database definitions. Note that if a single Character picks up two versions of exactly the same spell storing item (i.e. with the same item name) the results are unpredicable... The GM should use the --gm-edit-mi menu to rename one or both of the rings to give them unique names.
' + +'3.3 Flexible Spell-Storing Magic Items
' + +'Some spell-storing magic items are more flexible in what they can do than the standard Ring of Spell Storing. Here is an example of one that the player character can add spells to, and alter the spells stored (within certain limits):
' + +'Vibrant Purple Ioun Stone
' + +'&{template:RPGMitem}{{name=(Vibrant Purple)}}Specs=[Ioun Stone,Miscellaneous,0H,Stone]{{}}MiscData=[w:Vibrant Purple Ioun Stone,st:Floating Vibrant Purple Stone,wt:2,sp:3,qty:2d6,lvl:1,store:any,rc:single-uncharged]{{}}%{MI-DB|Ioun-Stone}{{Size=T}}{{Use=Can store "quantity" levels of spell that the possessor casts into it. [Store Spells](!magic --mem-spell MI-MU|@{selected|token_id}|Ioun-Stone-Vibrant-Purple) or [View Spells](!magic --view-spell MI|@{selected|token_id}|Ioun-Stone-Vibrant-Purple) or [Cast Spell](!magic --cast-spell MI|@{selected|token_id}||Vibrant Purple Ioun Stone||Ioun-Stone-Vibrant-Purple). The quantity/number of charges represents the number of levels of spell that can be stored.}}{{Looks Like=A vibrant purple prismatic stone that is floating in the air}}{{GM Info=This version of the Vibrant Purple Ioun Stone can store *any* spell and the player character can change the spells stored.}}
This data definition has a couple of features not previously seen.
' + +'The store: and lvl: data attributes: These attributes are unique to spell-storing magic items, and define limits on how spells can be stored in the item, using the !magic --mem-spell command.
| lvl: | [ 1 / 0 ] | Defaults to \'0\'. Flag restricting the total levels of spell that can be cast into the item to be the item\'s qty: / number of charges |
|---|---|---|
| store: | [ add / any / change / none ] | Defaults to none (or not specified). Specifies flexibility of spell storing |
| add | Allows the character to add additional stored spells to the item (up to any level limit) but stored spells can only be replaced by the same | |
| change | Allows the character to change what spell is stored in each slot (within any level limit), but not to add spells to additional slots | |
| any | Allows the character to both add additional spells and to change the currently stored spells (up to any level limit). |
Merging another item definition: Using the Roll20 standard syntax of %{...|...} to merge in another item data definition saves duplicating text that has already been written. The name before the \'pipe\' character (\'|\') is the name of the database to get the merged specification from - this can be a database held in memory by the APIs or a character sheet database: the APIs will work this out. The APIs only recognise the first Specs=[...] and Data=[...] they find, so these are presented in this definition before the %{...|...}. On the contraty, when displaying the template to a player, later {{ xxx=... }} with the same xxx will overwrite earlier ones, so the differences in the description for this particular item are placed after the %{...|...}.
' + +'3.4 Magic-Item-storing Items
' + +'Some items can store other items, including magic items. When such an item is viewed, used or exchanged between containers and characters, a character sheet specifically for the MI-storing item is created, or found if already previously created. The very act of viewing or using the item will trigger the creation or selection - there is no need for the GM or Player to do so. An example of this is a Bag of Holding.
' + +'Bag of Holding
' + +'&{template:RPGMitem}{{name=Bag of Holding}}{{subtitle=Magic Item}}Specs=[Bag of Holding,Miscellaneous,1H,Alteration]{{Size=[[15]]/[[250]]lbs, 30cu.ft}}MiscData=[w:Bag of Holding,st:Bag,sp:0,rc:uncharged,bag:2],[cl:MI,w:Potion-of-Healing,qty:1],[cl:MI,w:Scroll of Protection vs Magic,qty:2]{{Access=Drag the *Bag of Holding* token onto the map and use your MI menu *Search* function (to retrieve stuff from it) or *Store* function (to put stuff in it)}}{{desc=As with other magical bags, this one appears to be a common cloth sack of about 2 feet by 4 feet size. The Bag of Holding opens into a nondimensional space, and its inside is larger than its outside dimensions. Regardless of what is put into this item, the bag always weighs a fixed amount. This weight, the bag\'s weight limit in contents, and its volume limit are 15 lbs. 250 lbs. 30 cu. ft.
'
+ +'If overloaded, or if sharp objects pierce it (from inside or outside), the bag will rupture and be ruined. The contents will be lost forever in the vortices of nilspace.}}
The important attributes are:
' + +'| bag: | <#> | Identifies the item as generating an item character sheet. Up to # items can be defined as initially being held in the item sheet (default 0) |
|---|---|---|
| cl: | \'MI\' | Subsequent data sets with class \'MI\' define items initially held in the item, and will be inserted in a newly created item sheet when first viewed or used |
| w: | <text> | The name of the item to initially be stored in the item character sheet MI bag. Should be an item named in a database |
| qty: | <#> | The initial quantity of this item to be stored in the item-holding item character sheet MI bag (default 1) |
And one additional new attribute:
' + +'| st: | \'\' | Defines the "Item Type" (or SuperType) to be displayed when a container is searched that has its properties set to only show the types of items contained. If not provided, defaults to the item class from the Specs definition |
|---|
Thus, the definition of the particular Bag of Holding defined above, when a character has it in their Items & Equipment and either views or uses the item, will result in a new separate character sheet being created, named "Bag of Holding" (same as the item), placed in the controlling Player\'s journal and marked as controlled by that player, and for one Potion of Healing and two Scrolls of Protection vs. Magic to be inserted automatically into the Bag of Holding, ready for the Character to find and use by dragging the bag onto the map from their Journal and Searching the Bag.
' + +'Once the Bag is created, the existing items can be taken out into the Character\'s own items & equipment, or new ones placed in the bag, the bag passed from one Character to another or itself placed in a different container.
' + +'It is recommended that, where a GM places multiple item-holding items in a campaign, such as multiple Bags of Holding, that the GM uses the functions of the [Add Items] menu to rename each with a different name in the original container to which they are placed and before each is viewed or used (i.e. before the item character sheet is created by the system) - perhaps naming each after some previous owner or its creator. This prevents confusion with multiple Character Sheets all with the same name (which Roll20 will allow, but can definately be confusing for the GM who will see them all even if players only see the ones they control).
' + +'' + +'
4. Weapons (if using AttackMaster API)
' + +'Weapons, magical or not, are special types of items in the Magic Items databases. If coded properly (in the same way as those in the MI-DB-Weapons database), they can be used with the AttackMaster API to implement fully automatic weapon management, the ability to hold weapons "in-hand" or sheathed, to have automatic ammo and range management for ranged weapons, automatic entry of weapons into the melee and/or ranged weapons tables, ready to make attacks with magical plusses and other specifications all set up, and support for dancing weapons (ones that can attack without being held by the Character), creatures with more than 2 hands, and 1-handed weapons, 2-handed weapons, and even weapons that need more than 2 hands!
' + +'See the Weapon & Armour Database Help handout and AttackMaster API documentation for how Weapon definitions should be structured for use with the AttackMaster API, which are just a few additions to the standard definition of an item.
' + +'' + +'
5. Armour & Shields
' + +'Like weapons, armour and shields of all types (including magical armour like magical Bracers and Rings of Protection) can be coded to be used with the AttackMaster API to automatically calculate the appropriate AC for various scenarios (such as with & without Shield, from the back, if surprised, etc). This will take into account if the armour is valid for the character class, determine which is the best armour combination that the character has, if various armour elements can or can\'t work together, and add in Dexterity bonuses or impairments. It will also allow magical effects cast on the character to take effect or be adjusted via the token "circles" and highlight when such an effect is in place by showing the relevant token bar (only when there is a difference between the token AC and calculated AC).
' + +'See the Weapon & Armour Database Help handout and AttackMaster API documentation for how Armour & Shield definitions should be structured for use with the AttackMaster API, which are just a few additions to the standard definition of an item.
' + +'Also, see the RoundMaster API documentation for how magical effects can be placed on and affect tokens and characters.
' + +'' + +'
6. Specs & Data field values
' + +'Below are lists of the current possible values for the item database Ability macro sections.
' + +'6.1 Specs sections
' + +'Specs=[Type, Item-Class, Handedness, Group-Type]' + +'
There are no default settings for any of the Specs data fields. All must be explicitly specified.
' + +'7.1(a) Magic Item Types
' + +'There is an infinite list of magic item types: generally the type is the magic item name. A magic item can have more than one type, with each separated by a vertical bar character \'|\'
' + +'7.1(b) Magic Item Classes
' + +'Any magic item can have more than one class, each separated by a vertical bar \'|\'. It will then behave and be listed as each of the specified classes.
' + +'| Weapon | Weapons that are not Melee or Ranged weapons or any other class |
|---|---|
| Magic | Magic attacks that are not melee or ranged attacks, often a spell or power of a magic item |
| Melee | Melee weapons that are used in hand-to-hand combat |
| Innate-Melee | Melee weapons that do not attract any proficiency penalties |
| Ranged | Ranged weapons that are either thrown or fire ammunition |
| Innate-Ranged | Ranged weapons that do not attract any proficiency penalties |
| Ammo | All types of ammunition that is used by Ranged weapons |
| Armour | Any type of armour that does not need to be held to work |
| Armor | The same as Armour |
| Helm | Any type of armour or clothing worn on the head |
| Shield | A barrier that is held in hand(s) and defends against one or more attacks from the front |
| Protection-cloak | Any type of clothing that has protective qualities |
| Potion | Any type of potion, oil, pill or similar that is consumed or rubbed on |
| Scroll | Scrolls and spell books, that contain one or multiple spells |
| Scrollcase | An object that can hold a scroll |
| Wand | Wands that cast spells or spell-like effects when wielded in the hand |
| Staff | Quarterstaffs and similar large bludgeoning items that can also have spell-like abilities |
| Rod | Walking-stick sized rods that can do spell-like effects, especially when used to attack |
| Ring | Rings that are worn on a finger, one to each hand, that protect, have powers or spells |
| Protection-Ring | Any special type of ring that imparts protective qualities |
| Protection-[item] | Any item (other than clothing or a ring) that imparts protective qualities |
| Light | All types of lantern, torch, and other illumination |
| DM-item | An item that only appears in a list button on the menu displayed by --gm-edit-mi |
| Attack-macro | An attack macro template for a magic item held in a MI database |
| Miscellaneous | Anything that does not fit in one of the other categories |
| Unspecified | Items without any Specs section or an empty Class definition are listed under DM-Only |
7.1(c) Armour Handedness
' + +'0H Items that do not require to be held to work (e.g. a Ring, Buckler or a Helm)
'
+ +'1H An item that must be held in one hand to work, such as a Wand
'
+ +'2H Items that need two hands to wield, like a Staff
'
+ +'3H Items that need three hands to use, perhaps by two characters...
'
+ +'... etc.
7.1(d) Item Schools
' + +'Currently, all Magic Items other than Weapons and Armour use the same set of magical schools as for Spells & Powers, as they mostly perform spell-like effects. See section 7.1(d) for the list.
' + +'7.2 Data Sections
' + +'Definitions for Data Section field types for Weapons & Armour can be found in the AttackMaster API documentation. Below are the definitions for Spell, Power & other Magical Item types.
' + +'Note: Always refer to the database specification definitions in other sections above for detailed information on the use of these Field specifiers. Not all specifiers have an obvious use.
' + +'| Field | ' + +'Format | ' + +'Default Value | ' + +'Description | ' + +'Can be used in | ' + +'|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Spell Data | '
+ +' Potion Data | '
+ +' Scroll Data | '
+ +' Wand Data | '
+ +' Staff Data | '
+ +' Rod Data | '
+ +' Ring Data | '
+ +' Misc Data | '
+ +' ToHit Data | '
+ +' AC Data | '
+ +' ||||
| w: | < text > | \'-\' | Name to be displayed | X | X | X | X | X | X | X | X | X | |
| w: | < text > | \'\' | Name of spell or power (Not case sensitive) | X | |||||||||
| +: | [ + / - ] # | 0 | Magical adjustment | X | X | X | X | X | X | ||||
| n: | # [ / # ] | 1 | Attacks per round | X | X | X | X | X | |||||
| st: | < text > | \'\' | Item type to display | X | X | X | X | X | X | X | X | ||
| hide: | [hide / nohide] | \'\' | Hidden item status | X | X | X | X | X | X | X | X | ||
| rev: | [manual / view / use] | \'\' | Hidden item reveal trigger | X | X | X | X | X | X | X | X | ||
| sz: | [ t / s / m / l / h ] | \'\' | Size of item | X | X | X | X | X | X | X | |||
| sp: | [-]# or Dice Roll spec | 0 | Speed in segments (1/10 round) | X | X | X | X | X | X | X | X | X | |
| wt: | # | 1 | Weight of item in lbs | X | X | X | X | X | X | ||||
| rules: | [+/-][rule] | ... | 0 | Save / Check rules | X | X | X | X | X | X | ||||
| svXXX: | [=][+/-]# | 0 | Save / Check mod | X | X | X | X | X | X | ||||
| ppa: | [+/-]# | 0 | Pick Pocket mod | X | X | X | X | X | |||||
| ola: | [+/-]# | 0 | Open Locks mod | X | X | X | X | X | |||||
| rta: | [+/-]# | 0 | Find/Remove Traps mod | X | X | X | X | X | |||||
| msa: | [+/-]# | 0 | Move Silently mod | X | X | X | X | X | |||||
| hsa: | [+/-]# | 0 | Hide in Shadows mod | X | X | X | X | X | |||||
| dna: | [+/-]# | 0 | Detect Noise mod | X | X | X | X | X | |||||
| cwa: | [+/-]# | 0 | Climb Walls mod | X | X | X | X | X | |||||
| rla: | [+/-]# | 0 | Read Languages mod | X | X | X | X | X | |||||
| lla: | [+/-]# | 0 | Ledgend Lore mod | X | X | X | X | X | |||||
| on: | command | \'\' | Cmd to execute when worn | X | X | X | X | ||||||
| off: | command | \'\' | Cmd to execute when removed | X | X | X | X | ||||||
| ns: | # | 0 | Number of stored spells & powers defined for item | X | X | X | X | X | X | X | |||
| w: | < text > | \'-\' | Name of stored spell or power (Not case sensitive) | X | X | X | X | X | X | X | |||
| cl: | MU / PR / PW | \'\' | Type of stored spell or power | X | X | X | X | X | X | X | |||
| lv: | # | 1 | Level at which spell/power is cast | X | X | X | X | X | X | ||||
| pd: | -1 / # | 1 | Number per day (power only) | X | X | X | X | X | X | ||||
| rc: | Charged / Uncharged / Rechargeable / Recharging / Self-chargeable / Cursed / Charged-Cursed / Recharging-Cursed / Self-chargeable-Cursed | Uncharged | Initial charged and Cursed status of item when found (Can be changed by DM using -gm-only-mi command once added to Character Sheet) Not case sensitive | X | X | X | X | X | X | X | X | X | |
| c: | # | 1 | The number of charges expended by using a charged magic item. Uncharged items always use 0 charges | X | X | X | X | X | X | X | X | X | |
| desc: | [MU-/PR-/PW-/MI-]name | \' \' | Power or Spell to display | X | X | ||||||||
| msg: | < text > | \' \' | Attack message | X | X | ||||||||
| cmd: | Command | \' \' | Attack API command | X | X | ||||||||
| learn: | [ 0 | 1 ] | 0 | Learnable stored spells | X | X | ||||||||
' + +'
7.3 Character Sheet data fields
' + +'The Character Sheet field mapping to the API script can be altered using the definition of the fields object, the definition for which can be found at the top of the game-version-specific RPGMaster Library API for the game-version you are using. You can find the complete mapping for all APIs in the RPGMaster series, with an explanation of each, in a separate document - ask the Author for a copy.
' + +'Character Class & Race Databases
' + +'for RPGMaster APIs v'+version+' and later
' + +'' + +'
New in this Help Handout
' + +'- '
+ +'
- New Rogue class base skill modifiers ' + +'
- New Race modifiers for rogue skills ' + +'
- New Drag & Drop NPCs with calculated attributes, class, race & levels ' + +'
- New Drag & Drop NPCs and Creatures can have any number of random equip/magic items auto-allocated ' + +'
- New Drag & Drop NPC and Creature weapon allocations can have proficiency specified in definition ' + +'
- New Drag & Drop Rogue NPCs can have a specified level of randomness for rogue skill level mods ' + +'
2. Character Class Database
' + +'The DM can add Character Class databases as character sheets that have names that start with Class-DB. The Class definitions that come with the installed game-version-specific RPGMaster Library can be extracted to a character sheet and viewed by using the !magic --extract-db Class-DB or !attk --extract-db Class-DB commands. Note: it is best to delete the extracted Class-DB database character sheet after viewing/using, so that the system uses the much faster internal database version. After deleting or changing any character sheet database, always run the !magic --check-db or !attk --check-db command to re-index the databases.
' + +'Classes: Class-DB-[added name]
' + +'Those with version numbers of the form v#.# as part of the name will be ignored.
' + +'As previously stated, each class definition has 3 parts in the database (see Section 1): an Ability Macro with a name that is unique and matches the Class being defined, an Attribute with the name of the Ability Macro preceded by "ct-", and a listing in the database character sheet of the ability macro name separated by \'|\' along with others of the same base class: the base classes being "Warrior", "Wizard", "Priest", "Rogue", and "Psion". The quickest way to understand these entries is to examine existing entries. Do extract the root database using the --extract-db command and take a look (remember to delete it after viewing - see above)
' + +'Note: The DM creating new classes does not need to worry about anything other than the Ability Macro in the database, as running the command --check-db will update all other aspects of the database appropriately for all databases, as long as the Specs and Data fields in the Ability Macros are correctly defined. Use the name of the particular database as a parameter to check and update just that database. Running the command --check-db with no parameters will check and update all databases.
' + +'Ability macros can be added to a database just by using the [+Add] button at the top of the Abilities column in the Attributes and Abilities tab of the Database Character Sheet, and then using the edit "pencil" icon on the new entry to open it for editing. Ability macros are standard Roll20 functionality and not dependent on the API. Refer to the Roll20 Help Centre for more information.
' + +'Standard / Simple Class definitions
' + +'The Ability Macro for a Class may look something like this:
' + +'Thief
' + +'&{template:RPGMclass}{{name=Thief}}{{subtitle=Rogue Class}}{{Min Abilities=Dex:[[9]]}}{{Race=Any}}{{Hit Dice=1d6}}{{Alignment=Any not Lawful}}Specs=[Thief,RogueClass,0H,Rogue]{{=**Powers**}}{{1st Level=Thieving Abilities *Pick Pockets, Open Locks, Find/Remove Traps, Move Silently, Hide in Shadows, Detect Noise, Climb Walls,* and *Read Languages* Also, Thieves can *Backstab*}}{{10th Level=Limited ability to use magical & priest scrolls, with 25% chance of backfire}}ClassData=[w:Thief, hd:1d6, align:ng|nn|n|ne|cg|cn|ce, weaps:club|shortblade|fencingblade|dart|handxbow|lasso|shortbow|sling|broadsword|longsword|staff, ac:padded|leather|studdedleather|elvenchainmail|magicitem|ring|cloak, rp:60.30, ppa:15, ola:10, rta:5, msa:10, hsa:5, dna:15, cwa:60, rla:0, lla:0]{{desc=Thieves come in all sizes and shapes, ready to live off the fat of the land by the easiest means possible. In some ways they are the epitome of roguishness.
The profession of thief is not honorable, yet it is not entirely dishonorable, either. Many famous folk heroes have been more than a little larcenous -- Reynard the Fox, Robin Goodfellow, and Ali Baba are but a few. At his best, the thief is a romantic hero fired by noble purpose but a little wanting in strength of character. Such a person may truly strive for good but continually run afoul of temptation.}}
The ability specification for this Rogue class uses a Roll20 Roll Template, in this case defined by the RPGMaster Library (see the documentation for the Library for specifications of this Roll Template), but any Roll Template you desire can be used. The entries in the Roll Template itself can be anything you desire, giving as much or as little information as you want. However, the important elements for the RPGMaster APIs are those highlighted. Each of the elements important to the database are inserted between the elements of the Roll Template, meaning they will not be seen by the player when the macro is run. Generally spaces, hyphens and underscores in the data elements are ignored, and case is not significant. Each element is described below:
' + +'Specs = [Character Class, Macro Type, Handedness, Base Class]' + +'
The Specs section describes what Character Class and Base Class this is (and tells the APIs that this is a macro of type "Class"). These fields must be in this order. This format is identical for all database items, whether in these databases or others used by the RPGMaster series of APIs. Where there are multiple answers for a field, separate each by \'|\'. Note:Only A-Z, a-z, 0-9, hyphen/minus(-), plus(+), equals(=) point(.) and vertical bar(|) are allowed. Replace any forward slash with hyphen.
' + +'| Character Class | the Character Class name, often the same as the ability macro name. |
|---|---|
| Macro Type | the type of the data in this Ability Macro, one of WarriorClass, WizardClass, PriestClass, RogueClass, or PsionClass. |
| Handedness | #H, where # is the number of hands needed to be a character of this class (not currently used). |
| Base Class | the base class that this class belongs to, one of Warrior, Wizard, Priest, Rogue, or Psion. |
ClassData=[w:Thief, hd:1d6, align:ng|nn|n|ne|cg|cn|ce, npp:-3, weaps:club|shortblade|dart|handxbow|lasso|shortbow|sling|broadsword|longsword|staff, ac:padded|leather|studdedleather|elvenchain|magicitem|ring|cloak]' + +'
The ClassData section specifies the data relating to the class. These fields can be in any order.
' + +'| w: | <text> | the name of the class |
|---|---|---|
| align: | <lg|ln|le|ng|nn|n|ne|cg|cn|ce> or <any> | the valid alignments for characters of this class, separated by \'|\' (not currently restricted) |
| attr: | #[:#] | minimum and maximum starting attribute values (default is 3:18) |
| race: | <list of races> or <any> | the races that can take this class, separated by \'|\' (not currently restricted) |
| hd: | <dice roll spec> | the dice roll specification for hit points at each level (not currently used, for future expansion) |
| npp: | <[-/+]#> | optional field to set a bespoke non-proficient weapon penalty for the character class. If not provided defaults to that for the Base Class. |
| weaps: | <list of weapons & weapon types> or <any> | a vertical bar \'|\' separated list of weapons and weapon types that are valid for the class (see the Weapons database/documentation for types). Preceeding by \'!\' means \'not this weapon\' and with \'+\' means \'include this whatever\' |
| ac: | <list of armour types> or <any> | a vertical bar \'|\' separated list of armour and armour types that are valid for the class (see the Weapons database/documentation for types). \'!\' and \'+\' work the same as for weapons |
The list of weapons and weapon types listed after the "weaps:" tag are checked by the system when a character tries to take a weapon in-hand using the "Change Weapons" dialogue or AttackMaster --weapon command, as determined by the API configuration setting, accessed via the MagicMaster or AttackMaster --config command. This configuration can be to restrict weapons to those listed ("Strict" mode), to give unlisted weapons a penalty of double the non-proficient weapon penalty for the base class ("Lax" mode), or to ignore this list and allow any weapon to be proficient or to just get the standard non-proficient weapon penalty ("Allowed" mode).
' + +'In exactly the same way as for weapons, armour and armour types listed after the "ac:" tag are checked when calculating the Armour Class of the character using the "Check AC" dialogue or AttackMaster --checkac command, or automatically by the APIs at various points when AC might change, again according to the API configuration settings accessed via the --config command. This configuration can restrict a class to the armours and armour types listed for the class ("Rules" mode), or not restrict usage at all ("Allowed" mode).
' + +'Three additional field tags are optionally available to allow the default weapon attacks per round progression to be overridden with a bespoke progression. Any one, two or all three can be specified: if just the progression level sequence is given, these levels will override the default levels, and similarly for the melee and ranged weapon mods, and defaults will be used or those not overridden. This only works for classes that are types of Warrior. The defaults are those specified for the Warrior class in the Player\'s Handbook.
' + +'| attkl: | <0|#|#|...> | a vertical bar \'|\' separated list of levels (the first must be 0) at which the next higher number of attacks per round is achieved. |
|---|---|---|
| attkm: | <#|#|#|...> | a vertical bar \'|\' separated list of modifications to the standard number of attacks per round for any melee weapon used. Each can be an integer, a decimal float (# . #) or a fraction (# / #) |
| attkr: | <#|#|#|...> | a vertical bar \'|\' separated list of modifications to the standard number of attacks per round for any ranged weapon used. Each can be an integer, a decimal float (# . #) or a fraction (# / #) |
Changing the Default Saving Throws
' + +'The default Saving Throw table from the Player\'s Handbook can be overridden for any class definition. A new set of base saving throws by experience level can be defined.
' + +'Dwarven Defender
' + +'&{template:RPGMclass}{{name=Dwarven Defender}}{{subtitle=Warrior Class}}{{Min Abilities=Str:[[12]], Con:[[15]]}}{{Race=Dwarf only}}{{Alignment=Any}}Specs=[Dwarven Defender,WarriorHRClass,0H,Warrior]{{Hit Dice=1d12}}{{=**Powers**}}{{1st Level=*Defensive Stance* (1/4 levels per day}}ClassData=[w:Fighter, align:any, hd:1d12, race:dwarf, weaps:axe|club|flail|longblade|fencingblade|mediumblade|shortblade|polearm, ac:any, svl0:16|18|17|20|19, svl1:12|17|15|16|15, svl3:11|16|14|15|14, svl5:10|14|12|12|12, svl7:9|13|11|11|11, svl10:7|11|9|8|9, svl13:4|9|6|5|7, sv16:2|7|4|3|4, ns:1][cl:PW, w:Defensive-Stance, lv:1, pd:1l4]{{desc=The Dwarven defender is a formidable warrior. They are trained in the art of defence from a young age and make a defensive line nearly unbreakable.
'
+ +'The class is limited to Dwarves.
'
+ +'They can wear any armour but tend to go with the heaviest and toughest they can afford. They always use a shield, whenever possible a special Dwarven Tower shields (+1 in melee but +3 vs missiles when braced and in position). To use a Tower Shield requires a weapon proficiency slot. The dwarven Tower Shield has to be acquired in the campaign, it isn’t just granted to the character on creation (it’s a bit like a Paladins Warhorse). It may take many levels before they get a quest to acquire one.
'
+ +'They can only become proficient, specialise and double specialise in axes (not great axes) or hammers. They can never use missile weapons like a bow or crossbow but can throw hammers or axes.
'
+ +'They get bonus non weapon proficiency slots in Armourer, Blacksmithing and Mining.}}
In addition to the elements described previously, the ClassData section specifies new elements regarding saving throws (ignore the ns: and everything beyond for now):
' + +'ClassData=[w:Fighter, align:any, hd:1d12, race:dwarf, weaps:axe|club|flail|longblade|fencingblade|mediumblade|shortblade|polearm, ac:any, svl0:16|18|17|20|19, svl1:12|17|15|16|15, svl3:11|16|14|15|14, svl5:10|14|12|12|12, svl7:9|13|11|11|11, svl10:7|11|9|8|9, svl13:4|9|6|5|7, svl16:2|7|4|3|4, ns:1]' + +'
Each svl# element specifies the base saves at and above experience level "#", for the five standard base save types, Paralysation, Poison & Death | Rod, Staff & Wand | Petrification & Polymorph | Breath Weapon | Spells. The highest specification element applies to all higher experience levels.
' + +'Magic Items, Race definitions, and other database elements that affect a character can specify modifications to the base Saving Throws (whether using the defaults or custom Class specifications) by using the data element svXXX:[+-=]#,, where "XXX" is one of par, poi, dea, rod, sta, wan, pet, pol, bre, spe or sav for all saving throws, str, dex, con, int, wis, chr or atr for all character attributes, or all for everything, followed by a colon, then a plus (+), a minus (-), an equals (=), and a number, or just a number with nothing before it. Each of the three-letter qualifiers refers to the relevant save, except "all" which applies the modifier to all saves. Preceeding the modifier amount by plus (+) or nothing improves the save by the modifier, preceeding by minus (-) worsens the save by the modifier, and by equals (=) overrides any other modifier being applied and applies only the best modifier of that type from all items preceeded by an equals. Obviously, racial mods apply at all times (unless overridden by a magic item using the "=" modifier), and magic item mods only apply if the character has the magic item in their held items.
' + +'It is also possible to specify rules for when the specified saving throw/ability check modifiers are valid. These are specified by including the data tag rules:. See the Magic Database Help handout for more information on rules:.
' + +'Restricting the Schools and Spheres of Spells available
' + +'While standard Wizards and Priests are very similar to the standard specification above, the definitions of specialist spellcaster classes is slightly more complex.
' + +'Conjurer
' + +'&{template:RPGMclass}{{name=Conjurer}}{{subtitle=Wizard Class}}{{Min Abilities=Int:[[9]], Con:[[15]]}}{{Alignment=Any}}{{Race=Human & Half Elf}}{{Hit Dice=1d4}}Specs=[Conjurer,WizardClass,0H,Wizard]{{=**Spells**}}{{Specialist=Conjuration / Summoning}}{{Banned=Greater Divination & Invocation}}ClassData=[w:Conjurer, hd:1d4, race:human|halfelf, sps:conjuration|summoning|conjurationsummoning, spb:greaterdivination|invocation, weaps:dagger|staff|dart|knife|sling, ac:magicitem|ring|cloak]{{desc=This school includes two different types of magic, though both involve bringing in matter from another place. Conjuration spells produce various forms of nonliving matter. Summoning spells entice or compel creatures to come to the caster, as well as allowing the caster to channel forces from other planes. Since the casting techniques and ability requirements are the same for both types of magic, conjuration and summoning are considered two parts of the same school.}}
' + +'ClassData=[w:Conjurer, hd:1d4, race:human|halfelf, sps:conjuration|summoning|conjurationsummoning, spb:greaterdivination|invocation, weaps:dagger|staff|dart|knife|sling, ac:magicitem|ring|cloak]' + +'
The ClassData for specialist casters includes additional tags to specify the schools/spheres of magic that the caster can and cannot use (and for priests major and minor access to spheres).
' + +'| sps: | <text|text|...> or <any> | a list of specialist schools or major spheres separated by vertical bars (\'|\') |
|---|---|---|
| spb: | <text|text|...> | a list of banned schools/spheres that this class is not allowed to use separated by vertical bars (\'|\') |
| spm: | <text|text|...> | a list of minor spheres (only relevant to Priest classes) separated by vertical bars (\'|\') |
The spellcaster will be restricted to memorising only spells from the schools/spheres listed depending on the API configuration using the --config command. The configuration can be to restrict to the specified schools/spheres ("Strict" mode) or allow all at any level ("Allowed" mode). The DM will also have a single button to add all valid spells at all levels to a Priest character sheet using the [Token-setup] macro or the !cmd --abilities command, and then using the [Add to Spellbook] / [Priest] dialogue.
' + +'Default spells and spells per level
' + +'Using the classes called "Wizard" or "Priest" will always grant the standard Wizard and Priest spells per level respectively as per the Player\'s Handbook, thus the class specifications are no different from that above. Also, any class name placed in the Wizard class fields (e.g. the second class definition column of the Advanced 2e sheet) will get standard Wizard spell casting capabilities (unless otherwise specified as below), and those in the Priest class fields (e.g. the third class definition column of the Advanced 2e sheet) will get standard Priest spell casting capabilities (unless otherwise specified as below).
' + +'Non-standard spells per level
' + +'A non-standard spellcaster (such as a Ranger, Paladin or Bard, or any class you wish to specify of a similar nature) can have their spellcasting capabilities specified in the class definition:
' + +'Priest of Magic
' + +'&{template:RPGMclass}{{name=Priest of Magic}}{{subtitle=Priest Class}}{{Min Abilities=Wis:[[12]], Int:[[13]]}}{{Race=Human or Half Elf}}{{Hit Dice=1d8}}{{Reference=*House Rules v16*}}{{=**Alignment**}}{{Deity=True Neutral}}{{Priests=Any Neutral}}{{Flock=Any Alignment}}{{ =**Spells**}}{{Major Spheres=All, Divination, Protection, Healing, Elemental}}{{Minor Spheres=Sun}}Specs=[Priest of Magic,PriestClass,0H,Priest]{{Powers=None}}ClassData=[w:Priest of Magic, hd:1d8, race:human|halfelf, align:ng|nn|n|ne, weaps:dagger|staff|dart|knife|sling, ac:any, sps:any, slv:4|3|12|MU, spl1:1|2|2|3|3|3|4|4|4|4|5|5, spl2:0|0|1|1|2|2|3|3|3|4|4|4, spl3:0|0|0|0|1|1|2|2|3|3|3|3, spl4:0|0|0|0|0|0|1|1|1|2|2|3],[w:Priest of Magic, sps:all|divination|protection|healing|elemental, spm:sun, slv:7|1|100|PR, spl1:1|2|2|3|3|3|3|3|3|3|3|3|3|3|4|4|4|4|4, spl2:0|0|1|1|2|2|3|3|3|3|3|3|3|3|3|4|4|4|4, spl3:0|0|0|0|0|1|1|2|2|3|3|3|3|3|3|3|4|4|4, spl4:0|0|0|0|0|0|0|0|1|1|2|2|3|3|3|3|3|4|4, spl5:0|0|0|0|0|0|0|0|0|0|0|1|1|2|2|3|3|3|4, spl6:0|0|0|0|0|0|0|0|0|0|0|0|0|0|1|1|2|2|3, spl7:0|0|0|0|0|0|0|0|0|0|0|0|0|0|1|1|2|2|2]{{desc=The Priest of Magic is an optional character class that can be used if your DM allows. It is a curious class in that it is a priest of the god of Magic, who then grants the priest the use of some limited Wizard spells as well as a slightly more restricted range of clerical spells.}}
' + +'The Priest of Magic (a "House Rules" class for my group) can cast some Wizard spells at the expense of loosing some Priest spellcasting capability. Its class definition has ClassData for both "MU" and "PR" spells, in two separate sections (enclosed in each comma-separated \'[...]\').
' + +'| slv: | <#|#|#|(MU/PR)> | three numbers followed by either MU or PR (no brackets), separated by vertical bars (\'|\'). The first number is the highest level of spell that can be cast, the second the first class level at which spells can be cast, and the third the maximum casting level, followed by the class of spells being specified (MU=Wizard, PR=Priest) |
|---|---|---|
| spl#: | <#|#|#|...> | for spells of level spl#, starting at the class level at which spells can be cast, the numbers of spells that can be cast at that and subsequent levels |
| specmu: | [ 0 | 1 ] | (not shown above) a flag signifying whether a non-standard wizard-type spellcaster is a specialist or not, granting the extra spell per level if \'1\' |
New Base Rogue Skill values
' + +'Rogues, the sub-classes of rogue such as Thieves and Bards, can have the base value defined for their rogue skills, such as picking pockets and opening locks.
' + +'&{template:RPGMclass}{{name=Thief}}{{subtitle=Rogue Class}}{{Min Abilities=Dex:[[9]]}}{{Race=Any}}{{Hit Dice=1d6}}{{Alignment=Any not Lawful}}Specs=[Thief,RogueClass,0H,Rogue]{{=**Powers**}}{{1st Level=Thieving Abilities *Pick Pockets, Open Locks, Find/Remove Traps, Move Silently, Hide in Shadows, Detect Noise, Climb Walls,* and *Read Languages* Also, Thieves can *Backstab*}}{{10th Level=Limited ability to use magical & priest scrolls, with 25% chance of backfire}}ClassData=[w:Thief, hd:1d6, align:ng|nn|n|ne|cg|cn|ce, weaps:club|shortblade|fencingblade|dart|handxbow|lasso|shortbow |sling|broadsword|longsword|staff, ac:padded|leather|studdedleather|elvenchainmail|magicitem|ring|cloak, rp:60.30, ppa:15, ola:10, rta:5, msa:10, hsa:5, dna:15, cwa:60, rla:0, lla:0]{{desc=Thieves come in all sizes and shapes, ready to live off the fat of the land by the easiest means possible. In some ways they are the epitome of roguishness.
The profession of thief is not honorable, yet it is not entirely dishonorable, either. Many famous folk heroes have been more than a little larcenous -- Reynard the Fox, Robin Goodfellow, and Ali Baba are but a few. At his best, the thief is a romantic hero fired by noble purpose but a little wanting in strength of character. Such a person may truly strive for good but continually run afoul of temptation.}}
The base value for rogue skills used by this class of character are specified using the following tags:
' + +'| ppa:[+/-]# | Specifies the base skill percentage for pick pockets (+ is beneficial) |
|---|---|
| ola:[+/-]# | Specifies the base skill percentage for open locks (+ is beneficial) |
| rta:[+/-]# | Specifies the base skill percentage for find/remove traps (+ is beneficial) |
| msa:[+/-]# | Specifies the base skill percentage for move silently (+ is beneficial) |
| hsa:[+/-]# | Specifies the base skill percentage for hide in shadows (+ is beneficial) |
| dna:[+/-]# | Specifies the base skill percentage for detect noise (+ is beneficial) |
| cwa:[+/-]# | Specifies the base skill percentage for climb walls (+ is beneficial) |
| rla:[+/-]# | Specifies the base skill percentage for read languages (+ is beneficial) |
| lla:[+/-]# | Specifies the base skill percentage for legend lore (+ is beneficial) |
| rp:#.# | Specifies the base.increase for player allocatable skill points |
Not every tag needs to be specified. The default value for any missing specification of a rogue skill is zero.
' + + +'Classes with Specific Powers
' + +'A character class can also be granted powers, and these can be specified in the class definition both as text for the Player to read, and also coded so the APIs can read them.
' + +'Priest of Light
' + +'&{template:RPGMclass}{{name=Priest of Light}}{{subtitle=Priest Class}}{{ =**Alignment**}}{{Deity=Neutral Good}}{{Priests=Any Good}}{{Flock=Any Neutral or Good}}{{Hit Dice=1d8}}Specs=[Priest of Light,PriesthoodClass,0H,Priest]{{ =**Powers**}}{{1st Level=*Infravision, Turn Undead*}}{{3rd Level=*Laying on Hands*}}{{5th Level=*Charm/Fascination*}}{{9th Level=*Prophecy*}}{{ =**Spells**}}{{Major Spheres=All, Charm, Divination, Healing and Sun}}{{Minor Spheres=Animal, Creation, Necromantic and Plant}}ClassData=[w:Priest of Light, align:LG|NG|CG, hd:1d8, weaps:bow|crossbow|dagger|dirk|dart|javelin|knife|slings|spear, ac:leather|padded|hide|magicitem|ring|cloak, sps:all|charm|divination|healing|sun, spm:animal|creation|necromantic|plant, ns:5][cl:PW, w:Infravision, lv:1, pd:-1][cl:PW, w:Turn Undead, lv:1, pd:-1][cl:PW, w:Laying on Hands, lv:3, pd:1][cl:PW, w:Charm-Fascination, lv:5, pd:1][cl:PW, w:Prophecy, lv:9, pd:1]{{desc=The god of all forms of light: Sunlight, moonlight, firelight, etc. The god is a friend of life, a patron of magic, a proponent of logical thought, and an enemy of the undead.
'
+ +'The priesthood of the god is devoted to celebrating these aspects of the god and to promoting positive forces such as healing.
'
+ +'Lesser gods of this attribute would be gods of one aspect of light. One god might be the god of Reason, another the god of Inspiration, etc.
'
+ +'This deity is as likely to be male as female.
'
+ +'The priests of this god are on good terms with the priests of Arts, Crafts, Darkness/Night, Dawn, Elemental Forces, Fire, Healing, Hunting, Literature/Poetry, Magic, Metalwork, Moon, Music/Dance, Oracles/Prophecy, and Sun.}}{{Reference=*The Complete Priest\'s Handbook* Sample Priesthoods}}
The ClassData specification now has a tag of ns: which specifies a following number of sections enclosed in square brackets (\'[...]\'), each of which defines a single power granted to characters of this class. These sections include the following fields:
' + +'| ns: | <1> | specifies a following number of sections each of which defines a single power granted to characters of this class |
|---|---|---|
| cl: | <PW> | specifies the type of granted capability - for Class definitions, this is always PW (standing for Power) |
| w: | <text> | the name of the power granted (which should match a definition in the Powers database Powers-DB) |
| lv: | <#> | the character level at which they will gain this power |
| age: | <#> | (not shown above) the character age value at which they will gain this power (used for e.g. dragons). The age value is stored in @{selected|age|max} |
| pd: | < -1 / # / #L# > | the number of times per day the power can be used. A number, or -1 (meaning "at will"), or #L# which is first number per second number levels per day (e.g. 1L4 means once per day for L1 to L4, twice L5 to L8, etc) |
This allows the DM to use a single button to add all the specified powers to the Powers list of a specific character sheet using the [Token-Setup] macro or the !cmd --abilities command, and then using the [Add to Spellbook] / [Powers] dialogue. The Player will then only be able to memorise the appropriate powers for the character\'s level.
' + +'3. Race & Creature Databases
' + +'Exactly as with Character Classes, the DM can also add Race databases as character sheets that have names that start with Race-DB. The Race definitions that come with the installed game-version-specific RPGMaster Library can be extracted to a character sheet and viewed by using the !magic --extract-db Race-DB or !attk --extract-db Race-DB commands, and Creature definitions can be extracted by replacing "Race-DB" with "Race-DB-Creatures". Note: it is best to delete the extracted database character sheet after viewing/using, so that the system uses the much faster internal database version. After deleting or changing any character sheet database, always run the !magic --check-db or !attk --check-db command to re-index the databases.
' + +'Races: Race-DB-[added name]
Creatures: Race-DB-Creatures-[added name]
Those with version numbers of the form v#.# as part of the name will be ignored.
' + +'As previously stated, each database definition has 3 parts in the database (see Section 1), the same as for the Class Database explanation above. Note: The DM creating new classes does not need to worry about anything other than the Ability Macro in the database, as running the command --check-db will update all other aspects of the database appropriately.
' + +'Ability macros can be added to a database just by using the [+Add] button at the top of the Abilities column in the Attributes and Abilities tab of the Database Character Sheet, and then using the edit "pencil" icon on the new entry to open it for editing. Ability macros are standard Roll20 functionality and not dependent on the API. Refer to the Roll20 Help Centre for more information.
' + +'Standard / Simple Race Definitions
' + +'The database definition for a simple, standard Race might look something like this:
' + +'Human
' + +'&{template:RPGMdefault}{{name=Human}}{{subtitle=Race}}Specs=[Human,HumanoidRace,0H,Humanoid]{{Alignment=Any}}{{Languages=Often *common*}}{{Height=Males [60+2d10](!
/r 60+2d10 ins height)ins, Females [58+2d10](!
/r 58+2d10 ins height)ins}}{{Weight=Males [140+6d10](!
/r 140+6d10 lbs weight)lbs, Females [100+6d10](!
/r 100+6d10 lbs weight)lbs}}{{Life Expectancy=95 years}}{{Section=**Attributes**}}{{Minimum=None}}{{Maximum=None}}{{Adjustment=None}}{{Section1=**Powers**}}{{Section2=None}}{{Section3=**Special Advantages**}}{{Section4=None}}{{Section5=**Special Disadvantages**}}{{Section6=None}}RaceData=[w:Human, align:any, weaps:any, ac:any]{{desc=Although humans are treated as a single race in the AD&D game, they come in all the varieties we know on Earth. A human PC can have whatever racial characteristics the DM allows.
'
+ +'Humans have only one special ability: They can be of any character class and rise to any level in any class. Other PC races have limited choices in these areas.
'
+ +'Humans are also more social and tolerant than most other races, accepting the company of elves, dwarves, and the like with noticeably less complaint.
'
+ +'Because of these abilities and tendencies, humans have become significant powers within the world and often rule empires that other races (because of their racial tendencies) would find difficult to manage.}}
As with Class definitions, and any other RPGMaster database entry, a Roll Template is used for formatting and the text in the template can be whatever you desire to display. The important elements for the RPGMaster APIs are highlighted and, as elsewhere, they are between the elements of the Roll Template to hide them when displayed, case is ignored and spaces, hyphens and underscores can be used but are ignored. Each element is described below:
' + +'Specs=[Human,HumanoidRace,0H,Humanoid]' + +'
The Specs section for a race describes the Sub-Race and base Race for the entry, and that this is a race definition. The fields must be in this order, identical for all database items.
' + +'| Sub-Race | the Sub-Race or Race name, often the same as the ability macro name. |
|---|---|
| Macro Type | the type of the data in this Ability Macro, one of HumanoidRace, HumanoidCreature, or CreatureRace. |
| Handedness | #H, where # is the number of hands needed to be a character of this race (not currently used). |
| Base Race | the base race that this sub-race belongs to, and can be any other race in the database. For PCs generally one of Dwarf, Elf, Half-Elf, Halfling, Half-Orc, Human, or Gnome. |
The Sub-Race will "inherit" any data definitions and powers defined for the Base Race unless they are specifically overwritten or excluded by the Sub-Race definition. This reduces inconsistencies and the work of entering multiple duplications.
' + +'RaceData=[w:Human, align:any, weaps:any, ac:any]' + +'
All the same data fields (that are relevant) are available as for a Class definition. Where both the Class and Race of a character have specified restrictions or allowances, both the Class and the Race must allow an item / spell to be used. Whereas two Classes combine permissions as Class A OR Class B, Class and Race are Class AND Race. So a Warrior class can use a Greatsword, but a Warrior Gnome may not be able to use it as it would hit the ground as they wielded it!
' + +'Save and To-Hit Modifiers
' + +'There are a number of additional data fields relevant to Races:
' + +'Halfling
' + +'&{template:RPGMdefault}{{name=Halfling}}{{subtitle=Race}}{{Alignment=Any (Usually NG)}}Specs=[Halfling,HumanoidRace,0H,Humanoid]{{Languages=Often *common, halfling, dwarf, elf, gnome, goblin,* and *orc*}}{{Height=Males [32+2d8](!
/r 32+2d8 ins height)ins, Females [30+2d8](!
/r 30+2d8 ins height)ins}}{{Weight=Males [52+5d4](!
/r 52+5d4 lbs weight)lbs, Females [48+5d4](!
/r 48+5d4 lbs weight)lbs}}{{Life Expectancy=100 to 150 years}}{{Section=Attributes}}{{Minimum=Str:7, Con:7, Dex:10, Int:6}}{{Maximum=Wis:17}}{{Adjustment=Dex:+1, Str:-1}}{{Section1=Powers}}{{Expert Miners=Stouts can detect slopes, and approximate direction underground}}{{Section2=Special Advantages}}{{Infravision=Any halfling character has a 15% chance to have normal infravision (this means he is pure Stout), out to 60ft; failing that chance, there is a 25% chance that he has limited infravision (mixed Stout/Tallfellow or Stout/Hairfeets lineage), effective out to 30 feet.}}{{Magic Resistance=Magic-resistant, giving a bonus to saving throws against magical wands, staves, rods, and spells of +1 for every 3.5 points of Constitution score.}}{{Poison Resistance=Save vs. poison at +1 for every 3.5 points of Constitution score.}}{{Attack bonus=+1 To Hit with slings and thrown weapons}}{{Surprise=Enemies get a –4 penalty to surprise if the halfling is: 1) moving alone, 2) is 90 feet away from the rest of their party, or 3) is with other elves or halflings and all are in nonmetal armor. If the halfling must open a door or screen to get to the enemy, the penalty is reduced to –2.}}RaceData=[w:Halfling, align:any, weaps:any, ac:any, attr:str=7|con=7|dex=10|int=6|wis=1:17, thmod:throwing=1|dart=1|hand-axe=1|magical-stone=1|slings=1, svatt:con, svpoi:3.5 svrod:3.5, svsta:3.5, svwan:3.5, svspe:3.5, ns:2],[cl:PW,w:Detect Slope,lv:0,sp:0,pd:-1],[cl:PW,w:Determine Direction Underground,lv:0,sp:0,pd:-1]{{desc=Halflings are short, generally plump people, very much like small humans. Their faces are round and broad and often quite florid. Their hair is typically curly and the tops of their feet are covered with coarse hair. They prefer not to wear shoes whenever possible. Halflings see wealth only as a means of gaining creature comforts, which they love. Though they are not overly brave or ambitious, they are generally honest and hard working when there is need.
'
+ +'Elves generally like them in a patronizing sort of way. Dwarves cheerfully tolerate them, thinking halflings somewhat soft and harmless. Gnomes, although they drink more and eat less, like halflings best, feeling them kindred spirits. Because halflings are more open and outgoing than any of these other three, they get along with other races far better.
'
+ +'There are three types of halflings: Hairfeets, Tallfellows, and Stouts. Hairfeets are the most common type, but for player characters, any of the three is acceptable.}}
| attr: | #[:#] | minimum and maximum starting attribute values (default is 3:18) |
|---|---|---|
| svXXX[+]: | [+ - =] # | saving throw modifiers |
| thmod: | weapon=[+-]# | weapon=[+-]# | ... | a list of weapon type (or super-type) to-hit modifiers separated by vertical bars (\'|\') |
The saving throw modifiers are cumulative with those relevant to a Class and/or to worn/held magic items. The XXX can be one of att, par, poi, dea, rod, sta, wan, pet, pol, bre, spe or all, optionally followed by a "+" (see next paragraph), followed by a colon, then a plus (+), a minus (-), an equals (=), and a number, or just a number with nothing before it. Each of the three-letter qualifiers refers to the relevant save, except "all" which applies the modifier to all saves, and "att" which specifies an attribute by whose value any save may vary. Preceding the modifier amount by plus (+) or nothing improves the save by the modifier, preceding by minus (-) worsens the save by the modifier, and by equals (=) overrides any other modifier being applied and applies only the modifier preceded by the equals.
' + +'If the XXX is followed by a "+" (e.g. like svpoi+:3), the save modifier will be a straight addition to (or subtraction from) the saving throw. Otherwise, the value of the attribute defined by the "svatt:" (which can be str, con, dex, int, wis, or chr, defaulting to con) is divided by the modifier provided and rounded down: e.g. if svatt:con and svpoi:3.5, a Constitution of 12 will result in a poison save bonus of 3.
' + +'To-Hit modifiers are supplied as a list separated by vertical bars. Each entry is a weapon type or weapon super-type, followed by "=", followed by a number preceded by an optional "+" or "-". A plus (+) improves the chance of hitting, and a minus (-) is a penalty. Any weapon of the specified type or super-type will get the modifier.
' + + +'New Rogue Race Modifiers
' + +'Each race might have different modifiers to the success percentage for rogue skills. Such differences can be specified in the Race data.
' + +'Gnome
' + +'&{template:RPGMdefault}{{title=Gnome}}{{subtitle=Race}}Specs=[Gnome,HumanoidRace,0H,Humanoid]{{Alignment=Any (Usually NG)}}{{Languages=Often *common, dwarf, gnome, halfling, goblin, kobold,* and the simple common speech of burrowing mammals (*moles, badgers, weasels, shrews, ground squirrels,* etc.)}}{{Height=Males [38+d6](!
/r 38+1d6 ins height)ins, Females [36+d6](!
/r 36+1d6 ins height)ins}}{{Weight=Males [72+5d4](!
/r 72+5d4 lbs weight)lbs, Females [68+5d4](!
/r 68+5d4 lbs weight)lbs}}{{Life Expectancy=350 years}}{{Section=**Attributes**}}{{Min Attributes=Str:6, Con:8, Int:6}}{{Attribute Adj.=Int:+1, Wis:-1}}{{Section1=**Powers**}}{{Expert Miners=Detect slopes, unsafe walls, cielings & floors, determine approximate depth and direction underground}}{{Section3=**Special Advantages**}}{{Infravision=*Infravision* to 60ft.}}{{Magic Resistance=Gnomes are magic-resistant, giving a bonus to saving throws against magical wands, staves, rods, and spells of +1 for every 3.5 points of Constitution score.}}{{Attack bonus=+1 To Hit kobolds and goblins}}{{Small size=Gnolls, bugbears, ogres, trolls, ogre magi, giants, and titans suffer a -4 penalty to attack}}{{Sense Curses=Can sense a cursed item, but only if the device fails to function}}{{Section5=**Special Disadvantages**}}{{Item failure=20% chance for failure of any magical item except weapons, armor, shields, illusionist items, and (if the character is a thief) items that duplicate thieving abilities.}}RaceData=[w:Gnome, align:any, weaps:any, ac:any, attr:str=6|con=8|int=6, +:1|kobold|goblin, -:4|gnoll|bugbear|ogre|troll|ogre-magi|oni|giant|titan, svatt:con,svrod:3.5,svsta:3.5,svwan:3.5,svspe:3.5, ola:+5,rta:+10,msa:+5,hsa:+5,dna:+10,cwa:-15, ns:4],[cl:PW,w:Detect Slope,lv:0,sp:0,pd:-1],[cl:PW,w:Detect Flawed Stonework,lv:0,sp:0,pd:-1],[cl:PW,w:Determine-Depth-Underground,lv:0,sp:0,pd:-1],[cl:PW,w:Determine Direction Underground,lv:0,sp:0,pd:-1]{{desc=Kin to dwarves, gnomes are noticeably smaller than their distant cousins. Gnomes, as they proudly maintain, are also less rotund than dwarves. Their noses, however, are significantly larger. Most gnomes have dark tan or brown skin and white hair.
Gnomes have lively and sly senses of humor, especially for practical jokes. They have a great love of living things and finely wrought items, particularly gems and jewelry. Gnomes love all sorts of precious stones and are masters of gem polishing and cutting.
Their diminutive stature has made them suspicious of the larger races - humans and elves - although they are not hostile. They are sly and furtive with those they do not know or trust, and somewhat reserved even under the best of circumstances. Dwelling in mines and burrows, they are sympathetic to dwarves, but find their cousins\' aversion to surface dwellers foolish.}}
Race modifiers to the rogue skills are specified using the same tags as used for Class definitions (see previous section). Modifiers can improve (+) or penalise (-) the skill percentage score. These modifiers will apply for any class, though of course other classes do not get class or level modifiers. GMs can allow non-rogue classes to have a chance (however minimal) to succeed at rogue skills, or not, through configuration options using the !magic --config or !attk --config commands. Creatures and NPCs can also have race modifiers to rogue skills using the same data tags.
' + + +'
Race Powers
' + +'As with classes, races can have specific powers. If a Sub-Race has a Base Race defined, the powers for both will be used - if you don\'t want any powers from a Base Race, do not specify one.
' + +'Dwarf
' + +'&{template:RPGMdefault}{{name=Dwarf}}{{subtitle=Race}}Specs=[Dwarf,HumanoidRace,0H,Humanoid]{{Alignment=Any (Usually LG)}}{{Height=4 to 4.5 ft}}{{Weight=150lbs}}{{Life Expectancy=350 years}}{{Languages=Often *Dwarf, Common, Orc, Kobold, Goblin, Gnome*}}{{Section=**Attributes**}}{{Min Attributes=Str:8, Con:11}}{{Max Attributes=Dex:17, Chr:17}}{{Attribute Adj.=Con:+1, Chr:-1}}{{Section1=**Powers**}}{{Infravision=*Infravision* to 60ft}}{{Expert Miners=Detect slopes, new tunnel construction, shifting walls, and stonework traps, and determine approximate depth underground}}{{Section2=**Special Advantages**}}{{Small size=Ogres, trolls, ogre magi, giants, and titans suffer a -4 penalty to attack Dwarves.}}{{Magic Resistance=Dwarves are nonmagical, which gives a bonus to dwarves\' saving throws against magical wands, staves, rods, and spells, of +1 for every 3.5 points of Constitution score.}}{{Sense Curses=Can sense a cursed item, but only if the device fails to function}}{{Section3=**Special Disadvantages**}}{{Item Failure=Magical items not specifically suited to the character\'s class have a 20% chance to malfunction when used.}}RaceData=[w:Dwarf, align:any, weaps:any, ac:any, attr:str=8|con=11|dex=1:17|chr=1:17, +:1|orc|half-orc|goblin|hobgoblin, -:4|ogre|troll|ogre-magi|oni|giant|titan, svatt:con,svpoi:3.5,svrod:3.5,svsta:3.5,svwan:3.5,svspe:3.5, ns:5],[cl:PW,w:Detect Slope,lv:0,sp:0,pd:-1],[cl:PW,w:Detect New Construction,lv:0,sp:0,pd:-1],[cl:PW,w:Detect Shifting Walls,lv:0,sp:0,pd:-1],[cl:PW,w:Detect Stonework Traps,lv:0,sp:0,pd:-1],[cl:PW,w:Determine Depth Underground,lv:0,sp:0,pd:-1]{{desc=Dwarves are short, stocky fellows, easily identified by their size and shape. They have ruddy cheeks, dark eyes, and dark hair. Dwarves tend to be dour and taciturn. They are given to hard work and care little for most humor. They are strong and brave. They enjoy beer, ale, mead, and even stronger drink. Their chief love, however, is precious metal, particularly gold. They prize gems, of course, especially diamonds and opaque gems (except pearls, which they do not like). Dwarves like the earth and dislike the sea. Not overly fond of elves, they have a fierce hatred of orcs and goblins. Their short, stocky builds make them ill-suited for riding horses or other large mounts (although ponies present no difficulty), so they tend to be a trifle dubious and wary of these creatures. They are ill-disposed toward magic and have little talent for it, but revel in fighting, warcraft, and scientific arts such as engineering.
'
+ +'Though dwarves are suspicious and avaricious, their courage and tenacity more than compensate for these shortcomings.
'
+ +'Dwarves typically dwell in hilly or mountainous regions. They prefer life in the comforting gloom and solidness that is found underground.}}
As master miners, Dwarves have a number of powers that they can call on when underground, to assess their situation. These use the same syntax for specification as for Classes with powers.
' + +'Dwarves also have to-hit and AC bonuses when facing various types of creature. These are specified in the race data as follows:
' + +'| +: | [+-] # | race/creature | race/creature | ... | a modifier to hit of # when attacking any listed creature (not currently implemented) |
|---|---|---|
| -: | [+-] # | race/creature | race/creature | ... | a modifier to AC of # when being attacked by any listed creature (not currently implemented) |
A positive modifier is always a benefit, and a negative one is a penalty. These are not currently implemented as the APIs cannot know what race the opponent is, unless a targeted attack is used (see attackMaster API help handout for information on attacks) and targeted attacks are a DM and Player option which is not mandatory.
' + +'4. Creatures
' + +'The same specification approach can be used to define creatures other than humanoids, and humanoids other than PCs and NPCs. A number of such definitions are provided in the Race-DB-Creatures database, which can be extracted to a Character Sheet DB using the !magic --extract-db Race-DB-Creatures command. All the same data fields are available as for Race definitions, with some extras.
' + +'Vampire
' + +'&{template:RPGMdefault}{{name=Vampire}}{{subtitle=Creature}}{{Alignment=Usually Chaotic Evil}}Specs=[Vampire,HumanoidCreature,0H,Creature]{{Languages=Whatever they knew before they were a vampire, or what their vampire parents taught them.}}{{Height=As per pre-vampire race (usually [65+2d6](!
/r 65+2d6 ins height)ins,}}{{Weight=Their weight before becoming a vampire or [140+6d10](!
/r 140+6d10 lbs weight)lbs}}{{Life(?) Expectancy=Immortal}}{{Section=**Attributes**}}{{Minimum=Str:18(76), Int:15}}{{Maximum=Int:16}}{{Adjustment=None}}{{Section1=**Powers**}}{{Energy Drain=Drains 2 levels from anyone they successfully touch}}{{Charm=Any person who allows the vampire to look into their eyes will be affected as if by a *charm person* spell. Due to the power of this enchantment, a -2 is applied to the victim\'s saving throw vs. spell}}{{Summon Creatures=Can summon swarms of creatures to their aid}}{{Spell-like powers=*Gaseous Form* and *Spider Climb* at will}}{{Section2=**Special Advantages**}}{{Infravision=60 feet}}{{Shape Change=Can *Shape Change* into a large bat at will}}{{Plus Weapons To Hit=Attackers must use weapons of at least +1 to be able to hit a vampire}}{{Immunities=Immune to *Sleep, Charm,* and *Hold* spells, Paralysis and Poison. Spells based on cold or electricity cause only half damage}}{{Section3=**Special Disadvantages**}}{{Repellants=Odor of Strong Garlic; Mirror or Holy Symbol presented with conviction}}{{Holy Water or Symbol=Burns a vampire for 2-7 (1d6+1) damage with a successful hit}}{{Others=See Monsterous Compendium for other disadvantages}}RaceData=[w:Vampire, cattr:int=15:16|ac=1|mov=12|fly=18C|hd=8d8+3|thac0=11|attk1=hand:4+1d6:0:B,spattk:Energy drain,spdef:+1 weapon to hit; immune to *sleep, charm & hold*, ns:5],[cl:PW,w:Charm Person,sp:1,lv:0,pd:-1],[cl:PW,w:Summon Swarm,sp:2,lv:0,pd:-1],[cl:PW,w:Gaseous Form,sp:0,lv:0,pd:-1],[cl:PW,w:MU-Shape-Change,sp:9,lv:0,pd:-1],[cl:PW,w:Spider Climb,sp:1,lv:0,pd:-1]{{desc=Of all the chaotic evil undead creatures that stalk the world, none is more dreadful than the vampire. Moving silently through the night, vampires prey upon the living without mercy or compassion. Unless deep underground, they must return to the coffins in which they pass the daylight hours, and even in the former case they must occasionally return to such to rest, for their power is renewed by contact with soil from their graves.
'
+ +'One aspect that makes the vampire far more fearful than many of its undead kindred is its appearance. Unlike other undead creatures, the vampire can easily pass among normal men without drawing attention to itself for, although its facial features are sharp and feral, they do not seem inhuman. In many cases, a vampire\'s true nature is revealed only when it attacks. There are ways in which a vampire may be detected by the careful observer, however. Vampires cast no reflection in a glass, cast no shadows, and move in complete silence.}}
Creatures have additional data fields that set up all the important fields for the APIs on the AD&D2e Character Sheet (only when the creature is specified using the Class/Race menu on the "token-setup" menu - just typing the creature type into the Race field on the Character Sheet will not do this).
' + +'| spattk: | text | special attacks text to be displayed when the Specials Action Button is used |
|---|---|---|
| spdef: | text | special defenses text to be displayed when the Specials Action Button is used |
| cattr: | attr=value | attr=value | ... | a list of attribute/value pairs, where attr is one of: |
| ac | #[:#] | creature armour class |
| mov | # | creature movement on the ground |
| fly | text | creature movement in the air |
| sw | text | creature movement when swimming |
| hd | #[d#][+/-#][r#] | creature hit dice roll spec |
| hp | #[:#] | creature hit points |
| regen | # | creature regeneration HP/round |
| thac0 | # | creature Thac0 |
| tohit | [+/-]# | creature to-hit modifier |
| dmg | [+/-]# | creature damage modifier |
| crith | # | creature critical hit roll |
| critm | # | creature critical miss roll |
| attk1 | roll,text,[speed],[type],[+tohit] | specification for creature innate attack 1 |
| attk2 | roll,text,[speed],[type],[+tohit] | specification for creature innate attack 2 |
| attk3 | roll,text,[speed],[type],[+tohit] | specification for creature innate attack 3 |
| attkmsg | text[$$text][$$text] | message(s) for attacks |
| speed | # | creature overall attack speed |
When a creature (or race) with these data fields is selected in the Race/Class menu, the CommandMaster API automatically sets all of the respective Character Sheet attributes to the specified values. In fact, all of these data fields can be used with a standard race, but are less useful. Note: values in square brackets are optional and the brackets should not be included if used.
' + + +'New 4.1 Non-Player Characters (NPCs)
' + +'NPCs are just creatures with more detail on the "non-monster" part of the character sheet, and thus can use many of the same data tags in their definitions as stated above. Equally, Creatures can have many NPC characteristics, as exemplified by the Vampire definition example given above. However, in order for NPCs to be listed as NPCs in the Drag & Drop lists, the database record Class (the second attribute of the Specs=[...] section of the definition) must be NPCCreature, and Creatures must have CreatureRace.
' + +'Human Abjurer Wizard NPC
' + +'&{template:RPGMdefault}{{}}Specs=[Human-Abjurer,NPCCreature,2H,Human-Wizard]{{}}RaceData=[w:Human-Abjurer, query:NPClevel, cattr:cl=MU:Abjurer| lv=??0| hp=??0d4r2| wis=15:18]{{}}%{Race-DB|Human-Wizard}{{name=Abjurer}}
' + +'The more NPC-related data tags, which Creatures can also use, are:
' + +'| cattr: | attr=value | attr=value | ... | a list of attribute/value pairs, where attr is one of: |
|---|---|---|
| cl | [F/MU/PR/RO/PS]:Class name | Give creature a NPC class |
| lv | # | Give creature a NPC level |
| New | The following tags are new in this version | |
| str | # | Give NPC strength (# can be a calculation) |
| exstr | # | Give NPC extra strength if str evaluates to 18 (# can be a calculation & defaults to 1d100). Does not have to be a Warrior class. |
| con | # | Give NPC constitution (# can be a calculation) |
| dex | # | Give NPC dexterity (# can be a calculation) |
| int | # | Give NPC intelligence (# can be a calculation) |
| wis | # | Give NPC wisdom (# can be a calculation) |
| chr | # | Give NPC charisma (# can be a calculation) |
| npcpp | # | Set relative ratio for pick pokets level mod(# can be a calculation) |
| npcol | # | Set relative ratio for open locks level mod(# can be a calculation) |
| npcrt | # | Set relative ratio for find/remove traps level mod(# can be a calculation) |
| npcms | # | Set relative ratio for move silently level mod(# can be a calculation) |
| npchs | # | Set relative ratio for hide in shadows level mod(# can be a calculation) |
| npcdn | # | Set relative ratio for detect noise level mod(# can be a calculation) |
| npccw | # | Set relative ratio for climb walls level mod(# can be a calculation) |
| npcrl | # | Set relative ratio for read languages level mod(# can be a calculation) |
| npcll | # | Set relative ratio for legend lore level mod(# can be a calculation) |
For the attribute values (str, con, dex, int, wis, chr) the value is often a range speification of 3:18 which will evaluate to rolling 3d6. However, the lower value of the range may be modified to match the minimum scores for the class and race of the NPC.
' + +'For the rogue skill values (npcpp, npcol, npcrt, npcms, npchs, npcdn, npccw, npcrl, npcll) the value given to each (which can be a calulation, dice roll or range) represents the relative ratio vs. the other specified rogue skill values. The total allowable level points for the NPC is calculated by the APIs, and then allocated across the rogue skills using the specified ratios, so that the total points are fully allocated. Making the ratio values dice roll or range specifications allows for a degree of randomness in the outcome, so no two NPCs using the same definition are the same in rogue skill values.
' + + +'Updated 4.2 Specifying Creature & NPC Items, Weapons & Armour
' + +'Many creatures have attacks using their claws, bites and other "innate" attacks, and have tough natural armoured skin. However, many humanoid creatures can use normal weapons & armour to attack adventurers and defiend themselves. It is possible to specify the possible weapon combinations and available armour for each creature type, and add a randomness to the selection criteria, as this example shows:
' + +'Drow Fighter NPC
' + +'&{template:RPGMdefault}{{}}Specs=[Drow-Fighter,NPCCreature,0H,Drow]{{}}RaceData=[w:Drow-Fighter, query:NPClevel, align:CE, cattr:cl=F| lv=??0| hp=??0d8r4| str=8:18| con=7:14| dex=8:20| int=9:19| wis=3:18| chr=6:16| mov=12, ns:1],[cl:MI,items:random:1d??0],[cl:AC,items:chain-mail+??1|buckler+??2], [cl:WP,%:50 ,prime:shortsword+??2,offhand:dagger+??2:3], [cl:WP,%:10 ,prime:shortsword+1 < Mastery,offhand:dagger+1], [cl:WP,%:7 ,prime:shortsword+2,offhand:dagger+1:3], [cl:WP,%:5 ,prime:shortsword+1,offhand:dagger+2] , [cl:WP,%:5 ,prime:shortsword+2,offhand:dagger+2], [cl:WP,%:3 ,prime:shortsword+3,offhand:dagger+1:5], [cl:WP,%:1 ,prime:shortsword+3,offhand:dagger+2:3], [cl:WP,%:50 ,prime:shortsword+??2,offhand:dagger+??2,items:hand-crossbow|hand-quarrel+poison:10], [cl:WP,%:10 ,prime:hand-crossbow=%%3,offhand:shortsword+1,items:dagger+1|hand-quarrel+poison:10], [cl:WP,%:4 ,prime:shortsword+2,offhand:dagger+1,items:hand-crossbow|hand-quarrel+poison:10], [cl:WP,%:4 ,prime:hand-crossbow,offhand:shortsword+1,items:dagger+2|hand-quarrel+poison:10],[cl:WP,%:20,prime:Javelin+poison:3 < Specialist,items:dagger+??1:5]{{}}%{Race-DB|Drow}{{name= Fighter}}{{subtitle=Drow}}{{Alignment=Chaotic Evil}}
' + +'The additional RaceData datasets highlighted have the following fields:
' + +'| ns: | [ = / - ]1 | specifies a following number of sections. An \'=\' ignores all inherited sections. A \'-\' ignores Class definitios for weapons, powers and items |
|---|---|---|
| cl | WP / AC / MI | Type of data in the dataset. WP = weapon, AC = armour, MI = items |
| % | # | Chance of dataset being used relative to others of same type (does not have to add up to 100) |
| prime | weapon [: qty][ < prof] | Name, optional quantity, and optional proficiency of weapon to take in Primary hand. Only 1 is taken in-hand, rest of qty held in items |
| offhand | weapon [: qty][ < prof] | Name, optional quantity, and optional proficiency of weapon to take in Off-hand hand. Only 1 is taken in-hand, rest of qty held in items |
| both | weapon [: qty][ < prof] | Name, optional quantity, and optional proficiency of two-handed weapon to take in both hands. Only 1 is taken in-hand, rest of qty held in items |
| items | weap/armour/item[:qty][ < prof] | weap/armour/item[:qty][ < prof] | ... | Name, quantity & proficiency of weapons, armours, or equipment/magic items to store as items of equipment. Armour will automatically contribute to creature armour class. |
| items | random:qty | weap/armour/item:qty | ... | Add qty random items from the databases to the NPCs carried items, each of which will affect the NPC appropriately and can immediately be used. |
4.3 NPCs/Creatures with Spell-Casting Ability
' + +'It is possible to give spell-casting creatures spells as powers - just specify the number per day as 1, and you can even use the MU-[Spell-Name] or PR-[spell-name] syntax as the power name to specify the spells to use (as shown in the Vampire above). However, for larger numbers of spells, and/or to grant random spells, an additional syntax is available:
' + +'&{template:RPGMdefault}{{}}RaceData=[w:Frost Giant Witch Doctor,sps:any,cattr:cl=pr:frost-giant-shaman/mu:frost-giant-witch-doctor|lv=7/3,ns:2],[cl:MU,lv:1,w:random|random|random|Detect-Magic],[cl:MU,lv:2,w:random|ESP|Mirror-Image|random|random]{{}}Specs=[Frost-Giant-Witch-Doctor,CreatureRace,2H,Frost-Giant-AC0]{{}}%{Race-DB-Creatures|Frost-Giant-AC0}{{name= Witch Doctor}}{{Section3=**Witch Doctor:** This Frost Giant is a Witch Doctor that can cast spells of a number of wizard spells, and priest spheres of magic:*healing, charm, protection, divination*, or *weather*}}{{desc6=**Frost Giant Witch Doctor:** There is a 20% chance that any band of frost giants will have a shaman (80%) or witch doctor (20%). If the group is led by a jarl, there is an 80% chance for a spell caster. Frost giant shamans are priests of up to 7th level. A shaman can cast normal or reversed spells from the *healing, charm, protection, divination*, or *weather* spheres. Frost giant witch doctors are priest/wizards of up to 7th/3rd level; they prefer spells that can bewilder and confound other giants. Favorite spells include: *unseen servant, shocking grasp, detect magic, ventriloquism, deeppockets, ESP, mirror image,* and *invisibility*.}}
' + +'This Witch Doctor has a number of spells specified to be in their spellbook by using the RaceData extension data sets:
' + +'[cl:MU,lv:1,w:random|random|random|Detect-Magic],[cl:MU,lv:2,w:random|ESP|Mirror-Image|random|random]' + +'
The cl:MU specifies that this data set specifies spells for the spellbook, and the lv:# specifies the level of spells. The w: string then defines the spell names, separated by pipes \'|\'. These names must be the same as those given in the spells databases (which can be listed using the GMs [Token Setup] / [Add Spells & Powers] dialog), or can be \'random\'. Specifying \'random\' will do what it says on the tin - a random spell will be chosen from all available spells at that level. If more than one spell is stated as \'random\' there is a chance that the same one will come up twice - the APIs will allow this.
If a spellbook is specified for a creature in this way, it must be of a class that can cast spells or it will not be able to use them. The creature\'s level as a spellcaster will determine how many spells can be memorised at each level, regardless of how many are given in the spellbooks.
' + +'Also, if spellbooks are specified like this the API will automatically memorise spells, selecting spells from the list at random up to the correct number for the creature\'s level. If a creature can cast Wizard spells and no spellbooks are specified, random spells will be memorised from all possible wizard spells that are valid for the schools that caster can cast. The GM (or other controlling player) can always use the Spells Menu to memorise different spells, and the GM can use the [Token Setup] / [Add Spells & Powers] dialog to change the spellbooks.
' + +'If the creature can cast Priest spells, the creature will be granted a spellbook of all priest spells that are valid for the spheres it can cast, and random spells from this list automatically memorised from this list. The specification can override this behaviour by specifying particuler priest spells to have in the spellbook at a specific level using [cl:PR,lv:#,w:....]. Alternatiely, if the w: is followed by an empty string e.g. [cl:PR,lv:#,w:], then the correct number of random priest spells will be memorised at each level, but only those memorised spells will be written to the spellbook. An example of this is for dragons, as according to the Monsterous Manual they only know an exclectic mix of spells they have picked up as they age and are not granted spells by a god.
4.4 Complex Creatures with Multiple Forms
' + +'Some creatures, such as Dragons, have multiple forms and also vary within a single form. For example, a Dragon can be Red, Blue, White, Gold, Silver, Crystal, ... etc. Not only that, but each of these dragons\' powers grow with age from Hatchling through Juvenile, Adulthood, to Venerable, Wyrm & Great Wyrm. Rather than create a definition for each age and colour combination (which would result in 180 definitions just for the standard dragons!) it is possible to add a query presented to the GM when selecting the type of creature to drag & drop. This query can specify data to be factored into calculations in the RaceData specification dependent on the selection made.
' + +'&{template:RPGMdefault}{{title=Red}}{{name=Dragon}}Specs=[Dragon,DragonRace,2H,Creature]{{subtitle=Dragon}}RaceData=[w:Red Dragon, query:What Age?|Hatchling%%1%%-6|Very Young%%2%%-4|Young%%3%%-2|Juvenile%%4%%0|Young Adult%%5%%1|Adult%%6%%2|Mature Adult%%7%%3|Old%%8%%4|Very Old%%9%%5|Venerable%%10%%6|Wyrm%%11%%7|Great Wyrm%%12%%8, align:CE, ac:none, cattr:int=15:16|mov=9|fly=30C|jump=3|ac=1-??1|age=??0:??1|hd=(11+??1)d8r1|mr=(v(^((??1-4);0);1)*??1*5)|cl=mu:red-dragon/pr:red-dragon|lv=8+??1/8+??1|spellsp=1|thac0=11-??1|tohit=??2|dmg=??1|size=G|attk1=1d10:Claw x 2 or Claw+Kick:0:S|attk2=3d10:Bite:0:P|attk3=2d10:Tail Swipe:0:B|attkmsg=Remember powers such as *Dragon Fear; Wing Buffet; Snatch; Plummet;* and *Spell Casting*$$Remember powers such as *Dragon Fear; Wing Buffet; Snatch; Plummet;* and *Spell Casting*$$\lbrak;Show the radius\rbrak;\lpar;!rounds ~~aoe `{selected¦token_id}¦arc180¦0¦80¦160¦red\rpar; then up to \lbrak;\lbrak;`{selected¦age|max}\rbrak;\rbrak; opponents in the area take damage and Save vs. Petrification with the penalty shown below or be \lbrak;Stunned\rbrak;\lpar;!rounds ~~target area¦`{selected¦token_id}¦`{target¦Select the stunned creature¦token_id}¦Stunned¦\lbrak;[1+1d4]\rbrak;¦-1¦Stunned by a dragon tail slap¦back-pain\rpar; for 1d4+1 rounds., spattk:*Dragon Fear; Wing Buffet; Snatch; Plummet;* and *Spell Casting*, spdef:Magic resistance \lbrak;\lbrak;({ { { {(@{selected|age|max}-4)},{0} }kh1}, {1} }kl1) * (@{selected|age|max}+1) * 5\rbrak;\rbrak;%, ns:1],[cl:PW,w:MU-Affect-Normal-Fires,pd:3,sp:1],[cl:PW,w:MU-Pyrotechnics,pd:3,sp:1],[cl:PW,w:PR-Heat-Metal,pd:1,sp:1],[cl:PW,w:MU-Suggestion,pd:1,sp:1],[cl:PW,w:MU-Hypnotism,pd:1,sp:1],[cl:PW,w:Detect-Gems-Kind+Number,pd:3,sp:1],[cl:PW,w:Red-Dragon-Breath,pd:-1,sp:1],[cl:PW,w:PW-Snatch,lv:14,pd:-1,sp:0],[cl:PW,w:PW-Plummet,pd:-1,sp:0],[cl:PW,w:PW-Wing-Buffet,lv:14,pd:-1,sp:0],[cl:PW,w:PW-Stall,pd:-1,sp:0],[cl:PW,w:PW-Dragon-Fear,lv:14,pd:-1,sp:0],[cl:PR,lv:1,w:],[cl:PR,lv:2,w:]{{Section=**Attributes**}}{{Intelligence=Exceptional (15-16)}}{{AC=Varies with age, adult red dragon is AC -5}}{{Alignment=Chaotic Evil}}{{Move=9, FL 30(C), Jump 3}}{{Hit Dice=Varies with age, adult red dragon is 15 HD}}{{THAC0=Varies with age, adult red dragon is 5}}{{Section1=**Attacks:** ToHit and damage bonus varies with age, adult red dragon is +2 and +6. 2 x Claws for 1d10 HP each, possibly with 1 or 2 kicks for 1d10 each, bite for 3d10, and tail slap for 2d10 and possible *stun* within an area varying with age. Several other attacks possible - see *Powers*}}{{Languages=*Red Dragon* and *Dragon Common*, and 16% if hatchlings (+5% per age level) can perform universal communication with any intelligent creature}}{{Size=G, varies with age}}{{Life Expectancy=Possibly in excess of 1,000 years. Adult dragons are considered between 100 and 200 years old}}{{Section2=**Powers**}}{{Breath Weapon=A cone of flame, 90ft long, 5ft wide at dragon and spreading to 30ft wide. Damage varies by age from 2d10+1 to 24d10+12. Save vs. Breath Weapon to take half damage}}{{Fear=Can inspire fear in creatures that see the dragon: affect varies with the level / HD of the viewing creature.}}{{Spell Casting=Knows a number of random wizard and priest spells cast at a level from 10 to 21 varying with age. All spells are cast at a speed of 1 segment regardless of the spell}}{{Spell-like Powers=*Young* dragons can *Affect Normal Fires* x 3 per day, *Juveniles* gain *Pyrotechnics* x3 per day, *Adult* gains *Heat Metal* x 1 per day, *Old* gain *Suggestion* x 1 per day, *Very Old* gain *Hypnotism* x 1 per day, and *Venerable* gain *Detect Gems, Kind & Number* x 3 per day}}{{Special Attacks=*Snatch, Plummet, Stall*, and *Wing Buffet*}}{{Section4=**Special Advantages**}}{{Section5=Its a Dragon!}}{{Section6=**Special Disadvantages**}}{{Section7=None}}{{Section9=**Description**}}{{desc7=Dragons are an ancient, winged reptilian race. They are known and feared for their size, physical prowess, and magical abilities. The oldest dragons are among the most powerful creatures in the world.
Most dragons are identified by the color of their scales. All subspecies of dragons have 12 age categories, and gain more abilities and greater power as they age. Dragons range in size from several feet upon hatching to more than 100 feet, after they have attained the status of great wyrm. The exact size varies according to age and subspecies... }}
In the case of dragons, this query asks the GM for the age to make the dragon, and sets two values based on the age to use in calculations (seen above in red). The query will be applied to all creatures of the Creature Database-Class (Specs definition field 2), in this case any DragonRace creature, even if the roll query is specified in the definition of only 1 such creature. Different roll queries can be specified for different Creature Database-Classes: you can make up your own db-classes to differentiate them.
' + +'The query specification in the Data section has the following syntax:
' + +'query:What Age?|Hatchling%%1%%-6|Very Young%%2%%-4|Young%%3%%-2|Juvenile%%4%%0|Young Adult%%5%%1|Adult%%6%%2|Mature Adult%%7%%3|Old%%8%%4|Very Old%%9%%5|Venerable%%10%%6|Wyrm%%11%%7|Great Wyrm%%12%%8' + +'
If you are familiar with Roll20 Roll Queries, you will note that the ?{...} has been left out: only the text between the braces is defined. This text starts with the query text to be presented to the GM - "What Age?". Possible answers are then specified, separated by pipes \'|\'. Each answer has text followed by values separated by double-percents \'%%\'. The text will be displayed in the roll query to the GM to select the option. The percent-separated values will be returned by the query, including the text as the first value.
' + +'It is then possible to refer to the returned values in the RaceData specification using the syntax ??#, where # is the zero-based number of the value - ??0 is the text of the option selected, ??1 the next value, ??2 the value after that, etc. An example of this is given in the new age=??0:??1 data specification in red above, which will set the character sheet "age" field to the text of the dragon\'s age selected by the GM, and the sheet "age|max" field to the ??1 parameter, which is the "age value" of that age of dragon.
It is possible to do simple maths using these values and others in the data specification. The API supports plus (+), minus (-), times (*), divide (/), left & right parenthesis (()), max (^(...;...)), min (v(...;...)), dice rolls (#d#+#r#), and ranges (#:#). These operators can be combined in simple ways - to be honest, I\'ve not tested all possible combinations - keep it simple and it should work! An example is the calculation for magic resistance:
' + +'mr=(v(^((??1-4);0);1)*??1*5)' + +'
The order of calculation is:
' + +'- the two instances of ??1 will be replaced by the first value after the selected text in the roll query, ' + +'
- then the parentheses that hold numbers are calculated (??1-4), ' + +'
- then any ranges are resolved by rolling a number in the range (none here), ' + +'
- next dice rolls are made (none here), ' + +'
- then the max & min are resolved and ' + +'
- the final parentheses calculated.
Ranges: These are specified with two numbers separated by a colon, thus ##:##. E.g. 3:18 - The API will attempt to roll any range by using the Roll20 dice roller, with 3 dice if possible (so that standard attribute rolls of NPCs and creatures are as close to real as possible). Thus, 3:18 is rolled using 3d6, 6:15 will be 3d4+3, 5:17 is 3d5+2. If a range is too small or cannot be done with 3 dice, 2 or 1 will be used instead, so 2:4 will be 1d3+1, 15:16 will be 1d2+14 etc. If you want more control, specify a particular dice roll.
Dice Rolls: can be specified using the syntax #d#+#r# or #d#-#r#: all parts except the #d# are optional. The r# specifies a re-roll number - if any dice roll is equal to or less than the r# number, that dice alone will be rerolled until the value is higher. Note: The Hit Dice specification (hd=) can use a format like #d# or #d#+# or #d#+#r# (the plus can be a minus), or can be extended to #d#+#d#r# (i.e. the roll modifier can be a dice roll itself) - but the reroll value always applies to the main dice roll. Avoid other maths for the Hit Dice value, but ??# substitutions and maths on the number of dice are possible e.g. (??1+9)d8+??2r2 is valid.
Min & Max: The operators ^ (caret - max) and v (lower-case V - min) can be used with the syntax ^(#;#;#) or v(#;#;#;#) (any number of values is valid) and will evaluate to the maximum or minimum value respectively. Note that a semi-colon separator \';\' is used rather than a comma.
So now it can be seen that the Magic Resistance calculation above will resolve to 0 if the ??1 value is 4 or less, or (5 times ??1) if ??1 is 5 or more. The combination of the Roll Query, values set by the answer to it, and the simple maths engine can provide powerful results.
' + +'Note: semi-colons are used for min & max seperators, and square brackets avoided for calculations, so that Roll20 calculations are not inappropriately triggered when the Roll Templates are displayed and so that these calculations can be passed in API calls. Use these forms of maths in creature definition data specifications, and not Roll20 calculations, to avoid issues. Roll20 calculations can be used inside {{...}} parts of Roll Templates as these will never be encountered by the API management functions, including in API button calls.
' + +'5. Specs & Data field values
' + +'Below are lists of the current possible values for the Class and Race database Ability macro sections.
' + +'5.1 Specs sections
' + +'Specs=[Class Type, Macro Type, Handedness, Class Group-Type]' + +'
Specs=[Sub-Race, Macro Type, Handedness, Base-Race]' + +'
There are no default settings for any of the Specs data fields. All must be explicitly specified.
' + +'5.1(a) Class & Race Types
' + +'There is an infinite list of class types: generally the type is the class name.
' + +'There is an infinite list of race and creature types: generally the type is the sub-race or creature name.
' + +'5.1(b) Macro Type
' + +'Classes: One of "WarriorClass", "WizardClass", "PriestClass", "RogueClass", "PsionClass", relating to the base class of the character. This field is used to add the Class name to the right base class list for selection by the Players.
' + +'Races: One of "HumanoidRace", "HumanoidCreature", "CreatureRace", relating to the base race of the character. This field is used to add the Race name to the right race or creature list for selection.
' + +'5.1(c) Handedness
' + +'0H A Race, Creature or Class that can only be taken by characters and creatures that do not have hands (e.g. a fish-type creature)
'
+ +'1H A Race, Creature or Class that can only be taken by characters or creatures with only one hand (e.g. a snake NPC that can use its prehensile tail to hold weapons)
'
+ +'2H A Race, Creature or Class that has two hands - the normal for humanoid PCs and NPCs
'
+ +'3H A Race, Creature or Class that can only be taken by characters or creatures with three or more hands
'
+ +'4H Etc
'
+ +'... ...
(Handedness for Race and Classes are not currently restricted or used by the system. In future, the number of hands specified on the "Change Weapon" dialogue may be related to the Character Race & Class)
' + +'5.1(d) Base Classes
' + +'The Base Class can currently be one of "Warrior", "Wizard", "Priest", "Rogue" or "Psion". If a character class is allowed to be of more than one base class, separate each with a vertical bar character \'|\'. This determines the valid Character Sheet fields that this Class Type can appear in.
' + +'The Base Race or Creature Type can be for any other Race or Creature definition. Multiples are not allowed (no vertical bars \'|\'), and the Sub-Race / Creature will inherit the specifications and powers of the Base Race / Creature.
' + +'' + +'
5.2 Data Sections
' + +'Below are the definitions for each of the possible ClassData and RaceData fields.
' + +'Note: Always refer to the database specification definitions in other sections above for detailed information on the use of these Field specifiers. Not all specifiers have an obvious use.
' + +'| Field | ' + +'Format | ' + +'Default Value | ' + +'Description | ' + +'
|---|---|---|---|
| w: | < text > | \'Fighter\' | Name of the Class |
| hd: | Dice Roll spec | 0 | Hit dice roll per level |
| align: | [ lg / ng / cg / ln / nn / n / cn / le / ne / ce / any ] | any | Allowed alignments |
| race: | < text | text | ... > or any | any | Allowed races |
| weaps: | < text | text | ... > or any | any | Allowed weapons and weapon types |
| npp: | [-]# | \'\' | The weapon non-proficiency penalty for the class |
| twp: | [-]#.# | 2.4 | The two weapon penalty (primary.secondary) for the class |
| ac: | < text | text | ... > or any | any | Allowed armour types |
| attkl: | < 0 | # | # | ... > | \'\' | Class level progression for "attacks per round" modifiers |
| attkm: | < # | # | # | ... > | \'\' | Melee weapon "attacks per round" modifiers by class level progression |
| attkr: | < # | # | # | ... > | \'\' | Ranged weapon "attacks per round" modifiers by class level progression |
| sps: | < text | text | ... > or any | any | Allowed spell schools or major spheres |
| spm: | < text | text | ... > | \'\' | Allowed minor spheres |
| spb: | < text | text | ... > | \'\' | Banned spell schools |
| slv: | < # | # | # | <MU / PR> > | \'\' | Non-standard spellcaster level/type specification |
| spl# | < # | # | # | ... > | \'\' | No. of spells of level spl# at each character level |
| attr: | #[:#] | 3:18 | minimum and maximum starting attribute values |
| svXXX[+]: | [+ - =] # | 0 | saving throw modifiers |
| thmod: | weapon=[+-]# | weapon=[+-]# | ... | \'\' | a list of weapon type (or super-type) to-hit modifiers separated by vertical bars (\'|\') |
| +: | [+-] # | race/creature | race/creature | ... | \'\' | a modifier to hit of # when attacking any listed creature (not currently implemented) |
| -: | [+-] # | race/creature | race/creature | ... | \'\' | a modifier to AC of # when being attacked by any listed creature (not currently implemented) |
| spattk: | text | \'\' | special attacks text to be displayed when the Specials Action Button is used |
| spdef: | text | \'\' | special defenses text to be displayed when the Specials Action Button is used |
| cattr: | attr=value | attr=value | ... | \'\' | a list of attribute/value pairs, where attr defines a field on the Character Sheet Monster tab |
| ns: | # | 0 | Number of granted spells/powers defined for item |
| cl: | < MU / PR / PW > | \'\' | Type of granted spell/power (always PW=Power) |
| w: | < text > | \'-\' | Name of granted spell/power |
| lv: | # | 1 | The character level at which the Power is granted |
| pd: | [ -1 / # / #L# ] | 1 | No. of times per day power can be used. -1 is "at will", and #L# is first number per second number levels, per day |
' + +'
5.3 Character Sheet data fields
' + +'The Character Sheet field mapping to the API script can be altered using the definition of the fields object, the definition for which can be found at the top of the relevant RPGMaster Library API. You can find the complete mapping for all APIs in the RPGMaster series, with an explanation of each, in a separate document - ask the API Author for a copy.
' + +'Attacks Database
' + +'for AttackMaster API v'+version+' and later
' + +'' + +'[General DB Help]' + +'
2. How Attacks Work
' + +'In order to understand the Attacks Database, it is first important to understand how attacks are executed by the AttackMaster API. Under some (if not all) versions of D&D, and especially AD&D 2nd Edition, attacks are quite complex involving many factors that can vary from moment to moment. Some say that this is why they prefer RPG systems that require less maths and are faster to execute, that the complexity of the AD&D2e combat system interrupts the flow of play. The AttackMaster API handles attacks in such a way as to hide as much of that complexity from the players as possible, and thus allow game-play to flow and players to concentrate on the unfolding story.
' + +'In order for the API to achieve this, it must evaluate many factors "on the fly" such as current magical effects in place (generally or on individuals), the current attributes of a character (which can vary as they are affected by game play), the type, range and properties of the weapon combinations used at that point in time for that particular attack, and the effects of the race, class, level and proficiency of the character, among several others. Given that these factors can vary even during a single round, each attack must be fully evaluated from scratch each time it is made.
' + +'Another issue is introduced by players feeling much more satisfied if they can see dice rolling for the attack, or they may want to use the Roll20 dice rolling mouse action, or even their own physical dice. Unfortunately for API authors, at the time of writing the API it is only possible to display rolling 3D dice from Chat Window dice rolls, either typed in the entry box by the player or run from Macros displayed in the Chat Window - 3D dice will not work when called by or included in API calls and commands.
' + +'So how does the AttackMaster API achieve 3D dice rolls and attack calculations that can accelerate game-play? The answer is that it uses Attack Template definitions which it parses and turns into Ability Macros on the Character Sheet of the character that selects to do an attack. The Melee Weapon templates are parsed and the attack Ability Macros for each Melee weapon in-hand created on the Character Sheet as (in fact just before) the Attack chat window menu is displayed, and Ranged Weapon templates are parsed and their attack Ability Macros are created after the type of Ammo has been selected and just before the relevant range buttons on the Attack menu are enabled for the Player to select. Monster attack templates are parsed just before the Monster Attack menu is shown, with a template "set" created for each defined Monster innate attack on the Monster character sheet tab. When the Player selects a Melee weapon to attack with, or the relevant range button for a Ranged weapon or Monster attack, the API is then not actually involved at all - the Roll20 Chat Window button just selected is just doing a standard macro call to the relevant attack Ability Macro just created on the Character Sheet. This also means the actual attacks happen at the fastest speed Roll20 can achieve as no API code is being run at that point.
' + +'' + +'
3. The Attacks Database
' + +'The Attack Templates are stored in the internal API Attacks Database, which can be exposed in Character Sheet Database form as Attacks-DB using the AttackMaster !attk --extract-DB Attacks-DB command. Attack Templates can also exist in additional bespoke Attacks Databases the DM/Game Creator adds using the Character Sheet name Attacks-DB-[added name]. There are 12 basic Attack Templates:
' + +'| MW-ToHit | Melee Weapon calculation to assess and display the Armour Class hit by an attack |
|---|---|
| MW-DmgSM | Melee Weapon calculation to assess the damage done to a Medium or smaller opponent if the hit was sucessful |
| MW-DmgL | Melee Weapon calculation to assess the damage done to Large or larger opponents as a result of a successful hit |
| MW-Targeted-Attk | Melee Weapon calculation for using a targeted attack which rolls all attack and damage dice at once, and then displays the AC hit, the damage vs. all types of opponents, and the current AC & HP of the targeted opponent |
| RW-ToHit | Ranged Weapon calculation to assess and display the Armour Class hit by an attack |
| RW-DmgSM | Ranged Weapon calculation to assess the damage done to a Medium or smaller opponent if the hit was sucessful |
| RW-DmgL | Ranged Weapon calculation to assess the damage done to Large or larger opponents as a result of a successful hit |
| RW-Targeted-Attk | Ranged Weapon calculation for using a targeted attack which rolls all attack and damage dice at once, and then displays the AC hit, the damage vs. all types of opponents, and the current AC & HP of the targeted opponent |
| Mon-Attk | Monster/Creature attack calculation to assess and display the Armour Class hit by an attack |
| Mon-DmgSM | Monster/Creature damage calculation to assess and display the damage done to Medium or smaller opponets by an attack |
| Mon-DmgL | Monster/Creature damage calculation to assess and display the damage done to a Large or larger opponent by an attack |
| Mon-Targeted-Attk | Monster/Creature for a targeted attack calculation to assess and display the Armour Class hit and damage done by an attack, along with the target\'s current AC and HP |
The Melee Weapon Attack Templates will be parsed for each Melee Weapon in-hand at the time of the attack, and the Ranged Weapon Attack Templates will be parsed for each possible range of the Ranged Weapon/Ammo combination selected for the attack. Two additional Melee Weapon Attack Templates are parsed if the character making the attack is a Rogue class:
' + +'| MW-Backstab-DmgSM | Melee Weapon calculation to assess the damage done to a Medium or smaller opponent if the hit was a Rogue doing a backstab and the attack was successful |
|---|---|
| MW-Backstab-DmgL | Melee Weapon calculation to assess the damage done to a Large or larger opponent if the hit was a Rogue doing a backstab and the attack was successful |
All of the above templates are provided in the Attacks-DB database supplied with the game version-specific RPGMaster Library API. They are created to follow the rules of the game version supported by that specific library: DMs and Game Creators can create their own attack and damage calculations following whatever rules they want in their own bespoke Attacks Database, using the information provided in the next section.
' + +'It is possible to add additional Attack Templates that are specific to particular Races, Classes, or even individual weapons! Indeed, the database supplied includes an example of a bespoke Attack Template set for a thrown prepared Oil Flask. When an attack is the action selected by the Player, the API will search the Attacks-DB and bespoke user Attacks Databases for Melee and Ranged Attack Templates in the following name order (replace the ?W with either MW or RW as appropriate):
' + +'- '
+ +'
- ?W-ToHit-\< weapon name \> Searches for a weapon-specific Attack Template set for the weapon being used to attack with, but if not found then ' + +'
- ?W-ToHit-\< class name \> Searches for a class-specific Attack Template set for the class (or each class of a multi/dual class) of the attacking character, but if not found then ' + +'
- ?W-ToHit-\< race \> Searches for a race-specific Attack Template set for the race of the attacking character, but if not found then ' + +'
- ?W-ToHit Uses the default Attack Template set. ' + +'
' + +'
4. Attack Data Fields
' + +'Attack Templates can take the form of any message or macro that can be held in a Roll20 Character Sheet Ability Macro and be displayed in the Chat Window when called. Typically, this will use a Roll Template (standard Roll20 functionality - see Roll20 Help for information), but it can be any format you desire as long as it results in the correct display of information to the Player.
' + +'The Attack Template has a large number of template fields that it can call upon to use in its calculations - these are pre-calculated values supplied by the API that the DM / Game Creator writing a new Attack Template can use. The standard Roll20 attribute value notation of @{selected|field-name} is not recommended for use in Attack Templates, as when the template is parsed, and then later the resulting Ability Macro run as part of the attack, there are circumstances where the token for the attacking Character may not be currently selected, resulting in the wrong value being used or, worse, an error occurring and the game halting. Instead, all the following template fields are available:
' + +'| All Attack Templates | |
|---|---|
| ^^toWho^^ | Resolves to a Roll20 whisper command to the Character making the attack |
| ^^toWhoPublic^^ | Resolves to a Roll20 chat command to the GM if a GM controlled creature is making the attack, otherwise a public message to all Players |
| ^^defaultTemplate^^ | Resolves to the name of the Default Roll Template name set in the AttackMaster API |
| ^^cname^^ | Resolves to the Character Name of the attacking character |
| ^^tname^^ | Resolves to the Token Name of the attacking character |
| ^^cid^^ | Resolves to the Roll20 Character ID of the attacking character |
| ^^tid^^ | Resolves to the Roll20 Token ID of the attacking character |
| ^^toHitRoll^^ | Depending on if the Player chose for Roll20 to roll the attack dice or to roll their own dice, resolves to one of (a) the attack dice specification provided in the Attack Template\'s Specs field, or (b) a Roll Query requesting the Player to enter a dice roll result |
| ^^thac0^^ | Resolves to the base thac0 (value "to hit armour class 0") of the attacking character without any adjustments |
| ^^ACfield^^ | Resolves to the Character Sheet field name that holds the target creatures current Armour Class (only used in targeted attacks) |
| ^^targetACfield^^ | Resolves to the targeted token value Armour Class macro call @{target|Select Target|^^ACfield^^} vs. a targeted opponent (only used in targeted attacks) |
| ^^HPfield^^ | Resolves to the Character Sheet field name that holds the target creatures current Hit Points (only used in targeted attacks) |
| ^^targetHPfield^^ | Resolves to the targeted token value Hit Points macro call @{target|Select Target|^^HPfield^^} vs. a targeted opponent (only used in targeted attacks) |
| ^^magicAttkAdj^^ | Resolves to any magical effect attack bonus or penalty resulting from magic currently in effect |
| ^^strAttkBonus^^ | Resolves to the strength to-hit bonus/penalty of the attacking character |
| ^^strDmgBonus^^ | Resolves to the strength damage bonus/penalty of the attacking character |
| ^^slashWeap^^ | Resolves to 1 if the damage type of the weapon includes Slashing (or S), otherwise 0 |
| ^^pierceWeap^^ | Resolves to 1 if the damage type of the weapon includes Piercing (or P), otherwise 0 |
| ^^bludgeonWeap^^ | Resolves to 1 if the damage type of the weapon includes Bludgeoning (or B), otherwise 0 |
| ^^weapType^^ | Resolves to the 3 letter damage type of the weapon (S, P, B or any combination) |
| ^^ACvsNoMods^^ | Resolves to the targeted standard Armour Class macro call @{target|Select Target|AC-field} vs. a targeted opponent (only used in targeted attacks) |
| ^^ACvsSlash^^ | If a slashing weapon, resolves to the targeted Slashing damage Armour Class macro call @{target|Select Target|SlashAC-field} vs. a targeted opponent, otherwise is blank (only used in targeted attacks) |
| ^^ACvsPierce^^ | If a piercing weapon, resolves to the targeted Piercing Armour Class macro call @{target|Select Target|PierceAC-field} vs. a targeted opponent, otherwise is blank (only used in targeted attacks) |
| ^^ACvsBludgeon^^ | If a bludgeoning weapon, resolves to the targeted Bludgeoning Armour Class macro call @{target|Select Target|BludgeonAC-field} vs. a targeted opponent, otherwise is blank (only used in targeted attacks) |
| ^^ACvsNoModsTxt^^ | Resolves to the text "No Mods" |
| ^^ACvsSlashTxt^^ | If this is a slashing weapon, resolves to the text "Slash", otherwise resolves to an empty string |
| ^^ACvsPierceTxt^^ | If this is a piercing weapon, resolves to the text "Pierce", otherwise resolves to an empty string |
| ^^ACvsBludgeonTxt^^ | If this is a bludgeoning weapon, resolves to the text "Bludgeon", otherwise resolves to an empty string |
| ^^ACvsSTxt^^ | If this is a slashing weapon, resolves to the text "S", otherwise resolves to an empty string |
| ^^ACvsPTxt^^ | If this is a piercing weapon, resolves to the text "P", otherwise resolves to an empty string |
| ^^ACvsBTxt^^ | If this is a slashing weapon, resolves to the text "B", otherwise resolves to an empty string |
' + +'
| Monster Attack Templates | |
|---|---|
| ^^attk1^^ | Resolves to the name of the creature\'s attack 1, if provided (applies to monster attacks only) |
| ^^attk2^^ | Resolves to the name of the creature\'s attack 2, if provided (applies to monster attacks only) |
| ^^attk3^^ | Resolves to the name of the creature\'s attack 3, if provided (applies to monster attacks only) |
| ^^monsterCritHit^^ | Resolves to the critical hit dice roll value of the creature (applies to monster/creature attacks only) |
| ^^monsterCritMiss^^ | Resolves to the critical miss dice roll value of the creature (applies to monster/creature attacks only) |
| ^^monsterDmgMacroSM^^ | Resolves to the correct Ability Macro name to use in an API button or macro call to run the matching Monster Ability damage Macro |
| ^^monsterDmgMacroL^^ | Resolves to the correct Ability Macro name to use in an API button or macro call to run the matching Monster Ability damage Macro |
| ^^monsterDmgMacro1^^ or ^^monsterDmgMacro2^^ or ^^monsterDmgMacro3^^ | Legacy values. Resolve to the same damage Macro call as ^^monsterDmgMacroSM^^ |
| ^^monsterDmgSM^^ or ^^monsterDmgL^^ | Depending on if the Player chose for Roll20 to roll the damage dice or to roll their own dice, resolves to one of (a) the damage dice specification for the selected Monster attack, or (b) a Roll Query requesting the Player to enter a dice roll result. Currently both SM and L resolve the same |
| ^^monsterDmg1^^ or ^^monsterDmg2^^ or ^^monsterDmg3^^ | Legacy values. Resolve to the same as ^^monsterDmgSM |
' + +'
| Melee Weapon Attack Templates | |
|---|---|
| ^^weapon^^ | Resolves to the name of the weapon |
| ^^weapAttkAdj^^ | Resolves to the magical attack adjustment of the weapon |
| ^^weapStyleAdj^^ | Resolves to the fighting style attack adjustment of the weapon |
| ^^weapStrHit^^ | Resolves to a 1 if the character\'s strength to-hit bonus applies to this weapon, or 0 otherwise |
| ^^profPenalty^^ | Resolves to any proficiency penalty incurred by the attacking character for using a non-proficient or related weapon, or 0 if is proficient |
| ^^specProf^^ | Resolves to 1 if the attacking character is a specialist in the weapon, otherwise 0 |
| ^^masterProf^^ | Resolves to 1 if the attacking character is a master (double specialised) in the weapon, otherwise 0 |
| ^^raceBonus^^ | Resolves to the race bonus of the attacking character with this weapon |
| ^^twoWeapPenalty^^ | Resolves to any penalty relevant if the attacking character is using two weapons to attack, adjusted by any relevant Fighting Style benefit (is 0 for character classes that can use two weapons without penalty, such as rangers) |
| ^^weapDmgAdj^^ | Resolves to the magical damage adjustment of the weapon |
| ^^weapStyleDmgAdj^^ | Resolves to any fighting style damage bonus |
| ^^magicDmgAdj^^ | Resolves to any magical effect damage bonus or penalty resulting from magic currently in effect |
| ^^backstab^^ | Resolves to a 1 if a backstab is being attempted, otherwise 0 |
| ^^rogueLevel^^ | Resolves to the Rogue class level of the attacking character (0 if not a Rogue) |
| ^^weapCritHit^^ | Resolves to the critical hit dice roll value of the weapon, adjusted by any relevant Fighting Style benefit |
| ^^weapCritMiss^^ | Resolves to the critical miss dice roll value of the weapon, adjusted by any relevant Fighting Style benefit |
| ^^weapDmgSM^^ | Depending on if the Player chose for Roll20 to roll the damage dice or to roll their own dice, resolves to one of (a) the damage dice specification vs. Medium and smaller opponents for the weapon, or (b) a Roll Query requesting the Player to enter a dice roll result |
| ^^weapStyleDmgSM^^ | Resolves to any Fighting Style damage bonus when doing damage to a Medium or smaller opponent |
| ^^weapDmgL^^ | Depending on if the Player chose for Roll20 to roll the damage dice or to roll their own dice, resolves to one of (a) the damage dice specification vs. Large and larger opponents for the weapon, or (b) a Roll Query requesting the Player to enter a dice roll result |
| ^^weapStyleDmgL^^ | Resolves to any Fighting Style damage bonus when doing damage to a Large or larger opponent |
| ^^weapStrDmg^^ | Resolves to a 1 if the character\'s strength damage bonus applies to this weapon, or 0 otherwise |
| ^^mwSMdmgMacro^^ | Resolves to the correct Ability Macro name to use in an API button or macro call to run the matching Melee weapon Ability damage Macro against Medium and smaller opponents |
| ^^mwLHdmgMacro^^ | Resolves to the correct Ability Macro name to use in an API button or macro call to run the matching Melee weapon Ability damage Macro against Large and larger opponents |
' + +'
| Ranged Weapon Attack Templates | |
|---|---|
| ^^weapon^^ | Resolves to the name of the weapon |
| ^^weapAttkAdj^^ | Resolves to the magical attack adjustment of the ranged weapon. Normally 0 as plus is often on the ammo |
| ^^weapStyleAdj^^ | Resolves to the Fighting Style attack adjustment of the weapon |
| ^^dexMissile^^ | Resolves to the dexterity missile adjustment of the attacking character |
| ^^weapDexBonus^^ | Resolves to a 1 if the dexterity missile bonus applies to the weapon, otherwise 0 |
| ^^strAttkBonus^^ | Resolves to the strength to-hit bonus/penalty of the attacking character |
| ^^weapStrHit^^ | Resolves to a 1 if the character\'s strength to-hit bonus applies to this weapon, or 0 otherwise |
| ^^profPenalty^^ | Resolves to any proficiency penalty incurred by the attacking character for using a non-proficient or related weapon, or 0 if proficient |
| ^^specProf^^ | Resolves to 1 if the attacking character is a specialist in the weapon, otherwise 0 |
| ^^masterProf^^ | Resolves to 1 if the attacking character is a master (double specialised) in the weapon, otherwise 0 |
| ^^raceBonus^^ | Resolves to the race bonus of the attacking character with this weapon |
| ^^twoWeapPenalty^^ | Resolves to any penalty relevant if the attacking character is using two weapons to attack, adjusted by any relevant Fighting Style benefit (is 0 for character classes that can use two weapons without penalty, such as rangers) |
| ^^weapDmgAdj^^ | Resolves to the magical damage adjustment of the weapon |
| ^^rangeMod^^ | Resolves to the range attack modifier, as modified by any valid fighting style |
| ^^rangeN^^ | Resolves to 1 if the range is "Near", otherwise 0 |
| ^^rangePB^^ | Resolves to 1 if the range is "Point Blank", otherwise 0 |
| ^^rangeS^^ | Resolves to 1 if the range is "Short", otherwise 0 |
| ^^rangeM^^ | Resolves to 1 if the range is "Medium", otherwise 0 |
| ^^rangeL^^ | Resolves to 1 if the range is "Long", otherwise 0 |
| ^^rangeF^^ | Resolves to 1 if the range is "Far", otherwise 0 |
| ^^rangeSMLF^^ | Resolves to 1 if the range is not "Near" or "Point Blank", otherwise 0 |
| ^^ammoDmgAdj^^ | Resolves to the magical damage adjustment of the selected ammunition of the ranged weapon |
| ^^ammoStyleDmgAdj^^ | Resolves to the fighting style damage adjustment of the ranged weapon |
| ^^magicDmgAdj^^ | Resolves to any magical effect damage bonus or penalty resulting from magic currently in effect |
| ^^strDmgBonus^^ | Resolves to the strength damage bonus/penalty of the attacking character |
| ^^weapCritHit^^ | Resolves to the critical hit dice roll value of the weapon, as modified by any valid fighting style |
| ^^weapCritMiss^^ | Resolves to the critical miss dice roll value of the weapon, as modified by any valid fighting style |
| ^^ACvsNoModsMissile^^ | Resolves to the targeted Armour Class vs missiles macro call @{target|Select Target|ACmissile-field} vs. a targeted opponent (only used in targeted attacks) |
| ^^ACvsSlashMissile^^ | Resolves to the targeted Slashing damage Armour Class vs missiles macro call @{target|Select Target|SlashACmissile-field} vs. a targeted opponent (only used in targeted attacks) |
| ^^ACvsPierceMissile^^ | Resolves to the targeted Piercing Armour Class vs missiles macro call @{target|Select Target|PierceACmissile-field} vs. a targeted opponent (only used in targeted attacks) |
| ^^ACvsBludgeonMissile^^ | Resolves to the targeted Bludgeoning Armour Class vs missiles macro call @{target|Select Target|BludgeonACmissile-field} vs. a targeted opponent (only used in targeted attacks) |
| ^^ACvsNoModsMissileTxt^^ | Resolves to the text "No Mods" |
| ^^ACvsSlashMissileTxt^^ | If this is a slashing weapon, resolves to the text "Slash", otherwise resolves to an empty string |
| ^^ACvsPierceMissileTxt^^ | If this is a piercing weapon, resolves to the text "Pierce", otherwise resolves to an empty string |
| ^^ACvsBludgeonMissileTxt^^ | If this is a bludgeoning weapon, resolves to the text "Bludgeon", otherwise resolves to an empty string |
| ^^ACvsSmissileTxt^^ | If this is a slashing weapon, resolves to the text "S", otherwise resolves to an empty string |
| ^^ACvsPmissileTxt^^ | If this is a piercing weapon, resolves to the text "P", otherwise resolves to an empty string |
| ^^ACvsBmissileTxt^^ | If this is a slashing weapon, resolves to the text "B", otherwise resolves to an empty string |
| ^^ammoDmgSM^^ | Depending on if the Player chose for Roll20 to roll the damage dice or to roll their own dice, resolves to one of (a) the damage dice specification vs. Medium and smaller opponents for the ammunition used, or (b) a Roll Query requesting the Player to enter a dice roll result |
| ^^ammoStyleDmgSM^^ | Resolves to any Fighting Style damage bonus when doing damage to a Medium or smaller opponent |
| ^^ammoDmgL^^ | Depending on if the Player chose for Roll20 to roll the damage dice or to roll their own dice, resolves to one of (a) the damage dice specification vs. Large and larger opponents for the ammunition used, or (b) a Roll Query requesting the Player to enter a dice roll result |
| ^^ammoStyleDmgL^^ | Resolves to any Fighting Style damage bonus when doing damage to a Large or larger opponent |
| ^^ammoStrDmg^^ | Resolves to a 1 if the character\'s strength damage bonus applies to the selected ammunition, or 0 otherwise |
| ^^ammoLeft^^ | Resolves to the quantity of the selected ammunition left after this attack |
| ^^rwSMdmgMacro^^ | Resolves to the correct Ability Macro name to use in an API button or macro call to run the matching Ranged weapon Ability damage Macro against Medium and smaller opponents |
| ^^rwLHdmgMacro^^ | Resolves to the correct Ability Macro name to use in an API button or macro call to run the matching Ranged weapon Ability damage Macro against Large and larger opponents |
' + +'
5. Character (PC & NPC) Attack Templates
' + +'As previously described, the Attacks Database contains Attack Templates as Ability Macro entries. For Characters and NPCs that attack using weapons "in-hand" (see AttackMaster API documentation for information on taking weapons "in-hand"), four standard Attack Templates are required: -ToHit; -DmgSM; -DmgL; and -Targeted-Attk.
' + +'5.1 The "To Hit" Template
' + +'A standard To Hit Attack Template looks like this (the example is for the AD&D2e version):
' + +'MW-ToHit
' + +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ attacks with their ^^weapon^^}}{{subtitle=Melee Attack}}{{Weapon Used=^^weapon^^}}Specs=[MWtoHit,AttackMacro,1d20,Attack]!setattr --silent --charid ^^cid^^ --ac-hit|{{AC Hit=[[([[^^thac0^^]][Thac0]) - ((([[^^weapAttkAdj^^]][Weapon+]) + ([[^^weapStyleAdj^^]][Style+]) + ([[(^^strAttkBonus^^ * ^^weapStrHit^^)]][Strength+]) + ([[^^profPenalty^^]][Prof Penalty] + [[^^specProf^^]][Specialist] + [[^^masterProf^^*3]][Mastery]) + ([[^^raceBonus^^]][Race mod]) + ([[^^magicAttkAdj^^]][Magic hit adj]) + ([[^^twoWeapPenalty^^]][2-weap penalty]))) - ([[^^toHitRoll^^cs>^^weapCritHit^^cf\<^^weapCritMiss^^]][Dice roll]) ]] }}!!!{{Attk Type=^^weapType^^}}{{Dmg S=[Roll](~^^mwSMdmgMacro^^)}}{{Dmg L=[Roll](~^^mwLHdmgMacro^^)}}{{Crit Roll=^^weapCritHit^^}}{{Fumble Roll=^^weapCritMiss^^}}' + +'
The four fields in the Specs data are the standard four used in all Specs fields: Entry Type (MWtoHit), Entry Class (AttackMacro), Handedness (in this case replaced by toHit dice roll spec 1d20), and Entry Supertype (Attack). The key field to note here is the ToHit Dice Roll Specification (which replaces the Handedness field). This can be any valid dice roll, and will be used for the ^^toHitRoll^^ template field if the Player selects Roll20 to roll the attack dice.
' + +'This Attack Template is formatted using a Roll20 Roll Template with a type specified using the ^^defaultTemplate^^ template field, but need not be - formatting is up to the creator of the Attack Template. It is important this information is displayed to the right people - Players that control a character, all Players as a public post, or just the DM for attacks by creatures & NPCs. The ^^toWhoPublic^^ template field will check if the attacking token represents a Character/NPC/Creature controlled by a Player and, if so, make a public post that all can see, but otherwise just whisper the results of the attack to the DM only. Similarly, ^^toWho^^ will whisper the attack information either only to the Player(s) that control the attacking character/creature or, if no one does, then to the DM.
' + +'The rest of the Attack Template defines the calculations using the API supplied data to display the Armour Class value that would be successfully hit by the attacking character, with the selected weapon under the current conditions. It also defines a display of the adjustments that are made to the dice roll which the Players and DM can hover a mouse over to get an explanation of the calculations. All the calculations and tag display are standard Roll20 functionality, so once the Attack Template Data Fields are replaced by actual values by the API and the resulting Ability Macro saved to the attacking character\'s Character Sheet, running it like any other Ability Macro will use only Roll20 functionality, and not involve use of the APIs (unless the Attack template specifically includes an API call).
' + +'The Attack Template shown above is a To Hit template for a Melee weapon attack. That for a Ranged weapon attack is very similar, just using some different and ranged attack related Template Fields.
' + +'5.2 The "Damage" Templates
' + +'There are always two damage Attack Templates to go with each To Hit Template, typically one for damage to Medium and smaller opponents and one for Large and larger. However, as will be seen when discussing the Oil Flask bespoke Attack Templates below, those are not always the outcomes of the two damage Templates. However, they do always start with MW-DmgSM and MW-DmgL for Melee weapon attacks, and RW-DmgSM and RW-DmgL for Ranged weapon attacks (optionally followed by a race, class or weapon name). The standard Damage Attack Template looks like this:
' + +'MW-DmgSM
' + +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ does damage with their ^^weapon^^}}{{Subtitle=Melee Attack}}Specs=[MWtoHit,AttackMacro,1d20,Attack]{{AC Hit=@{^^cname^^|ac-hit}}}{{Attk Type=^^weapType^^}}{{Dmg S=[[ ([[^^weapDmgSM^^]][Dice Roll]) + ([[^^strDmgBonus^^*^^weapStrDmg^^]][Strength+]) + ([[^^weapDmgAdj^^]][Weapon+]) + ([[^^weapStyleDmgAdj^^+^^weapStyleDmgSM^^]][Style+]) + ([[^^magicDmgAdj^^]][Magic dmg adj]) + ([[^^specProf^^*2]][Specialist+] + [[^^masterProf^^*3]][Mastery+])]]}}{{Dmg L=[Roll](~^^mwLHdmgMacro^^)}}{{Crit Roll=^^weapCritHit^^}}{{Fumble Roll=^^weapCritMiss^^}}
' + +'The damage Attack Template works in the same way as the other Attack Templates as explained above for the ToHit template. While the Specs data includes the "To Hit" dice roll specification, this is not used in the damage Template, and is irrelevant. That field just needs to hold something, and a dice roll specification is what is expected. Hopefully, the rest of this damage Attack Template is self explanatory.
' + +'6. Monster Attack Templates
' + +'If a creature specified as a Monster on the Character Sheet uses in-hand weapons, as supported under the RPGMaster APIs, attacks with those weapons (Melee or Ranged) will use the standard To Hit and Damage Attack Templates described above. However, attacks by creatures that are specified as Monsters (e.g. on the Monster tab of the Advanced 2nd Edition character sheet) are generally much simpler than character attacks with in-hand weapons. The differences mean that such creatures require different Attack Templates. Attacks specified on the Monster tab use the Monster Attack Templates: Mon-Attk, Mon-DmgSM, and Mon-DmgL (or the Targeted Attack Templates, see later). Remember that the AttackMaster API supports an extension of the Monster Attk fields on the Advanced 2nd Edition Character Sheet: each can contain a comma-separated list consisting of "attack name","dice roll","speed in segments","damage type" (see AttackMaster Help for details).
' + +'The Monster Attack and Damage Templates look like this:
' + +'Mon-Attk
' + +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ attacks with their ^^attk^^}}{{subtitle=Monster Attack}}{{Weapon Used=^^attk^^}}Specs=[MonAttk,AttackMacro,1d20,Attack]!setattr --silent --charid ^^cid^^ --ac-hit|{{AC Hit=[[([[^^thac0^^]][Thac0]) - ([[^^magicAttkAdj^^]][Magic hit adj]) - ([[^^toHitRoll^^cs\>^^monsterCritHit^^cf\<^^monsterCritMiss^^]][Dice roll]) ]]}}!!!{{Attk Type=^^weapType^^}}{{Dmg S=[Roll](~^^monsterDmgMacroSM^^)}}{{Dmg L=[Roll](~^^monsterDmgMacroL^^)}}{{Crit Roll=^^monsterCritHit^^}}{{Fumble Roll=^^monsterCritMiss^^}}
' + +'' + +'
Mon-DmgL
' + +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ does damage with their ^^attk^^}}{{subtitle=Monster Attack}}Specs=[MonRoll,AttackMacro,1d20,Attack]{{AC Hit=[[@{^^cname^^|ac-hit}[AC Hit] ]]}}{{Attk Type=^^weapType^^}}{{Dmg L=[[(([[^^monsterDmg^^]][^^attk^^ Dmg])+([[^^magicDmgAdj^^]][Added Magic Dmg]))]]}}{{Dmg S=[Roll](~^^monsterDmgMacroSM^^)}}{{Crit Roll=^^monsterCritHit^^}}{{Fumble Roll=^^monsterCritMiss^^}}
' + +'Unsurprisingly, these work in exactly the same way as other Attack Templates.
' + +'' + +'
7. Targeted Attack Templates
' + +'The AttackMaster API supports the DM (and optionally, Players) using "targeted attacks". This is an attack that prompts the DM / Player to select a target token, and then performs all attack and damage dice rolls at the same time, displaying the attack results alongside the Armour Class and relative health of the targeted opponent. This speeds the attack process even further than having the API do all the attack calculations. Note: the results of the attack are not applied to the targeted opponent - the results are still open to interpretation by the Players and DM, and circumstantial adjustment before manually applying them to the Token / Character Sheet of the opponent.
' + +'The Ranged weapon Targeted Attack Template for AD&D2e (for example) looks like this:
' + +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ attacks @{Target|Select Target|Token_name} with their ^^weapon^^}}{{subtitle=Ranged Attack * **Ammo Left: ^^ammoLeft^^**}}Specs=[RWtargetedAttk,AttackMacro,1d20,Attack]{{AC Hit=[[([[^^thac0^^]][Thac0])-(([[^^weapAttkAdj^^]][Weapon+]) + ([[^^ammoDmgAdj^^]][Ammo+]) + ([[^^weapStyleAdj^^]][Style+]) + ([[ ^^weapDexBonus^^*[[^^dexMissile^^]]]][Dexterity+] )+([[[[^^strAttkBonus^^]]*[[^^weapStrHit^^]]]][Strength+])+([[^^raceBonus^^]][Race mod])+([[^^profPenalty^^]][Prof penalty])+([[^^magicAttkAdj^^]][Magic Hit+])+([[^^twoWeapPenalty^^]][2-weap penalty])+([[^^rangeMod^^]][Range mod]))-([[^^toHitRoll^^cs\>^^weapCritHit^^cf\<^^weapCritMiss^^]][Dice roll]) ]] }}{{Attk Type=^^weapType^^}}{{Target AC=^^targetACmissile^^}}{{Target SAC=^^ACvsSlashMissile^^}}{{Target PAC=^^ACvsPierceMissile^^}}{{Target BAC=^^ACvsBludgeonMissile^^}}{{Dmg S=[[ floor( ([[^^ammoDmgSM^^]][Dice roll]) * ([[(^^rangeN^^*0.5)+(^^rangePB^^*(1+^^masterProfPB^^))+(^^rangeSMLF^^*1)]][Range mult])) + ([[^^rangePB^^*^^masterProfPB^^*2]][Range mod]) + (([[^^ammoDmgAdj^^]][Ammo+])+([[^^ammoStyleDmgAdj^^+^^ammoStyleDmgSM^^]][Style+])+([[^^magicDmgAdj^^]][Magic dmg+]) +([[^^strDmgBonus^^*^^ammoStrDmg^^]][Strength+])) ]]}}{{Dmg L=[[ floor( ([[^^ammoDmgSM^^]][Dice roll]) * ([[(^^rangeN^^*0.5)+(^^rangePB^^*(1+^^masterProfPB^^))+(^^rangeSMLF^^*1)]][Range mult])) + ([[^^rangePB^^*^^masterProfPB^^*2]][Range mod]) + (([[^^ammoDmgAdj^^]][Ammo+])+([[^^ammoStyleDmgAdj^^+^^ammoStyleDmgL^^]][Style+])+([[^^magicDmgAdj^^]][Magic dmg+]) +([[^^strDmgBonus^^*^^ammoStrDmg^^]][Strength+])) ]]}}{{Target HP=^^targetHP^^}}{{Target MaxHP=^^targetMaxHP^^}}{{Target Heart=^^targetHP^^/^^targetMaxHP^^}}{{Crit Roll=^^weapCritHit^^}}{{Fumble Roll=^^weapCritMiss^^}}{{Result=AC Hit\<=Target AC}}
' + +'The key difference, other than doing all of the calculations for the Armour Class hit and both the damage for Medium and smaller and Large and larger, is that several of the Template Fields used resolve to appropriately formatted Roll20 @{target|...} entries, that will display values from the targeted opponent\'s token and/or character sheet. The API searches for the most appropriate token and character sheet fields to resolve the targeted Template Fields to (it searches the attacking creature\'s data, and assumes all tokens are set up the same way): if using the standard RPGMaster token settings (as set by the CommandMaster API --abilities command or [Token Setup] DM\'s Macro button) it will find the data it needs on the token; otherwise it will first search other token fields, then standard Character Sheet character tab fields, then Character Sheet monster tab fields. If the API can\'t find AC or HP data, it will display appropriate text saying the data was not found, but will not cause an error. Thus it is sensible to use these Template Fields rather than statically defined @{target|...} commands.
' + +'' + +'
8. Bespoke / Custom Attack Templates
' + +'All of the above examples and discussion have explored the standard Attack Templates distributed with the AttackMaster API. It will be the case that this will cater for around 95% of attacks and attack-like situations (e.g. there is a weapon called "Touch" which Spell Casters can use for touch-attack spells, which uses the standard Attack Templates without change to achieve the needed outcome). However, for that other 5% (or perhaps closer to 1%) of special cases you can define your own bespoke or custom Attack Templates. Being able to change the way attacks are calculated is also essential if you wish to adapt the API to work for game systems other than those for which RPGMaster Library rulesets currently exist.
' + +'As stated in Section 1, you should not add Attack Templates to the Attacks-DB database directly. Instead, create your own Character Sheet named Attack-DB-[any-name-you-want] and add Attack Templates to it. If you want to replace the Attack Templates provided for Melee weapons, Ranged weapons and/or Monster attacks, just create ones in your added database with the same Ability Macro name and they will automatically be used in preference to the standard versions.
' + +'As also mentioned previously, while Attack Templates are always called with names of the format given in Section 3, they do not have to result in standard attacks or damage - the calculations and resulting information provided to players can be whatever is needed as a result of that attack action. An example of this is included in the distributed Attacks-DB, the Oil Flask Attack Template set:
' + +'RW-ToHit-Oil-Flask
' + +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ throws a prepared oil flask}}{{titlebox=transparent}}{{titletext=red; text-shadow: 1px 1px 1px gray}}{{titleimg=https://s3.amazonaws.com/files.d20.io/images/250365814/HB7bJNTar3xasqz7X9W5bg/thumb.png?1634239406}}{{subtitle=Ranged Attack * **Flasks Left: ^^ammoLeft^^**}}{{Weapon Used=Burning Oil Flask}}Specs=[RWtoHitOilFlask,AttackMacro,1d20,Attack]!setattr --silent --charid ^^cid^^ --ac-hit|{{AC Hit=[[([[^^thac0^^]][Thac0])-([[([[^^weapAttkAdj^^]][Weapon+]) + ([[^^weapStyleAdj^^]][Style+]) + ([[^^ammoDmgAdj^^]][Ammo+]) + ([[ ^^weapDexBonus^^*[[^^dexMissile^^]]]][Dexterity+] )+([[[[^^strAttkBonus^^]]*[[^^weapStrHit^^]]]][Strength+])+([[^^raceBonus^^]][Race mod])+([[^^profPenalty^^]][Prof penalty])+([[^^magicAttkAdj^^]][Magic Hit+])+([[^^twoWeapPenalty^^]][2-weap penalty])+([[^^rangeMod^^]][Range mod])]][Adjustments])-([[^^toHitRoll^^cs\>^^weapCritHit^^cf\<^^weapCritMiss^^]][Dice roll]) ]]}}!!!{{Attk Type=^^weapType^^}}{{dmgslabel=Direct Hit}}{{Dmg S=[Hit](~^^rwSMdmgMacro^^)}}{{dmgllabel=Grenade /Splash}}{{Dmg L=[Splash](~^^rwLHdmgMacro^^)}}{{Crit Roll=^^weapCritHit^^}}{{Fumble Roll=^^weapCritMiss^^}}
' + +'The To Hit Attack Template is very similar to a normal Ranged weapon Attack Template, except that instead of API buttons indicating damage rolls vs. different sized opponents, it provides one API button to select a [Direct Hit], and another selecting a [Grenade/Splash] outcome. Each of these still calls the same damage Attack Templates using the Template Fields provided but in this case, because the attack is with a weapon called Oil Flask, the Template Fields will resolve to calls to RW-DmgSM-Oil-Flask and RW-DmgL-Oil-Flask respectively, and these custom Attack Templates do damage in a very different way to a normal Ranged Weapon attack.
' + +'RW-DmgSM-Oil-Flask
' + +'!rounds --aoe @{target|Who\'s the target?|token_id}|circle|feet|0|7|0|fire|true --target single|^^tid^^|@{target|Who\'s the target?|token_id}|Oil-fire|1|-1|Taking fire damage from burning oil|three-leaves
'
+ +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ throws a prepared oil flask}}{{TitleBox=transparent}}{{titletext=red; text-shadow: 1px 1px 1px gray}}{{TitleImg=https://s3.amazonaws.com/files.d20.io/images/250365814/HB7bJNTar3xasqz7X9W5bg/thumb.png?1634239406}} {{subtitle=Burning oil * **Flasks Left: ^^ammoLeft^^**}}{{Weapon Used=Burning Oil Flask}}Specs=[RWDmgSMOilFlask,AttackMacro,1d20,Attack]{{AC Hit=[[@{^^cname^^|ac-hit}[AC Hit] ]]}}{{Attk Type=^^weapType^^}}{{DmgSlabel=Fire round 1}}{{Dmg S=[[([[^^ammoDmgSM^^]][Dice Roll])]]}}{{DmgLlabel=Grenade /Splash}}{{Dmg L=[Splash](~^^rwLHdmgMacro^^)}}
The Oil Flask version of the RW-DmgSM Attack Template caters for damage done by an Oil Flask successfully scoring a direct hit on an opponent. This results in a damage dice roll for this round of 2d6 with no modifiers, and then also makes an API call to the RoundMaster API with two stacked commands: an Area of Effect call to place fire on the opponent\'s token, and a Target call to add a status to the opponent\'s token which will last 2 rounds, causing a Status Effect Macro to run in the second round to prompt for another damage roll of 1d6.
' + +'RW-DmgL-Oil-Flask
' + +'!rounds --aoe ^^tid^^|circle|feet|[[(^^rangeN^^*5)+(^^rangePB^^*10)+(^^rangeS^^*10)+(^^rangeM^^*20)+(^^rangeL^^*30)+(^^rangeF^^*30)-5]]|4|0|fire
'
+ +'^^toWhoPublic^^ &{template:2Egrenademiss} {{name=Prepared Oil Flask}}Specs=[RWDmgLOilFlask,AttackMacro,1d20,Attack]{{aoe=[[3]]}} {{aoesplash=[[3]]}} {{hitdmg=[Hit](~^^rwSMdmgMacro^^)}} {{splashdmg=[Damage](!
/r ^^ammoDmgL^^)}}{{direction=[[1d10]]}} {{distancename=^^range^^}} {{distance=[[(^^rangePB^^+^^rangeS^^)d6+^^rangeM^^d10+(^^rangeL^^*2)d10+(^^rangeF^^*4)d10]]}} {{hit=[[0]]}} {{splash=[[1]]}}
The Oil Flask version of the RW-DmgL Attack Template caters for an Oil Flask that either missed its intended target, or is deliberately used as a grenade-like missile. This results in a dice roll of 1d3 splash damage to anyone in the area of effect, which is shown using a call to the RoundMaster API Area of Effect command which this time can be positioned where the oil flask landed.
' + +'RW-Targeted-Attk-Oil-Flask
' + +'^^toWhoPublic^^ &{template:^^defaultTemplate^^}{{title=^^tname^^ throws an oil flask at @{Target|Select Target|Token_name} }}{{titlebox=transparent}}{{titletext=red; text-shadow: 1px 1px 1px gray}}{{titleimg=https://s3.amazonaws.com/files.d20.io/images/250365814/HB7bJNTar3xasqz7X9W5bg/thumb.png?1634239406}}{{subtitle=Ranged Attack * **Flasks Left: ^^ammoLeft^^**}}Specs=[RWtargetedOilFlask,AttackMacro,1d20,Attack]{{AC Hit=[[([[^^thac0^^]][Thac0])-(([[^^weapAttkAdj^^]][Weapon+]) + ([[^^weapStyleAdj^^]][Style+]) + ([[^^ammoDmgAdj^^]][Ammo+]) + ([[ ^^weapDexBonus^^*[[^^dexMissile^^]]]][Dexterity+] )+([[[[^^strAttkBonus^^]]*[[^^weapStrHit^^]]]][Strength+])+([[^^raceBonus^^]][Race mod])+([[^^profPenalty^^]][Prof penalty])+([[^^magicAttkAdj^^]][Magic Hit+])+([[^^twoWeapPenalty^^]][2-weap penalty])+([[^^rangeMod^^]][Range mod]))-([[^^toHitRoll^^cs\>^^weapCritHit^^cf\<^^weapCritMiss^^]][Dice roll]) ]] }}{{Attk Type=^^weapType^^}}{{Target AC=^^targetACmissile^^}}{{Target SAC=^^ACvsSlashMissile^^}}{{Target PAC=^^ACvsPierceMissile^^}}{{Target BAC=^^ACvsBludgeonMissile^^}}{{DmgSlabel=Direct Hit}}{{Dmg S=[Hit](~^^rwSMdmgMacro^^)}}{{DmgLlabel=Grenade /Splash}}{{Dmg L=[Splash](~^^rwLHdmgMacro^^)}}{{Target HP=^^targetHP^^}}{{Target MaxHP=^^targetMaxHP^^}}{{Target Heart=^^targetHP^^/^^targetMaxHP^^}}{{Crit Roll=^^weapCritHit^^}}{{Fumble Roll=^^weapCritMiss^^}}{{Result=AC Hit<=Target AC}}
' + +'The Oil Flask version of the RW-Targeted-Attk Attack Template combines the functions and calculations of the other Oil Flask custom Attack Templates in a single result display, with appropriate API buttons to implement the various outcomes of the attack.
' + +'Similar or entirely different custom Attack Templates can be created for other individual weapons with non-standard attack outcomes, or for individual classes of character, creatures, or races. Just use the Attack Template naming conventions described in Section 3, and add them to your own Attack Databases as described in Section 1, and you can give Players more interesting situations and means of dealing with them. When combined with the features and capabilities of the RoundMaster API and other APIs of the RPGMaster suite, the possibilities are endless!
' + +'Fighting Styles Database
' + +'for AttackMaster API v'+version+' and later
' + +'' + +'[General DB Help]' + +'
2. Fighting Style Databases
' + +'Fighting style databases have names that start with Styles-DB, and can have anything put at the end, though those with version numbers of the form v#.# as part of the name will be ignored.
' + +'As previously stated, each style definition has 3 (or 4) parts in the database (see Section 1): an Ability Macro with a name that is unique and matches the style, an Attribute with the name of the Ability Macro preceded by "ct-", a listing in the database character sheet of the ability macro name separated by \'|\' along with other fighting styles. The quickest way to understand these entries is to examine existing entries. Do extract the root databases and take a look (but remember to delete them after exploring the items in them, so as not to slow the system down unnecessarily).
' + +'Note: The DM creating new weapons does not need to worry about anything other than the Ability Macro in the database, as running the AttackMaster or MagicMaster -check-db Styles-DB command will update all other aspects of the database appropriately for all databases that have a name starting with or including \'Styles-DB\', as long as the Specs and Data fields are correctly defined. Running the command -check-db with no parameters will check and update all databases.
' + +'The Styles-DB database provided with the APIs contains standard definitions for the four fighting styles defined in The Complete Fighter\'s Handbook, plus a couple of other examples for Ranged weapons to demonstrate how other styles can be defined. After extracting the provided Styles database or creating your own as discussed above, aAbility macros can be added to a database just by using the [+Add] button at the top of the Abilities column in the Attributes and Abilities tab of the Database Character Sheet, and then using the edit "pencil" icon on the new entry to open it for editing. Ability macros are standard Roll20 functionality and not dependent on the API. Refer to the Roll20 Help Centre for more information.
' + +'Here is an example:
' + +'Weapon & Shield Style
' + +'&{template:RPGMdefault}{{name=Two Weapon Fighting Style}}Specs=[Two Weapon,Style,2H,Melee-Style]{{desc=With this popular style, the fighter has a weapon in each hand—usually a longer weapon in his good hand and a shorter one in his off-hand. Unless the character has Style Specialization in this style, the second (off-hand) weapon must be shorter than the primary weapon.}}StyleData=[prime:melee, offhand:melee, t:any, st:any],[twp:0.2],[twp:0.2]{{desc1=**Advantages**
'
+ +'One great advantage to this style is that you always have another weapon in hand if you drop or lose one. A single Disarm maneuver cannot rid you of your weapons.}}{{desc2=**Disadvantages**
'
+ +'The principal disadvantage to this style, as with some other styles, is that you don\'t gain the AC benefit of a shield.}}{{desc3=**Style Specialization**
'
+ +'Please read the "Attacking with Two Weapons" section from the Player\'s Handbook, page 96, before continuing.
'
+ +'If you devote a weapon proficiency slot to style specialization with Two-Weapon Style, you get two important benefits. First, your attack penalty drops; before, it was a –2 with your primary weapon and –4 with your secondary, but with Specialization in Two-Weapon Style it becomes 0 with your primary weapon and a –2 with your secondary weapon. (If you\'re already ambidextrous, that penalty is 0 with primary weapon and 0 with secondary weapon). Second, you\'re allowed to use weapons of the same length in each hand, so you can, for example, wield two long swords.
'
+ +'When fighting with two-weapon technique, you can choose for both weapons to try the same maneuver (for example, two strikes, or two disarms), or can have each try a different maneuver (one strike and one parry, one pin and one strike). If the two maneuvers are to be different, each receives a –1 attack penalty.
'
+ +'Though rangers don\'t suffer the off-hand penalties for two-weapons use, they do not get a bonus to attack rolls if they devote a weapon proficiency slot to Two-Weapon Style. They do get the other benefit, of being able to use weapons of equal length.}}
The ability specification for the Weapon & Shield Fighting Style uses a Roll20 Roll Template, in this case defined in the RPGMaster Library (see the help handout for the Library to review the specifications of this template), but any Roll Template you desire can be used. The entries in the Roll Template itself can be anything you desire, giving as much or as little information as you want. However, the important elements for the APIs are those highlighted. Each of these elements are inserted between the elements of the Roll Template, meaning they will not be seen by the player when the macro is run. Generally spaces, hyphens and underscores in the data elements are ignored, and case is not significant. Each element is described below:
' + +'Specs = [Type, Spec Class, Handedness, Style Group]' + +'
The Specs section describes what style type and proficiency groups this weapon belongs to. These fields must be in this order. This format is identical for all database items, whether in these databases or others used by the Master series of APIs.
' + +'| Type | is the type of the style, often similar to the ability macro name. |
| Spec Class | is always Style for entries in the Styles database. |
| Handedness | is #H, where # is the number of hands needed to engage in this fighting style. |
| Style Group | is the group of related fighting styles that the style belongs to, which currently can be Melee Style or Ranged Style. Further Style Groups related to other forms of combat may be introduced in the future. |
StyleData=[prime:melee, offhand:shield|melee, t:any, st:any],[shattk:+1],[shattk:+1,twp:0.2]' + +'
The StyleData section specifies the data relating to the style rules for which types of weapon need to be wielded in which hands, and the benefits then achieved if either Proficient in the Style, or a Specialist in the Style. The first set of brackets enclose the preconditions for the style to be valid given what the character has in-hand (as equipped using the attk menu / change weapon menu). The second set specify the benefits to be implemented if the style is valid and the character is proficient in the style, and the third set specify the benefits from being a specialist (as set by the token-setup / Add to Proficiences menu). These fields can be in any order.
' + +'| prime: | Nothing in hand | The class of weapon or item that must be being held in the Primary hand for this Style to be effective: one or more of spell, melee, ranged, shield, and throwing. Can be a multi-class item, such as a weapon defined as melee|ranged for a weapon that can be used both as a melee and a ranged weapon (e.g. a warhammer) |
| offhand: | Nothing in hand | The class of weapon or item that must be being held in the Offhand hand for this Style to be effective (classes as for Primary hand). Can be a multi-class item, as described for the Primary hand. In this case shield|melee is specified, meaning a shield that can be used to punch or parry as a weapon. |
| weaps: | any | The list of weapon/item type(s) or supertype(s) (weapon groups) that are valid to have in-hand for this Style to be effective, separated by verticle bars (\'|\'). If a supertype is specified, all weapons/items of that supertype will be valid. |
| shattk: | 0 | The number of additional attacks in a round to grant for a shield punch or parry if the style is valid and proficient at the specified level |
| twp: | 2.4 | The Two Weapon Penalty to grant if the style is valid and proficient at the specified level, specified as primary penalty, dot, offhand penalty |
Whenever proficiencies for the character are changed using the token-setup / Add to Proficiences menu, or items in-hand are equipped using the Attk menu / Change Weapon menu, the APIs will scan all currently proficient and specialist styles defined for the character, and see if any are valid. If they are, the APIs will automatically apply the benefits to initiative (if using the InitiativeMaster API) and to attacks.
' + +'Additional data fields are available for supporting the rules and benefits of other styles:
' + +'| twohand: | Nothing in hand | The class of weapon or item that must be being held in Both Hands or otherwise as a two (or more) handed weapon for this Style to be effective, with the same specification syntax as for the primary weapon above. Note that some one-handed weapons can now be taken in-hand as two-handed weapons using the list under the [Both hands] button when equipping, such as Battle Axe, so that the Two Hander Style can be supported as defined in The Complete Fighter\'s Handbook. This requires the latest Weapon Database to be loaded and not overridden by an old definition in a bespoke database in the campaign. |
| ac: | 0 | The Armour Class bonus or penalty granted when the style is active (e.g. as required by the Single Weapon Style) |
| mwsp: | 0 | The melee weapon speed bonus or penalty granted when the style is active (e.g. as required by the Two Hander Style). Negative numbers improve speed, positive numbers worsen it. |
| rwsp: | 0 | The ranged weapon speed bonus or penalty granted when the style is active. Negative numbers improve speed, positive worsen speed. |
| mwn: | 0 | The number of attacks per round to increase (or decrease) a melee weapon by when the style is active. Can be fractions expressed as e.g. 1/2 for one additional attack every 2 rounds. Negative numbers reduce attacks per round. |
| rwn: | 0 | Same as for mwn, but for ranged weapons. |
| mwadj: | 0 | Melee weapon To-hit bonus or penalty granted when the style is active. Positive numbers are beneficial. |
| rwadj: | 0 | Ranged weapon To-hit bonus or penalty granted when the style is active. Positive numbers are beneficial. |
| mwch: | 20 | Melee weapon Critical Hit value to set when the style is active. |
| rwch: | 20 | Ranged weapon Critical Hit value to set when the style is active. |
| mwcm: | 1 | Melee weapon Critical Miss value to set when the style is active. |
| rwcm: | 1 | Ranged weapon Critical Miss value to set when the style is active. |
| rwr: | \'\' | Adjusts the ranges of Ranged Weapons when the style is active. Format is [=][+/-]#/[+/-]#/[+/-]#/[+/-]# where each number adjusts ranges in the order Point Blank/Short/Medium/Long. If Point Blank range is irrelevant for a particular ranged weapon, the first number is ignored. Positive numbers increase range. If \'=\' is specified as the first character, the range is set to be that specified, rather than adjusted by it. |
| rwrm: | \'\' | The bonuses or penalties applied at different ranges for ranged weapons when the style is active. Uses the format N=[+/-]#|PB=[+/-]#|S=[+/-]#|M=[+/-]#|L=[+/-]#|F=[+/-]# where each value will be added to the standard range bonuses/penalties. |
| dmg: | 0 | The melee weapon damage benefit or penalty applied to any opponent when the style is active. |
| dmgsm: | 0 | The melee weapon damage benefit or penalty applied to Medium sized and smaller opponents when the style is active. |
| dmgl: | 0 | The melee weapon damage benefit or penalty applied to Large and larger opponents when the style is active. |
| ammoadj: | 0 | The ranged weapon ammo damage benefit or penalty applied to all opponents when the style is active. |
| ammosm: | 0 | The ranged weapon ammo damage benefit or penalty applied to Medium sized and smaller opponents when the style is active. |
| ammol: | 0 | The ranged weapon ammo damage benefit or penalty applied to Large and larger opponents when the style is active. |
| oneh: | \'\' | A specification using any of the above fields for benefits to be applied to one-handed weapons only. The format of the specification is oneh:key=value|key=value|... e.g. oneh:dmg=+1|mwn=1/2, |
| twoh: | \'\' | A specification using any of the above fields for benefits to be applied to two-handed weapons only. The format of the specification is the same as for oneh |
' + +'
Here is another example showing how the keys oneh and twoh are used in combination with other keys to implement the Two-Hander Style:
' + +'Two-Hander Style
' + +'&{template:RPGMdefault}{{name=Two Hander Fighting Style}}Specs=[Two Hander,Style,2H,Melee-style]{{desc=Two-Hander Style involves carrying and wielding a weapon with both hands. Naturally, many weapons (including polearms, the great axe, the two-handed sword, and others) require two-handed technique. Other weapons (such as bastard sword, javelin, and spear) have it as a listed option.}}StyleData=[twohand:melee, weaps:any],[1H:dmg=+1, 2H:mwsp=-3],[1H:dmg=+1, 2H:mwsp=-3]{{desc1=**Advantages**
'
+ +'The main advantage of two-handed weapon technique is that it allows the character to wield large two-handed weapons which can do substantial amounts of damage.
'
+ +'A second advantage is that, if you are using a two-handed weapon, the Disarm maneuver is only of partial use against you. A single successful Disarm against a two-handed weapon user won\'t knock the weapon out of the wielder\'s hands; it will merely knock his weapon askew and make him take some time to recover, so he automatically loses initiative on his next round. However, two Disarm maneuvers successfully made against the character in the same round will knock the weapon loose.}}{{desc2=**Disadvantages**
'
+ +'As with single-weapon use, two-handed weapon technique has the drawback that the user cannot wear or use a shield, or gain the shield\'s AC bonus.}}{{desc3=**Style Specialization**
'
+ +'You can, by devoting a weapon proficiency to it, take a Style Specialization with Two-Hander Style.
'
+ +'Style Specialization with Two-Hander Style gives you a very specific benefit: When you\'re using a weapon two-handed, that weapon\'s Speed Factor is reduced by 3.
'
+ +'This is because when a fighter wields such a weapon with both hands on the hilt, he has more leverage on the blade and can move it faster. That\'s what Style Specialization in Two-Hander Style will do for the character: It teaches him how to use the weapon much faster and more aggressively than someone with less specialized training in the weapon.}}{{desc4=**One-Handed Weapons Used Two-Handed**
'
+ +'Some players don\'t realize that many other one-handed weapons can also be used two-handed. If you specialize in Two-Hander Style and then use a one-handed weapon in two hands, you also get a bonus of +1 to damage. The one-handed weapons which can be used two-handed in this fashion include: Battle axe, Club, Footman\'s flail, Footman\'s pick, Horseman\'s flail, Horseman\'s mace, Horseman\'s pick, Morning star, Long sword, Warhammer.}}
Here the data specification is:
' + +'StyleData=[twohand:melee, weaps:any],[1H:dmg=+1, 2H:mwsp=-3],[1H:dmg=+1, 2H:mwsp=-3]' + +'
This specifies that there must be a melee weapon equipped in the [Both Hands] slot, and if this is a two-handed weapon then the melee weapon speed is improved by 3 segments. However, if the weapon in the [Both Hands] slot is one of the few one-handed weapons allowed to be taken in both hands (as defined in The Complete Fighter\'s Handbook for this style), then instead it will gain +1 to the damage it inflicts. In this case, the same benefits apply whether the character is just proficient or specialist in the Two-Hander Style.
' + +'Note: only cetain one-handed weapons can be taken in both hands. Indeed, only certain one-handd weapons will appear in the weapon list shown when the [Both Hands] button is selected on the Change Weapon menu. This is achieved in the weapon specifications in the Weapons Database. For full details, see the explanation given in the Weapons & Armour Database Help handout. In summary, a one-handed weapon which can be wielded two-handed and gain Two-Hander Fighting Style benefits, such as a Battle Axe, requires a second Specs dataset with the \'2H\' attribute, but no additional ToHitData datasets. This informs the APIs that this weapon can be taken in both hands, but will not gain any benefits from doing so (unlike, e.g. a Bastard Sword) unless the Character has proficiency in the Two-Hander Fighting Style.
' + +'Other styles can be defined that are not specified in The Complete Fighter\'s Handbook, and some examples are provided in the distributed database:
' + +'Bowyer Style
' + +'&{template:RPGMdefault}{{name=Bowyer Fighting Style}}Specs=[Bowyer,Style,2H,Ranged-style]{{desc=Bowyer Fighting Style reflects fighters who practice day in, day out at the range perfecting their use of bows of all types.}}StyleData=[twohand:ranged, weaps:bow],[rwr:+1/+1/+2/+3,rwsp:-2],[rwr:+1/+1/+3/+5,rwsp:-3,rwn:+1/2]{{desc1=**Advantages**
'
+ +'The main advantage of bowyer technique is that it allows the character to wield two-handed bows which can do damage at long ranges, staying out of melee and making you a difficult enemy to attack.}}{{desc2=**Disadvantages**
'
+ +'As with any two-handed weapon use use, bowyer weapon technique has the drawback that the user cannot wear or use a shield, or gain the shield\'s AC bonus.}}{{desc3=**Style Specialization**
'
+ +'You can, by devoting a weapon proficiency to it, take a Style Specialization with Bowyer Style.
'
+ +'Style Specialization with Bowyer Style enables you to extend your accuracy at range by 10 yards at short range, 20 at medium and 30 at long range, and improve the speed of the bow by 2 segments. As their skill improves further (by dedicating two proficiency slots), range increases further (by 30 yards at medium and 50 at long), and nocking arrows and drawing the bow faster to enable them to get additional attack every other round}}
This style has a slightly more complex data specification:
' + +'StyleData=[twohand:ranged, weaps:bow],[rwr:+1/+1/+2/+3,rwsp:-2],[rwr:+1/+1/+3/+5,rwsp:-3,rwn:+1/2]' + +'
You can see here the application of the restriction of this fighting style to two-handed ranged weapons that belong to the weapon group bow, then applying benefits using the range extension key rwr, the ranged weapon speed modifier rwsp, and improving the number of attacks for a ranged weapon by one attack per two rounds using rwn.
' + +'A wide range of fighting styles can be created using the different combination of rules and benefits, to enrich the game you create, and your players experience. If you need help or guidance, or experience any issues, do access the RPGMaster forum on Roll20 - search the wiki for the link, or navigate via the Community Forums to the API / Mods forum and search for RPGMaster.
' + } + }); + + const fieldGroups = Object.freeze({ + MELEE: {prefix:'MW_', tableDef:fields.MW_table}, + DMG: {prefix:'Dmg_', tableDef:fields.Dmg_table}, + RANGED: {prefix:'RW_', tableDef:fields.RW_table}, + AMMO: {prefix:'Ammo_', tableDef:fields.Ammo_table}, + WPROF: {prefix:'WP_', tableDef:fields.WP_table}, + MI: {prefix:'Items_', tableDef:fields.Items_table}, + MAGIC: {prefix:'Magic_', tableDef:fields.Magic_table}, + SPELLS: {prefix:'Spells_', tableDef:fields.Spells_table}, + POWERS: {prefix:'Powers_', tableDef:fields.Powers_table}, + INHAND: {prefix:'InHand_', tableDef:fields.InHand_table}, + QUIVER: {prefix:'Quiver_', tableDef:fields.Quiver_table}, + STYLES: {prefix:'Style_', tableDef:fields.Style_table}, + GEAR: {prefix:'Gear_', tableDef:fields.Gear_table}, + STORED: {prefix:'StoredGear_', tableDef:fields.StoredGear_table}, + POTIONS:{prefix:'Items_', tableDef:fields.Items_table}, + DUSTS: {prefix:'Dusts_', tableDef:fields.Dusts_table}, + MISC: {prefix:'Misc_', tableDef:fields.Misc_table}, + WANDS: {prefix:'Wands_', tableDef:fields.Wands_table}, + SCROLLS:{prefix:'Scrolls_', tableDef:fields.Scrolls_table}, + GEAR: {prefix:'Gear_', tableDef:fields.Gear_table}, + STORED: {prefix:'Stored_', tableDef:fields.Stored_table}, + INIT: {prefix:'InitMagic_', tableDef:fields.InitMagic_table}, + SAVES: {prefix:'Mods_', tableDef:fields.Mods_table}, + MODS: {prefix:'Mods_', tableDef:fields.Mods_table}, +// WEAP: {prefix:'Weap_', tableDef:fields.Weap_table}, + MONWEAP:{prefix:'MonWeap_', tableDef:fields.MonWeap_table}, + ALTWIZ: {prefix:'AltSpells_', tableDef:fields.AltWizSpells_table}, + ALTPRI: {prefix:'AltSpells_', tableDef:fields.AltPriSpells_table}, + ALTPWR: {prefix:'AltPowers_', tableDef:fields.AltPowers_table}, + }); + const miTypeLists = Object.freeze({ + miscellaneous: {type:'miscellaneous',field:fields.ItemMiscList}, + protectioncloak:{type:'miscellaneous',field:fields.ItemMiscList}, + protectionboots:{type:'miscellaneous',field:fields.ItemMiscList}, + weapon: {type:'weapon',field:fields.ItemWeaponList}, + melee: {type:'weapon',field:fields.ItemWeaponList}, + innatemelee: {type:'weapon',field:fields.ItemWeaponList}, + ranged: {type:'weapon',field:fields.ItemWeaponList}, + innateranged: {type:'weapon',field:fields.ItemWeaponList}, + ammo: {type:'ammo',field:fields.ItemWeaponList}, + armor: {type:'armour',field:fields.ItemArmourList}, + armour: {type:'armour',field:fields.ItemArmourList}, + totalac: {type:'armour',field:fields.ItemArmourList}, + shield: {type:'armour',field:fields.ItemArmourList}, + helm: {type:'armour',field:fields.ItemArmourList}, + barding: {type:'armour',field:fields.ItemArmourList}, + ring: {type:'ring',field:fields.ItemRingList}, + protectionring: {type:'ring',field:fields.ItemRingList}, + potion: {type:'potion',field:fields.ItemPotionList}, + scroll: {type:'scroll',field:fields.ItemScrollList}, + scrollcase: {type:'scroll',field:fields.ItemScrollList}, + rod: {type:'rod',field:fields.ItemWandsList}, + staff: {type:'rod',field:fields.ItemWandsList}, + wand: {type:'rod',field:fields.ItemWandsList}, + magic: {type:'rod',field:fields.ItemWandsList}, + dmitem: {type:'dmitem',field:fields.ItemDMList}, + equipment: {type:'equipment',field:fields.ItemEquipList}, + light: {type:'equipment',field:fields.ItemEquipList}, + treasure: {type:'treasure',field:fields.ItemTreasureList}, + attackmacro: {type:'attack',field:fields.ItemAttacksList}, + style: {type:'style',field:fields.ItemWeaponList}, + ability: {type:'ability',field:fields.ItemAbilitiesList}, + trap: {type:'trap',field:fields.ItemTrapsList}, + lock: {type:'lock',field:fields.ItemLocksList}, + }); + var clTypeLists = { + warriorclass: {type:'warrior',field:fields.ClassWarriorList,query:''}, + warriorhrclass: {type:'warrior',field:fields.ClassWarriorList,query:''}, + warriorkitclass:{type:'warrior',field:fields.ClassWarriorList,query:''}, + wizardclass: {type:'wizard',field:fields.ClassWizardList,query:''}, + wizardhrclass: {type:'wizard',field:fields.ClassWizardList,query:''}, + wizardkitclass: {type:'wizard',field:fields.ClassWizardList,query:''}, + priestclass: {type:'priest',field:fields.ClassPriestList,query:''}, + priesthrclass: {type:'priest',field:fields.ClassPriestList,query:''}, + priesthoodclass:{type:'priest',field:fields.ClassPriestList,query:''}, + priestkitclass: {type:'priest',field:fields.ClassPriestList,query:''}, + rogueclass: {type:'rogue',field:fields.ClassRogueList,query:''}, + roguehrclass: {type:'rogue',field:fields.ClassRogueList,query:''}, + roguekitclass: {type:'rogue',field:fields.ClassRogueList,query:''}, + psionclass: {type:'psion',field:fields.ClassPsionList,query:''}, + psionhrclass: {type:'psion',field:fields.ClassPsionList,query:''}, + psionkitclass: {type:'psion',field:fields.ClassPsionList,query:''}, + creatureclass: {type:'creature',field:fields.ClassCreatureList,query:''}, + humanoidrace: {type:'humanoid',field:fields.RaceHumanoidList,query:''}, + humanoidhrrace: {type:'humanoid',field:fields.RaceHumanoidList,query:''}, + humanoidkitrace:{type:'humanoid',field:fields.RaceHumanoidList,query:''}, + humanoidcreature:{type:'creature',field:fields.RaceCreatureList,query:''}, + creaturerace: {type:'creature',field:fields.RaceCreatureList,query:''}, + creaturehrrace: {type:'creature',field:fields.RaceCreatureList,query:''}, + creaturekitrace:{type:'creature',field:fields.RaceCreatureList,query:''}, + npccreature: {type:'npc',field:fields.RaceNPCList,query:''}, + container: {type:'container',field:fields.ContainerList,query:''}, + }; + const spTypeLists = Object.freeze({ + muspelll1: {type:'muspelll1',field:['spellmem','current']}, + muspelll2: {type:'muspelll2',field:['spellmem2','current']}, + muspelll3: {type:'muspelll3',field:['spellmem3','current']}, + muspelll4: {type:'muspelll4',field:['spellmem4','current']}, + muspelll5: {type:'muspelll5',field:['spellmem30','current']}, + muspelll6: {type:'muspelll6',field:['spellmem5','current']}, + muspelll7: {type:'muspelll7',field:['spellmem6','current']}, + muspelll8: {type:'muspelll8',field:['spellmem7','current']}, + muspelll9: {type:'muspelll9',field:['spellmem8','current']}, + muspelll0: {type:'muspelll0',field:['spellmem20','current']}, + prspelll1: {type:'prspelll1',field:['spellmem10','current']}, + prspelll2: {type:'prspelll2',field:['spellmem11','current']}, + prspelll3: {type:'prspelll3',field:['spellmem12','current']}, + prspelll4: {type:'prspelll4',field:['spellmem13','current']}, + prspelll5: {type:'prspelll5',field:['spellmem14','current']}, + prspelll6: {type:'prspelll6',field:['spellmem15','current']}, + prspelll7: {type:'prspelll7',field:['spellmem16','current']}, + prspelll0: {type:'prspelll0',field:['spellmem17','current']}, + power: {type:'power', field:['spellmem23','current']}, + itempower: {type:'itempower',field:['spellmem21','current']}, + itemspell: {type:'itemspell',field:['spellmem22','current']}, + melee: {type:'',field:['']}, + innatemelee: {type:'',field:['']}, + ranged: {type:'',field:['']}, + innateranged: {type:'',field:['']}, + magic: {type:'',field:['']}, + innatemagic: {type:'',field:['']}, + }); + const primeClasses=['Warrior','Wizard','Priest','Rogue','Psion','Creature']; + const classLevels = [ + [fields.Fighter_class,fields.Fighter_level], + [fields.Wizard_class,fields.Wizard_level], + [fields.Priest_class,fields.Priest_level], + [fields.Rogue_class,fields.Rogue_level], + [fields.Psion_class,fields.Psion_level], + [fields.Fighter_class,fields.Monster_hitDice] + ]; + const casterLevels = [ + [fields.Wizard_class,fields.Wizard_level,'MU'], + [fields.Priest_class,fields.Priest_level,'PR'], + [fields.Fighter_class,fields.Fighter_level,'F'], + [fields.Rogue_class,fields.Rogue_level,'RO'], + [fields.Psion_class,fields.Psion_level,'PS'], + [fields.Fighter_class,fields.Monster_hitDice,'M'] + ]; + var classMap = [[fields.ClassMap1,fields.LevelMap1],[fields.ClassMap2,fields.LevelMap2],[fields.ClassMap3,fields.LevelMap3]]; + + const baseThac0table = [ + [20,20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1], + [20,20,20,20,19,19,19,18,18,18,17,17,17,16,16,16,15,15,15,14,14], + [20,20,20,20,18,18,18,16,16,16,14,14,14,12,12,12,10,10,10,8,8], + [20,20,20,19,19,18,18,17,17,16,16,15,15,14,14,13,13,12,12,11,11], + [20,20,20,19,19,18,18,17,17,16,16,15,15,14,14,13,13,12,12,11,11], + ]; + + const exstrIndex = [0,50,75,90,99,100]; + const numNames = ['','1st','2nd','3rd','4th','5th','6th','7th','8th','9th']; + + const attrMods = { + str: { + hit: {field:fields.Strength_hit,data:[0,-5,-3,-3,-2,-2,-1,-1,0,0,0,0,0,0,0,0,0,1,1,1,2,2,2,3,3,3,4,4,5,6,7]}, + dmg: {field:fields.Strength_dmg,data:[0,-4,-2,-1,-1,-1,0,0,0,0,0,0,0,0,0,0,1,1,2,3,3,4,5,6,7,8,9,10,11,12,14]}, + weight: {field:fields.MaxWeight,data:[0,1,1,5,10,10,20,20,35,35,40,40,45,45,55,55,70,85,110,135,160,185,235,335,485,535,635,785,935,1235,1535]}, + press: {field:fields.MaxPress,data:[0,3,5,10,25,25,55,55,90,90,115,115,140,140,170,170,195,220,255,280,305,330,380,480,640,700,810,970,1130,1440,1750]}, + opendoor: {field:fields.OpenDoors,data:[[0,1,1,2,3,3,4,4,5,5,6,6,7,7,8,8,9,10,11,12,13,14,15,16,16,17,17,18,18,19,19], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,3,6,8,10,12,14,16,17,18]]}, + bendbars: {field:fields.BendBars,data:[0,0,0,0,0,0,0,0,1,1,2,2,4,4,7,7,10,13,16,20,25,30,35,40,50,60,70,80,90,95,99]}, + }, + dex: { + react: {field:fields.Dex_react,data:[0,-6,-4,-3,-2,-1,0,0,0,0,0,0,0,0,0,0,1,2,2,3,3,4,4,4,5,5]}, + missile: {field:fields.Dex_missile,data: [0,-6,-4,-3,-2,-1,0,0,0,0,0,0,0,0,0,0,1,2,2,3,3,4,4,4,5,5]}, + defadj: {field:fields.Dex_acBonus,data:[0,5,5,4,3,2,1,0,0,0,0,0,0,0,0,-1,-2,-3,-4,-4,-4,-5,-5,-5,-6,-6]}, + }, + con: { + hpadj: {field:fields.HPconAdj,data:[0,-3,-2,-2,-1,-1,-1,0,0,0,0,0,0,0,0,1,2,2,2,2,2,2,2,2,2,2]}, + fighthp: {field:fields.HPconAdj,data:[0,-3,-2,-2,-1,-1,-1,0,0,0,0,0,0,0,0,1,2,3,4,5,5,6,6,6,7,7]}, + syshock: {field:fields.SystemShock,data:[0,25,30,35,40,45,50,55,60,65,70,75,80,85,88,90,95,97,99,99,99,99,99,99,99,100]}, + resurrect: {field:fields.ResSurvive,data:[0,30,35,40,45,50,55,60,65,70,75,80,85,90,92,94,96,98,100,100,100,100,100,100,100,100]}, + poison: {field:fields.ConPoison,data:[0,-2,-1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,2,2,3,3,4]}, + regen: {field:fields.Regenerate,data:[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,6,5,4,3,2,1]}, + }, + int: { + lang: {field:fields.Languages,data:[0,0,1,1,1,1,1,1,1,1,2,2,2,3,3,4,4,5,6,7,8,9,10,11,12,15,20]}, + splev: {field:fields.SpellLevel,data:[0,0,0,0,0,0,0,0,0,4,5,5,6,6,7,7,8,8,9,9,9,9,9,9,9,9]}, + learn: {field:fields.LearnSpell,data:[0,0,0,0,0,0,0,0,0,35,40,45,50,55,60,65,70,75,85,95,96,97,98,99,100,100]}, + perlev: {field:fields.SpellMax,data:[0,0,0,0,0,0,0,0,0,6,7,7,7,9,9,11,11,14,18,99,99,99,99,99,99,99]}, + illusion: {field:fields.IllusionImmune,data:['','','','','','','','','','','','','','','','','','','','1st','2nd','3rd','4th','5th','6th','7th']}, + }, + wis: { + wisdef: {field:fields.Wisdom_defAdj,data:[0,-6,-4,-3,-2,-1,-1,-1,0,0,0,0,0,0,0,1,2,3,4,4,4,4,4,4,4,4]}, + wisbonus: {field:fields.BonusSpells,data:[[0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,2,2,3,4,3,4,5,5,6,6,7], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,2,3,4,1,5,6]]}, + fail: {field:fields.SpellFail,data:[0,80,60,50,45,40,35,30,25,20,15,10,5,0,0,0,0,0,0,0,0,0,0,0,0,0]}, + immune: {field:fields.SpellImmune,data:['','','','','','','','','','','','','','','','','','','','Cause Fear,Charm Person,Command,Friends,Hypnotism','Forget,Hold Person,Ray of Enfeeblement,Scare,Fear','Charm Monster,Confusion,Emotion,Fumble,Suggestion','Chaos,Feeblemind,Hold Monster,Magic Jar,Quest,Geas,Mass Suggestion,Rod of Rulership','Antipathy/Sympathy,Death Spell,Mass Charm']}, + }, + chr: { + hench: {field:fields.ChrHench,data:[0,0,1,1,1,2,2,3,3,4,4,4,5,5,6,7,8,10,15,20,25,30,35,40,45,50]}, + loyalty: {field:fields.ChrLoyalty,data:[0,-8,-7,-6,-5,-4,-3,-2,-1,0,0,0,0,0,1,3,4,6,8,10,12,14,16,18,20,20]}, + react: {field:fields.ChrReact,data:[0,-7,-6,-5,-4,-3,-2,-1,0,0,0,0,0,1,2,3,5,6,7,8,10,15,20,25,30,35,40,45,50]}, + }, + }; + + var saveFormat = { + Saves: { + Paralysis: {save:fields.Saves_paralysis,mod:fields.Saves_modParalysis,mon:fields.Saves_monParalysis,index:0,roll:'1d20',tag:'par'}, + Poison: {save:fields.Saves_poison,mod:fields.Saves_modPoison,mon:fields.Saves_monPoison,index:0,roll:'1d20',tag:'poi'}, + Death: {save:fields.Saves_death,mod:fields.Saves_modDeath,mon:fields.Saves_monDeath,index:0,roll:'1d20',tag:'dea'}, + Rod: {save:fields.Saves_rod,mod:fields.Saves_modRod,mon:fields.Saves_monRod,index:1,roll:'1d20',tag:'rod'}, + Staff: {save:fields.Saves_staff,mod:fields.Saves_modStaff,mon:fields.Saves_monStaff,index:1,roll:'1d20',tag:'sta'}, + Wand: {save:fields.Saves_wand,mod:fields.Saves_modWand,mon:fields.Saves_monWand,index:1,roll:'1d20',tag:'wan'}, + Petrification: {save:fields.Saves_petrification,mod:fields.Saves_modPetrification,mon:fields.Saves_monPetri,index:2,roll:'1d20',tag:'pet'}, + Polymorph: {save:fields.Saves_polymorph,mod:fields.Saves_modPolymorph,mon:fields.Saves_monPolymorph,index:2,roll:'1d20',tag:'pol'}, + Breath: {save:fields.Saves_breath,mod:fields.Saves_modBreath,mon:fields.Saves_monBreath,index:3,roll:'1d20',tag:'bre'}, + Spell: {save:fields.Saves_spell,mod:fields.Saves_modSpell,mon:fields.Saves_monSpell,index:4,roll:'1d20',tag:'spe'}, + }, + Attributes: { + Strength: {save:fields.Strength,mod:fields.Saves_modStrength,roll:'1d20',tag:'str'}, + Constitution: {save:fields.Constitution,mod:fields.Saves_modConstitution,roll:'1d20',tag:'con'}, + Dexterity: {save:fields.Dexterity,mod:fields.Saves_modDexterity,roll:'1d20',tag:'dex'}, + Intelligence: {save:fields.Intelligence,mod:fields.Saves_modIntelligence,roll:'1d20',tag:'int'}, + Wisdom: {save:fields.Wisdom,mod:fields.Saves_modWisdom,roll:'1d20',tag:'wis'}, + Charisma: {save:fields.Charisma,mod:fields.Saves_modCharisma,roll:'1d20',tag:'chr'}, + }, + Checks: { + Open_Doors: {save:fields.OpenDoors,mod:fields.Saves_modOpenDoors,roll:'1d20',tag:'opd'}, + Bend_Bars: {save:fields.BendBars,mod:fields.Saves_modBendBars,roll:'1d100',tag:'bbr'}, + System_Shock: {save:fields.SystemShock,mod:fields.Saves_modSystemShock,roll:'1d100',tag:'sys'}, + Resurrection: {save:fields.ResSurvive,mod:fields.Saves_modResSurvive,roll:'1d100',tag:'res'}, + Learn_Spell: {save:fields.LearnSpell,mod:fields.Saves_modLearnSpell,roll:'1d100',tag:'lsp'}, + Spell_Failure: {save:fields.SpellFail,mod:fields.Saves_modSpellFail,roll:'1d100',tag:'spf'}, + }, + }; + + const rogueSkills = { + pickpockets: {name:'Pick_Pockets',save:['ppt','current'],roll:'{ {1d101},{100} }kl1',tag:'pp',factors:['ppb','ppr','ppd','ppk','ppa','ppm','ppl'],gmrolls:true,success:'You got the item!',failure:'You can try again, unless you are caught!'}, + openlocks: {name:'Open_Locks',save:['olt','current'],roll:'1d100',tag:'ol',factors:['olb','olr','old','olk','ola','olm','oll'],gmrolls:false,success:'Click! After [[1d10]] rounds the lock opens',failure:'Hard luck. [[1d10]] rounds wasted. You can try once per experience level'}, + findtraps: {name:'Find_Traps',save:['rtt','current'],roll:'{ {1d101},{100} }kl1',tag:'rt',factors:['rtb','rtr','rtd','rtk','rta','rtm','rtl'],gmrolls:true,success:'After [[1d10]] rounds you know the general nature of any trap but not exact detail',failure:'[[1d10]] rounds go by. Try again at next level'}, + removetraps: {name:'Remove_Traps',save:['rtt','current'],roll:'{ {1d101},{100} }kl1',tag:'rt',factors:['rtb','rtr','rtd','rtk','rta','rtm','rtl'],gmrolls:true,success:'After [[1d10]] rounds you have successfully removed the trap',failure:'[[1d10]] rounds go by unsuccessfully. 96-00 triggers trap! Try again at next level'}, + movesilently: {name:'Move_Silently',save:['mst','current'],roll:'{ {1d101},{100} }kl1',tag:'ms',factors:['msb','msr','msd','msk','msa','msm','msl'],gmrolls:true,success:'Move at 1/3 rate. Gain -2 to surprise only if also unseen',failure:'Movement still reduced to 1/3'}, + hideinshadows: {name:'Hide_in_Shadows',save:['hst','current'],roll:'{ {1d101},{100} }kl1',tag:'hs',factors:['hsb','hsr','hsd','hsk','hsa','hsm','hsl'],gmrolls:true,success:'Does not work in darkness. Hidden only while motionless except small movements (draw weapon, drin potion etc). Cannot be seen with infravision except in darkness. "See Invisible" will see character',failure:'The character is not hidden'}, + detectnoise: {name:'Detect_Noise',save:['dnt','current'],roll:'{ {1d101},{100} }kl1',tag:'dn',factors:['dnb','dnr','dnd','dnk','dna','dnm','dnl'],gmrolls:true,success:'In silent surrounds & not wearing head-gear, sounds are heard',failure:'Even in silent surrounds & not wearing head-gear, nothing is heard'}, + climbwalls: {name:'Climb_Walls',save:['cwt','current'],roll:'1d100',tag:'cw',factors:['cwb','cwr','cwd','cwk','cwa','cwm','cwl'],gmrolls:false,success:'Can climb up to 100ft in 10 rounds, then roll again',failure:'Can\'t start or is stuck where currently is. Try again somewhere significantly different'}, + readlanguages: {name:'Read_Languages',save:['rlt','current'],roll:'1d100',tag:'rl',factors:['rlb','rlr','rld','rlk','rla','rlm','rll'],gmrolls:false,success:'Can understand about value2% of the meaning',failure:'Not understandable at all. Try again at next level'}, + legendlore: {name:'Legend_Lore',save:['ibt','current'],roll:'1d100',tag:'ib',factors:['ibb','ibr','ibd','ibk','iba','ibm','ibl'],gmrolls:false,success:'In [[1d10]] rounds of examination you learn some general information',failure:'[[1d10]] rounds of examination reveal nothing'}, + }; + const thiefSkillFactors = ['Base','Race','Dexterity','Kit','Armour','Magic','Level']; + + const rogueDexMods = [{lv:9,pp:-15,ol:-10,rt:-10,ms:-20,hs:-10,dn:0,cw:0,rl:0,ll:0}, + {lv:10,pp:-10,ol:-5,rt:-10,ms:-15,hs:-5,dn:0,cw:0,rl:0,ll:0}, + {lv:11,pp:-5,ol:0,rt:-5,ms:-10,hs:0,dn:0,cw:0,rl:0,ll:0}, + {lv:12,pp:0,ol:0,rt:0,ms:-5,hs:0,dn:0,cw:0,rl:0,ll:0}, + {lv:13,pp:0,ol:0,rt:0,ms:0,hs:0,dn:0,cw:0,rl:0,ll:0}, + {lv:14,pp:0,ol:0,rt:0,ms:0,hs:0,dn:0,cw:0,rl:0,ll:0}, + {lv:15,pp:0,ol:0,rt:0,ms:0,hs:0,dn:0,cw:0,rl:0,ll:0}, + {lv:16,pp:0,ol:5,rt:0,ms:0,hs:0,dn:0,cw:0,rl:0,ll:0}, + {lv:17,pp:5,ol:10,rt:0,ms:5,hs:5,dn:0,cw:0,rl:0,ll:0}, + {lv:18,pp:10,ol:15,rt:5,ms:10,hs:10,dn:0,cw:0,rl:0,ll:0}, + {lv:19,pp:15,ol:20,rt:10,ms:15,hs:15,dn:0,cw:0,rl:0,ll:0}, + ]; + + var ordMU =['wizard', + 'magicuser', + 'mage', + 'mu']; + + var specMU = ['abjurer', + 'conjurer', + 'diviner', + 'enchanter', + 'illusionist', + 'invoker', + 'necromancer', + 'transmuter']; + + const wisdomSpells = [ + [0,0,0,0,0,0,0,0,0,0,0,0,0,1,2,2,2,2,2,3,3,3,3,4,4], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,2,2,2,2,3,3,3,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,2,2,2,3,3,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,2,2,3,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,2,2,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,2] + ]; + const spellLevels = Object.freeze({ + mu: [{ spells: 0, base: 0, book: 0 }, + { spells: 0, base: 1, book: '' }, + { spells: 0, base: 4, book: 2 }, + { spells: 0, base: 7, book: 3 }, + { spells: 0, base: 10, book: 4 }, + { spells: 0, base: 70, book: 30}, + { spells: 0, base: 13, book: 5 }, + { spells: 0, base: 16, book: 6 }, + { spells: 0, base: 19, book: 7 }, + { spells: 0, base: 22, book: 8 }], + pr: [{ spells: 0, base: 0, book: 0 }, + { spells: 0, base: 28, book: 10}, + { spells: 0, base: 31, book: 11}, + { spells: 0, base: 34, book: 12}, + { spells: 0, base: 37, book: 13}, + { spells: 0, base: 40, book: 14}, + { spells: 0, base: 43, book: 15}, + { spells: 0, base: 46, book: 16}], + pw: [{ spells: 0, base: 0, book: 0 }, + { spells: 1, base: 67, book: 23}], + mi: [{ spells: 0, base: 0, book: 0 }, + { spells: 0, base: 64, book: 22}], + pm: [{ spells: 0, base: 0, book: 0 }, + { spells: 0, base: 61, book: 21}], + }); + + var spellsPerLevel = { + wizard: {MU:[[9,1,100,'MU'], + [0,1,2,2,3,4,4,4,4,4,4,4,4,5,5,5,5,5,5,5,5], + [0,0,0,1,2,2,2,3,3,3,4,4,4,5,5,5,5,5,5,5,5], + [0,0,0,0,0,1,2,2,3,3,3,4,4,5,5,5,5,5,5,5,5], + [0,0,0,0,0,0,0,1,2,2,2,3,4,4,4,5,5,5,5,5,5], + [0,0,0,0,0,0,0,0,0,1,2,3,4,4,4,5,5,5,5,5,5], + [0,0,0,0,0,0,0,0,0,0,0,0,1,2,2,2,3,3,3,3,4], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,2,3,3,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,2,2,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,2], + ]}, + priest: {PR:[[7,1,100,'PR'], + [0,1,2,2,3,3,3,3,3,4,4,5,6,6,6,6,7,7,8,9,9], + [0,0,0,1,2,3,3,3,3,4,4,4,5,6,6,6,7,7,8,9,9], + [0,0,0,0,0,1,2,2,3,3,3,4,5,6,6,6,7,7,8,8,9], + [0,0,0,0,0,0,0,1,2,2,3,3,3,4,5,6,6,7,8,8,8], + [0,0,0,0,0,0,0,0,0,1,2,2,2,2,3,4,4,5,6,6,7], + [0,0,0,0,0,0,0,0,0,0,0,1,2,2,2,2,3,3,4,4,5], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,2,2,2,2], + ]}, + ranger: {PR:[[3,8,9,'PR'], + [0,0,0,0,0,0,0,0,1,2,2,2,2,3,3,3,3], + [0,0,0,0,0,0,0,0,0,0,1,2,2,2,2,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,1,1,2,2,3], + ]}, + paladin:{PR:[[4,9,9,'PR'], + [0,0,0,0,0,0,0,0,0,1,2,2,2,2,3,3,3,3,3,3,3], + [0,0,0,0,0,0,0,0,0,0,0,1,2,2,2,2,3,3,3,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,2,3,3,3,3], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,2,3], + ]}, + bard: {MU:[[6,1,100,'MU'], + [0,0,1,2,2,3,3,3,3,3,3,3,3,3,3,3,4,4,4,4,4], + [0,0,0,0,1,1,2,2,3,3,3,3,3,3,3,3,3,4,4,4,4], + [0,0,0,0,0,0,0,1,1,2,2,3,3,3,3,3,3,3,4,4,4], + [0,0,0,0,0,0,0,0,0,0,1,1,2,2,3,3,3,3,3,4,4], + [0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,2,2,3,3,3,4], + [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,2,2,3], + ]}, + other: {MU:[[0,0,0,'']], + PR:[[0,0,0,'']]}, + }; + var defaultNonProfPenalty = [ + [fields.Fighter_class,fields.Fighter_level,-2], + [fields.Wizard_class,fields.Wizard_level,-5], + [fields.Priest_class,fields.Priest_level,-3], + [fields.Rogue_class,fields.Rogue_level,-3], + [fields.Psion_class,fields.Psion_level,-4], + [fields.Monster_class,fields.Monster_level,-2], + ]; + var rangedWeapMods = { + N : -5, + PB : 2, + S : 0, + M : -2, + L : -5, + F : -20, + }; + var saveLevels = { + warrior: [0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9], + wizard: [0,1,1,1,1,1,2,2,2,2,2,3,3,3,3,3,4,4,4,4,4,5], + priest: [0,1,1,1,2,2,2,3,3,3,4,4,4,5,5,5,6,6,6,7], + rogue: [0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,6], + psion: [0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,6], + creature: [0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9], + }; + var baseSaves = { + warrior: [[16,18,17,20,19],[14,16,15,17,17],[13,15,14,16,16],[11,13,12,13,14],[10,12,11,12,13],[8,10,9,9,11],[7,9,8,8,10],[5,7,6,5,8],[4,6,5,4,7],[3,5,4,4,6]], + wizard: [[16,18,17,20,19],[14,11,13,15,12],[13,9,11,13,10],[11,7,9,11,8],[10,5,7,9,6],[8,3,5,7,4]], + priest: [[16,18,17,20,19],[10,14,13,16,15],[9,13,12,15,14],[7,11,10,13,12],[6,10,9,12,11],[5,9,8,11,10],[4,8,7,10,9],[2,6,5,8,7]], + rogue: [[16,18,17,20,19],[13,14,12,16,15],[12,12,11,15,13],[11,10,10,14,11],[10,8,9,13,9],[9,6,8,12,7],[8,4,7,11,5]], + psion: [[16,18,17,20,19],[13,15,10,16,15],[12,13,9,15,14],[11,11,8,13,12],[10,9,7,12,7],[9,7,6,11,9],[8,5,5,9,7]], + creature: [[16,18,17,20,19],[14,16,15,17,17],[13,15,14,16,16],[11,13,12,13,14],[10,12,11,12,13],[8,10,9,9,11],[7,9,8,8,10],[5,7,6,5,8],[4,6,5,4,7],[3,5,4,4,6]], + }; + var classSaveMods = { + undefined: {att:'con',par:0,poi:0,dea:0,rod:0,sta:0,wan:0,pet:0,pol:0,bre:0,spe:0,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + paladin: {att:'con',par:2,poi:2,dea:2,rod:2,sta:2,wan:2,pet:2,pol:2,bre:2,spe:2,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + }; + var raceSaveMods = { + undefined: {att:'con',par:0,poi:0,dea:0,rod:0,sta:0,wan:0,pet:0,pol:0,bre:0,spe:0,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + dwarf: {att:'con',par:0,poi:3.5,dea:0,rod:3.5,sta:3.5,wan:3.5,pet:0,pol:0,bre:0,spe:3.5,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + elf: {att:'con',par:0,poi:0,dea:0,rod:0,sta:0,wan:0,pet:0,pol:0,bre:0,spe:0,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + gnome: {att:'con',par:0,poi:0,dea:0,rod:3.5,sta:3.5,wan:3.5,pet:0,pol:0,bre:0,spe:3.5,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + halfelf: {att:'con',par:0,poi:0,dea:0,rod:0,sta:0,wan:0,pet:0,pol:0,bre:0,spe:0,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + halfling: {att:'con',par:0,poi:3.5,dea:0,rod:3.5,sta:3.5,wan:3.5,pet:0,pol:0,bre:0,spe:3.5,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + halforc: {att:'con',par:0,poi:0,dea:0,rod:0,sta:0,wan:0,pet:0,pol:0,bre:0,spe:0,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + human: {att:'con',par:0,poi:0,dea:0,rod:0,sta:0,wan:0,pet:0,pol:0,bre:0,spe:0,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + creature: {att:'con',par:0,poi:0,dea:0,rod:0,sta:0,wan:0,pet:0,pol:0,bre:0,spe:0,str:0,con:0,dex:0,int:0,wis:0,chr:0}, + }; + const xlateSave = {att:'Attribute',par:'Paralysis',poi:'Poison',dea:'Death',rod:'Rod',sta:'Staff',wan:'Wand',pet:'Petrify',pol:'Polymorph',bre:'Breath',spe:'Spell',str:'Strength',con:'Constitution',dex:'Dexterity',int:'Intelligence',wis:'Wisdom',chr:'Charisma',pp:'Pick Pockets',ol:'Open Locks',rt:'Find/Remove Traps',ms:'Move Silently',hs:'Hide in Shadows',dn:'Detect Noise',cw:'Climb Walls',rl:'Read Languages',ib:'Legend Lore'}; + var classNonProfPenalty = {}; + var raceToHitMods = { + elf: [['bow',1],['longsword',1],['shortsword',1]], + halfling: [['sling',1],['thrownblade',1]], + }; + var classAllowedWeaps = { + warrior: ['any'], + fighter: ['any'], + ranger: ['any'], + paladin: ['any'], + beastmaster: ['any'], + barbarian: ['any'], + defender: ['axe','clubs','flails','longblade','fencingblade','mediumblade','shortblade','polearm'], + wizard: ['dagger','staff','dart','knife','sling'], + mage: ['dagger','staff','dart','knife','sling'], + mu: ['dagger','staff','dart','knife','sling'], + abjurer: ['dagger','staff','dart','knife','sling'], + conjurer: ['dagger','staff','dart','knife','sling'], + diviner: ['dagger','staff','dart','knife','sling'], + enchanter: ['dagger','staff','dart','knife','sling'], + illusionist: ['dagger','staff','dart','knife','sling'], + invoker: ['dagger','staff','dart','knife','sling'], + necromancer: ['dagger','staff','dart','knife','sling'], + transmuter: ['dagger','staff','dart','knife','sling'], + priest: ['clubs','hammer','staff'], + cleric: ['clubs','hammer','staff'], + druid: ['club','sickle','dart','spear','dagger','scimitar','sling','staff'], + healer: ['club','quarterstaff','mancatcher','sling'], + priestofagriculture: ['hooks','flails','handaxe','throwingaxe','scythe','sickle'], + priestofancestors: ['club','dagger','dirk','dart','knife','staff'], + priestofanimals: ['hooks','cestus','clubs','maingauche','greatblade','longblade','mediumblade','shortblade','fencingblade','warhammer'], + priestofarts: ['bow'], + priestoflife: ['club','quarterstaff','mancatcher','sling'], + priestofwar: ['any'], + priestoflight: ['dart','javelin','spears'], + priestofknowledge: ['sling','quarterstaff'], + shaman: ['longblade','mediumblade','shortblade','blowgun','club','staff','shortbow','horsebow','handcrossbow'], + rogue: ['club','shortblade','dart','handcrossbow','lasso','shortbow','sling','broadsword','longsword','staff'], + thief: ['club','shortblade','dart','handcrossbow','lasso','shortbow','sling','broadsword','longsword','staff'], + bard: ['any'], + assassin: ['any'], + psion: ['shortbow','handcrossbow','lightcrossbow','shortblade','clubs','axe','horsemanspick','scimitar','spears','warhammer'], + }; + var classAllowedArmour = { + warrior: ['any'], + fighter: ['any'], + ranger: ['any'], + paladin: ['any'], + beastmaster: ['any'], + barbarian: ['padded','leather','hide','brigandine','ringmail','scalemail','chainmail','shield','ring','magicitem','cloak'], + defender: ['any'], + wizard: ['magicitem','ring','cloak'], + mage: ['magicitem','ring','cloak'], + mu: ['magicitem','ring','cloak'], + abjurer: ['magicitem','ring','cloak'], + conjurer: ['magicitem','ring','cloak'], + diviner: ['magicitem','ring','cloak'], + enchanter: ['magicitem','ring','cloak'], + illusionist: ['magicitem','ring','cloak'], + invoker: ['magicitem','ring','cloak'], + necromancer: ['magicitem','ring','cloak'], + transmuter: ['magicitem','ring','cloak'], + priest: ['any'], + cleric: ['any'], + druid: ['leather','padded','hide','woodenshield','magicitem','ring','cloak'], + healer: ['any'], + priestofagriculture: ['leather','padded','hide','woodenshield','magicitem','ring','cloak'], + priestofancestors: ['magicitem','ring','cloak'], + priestofanimals: ['leather','padded','hide','magicitem','ring','cloak'], + priestofarts: ['magicitem','ring','cloak'], + priestofbirth: ['magicitem','ring','cloak'], + priestofchildren: ['magicitem','ring','cloak'], + priestofcommunity: ['any'], + priestofcompetition: ['any'], + priestofcrafts: ['leather','padded','hide','shields','magicitem','ring','cloak'], + priestofculture: ['any','-shields'], + priestofdarkness: ['leather','padded','hide','magicitem','ring','cloak'], + priestofnight: ['leather','padded','hide','magicitem','ring','cloak'], + priestoflife: ['any'], + priestofwar: ['any'], + priestoflight: ['studdedleather','ringmail','chainmail','shield','ring','magicitem','cloak'], + priestofknowledge: ['magicitem','ring','cloak'], + shaman: ['padded','leather','hide','brigandine','ringmail','scalemail','chainmail','splintmail','bandedmail','shield','ring','magicitem','cloak'], + rogue: ['padded','leather','studdedleather','elvenchain','shield','ring','magicitem','cloak'], + thief: ['padded','leather','studdedleather','elvenchain','shield','ring','magicitem','cloak'], + bard: ['padded','leather','hide','brigandine','ringmail','scalemail','chainmail','ring','magicitem','cloak'], + assassin: ['any'], + psion: ['leather','studdedleather','hide','smallshield','ring','magicitem','cloak'], + }; + var weapMultiAttks = { + fighter: { + Levels: ['0','7','13'], + Proficient: { melee: ['0','1/2','1'], + ranged: ['0','0','0'], + }, + }, + All: { + Specialist: { melee: ['1/2','1','3/2'], + lightxbow: ['0','1/2','1'], + heavyxbow: ['0','1/2','1'], + throwndagger: ['1','2','3'], + throwndart: ['1','2','3'], + bow: ['0','0','0'], + arquebus: ['1/3','2/3','7/6'], + blowgun: ['1','2','3'], + knife: ['1','2','3'], + sling: ['1','2','3'], + ranged: ['0','1/2','1'], + }, + }, + }; + + const punchWrestle = [ {punch:'Haymaker',dmg:2,ko:25,wrestle:'Bearhug',hold:true}, + {punch:'Wild swing',dmg:0,ko:2,wrestle:'Leg twist',hold:false}, + {punch:'Uppercut',dmg:2,ko:15,wrestle:'Headlock',hold:true}, + {punch:'Hook',dmg:2,ko:12,wrestle:'Gouge',hold:false}, + {punch:'Rabbit punch',dmg:2,ko:5,wrestle:'Arm lock',hold:true}, + {punch:'Glancing blow',dmg:1,ko:3,wrestle:'Kick',hold:false}, + {punch:'Jab',dmg:2,ko:8,wrestle:'Gouge',hold:false}, + {punch:'Combination',dmg:2,ko:10,wrestle:'Throw',hold:false}, + {punch:'Uppercut',dmg:1,ko:9,wrestle:'Headlock',hold:true}, + {punch:'Combination',dmg:1,ko:10,wrestle:'Leg lock',hold:true}, + {punch:'Glancing blow',dmg:1,ko:3,wrestle:'Elbow smash',hold:false}, + {punch:'Hook',dmg:2,ko:10,wrestle:'Gouge',hold:false}, + {punch:'Kidney punch',dmg:1,ko:5,wrestle:'Throw',hold:false}, + {punch:'Hook',dmg:2,ko:9,wrestle:'Leg lock',hold:false}, + {punch:'Uppercut',dmg:1,ko:8,wrestle:'Leg twist',hold:false}, + {punch:'Jab',dmg:2,ko:6,wrestle:'Arm lock',hold:true}, + {punch:'Glancing blow',dmg:1,ko:2,wrestle:'Elbow smash',hold:false}, + {punch:'Kidney punch',dmg:1,ko:5,wrestle:'Trip',hold:false}, + {punch:'Rabbit punch',dmg:1,ko:3,wrestle:'Kick',hold:false}, + {punch:'Wild swing',dmg:0,ko:1,wrestle:'Arm twist',hold:false}, + {punch:'Haymaker',dmg:2,ko:10,wrestle:'Bearhug',hold:true} + ]; + + const reIgnore = /[-_\s\(\)]/g; + const settings_icon = 'https://s3.amazonaws.com/files.d20.io/images/11920672/7a2wOvU1xjO-gK5kq5whgQ/thumb.png?1440940765'; + const defaultImg = 'https://s3.amazonaws.com/files.d20.io/images/2796029/tJUjL-ilXyG-Ohu6T2Ykvg/thumb.png?1390103367'; + const defaultAs = 'RPGMaster'; + const archive = false; + const use3Ddice = false; + const stdDB = ['mu_spells_db','mu_spells_db_l1','mu_spells_db_l2','mu_spells_db_l3','mu_spells_db_l4','mu_spells_db_l5','mu_spells_db_l6','mu_spells_db_l7','mu_spells_db_l8','mu_spells_db_l9','mu_spells_db_custom','pr_spells_db_l1','pr_spells_db_l2','pr_spells_db_l3','pr_spells_db_l4','pr_spells_db_l5','pr_spells_db_l6','pr_spells_db_l7','pr_spells_db_custom','powers_db','mi_db','mi_db_custom','mi_db_ammo','mi_db_armour','mi_db_equipment','mi_db_treasure','mi_db_potions','mi_db_rings','mi_db_scrolls_books','mi_db_wands_staves_rods','mi_db_weapons','attacks_db','class_db','race_db','race_db_creatures_a_e','race_db_creatures_f_j','race_db_creatures_k_o','race_db_creatures_p_t','race_db_creatures_u_z','styles_db','abilities_db']; + const waitMsgDiv = '| '; + const endHeaderFrame = ' |
'; + const endSubtitle1 = ''; + const subtitle2 = '
'; + const endSubtitle2 = ''; + const settings = '
'),cmd => LibFunctions.sendAPI(LibFunctions.parseStr(cmd))); + } else if (txtObj.failcmd && txtObj.failcmd.length && !result) { + while (/%%[_\d\w\+-]+?%%/.test(txtObj.failcmd)) txtObj.failcmd = txtObj.failcmd.replace( /%%([_\d\w\+-]+?)%%/, varReplace ); + _.each(txtObj.failcmd.split('
'),cmd => LibFunctions.sendAPI(LibFunctions.parseStr(cmd))); + }; + } + }; + content += (hasDescs ? bodyFrame : lastBodyFrame) + +rowResult[result ? 0 : 1]+rowC+''+ ((isMax || crit) ? 'Natural '+dice_roll : ((isMin || fumble) ? 'Natural '+dice_roll : (result ? 'Success' : 'Failure'))) +''+endRowC+endRowResult + +endBodyFrame; + } + if (hasDescs) { + content += lastBodyFrame + +addDescs(txtObj,1) + +endBodyFrame; + } + content += endOuterFrame; + return content; + }; + + const RPGMspell = function( txt, preamble ) { + const spellDefaults = {prefix:'', title:'', name:'', splevel:'', school:'', range:'', components:'', duration:'', time:'', aoe:'', save:'', effects:''}; + let k=1; + const txtObj = _.object([...txt.replace(/[\r\n]/g,'').matchAll(/\{\{(.+?)=(.*?)\}\}/g)].map(v => v.slice(1)).map(v => [v[0].replace(/[-\s]/g,'_').toLowerCase(),v[1]])); + const isLooksLike = !isGM && !!txtObj.looks_like; + _.defaults(txtObj,spellDefaults); + const showMore = /{{hide\d=/img.test(originalTxt); + const showLess = /{{desc\d=/img.test(originalTxt); + const txtRowID = generateRowID(); + if (showMore || showLess) showMoreObj[txtRowID] = (preamble+'&{template:'+template+'}'+originalTxt.replace(/{{hide(\d)=/img,'{{reveal$1=').replace(/{{desc(\d)=/img,'{{hide$1=').replace(/{{reveal(\d)=/img,'{{desc$1=') ); + const showMoreButton = (showMore || showLess) ? (' *show '+(showMore ? 'more' : 'less')+'...*') : ''; + const hasDescs = !isLooksLike && /{{\s*desc\d?\s*=/im.test(txt); + var content = outerFrame + +headerFrame + +header2+ (!isLooksLike ? txtObj.prefix : '')+' '+txtObj.title+' '+(!isLooksLike ? txtObj.name : '')+endHeader2 + +(!isLooksLike ? (subtitle2+ txtObj.splevel +' * '+ txtObj.school +endSubtitle2) : '') + +settings + +endHeaderFrame + +lastBodyFrame + +(!isLooksLike ? ( + row2col[++k%2]+rowL+'Range
'+ txtObj.range +endRowL + +rowR+'Components
'+ txtObj.components +endRowR+endRow2col + +row2col[++k%2]+rowL+'Duration
'+ txtObj.duration +endRowL + +rowR+'Casting Time
'+ txtObj.time +endRowR+endRow2col + +row2col[++k%2]+rowL+'Area of Effect
'+ txtObj.aoe +endRowL + +rowR+'Saving Throw
'+ txtObj.save +endRowR+endRow2col + +(txtObj.healing ? (row2col[++k%2]+rowC2+'Healing: '+ txtObj.healing +endRowC2+endRow2col) : '') + +(txtObj.damage ? (row2col[++k%2]+rowC2+'Damage: '+ txtObj.damage +endRowC2+endRow2col) : '') + +(txtObj.reference ? (row2col[++k%2]+rowC2+'Reference: '+ txtObj.reference +endRowC2+endRow2col) : '') + +(txtObj.materials ? (row2col[++k%2]+rowC2+'Materials: '+ txtObj.materials +endRowC2+endRow2col) : '') + +(txtObj.use ? (row2col[++k%2]+row2+'Use: '+ txtObj.use +endRow2+endRow2col) : '') + +(txtObj.learn ? (row2col[++k%2]+row2+'Learn spell: '+ txtObj.learn +endRow2+endRow2col) : '') + +(isGM && txtObj.gm_info ? (row2col[++k%2]+row2+'GM Info: '+ txtObj.gm_info +endRow2+endRow2col) : '') + ) : '') + +(txtObj.looks_like || txtObj.appearance ? (row2col[++k%2]+row2+(!isLooksLike ? 'Looks Like: ' : '')+ (txtObj.looks_like ? txtObj.looks_like : txtObj.appearance) +endRow2+endRow2col) : '') + +(!isLooksLike ? ( + row2col[++k%2]+row2+'Effects: '+ txtObj.effects +showMoreButton +endRow2+endRow2col + +addDescs(txtObj,++k,'',row2col,row2) + ) : ''); + +endBodyFrame + +endOuterFrame; + return content; + } + + const RPGMmessage = function( txt ) { + + const txtObj = _.object([...txt.replace(/[\r\n]/g,'').matchAll(/\{\{(.+?)=(.*?)\}\}/g)].map(v => v.slice(1)).map(v => [v[0].replace(/[-\s]/g,'_').toLowerCase(),v[1]])); + let content = outerFrame; + if (txtObj.name || txtObj.title) { + content += headerFrame + +header1+ (txtObj.title || '')+(txtObj.name || '') +endHeader1 + +settings + +endHeaderFrame + +lastBodyFrame; + } else { + content += fullBodyFrame; + } + content += addDescs(txtObj,1) + +endBodyFrame + +endOuterFrame; + return content; + } + + const RPGMdefault = function( txt, preamble, isShowMore=true ) { + + var value1, value2; + + const resultTest = function( t ) { + let result = false; + const test = t.match(/([\w\s_.+-]+?|[-+]?[\d.]+?)((?:<=|>=|<|>|=|<>|!=))(.+)/); + if (test) { + value1 = (/^[-+]?[\d.]+/.test(test[1])|| _.isUndefined(txtObj[test[1]])) ? parseFloat(test[1]) : parseFloat(txtObj[test[1]].match(/[-+]?[\d.]+/)); + value2 = (/^[-+]?[\d.]+/.test(test[3])|| _.isUndefined(txtObj[test[3]])) ? parseFloat(test[3]) : parseFloat(txtObj[test[3]].match(/[-+]?[\d.]+/)); + switch (test[2]) { + case '=': result = value1 == value2; break; + case '<': result = value1 < value2; break; + case '>': result = value1 > value2; break; + case '<=': result = value1 <= value2; break; + case '>=': result = value1 >= value2; break; + case '<>': result = value1 != value2; break; + case '!=': result = value1 != value2; break; + default: result = false; + } + } + return result; + }; + + const rollVal = (m,v) => LibFunctions.evalAttr(v); + + const defDefaults = {prefix:'', title:'', name:'', success:'', failure:''}; + const txtObj = _.object([...txt.replace(/[\r\n]/g,'').matchAll(/\{\{(.+?)=(.*?)\}\}/g)].map(v => v.slice(1))); + const isLooksLike = !isGM && /{{\s*Looks\s?Like\s*=.*?}}/im.test(txt); + _.defaults(txtObj,defDefaults); + const showMore = /{{hide\d=/img.test(originalTxt); + const showLess = /{{desc\d=/img.test(originalTxt); + const txtRowID = generateRowID(); + if (isShowMore && (showMore || showLess)) showMoreObj[txtRowID] = (preamble+' &{template:'+template+'}'+originalTxt.replace(/{{hide(\d)=/img,'{{reveal$1=').replace(/{{desc(\d)=/img,'{{hide$1=').replace(/{{reveal(\d)=/img,'{{desc$1=') ); + const showMoreButton = (isShowMore && (showMore || showLess)) ? (' *show '+(showMore ? 'more' : 'less')+'...*') : ''; + let content = outerFrame + +headerFrame + +header1+ (!isLooksLike ? txtObj.prefix : '')+' '+txtObj.title+' '+(!isLooksLike ? txtObj.name : '')+endHeader1 + +(txtObj.subtitle && !isLooksLike ? (subtitle1+ txtObj.subtitle +endSubtitle1) : '') + +settings + +endHeaderFrame; + content += lastBodyFrame; + let j=1, crit=false, fumble=false, result=false; + + _.each(txtObj,(t,k) => { + switch (k.dbName()) { + case 'result': result = resultTest(t); break; + case 'critroll': crit = state.attackMaster.weapRules.criticals && resultTest(t); break; + case 'fumbleroll': fumble = state.attackMaster.weapRules.criticals && resultTest(t); break; + default: break; + } + }); + + result = !fumble && (crit || result); +// log('RPGMdefault: result = '+result+', crit = '+crit+', fumble = '+fumble); + _.each(txtObj,(t,k) => { + t = t.replace(/\
' : ''; + content += rowResult[result ? 0 : 1]+row1C+''+ (result ? 'Success' : 'Failure') +'' + + resultTxt+(result ? txtObj.success : txtObj.failure)+(resultTxt.length?'':'')+endRow1C+endRowResult; + if (txtObj.successcmd && txtObj.successcmd.length && result && !crit) { + LibFunctions.sendAPI(LibFunctions.parseStr(txtObj.successcmd)); + } else if (txtObj.failcmd && txtObj.failcmd.length && !result && !fumble) { + LibFunctions.sendAPI(LibFunctions.parseStr(txtObj.failcmd)); + }; + break; + case 'crit_roll': + content += (!crit ? '' : (rowResult[0]+row1C+ (txtObj.crit || 'Critical Success!') +endRow1C+endRowResult)); + if (txtObj.critcmd && txtObj.critcmd.length && crit) LibFunctions.sendAPI(LibFunctions.parseStr(txtObj.critcmd)); + break; + case 'fumble_roll': + content += (!fumble ? '' : (rowResult[1]+row1C+ (txtObj.fumble || 'Critical Failure!') +endRow1C+endRowResult)); + if (txtObj.fumblecmd && txtObj.fumblecmd.length && fumble) LibFunctions.sendAPI(LibFunctions.parseStr(txtObj.fumblecmd)); + break; + } + } else if (key === 'use') { + content += (row2col[(j++)%2]+row2+ '**'+k+'**: '+t +endRow2+endRow2col); + } else if (key.startsWith('hide')) { + return; + } else if (key.startsWith('section')) { + content += row1col[(j++)%2]+row1C+ t +endRow1C+endRow1col; + } else if (key === 'gminfo') { +// if (isGM) content += (row1col[(j++)%2]+rowHeader+ k +endRowHeader+rowBodyC+ t +endRowBodyC+endRow1col); + if (isGM) content += (row2col[(j++)%2]+row2+ '**'+k+'**: '+t +endRow2+endRow2col); + } else if (!['prefix','name','title','subtitle','successcmd','failcmd','success','failure','crit','fumble','critcmd','fumblecmd','gmdesc'].includes(key) && !key.startsWith('desc')) { + content += row1col[(j++)%2]+rowHeader+ k +endRowHeader+rowBodyC+ t +endRowBodyC+endRow1col; + } + }); + content += (isLooksLike ? '' : addDescs(txtObj,j,showMoreButton)) + + endBodyFrame + endOuterFrame; + return content; + } + + let content; + switch (template.toLowerCase()) { + case 'rpgmattack': + content = RPGMattack( txt ); + break; + case 'rpgmspell': + case 'rpgmpotion': + case 'rpgmitemspell': + case 'rpgmwandspell': + case 'rpgmscroll': + content = RPGMspell( txt, preamble ); + break; + case 'rpgmmessage': + content = RPGMmessage( txt ); + break; + case 'rpgmwarning': + case 'rpgmmenu': + content = RPGMdefault( txt, preamble, false ); + break; + case 'rpgmweapon': + case 'rpgmammo': + case 'rpgmarmour': + case 'rpgmitem': + case 'rpgmring': + case 'rpgmwand': + case 'rpgmclass': + case 'rpgmdefault': + content = RPGMdefault( txt, preamble, true ); + break; + default: + content = (template ? '&{template:'+template+'}' : '' ) + txt; + break; + } + while (/
')}; + content = (content[0] === '!' ? '' : preamble) + content; + setTimeout(() => sendChat(as?as:defaultAs,content,null,{noarchive:!archive, use3d:use3Ddice}), 0); + return content; + } + + /* + * Determine who to send a Response to: use who controls + * the character - if no one or if none of the controlling + * players are on-line send the response to the GM + */ + + LibFunctions.sendToWho = function(charCS,senderId,makePublic=false,embedded=false) { + + var to, controlledBy, players, viewerID, isPlayer=LibFunctions.checkPlayersLive( charCS ); + controlledBy = (!charCS ? '' : charCS.get('controlledby')); + if (controlledBy.includes('all')) { + to = ''; + } else if (playerIsGM(senderId) || !charCS || !isPlayer) { + to = embedded ? '/w gm ' : '/w gm '; + } else if (makePublic) { + to = ''; + } else { + to = (embedded ? ('/w "'+charCS.get('name')+'" ') : ('/w "' + charCS.get('name') + '" ')); + } + return to; + } + + /* + * A more reliable form of function to determine who + * to send a Response to: use who controls + * the character - if no one or if none of the controlling + * players are on-line send the response to the GM + */ + + LibFunctions.sendMsgToWho = function(charCS,senderId,msg,div='',makePublic=false,embedded=false) { + + var to, controlledBy, players, viewerID, isPlayer=false; +// match = !embedded ? /(?<=^|}}\s*)^(?!\!|\/)/mg : /(? 0) { + controlledBy = controlledBy.split(','); + viewerID = (state.roundMaster && state.roundMaster.viewer && state.roundMaster.viewer.is_set) ? (state.roundMaster.viewer.pid || null) : null; + players = controlledBy.filter(id => id != viewerID); + if (players.length) { + isPlayer = _.some( controlledBy, function(playerID) { + players = findObjs({_type: 'player', _id: playerID, _online: true}); + return (players && players.length > 0); + }); + }; + }; + if (controlledBy.includes('all')) { + to = ''; + } else if (playerIsGM(senderId) || !charCS || controlledBy.length == 0 || !isPlayer) { + to = embedded ? '/w gm ' : '/w gm '; + } else if (makePublic) { + to = ''; + } else { + to = (embedded ? ('/w "'+charCS.get('name')+'" ') : ('/w "' + charCS.get('name') + '" ')); + } + if (!embedded) msg = msg.replace(/^&{template:/img,(to+div+'$&')) + .replace(/^(?!\!|\/)/,('$&'+to+div)) + .replace(/^\!.*^(?!\!|\/)/mg,('$&'+to+div)) + .replace(/^\/(?:w|em|ooc|talktomyself|fx|desc|as|emas)\s.*?^(?!\!|\/)/img,('$&'+to+div)); + + return embedded ? to : msg; + } + + /** + * Insert a whisper into a body with a template. + * If no template, inserts the whisper at the start of + * the first line not starting with an API call. + **/ + + LibFunctions.insertWhisper = function(to, msg='') { + let splitMsg = msg.match(/([^]*?)^.*?((?:&|\\amp|\\amp;){template:.*)/msi); + if (!splitMsg || !splitMsg.length > 2) return to+' '+msg; + return splitMsg[1]+'\n'+to+' '+splitMsg[2]; + } + + /** + * Send public message with 3d dice rolls (if enabled) + */ + + LibFunctions.sendPublic = function(msg,charCS,senderId) { + if (!msg) + {return undefined;} + var who; + + if (charCS) { + who = 'character|'+charCS.id; + } else { + who = ''; + } + clearWaitTimer(); + setTimeout(() => sendChat(who,msg,null,{use3d:use3Ddice}), 0); + }; + + /** + * Send API command to chat + */ + LibFunctions.sendAPI = function(msg, senderId, from='', noSplit=false) { + var as; + if (!msg) { + log('sendMagicAPI: no msg'); + return undefined; + } + if (!senderId || senderId.length == 0) { + as = ''; + } else { + as = 'player|' + senderId; + } + let msgArray = noSplit ? [msg] : msg.split(/(?: |\n)/); + _.each(msgArray, m => sendChat(as,m, null,{noarchive:!archive, use3d:use3Ddice})); + }; + + /** + * Send locally parsed feedback to the GM only! + */ + LibFunctions.sendFeedback = function(msg,as,img) { + if (!msg) + {return;} + var gm = findTheGM(), + div = '
' + cmd.content + '') : '')
+ + '';
+
+ sendChat(((cmd && cmd.who) ? cmd.who : defaultAs),content,null,{noarchive:false, use3d:false});
+ log('RPGMaster error: '+msg+ (cmd ? (' while processing command '+cmd.content) : ''));
+ };
+ setTimeout(postErrorMsg,500,msg,cmd);
+ };
+
+ /**
+ * Send an error caught by try/catch
+ */
+
+ LibFunctions.sendCatchError = function(apiName,msg,e,cmdStr='') {
+ var postCatchMsg = function(apiName,msg,e,cmdStr) {
+ if (!msg || !msg.content) {msg= {};msg.content = '${cmdStr}' + + 'version:'+version+',
'; + objDef = 'db:['; + csDBlist = findObjs({ type: 'ability', characterid: dbCS.id }); + + _.each( _.sortBy(csDBlist,item => item.get('name')), function( item ) { + let itemName = item.get('name'); + if (foundItems.includes(itemName)) return; + foundItems.push(itemName); + + let objData = LibFunctions.resolveData(itemName,dbName,reNotAttackData,null,reDBdata).parsed, + objHitData = LibFunctions.resolveData(itemName,dbName,reToHitData,null,reDBdata).parsed, + objBody = encodeStr(item.get('action')), + objCT = objData.speed || objHitData.speed || 0, + objChg = (objData.type !== 'uncharged') ? objData.type : objHitData.type, + objCost = objData.cost || objHitData.cost || 0, + objType = '', + specs = objBody.match(/}}\s*?specs\s*?=(.*?){{/im); + + specs = specs ? [...('['+specs[0]+']').matchAll(reSpecClass)] : []; + for (let i=0; i < specs.length; i++) { + objType += (objType && objType.length) ? ('|' + specs[i][1]) : specs[i][1]; + } + objType = _.uniq(objType.toLowerCase().split('|')).join('|'); + if (typeFilter && typeFilter.length && !objType.includes(typeFilter)) return; + + objBody = objBody.replace(/template:2Edefault/i,'template:\'+fields.CSdefaultTemplate+\'') + .replace(/template:2Espell/i,'template:\'+fields.CSspellTemplate+\'') + .replace(/template:2Eattack/i,'template:\'+fields.CSweaponTemplate+\'') + .replace(/template:RPGMdefault/i,'template:\'+fields.defaultTemplate+\'') + .replace(/template:RPGMspell/i,'template:\'+fields.spellTemplate+\'') + .replace(/template:RPGMweapon/i,'template:\'+fields.weaponTemplate+\'') + .replace(/template:RPGMpotion/i,'template:\'+fields.potionTemplate+\'') + .replace(/template:RPGMattack/i,'template:\'+fields.targetTemplate+\'') + .replace(/template:RPGMammo/i,'template:\'+fields.ammoTemplate+\'') + .replace(/template:RPGMarmour/i,'template:\'+fields.armourTemplate+\'') + .replace(/template:RPGMitem/i,'template:\'+fields.itemTemplate+\'') + .replace(/template:RPGMitemSpell/i,'template:\'+fields.itemSpellTemplate+\'') + .replace(/template:RPGMring/i,'template:\'+fields.ringTemplate+\'') + .replace(/template:RPGMscroll/i,'template:\'+fields.scrollTemplate+\'') + .replace(/template:RPGMwand/i,'template:\'+fields.wandTemplate+\'') + .replace(/template:RPGMwandSpell/i,'template:\'+fields.wandSpellTemplate+\'') + .replace(/template:RPGMmessage/i,'template:\'+fields.messageTemplate+\'') + .replace(/template:RPGMwarning/i,'template:\'+fields.warningTemplate+\'') + .replace(/template:RPGMclass/i,'template:\'+fields.classTemplate+\''); + + objDef += '{name:\''+itemName+'\',' + + 'type:\''+objType+'\',' + + 'ct:\''+objCT+'\',' + + 'charge:\''+objChg+'\',' + + 'cost:\''+objCost+'\',' + + 'body:\''+objBody+'\'},
'; + }); + objDef += ']},
'; + dbHandout.set('notes',objHeader+objDef); + LibFunctions.sendFeedback('Extracted '+dbName+' v'+version,fields.feedbackName); + LibFunctions.setAttr( dbCS, fields.dbVersion, version ); + return dbHandout; + } + + /* + * Check the version of a Character Sheet database and, if + * it is earlier than the static data held in this API, update + * it to the latest version. + */ + + LibFunctions.buildCSdb = function( dbFullName, dbObj, typeList, silent ) { + + dbFullName = dbFullName.replace(/_/g,'-'); + + const spells = dbObj.type.includes('spell') || dbObj.type.includes('power'), + charClass = dbObj.type.includes('class'), + rootDB = dbObj.root.toLowerCase(); + + var dbVersion = 0.0, + dbCS = findObjs({ type:'character', name:dbFullName },{caseInsensitive:true}), + errFlag = false, + lists = {}, + foundItems = [], + csDBlist, specs, objType, objBody, + msg, versionObj, curDB; + + if (LibFunctions.checkDBver( dbFullName, dbObj, silent )) { + + if (dbCS && dbCS.length) { + let abilities = findObjs({ _type:'ability', _characterid:dbCS[0].id }); + _.each( abilities, a => a.remove() ); + dbCS = dbCS[0]; + } else { + dbCS = createObj( 'character', {name:dbFullName} ); + } + + let sorted = _.sortBy(dbObj.db,'name'); + + _.each(sorted, item => { + if (!!item.body && !foundItems.includes(item.name)) { + foundItems.push(item.name); + item.body = LibFunctions.parseStr(item.body,dbReplacers); + if (!LibFunctions.setAbility( dbCS, item.name, item.body )) { + errFlag = true; + } else { + LibFunctions.setAttr( dbCS, [fields.CastingTimePrefix[0]+item.name, 'current'], item.ct ); + LibFunctions.setAttr( dbCS, [fields.CastingTimePrefix[0]+item.name, 'max'], (spells ? item.cost : item.charge) ); + LibFunctions.addMIspells( dbCS, item ); + item.type.dbName().split('|').filter(t => !!t).map(t => { + let listType = typeList[t] ? typeList[t].type.toLowerCase() : (typeList.miscellaneous ? typeList.miscellaneous.type.toLowerCase() : undefined); + if (listType) { + if (!lists[listType]) lists[listType] = []; + if (!lists[listType].includes(item.name)) { + lists[listType].push(item.name); + } + } else if (_.isUndefined(listType)) { + LibFunctions.sendError(('Unable to identify item type '+t+' when updating '+item.name+' in database '+dbFullName)); + }; + }); + }; + }; + }); + if (errFlag) { + LibFunctions.sendError( ('Unable to completely update database '+dbFullName) ); + } else { + _.each(typeList, dbList => dbList.field[0].length ? LibFunctions.setAttr( dbCS, [dbList.field[0],'current'], (lists[dbList.type.toLowerCase()] || ['']).join('|')) : ''); + LibFunctions.setAttr( dbCS, fields.dbVersion, (dbObj.version || 1.0)); + dbCS.set('avatar',(dbObj.avatar || '')); + dbCS.set('bio',(dbObj.bio || '')); + dbCS.set('controlledby',(dbObj.controlledby || 'All')); + dbCS.set('gmnotes',(dbObj.gmnotes || '')); + let msg = 'Updated database '+dbFullName+' to version '+String(dbObj.version); + if (!silent) LibFunctions.sendFeedback( msg, fields.feedbackName ); else log(msg); + } + } + return (errFlag); + } + + /** + * Create an internal index of items in the databases + * to make searches much faster. Index entries indexed by + * database root name & short name (name in lower case with + * '-', '_' and ' ' ignored). index[0] = abilityID, + * index[1] = ct-attributeID + * v3.051 Check that other database-handling APIs have finished + * updating their databases and performed a handshake + **/ + + LibFunctions.updateDBindex = function() { + var rootDB, magicDB, validDB, + db, shortName, attrName, objList, + rootList = ['mu_spells_db','pr_spells_db','powers_db','mi_db','race_db','class_db','attacks_db','styles_db','locks_traps_db'], + index = {}; + + _.each( dbNames, (dbFields, db) => { + if (state.MagicMaster.spellRules.denyCustom && db.toLowerCase().includes('custom')) return; + _.each( dbFields.db, (item, i) => { + rootDB = db.toLowerCase().match( /[a-z_]+?_db/i ); + if (!item || !item.name) log('updateDBindex: item='+item.name+', i='+i+', unable to create shortName'); + shortName = item.name.dbName(); + if (_.isUndefined(index[rootDB])) index[rootDB] = {}; + if (_.isUndefined(index[rootDB][shortName])) index[rootDB][shortName] = ['',String(item.ct),db,i]; + }); + }); + + objList = filterObjs( function(obj) { + if (obj.get('type') != 'ability') return false; + if (!(magicDB = getObj('character',obj.get('characterid')))) { + return false; + } + db = magicDB.get('name').toLowerCase().replace(/-/g,'_'); + if (/\s*v\d*\.\d*/.test(db)) { + return false; + } + let validDB = false; + for (const rDB of rootList) { + if (db.startsWith(rDB)) { + validDB = true; + rootDB = rDB; + break; + } + } + if (!validDB) {return false;} + let shortName = obj.get('name').dbName(); + + if (_.isUndefined(index[rootDB])) {index[rootDB] = {};} + if (_.isUndefined(index[rootDB][shortName]) || !index[rootDB][shortName][0].length || !stdDB.includes(db)) { + index[rootDB][shortName] = [obj.id,'']; + } + return true; + }); + objList = filterObjs( function(obj) { + if (obj.get('type') != 'attribute') {return false;} + attrName = obj.get('name'); + if (!attrName || !attrName.toLowerCase().startsWith('ct-')) {return false;} + if (!(magicDB = getObj('character',obj.get('characterid')))) { + return false; + } + db = magicDB.get('name').toLowerCase().replace(/-/g,'_'); + if (/\s*v\d*\.\d*/.test(db)) {return false;} + let validDB = false; + for (const rDB of rootList) { + if (db.startsWith(rDB)) { + validDB = true; + rootDB = rDB; + } + } + if (!validDB) + {return false;} + let shortName = attrName.dbName().substring(2); + + if (!!!index[rootDB][shortName]) { + return false; + } + if (!stdDB.includes(db) || (!!!index[rootDB][shortName][1]) || (index[rootDB][shortName][1].length === 0)) { + index[rootDB][shortName][1] = obj.id; + }; + return true; + }); + magicList = {}; // Blank the internal index of items, as it might have changed and needs rebuilding +// LibFunctions.sendFeedback( waitMsgDiv+'RPGMaster is now ready.' ); + + return index; + } + + /* + * Check a character sheet database and update/create the + * required attributes from the definitions. This should + * be run after updating or adding item or spell definitions. + */ + + LibFunctions.checkCSdb = function( dbFullName ) { + + var db = dbFullName.toLowerCase(), + lists = {}, + spellsDB, + dbCSlist, + dbTypeList; + + var checkObj = function( obj ) { + var objCS, objCSname, objName, objBody, type, objCT, objChg, objCost, specs, spellsDB, classDB; + + if (!obj || obj.get('type') !== 'ability') return false; + objCS = getObj('character',obj.get('characterid')); + if (!objCS) {log('checkObj: not found database object');return false;} + objCSname = objCS.get('name').toLowerCase(); + if (db && db.length && (db !== '-db' && !objCSname.startsWith(db))) return false; + if (!objCSname.includes('-db') || (/\s*v\d*\.\d*/.test(objCSname))) return false; + objBody = obj.get('action'); + spellsDB = objCSname.includes('spells') || objCSname.includes('powers'); + classDB = objCSname.includes('class') || objCSname.includes('race'); + specs = objBody.match(reSpecs); + objName = obj.get('name'); + if (specs) { + dbTypeList = (spellsDB ? spTypeLists : (classDB ? clTypeLists : miTypeLists)); + specs = specs ? [...('['+specs[0]+']').matchAll(reSpecClass)] : []; + for (const i of specs) { + type = i[1]; + if (type && type.length) { + let typeList = type.dbName().split('|'); + for (const t of typeList) { + let itemType = dbTypeList[t] ? dbTypeList[t].type : (dbTypeList.miscellaneous ? dbTypeList.miscellaneous.type : undefined); + if (itemType) { + if (!lists[objCS.id]) lists[objCS.id] = {}; + if (!lists[objCS.id][itemType]) lists[objCS.id][itemType] = []; + if (!lists[objCS.id][itemType].includes(objName)) { + lists[objCS.id][itemType].push(objName); + }; + }; + }; + }; + }; + }; + objCT = (objBody.match(reDataSpeed) || ['',0])[1]; + objChg = (objBody.match(reDataCharge) || ['','uncharged'])[1]; + objCost = (objBody.match(reDataCost) || ['',0])[1]; + LibFunctions.setAttr( objCS, [fields.CastingTimePrefix[0]+objName, 'current'], objCT ); + LibFunctions.setAttr( objCS, [fields.CastingTimePrefix[0]+objName, 'max'], (spellsDB ? objCost : objChg) ); + LibFunctions.addMIspells( objCS, {name:objName,body:objBody} ); + return true; + }; + + dbCSlist = filterObjs( obj => checkObj(obj) ); + if (!dbCSlist || !dbCSlist.length) { + LibFunctions.sendFeedback('No databases found with a name that includes '+db,fields.feedbackName); + } else { + _.each(lists,(types,dbID) => { + let dbCS = getObj('character',dbID); + _.each(dbTypeList, dbList => { + if (types[dbList.type]) { + LibFunctions.setAttr( dbCS, [dbList.field[0],'current'], (types[dbList.type].sort().join('|') || '' )); + } + }); + }); + LibFunctions.sendFeedback(((!db || !db.length || db === '-db') ? 'All databases have' : ('Database '+dbFullName+' has')) + ' been updated',fields.feedbackName); + } + return; + } + + /** + * Get a new DB index of all Ability Objects stored in + * database character sheets + **/ + + LibFunctions.getDBindex = function(forceUpdate = false) { + if (_.isUndefined(DBindex) || forceUpdate) { + DBindex = LibFunctions.updateDBindex(); + } + return DBindex; + } + + /** + * Update or create the help handouts + **/ + + LibFunctions.updateHandouts = function(handouts,silent,senderId) { + + let classHelp = findObjs({ _type:'handout', name:'Class Database Help' }); + if (classHelp && classHelp[0]) classHelp[0].remove(); + _.each(handouts,(obj,k) => { + let dbCS = findObjs({ type:'handout', name:obj.name },{caseInsensitive:true}); + if (!dbCS || !dbCS[0]) { + log(obj.name+' not found. Creating version '+obj.version); + if (!silent) LibFunctions.sendFeedback(obj.name+' not found. Creating version '+obj.version); + dbCS = createObj('handout',{name:obj.name,inplayerjournals:(_.isUndefined(senderId) ? '' : senderId)}); + dbCS.set('notes',obj.bio.replace('[General DB Help]',General_DB_Help) + .replace('[Item Inheritance]',itemInheritance) + .replace('[General API Help]',General_API_Help)); + dbCS.set('avatar',obj.avatar); + } else { + dbCS = dbCS[0]; + dbCS.get('notes',function(note) { + let reVersion = new RegExp(obj.name+'\\s*?v(\\d+?.\\d*?)', 'im'); + let version = note.match(reVersion); + version = (version && version.length) ? (parseFloat(version[1]) || 0) : 0; + if (version >= obj.version) { + if (!silent) LibFunctions.sendFeedback('Not updating handout '+obj.name+' as is already version '+obj.version); + return; + } + dbCS.set('notes',obj.bio.replace('[General DB Help]',General_DB_Help) + .replace('[Item Inheritance]',itemInheritance) + .replace('[General API Help]',General_API_Help)); + dbCS.set('avatar',obj.avatar); + if (!silent) LibFunctions.sendFeedback(obj.name+' handout updated to version '+obj.version); + log(obj.name+' handout updated to version '+obj.version); + }); + } + }); + return; + } + + /** + * Get the handout IDs for all handouts + **/ + + LibFunctions.getHandoutIDs = function() { + + var handoutObjs = findObjs({ type: 'handout' }), + handoutIDs = {}; + _.each( handoutObjs, h => { + let name = h.get('name').replace(/[-_&\s]/g,''); + handoutIDs[name] = h.id; + }); + return handoutIDs; + }; + + /* -------------------------------- Utility Functions ---------------------------- */ + + /** + * Calculate/roll an attribute value that has a range + * Always tries to create a 3 dice bell curve for the value + **/ + + LibFunctions.calcAttr = function( attr='3:18' ) { + let attrRange = attr.split(':'), + low = parseInt(attrRange[0]), + high = parseInt(attrRange[1]); + if (high && !isNaN(low) && !isNaN(high)) { + let range = high - (low - 1); + if (range === 2) { + return low - 1 + randomInteger(2); + } else if (range === 3) { + return low - 2 + randomInteger(2) + randomInteger(2); + } else if (range === 5) { + return low - 2 + randomInteger(3) + randomInteger(3); + } else if ((range-2)%3 === 0) { + return low - 3 + randomInteger(Math.ceil(range/3)+1) + randomInteger(Math.floor(range/3)+1) + randomInteger(Math.floor(range/3)+1); + } else if ((range-1)%3 === 0) { + return low - 3 + randomInteger(Math.ceil(range/3)) + randomInteger(Math.ceil(range/3)) + randomInteger(Math.ceil(range/3)); + } else if ((range)%3 === 0) { + return low - 3 + randomInteger((range/3)+1) + randomInteger((range/3)+1) + randomInteger(range/3); + } + } + return attr; + } + + /** + * A function to calculate an internal dice roll + */ + + LibFunctions.rollDice = function( count, dice, reroll ) { + count = parseInt(count || 1); + dice = parseInt(dice || 8); + reroll = parseInt(reroll || 0); + let total = 0, + roll; + for (let d=0; d
| **'+saves[(i=s.index)]+'** | '; + } + a.push(k+'('+(mods[s.tag]>=0?'+':'')+mods[s.tag]+')'); + }); + content += a.join(', ')+' |
| **'+saves[index]+'** | '+modName+'('+(mods[tag]>=0?'+':'')+mods[tag]+') |
| **'+LibFunctions.attrLookup(charCS,a.save)+'** | '+k+'('+(mods[a.tag]>=0?'+':'')+mods[a.tag]+') |
| Menus | '+configButtons(state.MagicMaster.fancy, 'Plain menus', '!magic --config fancy-menus|false', 'Fancy menus', '!magic --config fancy-menus|true')+'|
| Player Targeted Attks | '+configButtons(!state.attackMaster.weapRules.dmTarget, 'Not Allowed', '!attk --config dm-target|true', 'Allowed by All', '!attk --config dm-target|false')+'|
| Allowed weapons | '+configButtons(state.attackMaster.weapRules.allowAll, 'Restrict Usage', '!attk --config all-weaps|false', 'All Can Use Any', '!attk --config all-weaps|true')+'|
| Restrict weapons | '+configButtons(!state.attackMaster.weapRules.classBan, 'Strict Denial', '!attk --config weap-class|true', 'Apply Penalty', '!attk --config weap-class|false')+'|
| Weapon Speed | '+configButtons(!state.attackMaster.weapRules.initPlus, 'Plus affects speed', '!attk --config weap-plus|true', 'Magic Plus Ignored', '!attk --config weap-plus|false')+'|
| Critical Rolls | '+configButtons(!state.attackMaster.weapRules.criticals, 'Always hit/miss', '!attk --config criticals|true', 'Calculate hit/miss', '!attk --config criticals|false')+'|
| Natural Max Min Rolls | '+configButtons(!state.attackMaster.weapRules.naturals, 'Always hit/miss', '!attk --config naturals|true', 'Calculate hit/miss', '!attk --config naturals|false')+'|
| Allowed Armour | '+configButtons(state.attackMaster.weapRules.allowArmour, 'Strict Denial', '!attk --config all-armour|false', 'All Can Use Any', '!attk --config all-armour|true')+'|
| Non-Prof Penalty | '+configButtons(!state.attackMaster.weapRules.prof, 'Class Penalty', '!attk --config prof|true', 'Character Sheet', '!attk --config prof|false')+'|
| Ranged Mastery | '+configButtons(state.attackMaster.weapRules.masterRange, 'Not Allowed', '!attk --config master-range|false', 'Mastery Allowed', '!attk --config master-range|true')+'|
| Rogue Skills | '+configButtons(state.attackMaster.thieveCrit, 'No Critical', '!attk --config rogue-crit|false', 'Critical Success', '!attk --config rogue-crit|true')+'|
| Rogue Crit Value | '+configButtons(state.attackMaster.thieveCrit>1, 'Critical = 1%', '!attk --config rogue-crit-val|false', 'Critical = 5%', '!attk --config rogue-crit-val|true')+'|
| NPC Attributes | '+configButtons(state.attackMaster.attrRoll, 'No Attributes', '!attk --config attr-roll|false', 'Roll Attributes', '!attk --config attr-roll|true')+'|
| NPC Attr Range | '+configButtons(state.attackMaster.attrRestrict, 'Full Range', '!attk --config attr-restrict|false', 'Restrict', '!attk --config attr-restrict|true')+'|
| Specialist Wizards | '+configButtons(!state.MagicMaster.spellRules.specMU, 'Specified in Rules', '!magic --config specialist-rules|true', 'Allow Any Specialist', '!magic --config specialist-rules|false')+'|
| Spells per Level | '+configButtons(!state.MagicMaster.spellRules.strictNum, 'Strict by Rules', '!magic --config spell-num|true', 'Allow to Set Misc', '!magic --config spell-num|false')+'|
| Spell Schools | '+configButtons(state.MagicMaster.spellRules.allowAll, 'Strict by Rules', '!magic --config all-spells|false', 'All Can Use Any', '!magic --config all-spells|true')+'|
| Powers by Level | '+configButtons(state.MagicMaster.spellRules.allowAnyPower, 'Strict by Rules', '!magic --config all-powers|false', 'All Can Use Any', '!magic --config all-powers|true')+'|
| Custom Objects | '+configButtons(!state.MagicMaster.spellRules.denyCustom, 'External / GM Defined', '!magic --config custom-spells|true', 'All Objects Allowed', '!magic --config custom-spells|false')+'|
| Auto-Hide Items | '+configButtons(state.MagicMaster.autoHide, 'GM Hide Manually', '!magic --config auto-hide|false', 'Auto-Hide if Possible', '!magic --config auto-hide|true')+'|
| Reveal Hidden Items | '+configButtons(state.MagicMaster.reveal, 'Reveal Manually', '!magic --config reveal|false', 'Reveal on Use', '!magic --config reveal|true')+'|
| Action Buttons | '+configButtons(state.MagicMaster.viewActions, 'Grey on View', '!magic --config view-action|false', 'Active on View', '!magic --config view-action|true')+'|
| Alphabetic Lists | '+configButtons(!state.MagicMaster.alphaLists, 'Alphabetic', '!magic --config alpha-lists|true', 'Not Alphabetic', '!magic --config alpha-lists|false')+'|
| Skill-Based Chance | '+configButtons(!state.MagicMaster.gmRolls, 'GM rolls', '!magic --config gm-rolls|true', 'Player rolls', '!magic --config gm-rolls|false')+'|
| [Set Default Token Bars](!cmd --button AB_ASK_TOKENBARS|) | |