Added more property help docs

This commit is contained in:
Stefan Zermatten
2022-09-01 12:18:29 +02:00
parent a63e2099d3
commit ffe37bf907
30 changed files with 948 additions and 11 deletions

View File

@@ -2,8 +2,8 @@ const PROPERTIES = Object.freeze({
action: {
icon: '$vuetify.icons.action',
name: 'Action',
helpText: 'Actions are things your character can do. When an action is taken, all the properties under it are activated.',
docsPath: 'property/action',
helpText: 'Actions are things your character can do. When an action is taken, all the properties under it are activated.',
suggestedParents: ['classLevel', 'feature', 'item'],
},
attribute: {
@@ -24,6 +24,7 @@ const PROPERTIES = Object.freeze({
buff: {
icon: '$vuetify.icons.buff',
name: 'Buff',
docsPath: 'property/buff',
helpText: 'When a buff is activated as a child of an action, it will copy the properties under itself onto a target character.',
suggestedParents: ['action', 'attack', 'savingThrow', 'spell', 'branch'],
},
@@ -44,24 +45,28 @@ const PROPERTIES = Object.freeze({
class: {
icon: 'mdi-card-account-details',
name: 'Class',
docsPath: 'property/class',
helpText: 'Your character should ideally have one starting class. Classes hold class levels',
suggestedParents: [],
},
classLevel: {
icon: '$vuetify.icons.class_level',
name: 'Class level',
docsPath: 'property/class-level',
helpText: 'Class levels represent a single level gained in a class',
suggestedParents: ['class'],
},
constant: {
icon: 'mdi-anchor',
name: 'Constant',
docsPath: 'property/constant',
helpText: 'A constant can define a static value that can be used in calculations elsewhere in the sheet',
suggestedParents: [],
},
container: {
icon: 'mdi-bag-personal-outline',
name: 'Container',
docsPath: 'property/container',
helpText: 'A container holds items in the inventory',
examples: 'Coin pouch, backpack',
suggestedParents: ['folder'],
@@ -69,18 +74,21 @@ const PROPERTIES = Object.freeze({
damage: {
icon: '$vuetify.icons.damage',
name: 'Damage',
docsPath: 'property/damage',
helpText: 'When damage is activated by an action it reduces the hit points of the target creature by the calculated amount.',
suggestedParents: ['action', 'attack', 'savingThrow', 'spell', 'branch'],
},
damageMultiplier: {
icon: '$vuetify.icons.damage_multiplier',
name: 'Damage multiplier',
docsPath: 'property/damage-multiplier',
helpText: 'Resistance, vulnerability, and immunity.',
suggestedParents: ['classLevel', 'feature', 'item'],
},
effect: {
icon: '$vuetify.icons.effect',
name: 'Effect',
docsPath: 'property/effect',
helpText: 'Effects change the value or state of attributes and skills.',
examples: '+2 Strength, Advantage on dexterity saving throws',
suggestedParents: ['buff', 'classLevel', 'feature', 'folder', 'item'],
@@ -88,42 +96,49 @@ const PROPERTIES = Object.freeze({
feature: {
icon: 'mdi-text-subject',
name: 'Feature',
docsPath: 'property/feature',
helpText: 'Descriptive or narrative features your character has access to',
suggestedParents: ['classLevel', 'folder'],
},
folder: {
icon: 'mdi-folder-outline',
name: 'Folder',
docsPath: 'property/feature',
helpText: 'A way to organise other properties on the character',
suggestedParents: ['folder'],
},
item: {
icon: 'mdi-cube-outline',
name: 'Item',
docsPath: 'property/item',
helpText: 'Objects and equipment your charcter finds on their adventures',
suggestedParents: ['container'],
},
note: {
icon: 'mdi-note-outline',
name: 'Note',
docsPath: 'property/note',
helpText: 'Notes about your character and their adventures',
suggestedParents: ['note', 'folder'],
},
pointBuy: {
icon: 'mdi-table',
name: 'Point Buy',
docsPath: 'property/point-buy',
helpText: 'A point buy table that allows the user to select an array of values that match a given cost',
suggestedParents: [],
},
proficiency: {
icon: 'mdi-brightness-1',
name: 'Proficiency',
docsPath: 'property/proficiency',
helpText: 'Proficiencies apply your proficiency bonus to skills already on your character sheet.',
suggestedParents: ['buff', 'classLevel', 'feature', 'folder'],
},
roll: {
icon: '$vuetify.icons.roll',
name: 'Roll',
docsPath: 'property/roll',
helpText: 'When activated by an action, rolls perform a calculation and temporarily store the result for other properties under the same action to use',
suggestedParents: ['action', 'attack', 'savingThrow', 'spell', 'branch'],
},
@@ -137,48 +152,56 @@ const PROPERTIES = Object.freeze({
savingThrow: {
icon: '$vuetify.icons.saving_throw',
name: 'Saving throw',
docsPath: 'property/saving-throw',
helpText: 'When a saving throw is activated by an action, it causes the target to make a saving throw, if the saving throw fails, the children properties of the saving throw are activated.',
suggestedParents: ['action', 'attack', 'spell'],
},
skill: {
icon: '$vuetify.icons.skill',
name: 'Skill',
docsPath: 'property/skill',
helpText: 'Skills, saves, languages, and weapon and tool proficiencies are all skills. Skills can have a default proficiency set. Proficiencies and effects can change the value and state of skills.',
suggestedParents: ['classLevel', 'folder'],
},
propertySlot: {
icon: 'mdi-power-socket-eu',
name: 'Slot',
docsPath: 'property/slot',
helpText: 'A slot in the character sheet is used to specify that a property needs to be selected from a library to fill the slot. The slot can determine what tags it is looking for, and any subscribed library property with matching tags can fill the slot',
suggestedParents: [],
},
slotFiller: {
icon: 'mdi-power-plug-outline',
name: 'Slot filler',
docsPath: 'property/slot-filler',
helpText: 'A slot filler allows for more advanced logic when it attempts to fill a slot. It can masquarade as any property type, and calculate whether it should fill a slot or not.',
suggestedParents: ['propertySlot'],
},
spellList: {
icon: '$vuetify.icons.spell_list',
name: 'Spell list',
docsPath: 'property/spell-list',
helpText: 'A list of spells on your character sheet. It can provide a DC and spell attack bonus to the spells within',
suggestedParents: [],
},
spell: {
icon: '$vuetify.icons.spell',
name: 'Spell',
docsPath: 'property/spell',
helpText: 'A spell your character can potentially cast',
suggestedParents: ['spellList'],
},
toggle: {
icon: '$vuetify.icons.toggle',
name: 'Toggle',
docsPath: 'property/toggle',
helpText: 'Togggles allow parts of the character sheet to be turned on and off, either manually or as the result of a calculation.',
suggestedParents: [],
},
trigger: {
icon: 'mdi-electric-switch',
name: 'Trigger',
docsPath: 'property/trigger',
helpText: 'Triggers apply their children in response to events on the character sheet, such as taking an action or receiving damage',
suggestedParents: [],
},