QuteObject

5eTools object attributes (object2md.txt)

Extension of Tools5eQuteBase.

Attributes

5eInitiativeYaml, 5eStatblockYaml, ac, acHp, acText, action, books, conditionImmune, creatureType, fluffImages, getAliases, hasImages, hasMoreImages, hasSections, hitDice, hp, hpText, immune, immuneResist, isNpc, labeledSource, name, objectType, reprintOf, resist, scores, senses, showAllImages, showMoreImages, showPortraitImage, size, source, sourceAndPage, sourcesWithFootnote, speed, tags, text, token, vaultPath, vulnerable

5eInitiativeYaml

A minimal YAML snippet containing object attributes required by the Initiative Tracker plugin. Use this in frontmatter.

5eStatblockYaml

Complete object attributes in the format required by the Fantasy statblock plugin. Uses double-quoted syntax to deal with a variety of characters occuring in trait descriptions. Usable in frontmatter or Fantasy Statblock code blocks.

ac

See AcHp#ac

acHp

Object AC and HP as AcHp

acText

See AcHp#acText

action

Object actions as a list of NamedText

books

List of source books using abbreviated name. Fantasy statblocks uses this list format, as an example.

conditionImmune

See ImmuneResist#conditionImmune

creatureType

Creature type (lowercase); optional

fluffImages

List of images as ImageRef (optional)

getAliases

Aliases for this note, including the note name, as quoted/escaped strings.

Example values:

In templates:

aliases:
{#each resource.aliases}
- {it}
{/each}

hasImages

Return true if any images are present

hasMoreImages

Return true if more than one image is present

hasSections

True if the content (text) contains sections

hitDice

See AcHp#hitDice

hp

See AcHp#hp

hpText

See AcHp#hpText

immune

See ImmuneResist#immune

immuneResist

Object immunities and resistances as ImmuneResist

isNpc

True if this is an NPC

labeledSource

Formatted string describing the content's source(s): _Source: <sources>_

name

Note name

objectType

Object type

reprintOf

List of content superceded by this note (as Reprinted)

resist

See ImmuneResist#resist

scores

Object ability scores as AbilityScores)

senses

Comma-separated string of object senses (if present).

showAllImages

Return embedded wikilinks for all images If there is more than one, they will be displayed in a gallery.

showMoreImages

Return embedded wikilinks for all but the first image If there is more than one, they will be displayed in a gallery.

showPortraitImage

Return an embedded wikilink to the first image Will have the "right" anchor tag.

size

Object size (capitalized)

source

String describing the content's source(s)

sourceAndPage

Book sources as list of SourceAndPage

sourcesWithFootnote

Get 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.

speed

Object speed as a comma-separated list

tags

Collected tags for inclusion in frontmatter

text

Formatted text. For most templates, this is the bulk of the content.

token

Token image as ImageRef

vaultPath

Path to this note in the vault

vulnerable

See ImmuneResist#vulnerable