#ROLL20 COMPENDIUM DOWN FULL#

So, the syntax for this button in a compendium drop section is as follows: If no section with that name is found, the window will open scrolled to the top.ĭragging an entry from the compendium contains an attribute specifically for this button, uniqueName, a string containing both the category and entry name, which ensures there will be only one match in the compendium.

This example will open the entry for the Bard class, pre-scrolled to the Spellcasting section. Īdding a '#' followed by a subhead title will cause the window to open directly to that section. Specifying the category ensures that there will be only one match. This is valid syntax, but since there is both a Class and a Monster compendium entry titled 'Bard', the resulting window will be present you with a choice of entries rather than going directly to one of them.

#ROLL20 COMPENDIUM DOWN FULL#

This can be used as a more convenient way to access rules and descriptions, for example, for a spell, the compendium button can be used to easily view the full description for that spell. The compendium button can be used to open a compendium entry directly from a character sheet, in the same way as if you clicked on an entry in the in-app compendium. So you can also create hidden inputs to accept data from the Compendium and then process that data further using Sheet Workers if you want more control over how the data is presented. Note that the process of changing these values will trigger local Sheet Worker and remote API events exactly as if the user themselves had entered the data by hand.

You can use accept='data' of you want to receive all attributes from a compendium page in a json format.

You can use accept='Content' if you wish to receive the plaintext content from the entry (the content located above the 'Attributes' header).

For select tags, the option that matches the Compendium value in either the value attribute OR the text inside the option tag will be selected.

For input and input tags, the box will be checked/radio selected if the value from the compendium exactly matches the value attribute from the tag.

For input and textarea tags, the value from the Compendium will be directly inserted.

Consult each individual Compendium for a listing of what Attributes are available.

The in accept='' must match the name of an Attribute from the bottom section of the Compendium entry.

Abjuration Conjuration Divination Enchantment Evocation Illusion Necromancy Transmutation Here's a simple example which would be compatible with the Fireball entry from the 5th Edition SRD Compendium. Then, add the accept='Attribute Name' attribute to one or more input, select, textarea tags.

For repeating sections, place this inside of the fieldset tag.

To do so, you must add the class compendium-drop-target to the div tag surrounding the section you want to fill in. This allows players to drag-and-drop an entry from the compendium directly into your sheet, and Roll20 will fill in the values you specify. In addition to basic compatibility, you have the option of telling Roll20 how information from the Compendium can be included on your sheet directly. If you are using a Custom sheet, there is a Setting on the Game Settings page that will allow you to manually select a Compendium to use for your game.Įnabling Drag-and-Drop Functionality for Your Sheet To designate compatibility with a Compendium, just include the Compendium's short name in the 'compendium' field of your sheet.json file.

Roll20 compendium down