Revision as of 16:09, 28 April 2016

Template:D5eshaped Please see the latest documentation: https://docs.google.com/document/d/1yPcIZ_bIc3JlnWsKZt2tAB0EQSIVEfeMtT0GifbpJIg

Attributes and Macros

Using Attributes

An attribute is a reference to a value inherent to the character. The simplest example is the character's strength but a more complex example is the character's attack modifier for a particular weapon or a skill check modifier taking into account expertise. The attributes within a sheet can be used to create custom macros for or by the players. Note that not only values can be used in macros but text attributes can be used as well.

The Attributes section of the wiki has valuable information on using attributes within macros. To use the Shaped Character Sheet attributes the syntax is:

@{name|attribute}

where name is the name of the character sheet, not the token. You can also use selected or target in place of name. This is a core functionality of Roll20 and is described in their appropriate wiki sections.

If the attribute is calculated then it will need to be used within an inline roll or the attribute will be listed as its formula and not actually calculated. Incidentally, using a calculated attribute outside of an inline roll is a way to determine its parts. An example syntax of using a calculated attribute is:

[[@{name|calculated_attribute}]]

Calculated attributes are noted as such and listed as Template:D5eshaped in the following sections.

Using Macros

The Shaped sheet has various macros available for use by the player. These are noted by dark blue clickable buttons usually containing a white image of a die but there are white heart images for saves and white check mark images for skill checks. Each of these macros has a name which can be called alone or as part of another macro. Note that the macros in the Shaped sheet are utilizing the 5e Roll Template also embedded in the sheet. Calling the macro will output the macro in its roll template format. More details about the Roll Template can be seen in its section.

The macros section of the Roll20 wiki has valuable information on using macros in general. To use the Shaped Character Sheet macros the syntax is:

%{name|macro}

where name is the name of the character sheet, not the token. You can also use selected or target in place of name. This is a core functionality of Roll20 and is described in their appropriate wiki sections.

Sheet Provided Macros

The sheet provides a macro for all saving throws and another for all ability/skill checks via drop down Roll Query. They can currently be referenced as below:

  %{name|save_query_macro}
  %{name|check_query_macro}

(Replace "name" with the name of your Character.)

Header

Core Stats

Abilities

Ability Checks

Ability Saving Throws

Skills

Passive Skill

Initiative

Weapons

Melee

The Melee Weapons section of the Weapons tab allows for seven weapons to be described. In each of these attributes the 0 can be replaced by any of the number according to your sheet.

repeating_weapons_melee_0_weapon macro

@{output_option} &{template:5eDefault} {{attack_roll=1}} {{character_name=@{character_name}}} @{show_character_name} {{title=@{repeating_weapons_melee_0_name}}} {{melee=1}} @{classactionmeleeweapon} {{attack=[[d20cs>@{repeating_weapons_melee_0_crit_range}@{d20_mod} + @{repeating_weapons_melee_0_to_hit} + (@{global_weapon_attack_bonus}) + (@{global_melee_attack_bonus})]]}} {{attackadv=[[d20cs>@{repeating_weapons_melee_0_crit_range}@{d20_mod} + @{repeating_weapons_melee_0_to_hit} + (@{global_weapon_attack_bonus}) + (@{global_melee_attack_bonus})]]}} {{targetAC=@{attacks_vs_target_ac}}} {{targetName=@{attacks_vs_target_name}}} {{reach=@{repeating_weapons_melee_0_reach}}} {{action_damage=[[@{repeating_weapons_melee_0_dmg} + @{repeating_weapons_melee_0_dmg_total} + (@{global_weapon_damage_bonus}) + (@{global_melee_damage_bonus}) + 0d0]]}} {{action_damage_type=@{repeating_weapons_melee_0_dmg_type}}} {{can_crit=1}} {{action_crit_damage=[[@{repeating_weapons_melee_0_dmg} + (@{repeating_weapons_melee_0_bonus_crit_dmg} * @{repeating_weapons_melee_0_toggle_crit_bonus}) + 0d0]]}} {{action_crit_damage_adv=[[@{repeating_weapons_melee_0_dmg} + (@{repeating_weapons_melee_0_bonus_crit_dmg} * @{repeating_weapons_melee_0_toggle_crit_bonus}) + 0d0]]}} {{action_second_crit_damage=[[@{repeating_weapons_melee_0_second_dmg} + 0d0]]}} {{action_second_crit_damage_adv=[[@{repeating_weapons_melee_0_second_dmg} + 0d0]]}}

Note the melee weapon macros are serially numbered starting from 0

Ranged

Spells

Background

Class

Armor

Inventory

Traits & Actions

NPC sheet only

Note the action macros start at 0

Settings

Roll Template

Information on using general roll templates can be found at the Roll20 wiki.

The Shaped Character Sheet for 5e Roll Template is described by the following syntax

&{template:5eDefault} {{field=value}} {{...}} ...

The table below describes the fields, their values, and their effect. The field and value must be set equal and enclosed in curly brackets as illustrated above. Certain fields require that other fields are present and have values. Below is a guide to what the types of values the fields can have.

The following code illustrates these values and shows the result

&{template:5eDefault} {{character_name=@{character_name}}} {{title=grey banner}} {{subheader=subheader}} {{subheaderright=right}} {{subheader2=subheader 2}} {{subheaderright2=right}} {{targetName=target}} {{emote=this is the emote}} {{freetextname=freetext name}} {{freetext=this is a the freetext output}} {{rollname=roll}} {{roll=[[d20]]}} {{rolladv=[[d20]]}}

General Formatting Fields

Action Fields

Spell Fields

To incorporate spell attacks and damage, use action fields.

Multi Attack Fields