QuteAbility
Pf2eTools Ability attributes (ability2md.txt or inline-ability2md.txt).
Abilities are rendered both standalone and inline (as an admonition block). The default template can render both. It contains some special syntax to handle the inline case.
Use %%-- to mark the end of the preamble (frontmatter and
other leading content only appropriate to the standalone case).
Extension of Pf2eQuteNote
Attributes
Permalinkactivity, bareTraitList, books, components, cost, embedded, frequency, getAliases, hasActivity, hasAttributes, hasDetails, hasEffect, hasSections, labeledSource, name, note, prerequisites, range, reference, reprintOf, requirements, source, sourceAndPage, sourcesWithFootnote, special, tags, text, traits, trigger, vaultPath
activity
PermalinkAbility (activity/activation details)
bareTraitList
PermalinkReturn a comma-separated list of de-styled trait links (no title attributes)
books
PermalinkList of source books using abbreviated name. Fantasy statblocks uses this list format, as an example.
components
PermalinkList of formatted strings. Activation components for this ability, e.g. command, envision
cost
PermalinkThe cost of using this ability
embedded
PermalinkTrue if this ability is embedded in another note (admonition block).
When this is true, the inline-ability template is used.
frequency
PermalinkQuteDataFrequency. How often this ability can be used/activated. Use directly to get a formatted string.
getAliases
PermalinkAliases for this note, including the note name, as quoted/escaped strings.
Example values:
- "+1 All-Purpose Tool"
- "Carl "The Elder" Frost"
In templates:
aliases:
{#each resource.aliases}
- {it}
{/each}
hasActivity
PermalinkTrue if an activity (with text), components, or traits are present.
hasAttributes
PermalinkTrue if hasActivity is true, hasEffect is true or cost is present. In other words, this is true if a list of attributes could have been rendered.
Use this to test for the end of those attributes (add whitespace or a special character ahead of ability text)
hasDetails
PermalinkTrue if the ability is a short, one-line name and description. Use this to test to choose between a detailed or simple rendering.
hasEffect
PermalinkTrue if frequency, trigger, and requirements are present. In other words, this is true if the ability has an effect.
hasSections
PermalinkTrue if the content (text) contains sections
labeledSource
PermalinkFormatted string describing the content's source(s): _Source: <sources>_
name
PermalinkNote name
note
PermalinkAny additional notes related to this ability that aren't included in the other fields.
prerequisites
PermalinkFormatted string. Prerequisites before this ability can be activated or taken.
range
PermalinkQuteDataRange. The targeting range for this ability.
reference
PermalinkA formatted string which is a link to the base ability that this ability references. Embedded only.
reprintOf
PermalinkList of content superceded by this note (as Reprinted)
requirements
PermalinkFormatted string. Requirements for activating this ability
source
PermalinkString describing the content's source(s)
sourceAndPage
PermalinkBook sources as list of SourceAndPage
sourcesWithFootnote
PermalinkGet Sources as a footnote.
Calling this method will return an italicised string with the primary source followed by a footnote listing all other sources. Useful for types that tend to have many sources.
special
PermalinkSpecial notes for this ability - usually requirements or caveats relating to its use.
tags
PermalinkCollected tags for inclusion in frontmatter
text
PermalinkFormatted text. For most templates, this is the bulk of the content.
traits
PermalinkCollection of trait links. Use {#for} or {#each} to iterate over the collection.
See traitList or bareTraitList.
trigger
PermalinkFormatted string. Trigger to activate this ability
vaultPath
PermalinkPath to this note in the vault