Integração do compêndio

Designar a compatibilidade da sua folha

Para designar a compatibilidade com um compêndio, basta incluir o nome abreviado do compêndio no campo "compendium" do seu ficheirosheet.json. 

Se estiver a usar uma folha personalizada, existe uma definição na página Definições do jogo que lhe permite selecionar manualmente um compêndio para usar no seu jogo.

Ativar a funcionalidade de arrastar e largar para a sua folha

Para além da compatibilidade básica, tem a opção de indicar ao Roll20 como as informações do Compêndio podem ser incluídas diretamente na sua folha. Isto permite aos jogadores arrastar e largar uma entrada do compêndio diretamente para a sua folha, e o Roll20 preencherá os valores que especificar. Para tal, deve adicionar a classecompendium-drop-targetà etiquetadivque rodeia a secção que pretende preencher. Para secções repetidas, coloque-a dentro da etiquetafieldset. Em seguida, adicione o atributoaccept="Attribute Name"a uma ou mais etiquetasinput, select, textarea. Aqui está um exemplo simples que seria compatível com a entradaFireballdo Compêndio SRD da 5ª Edição.

<fieldset class="repeating_spells">
  <div class="compendium-drop-target">
    <input type="text" name="attr_SpellName" accept="Name" />
    <input type="text" name="attr_SpellDamage" accept="Damage" />
    <select name="attr_SpellSchool" accept="School">
      <option value="Abjuration">Abjuration</option>
      <option value="Conjuration">Conjuration</option>
      <option value="Divination">Divination</option>
      <option value="Enchantment">Enchantment</option>
      <option value="Evocation">Evocation</option>
      <option value="Illusion">Illusion</option>
      <option value="Necromancy">Necromancy</option>
      <option value="Transmutation">Transmutation</option>
    </select>
    <input type="checkbox" name="attr_SpellRitual" value="Yes" accept="Ritual">
  </div>
</fieldset>

• O<Attribute Name>emaccept="<Attribute Name>"deve corresponder ao nome de um Atributo da secção inferior da entrada do Compêndio. Consulte cada Compêndio individual para obter uma lista dos Atributos disponíveis.
• Para as etiquetasinputetextarea, o valor do compêndio será inserido diretamente.
• Para as etiquetasinput[type=checkbox]einput[type=radio], a caixa será marcada/rádio selecionado se o valor do compêndio corresponder exatamente ao atributo de valor da etiqueta.
• Para as etiquetasselect, será selecionada a opçãoque corresponda ao valor do Compêndio no atributo value OU no texto dentro da etiqueta option
• Pode utilizaraccept="Content"se pretender receber o conteúdo em texto simples da entrada (o conteúdo localizado acima do cabeçalho "Attributes").
• Pode utilizaraccept="data"se pretender receber todos os atributos de uma página do compêndio num formato json.

Note que o processo de alteração destes valores desencadeará eventos locais do Sheet Worker e da API remota exatamente como se o próprio utilizador tivesse introduzido os dados à mão. Assim, também pode criar entradas ocultas para aceitar dados do compêndio e depois processar esses dados utilizando os trabalhadores de folha, se pretender ter mais controlo sobre a forma como os dados são apresentados.

Botões do compêndio

O botão do compêndio pode ser utilizado para abrir uma entrada do compêndio diretamente a partir de uma ficha de personagem, da mesma forma que se clicasse numa entrada do compêndio da aplicação. Isto pode ser usado como uma forma mais conveniente de aceder a regras e descrições, por exemplo, para um feitiço, o botão do compêndio pode ser usado para ver facilmente a descrição completa desse feitiço.

A sintaxe é<button type="compendium" value="<entryname>">. Eis alguns exemplos válidos:

<tipo de botão="compendium" valor="Bard"></button>

Esta sintaxe é válida, mas como existe uma entrada no compêndio de Classes e Monstros com o título "Bardo", a janela resultante irá apresentar-lhe uma escolha de entradas em vez de ir diretamente para uma delas.

<tipo de botão="compendium" valor="Classes:Bard"></button>

Esta é a sintaxe preferida. A especificação da categoria garante-lhe que só haverá uma correspondência.

<tipo de botão="compendium" valor="Classes:Bard#Spellcasting"></button>

Se adicionar um "#" seguido de um título de subtítulo, fará com que a janela se abra diretamente para essa secção. Este exemplo irá abrir a entrada para a classe Bardo, pré-rolada para a secção de Feitiços. Se não encontrar uma secção com esse nome, a janela abre-se com uma rolagem até ao topo.

Arrastar uma entrada do compêndio contém um atributo específico para este botão,uniqueName, uma cadeia de caracteres que contém o nome da categoria e da entrada, o que garante que haverá apenas uma correspondência no compêndio. Assim, a sintaxe para este botão numa secção suspensa do compêndio é a seguinte:

<tipo de botão="compendium" nome="attr_infoButton" aceitar="uniqueName"></button>

Também pode adicionar uma subsecção a este atributo através do sheetworker, por isso, se o item retirado do compêndio for um monstro e quiser que o botão abra diretamente a secção "Acções", pode definir o valor do botão parauniqueName + "#Actions".