Template:Action page/doc: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
(Updated doc to remove deprecated cost fields)
Line 7: Line 7:
| image =
| image =
| cost =
| cost =
| cost amount =
| cost2 =
| cost2 amount =
| cost3 =
| cost3 amount =
| hit cost =
| hit cost =
| hit cost amount =
| hit cost2 =
| hit cost2 amount =
| concentration =
| concentration =
| damage =
| damage =
Line 107: Line 99:
},
},
"cost": {
"cost": {
"description": "The resource cost of the action. Valid resources are any resource available in the Resource Template.",
"description": "A comma separated list of resources used to perform the action. Use a colon and a number to specify > 1 cost. Valid resources are any resource available in the Resource Template.",
"example": "action",
"example": "action, ki:2",
"suggestedvalues": [
"suggestedvalues": [
"action",
"action",
"bonus",
"bonus",
"reaction",
"reaction",
"freeaction",
"movement",
                "half movement",
"ki",
"ki",
"supdie"
"supdie"
Line 119: Line 112:
"suggested": true,
"suggested": true,
"type": "string"
"type": "string"
},
        "cost amount": {
"description": "The amount of the resource consumed by the action. If using the movement resource, the number specified is the movement specified in feet. Defaults to 1 if not specified.",
"example": "2",
"suggestedvalues": [
"1",
"5",
"2"
],
"suggested": true,
"type": "number"
},
        "cost2": {
"description": "The second resource cost of the action. Valid resources are any resource available in the Resource Template.",
"example": "action",
"suggestedvalues": [
"action",
"bonus",
"reaction",
"freeaction",
"ki",
"supdie"
],
"suggested": true,
"type": "string"
},
        "cost2 amount": {
"description": "The amount of the second resource consumed by the action. If using the movement resource, the number specified is the movement specified in feet. Defaults to 1 if not specified.",
"example": "2",
"suggestedvalues": [
"1",
"5",
"2"
],
"suggested": true,
"type": "number"
},
        "cost3": {
"description": "The third resource cost of the action. Valid resources are any resource available in the Resource Template.",
"example": "action",
"suggestedvalues": [
"action",
"bonus",
"reaction",
"freeaction",
"ki",
"supdie"
],
"suggested": true,
"type": "string"
},
        "cost3 amount": {
"description": "The amount of the third resource consumed by the action. If using the movement resource, the number specified is the movement specified in feet. Defaults to 1 if not specified.",
"example": "2",
"suggestedvalues": [
"1",
"5",
"2"
],
"suggested": true,
"type": "number"
},
},
         "hit cost": {
         "hit cost": {
"description": "The resource cost of the action used only if the action is successful. Any resource defined in [[Template:Resource]] can be used",
"description": "A comma separated list of resources used only if the action is successful. Any resource defined in [[Template:Resource]] can be used",
"example": "ki, bonus",
"suggestedvalues": [
"action",
"bonus",
"reaction",
"supdie",
"ki"
],
"suggested": true,
"type": "string"
},
        "hit cost amount": {
"description": "The amount of the resource consumed by the action. If using the movement resource, the number specified is the movement specified in feet. Defaults to 1 if not specified.",
"example": "2",
"suggestedvalues": [
"1",
"5",
"2"
],
"suggested": true,
"type": "number"
},
        "hit cost2": {
"description": "The second resource cost of the action used only if the action is successful. Any resource defined in [[Template:Resource]] can be used",
"example": "ki, bonus",
"example": "ki, bonus",
"suggestedvalues": [
"suggestedvalues": [
Line 217: Line 125:
"suggested": true,
"suggested": true,
"type": "string"
"type": "string"
},
        "hit cost2 amount": {
"description": "The amount of the second resource consumed by the action. If using the movement resource, the number specified is the movement specified in feet. Defaults to 1 if not specified.",
"example": "2",
"suggestedvalues": [
"1",
"5",
"2"
],
"suggested": true,
"type": "number"
},
},
"attack roll": {
"attack roll": {
Line 772: Line 669:
"image",
"image",
"cost",
"cost",
        "cost amount",
        "cost2",
        "cost2 amount",
        "cost3",
        "cost3 amount",
         "hit cost",
         "hit cost",
        "hit cost amount",
        "hit cost2",
        "hit cost2 amount",
"damage",
"damage",
"damage2",
"damage2",

Revision as of 23:13, 8 December 2023

Usage

{{ActionPage
| this is an example = 
| summary =
| description =
| image =
| cost =
| hit cost =
| concentration =
| damage =
| damage2 =
| recharge =
| duration =
| save =
| attack roll = 
| range =
| range m = 
| range ft = 
| aoe =
| aoe m =
| aoe ft =
| additional = 
| higherlevels =
| variants =
| variant of =
| condition =
| condition duration = 
| condition save = 
| condition dc =
| condition2 =
| condition2 duration = 
| condition2 save = 
| condition2 dc =
| area =
| area category =
| area shape =
| area range m =
| area range ft =
| area duration =
| area turn start damage =
| area turn start damage type =
| area turn start damage save =
| area turn start damage save effect =
| area turn end damage =
| area turn end damage type =
| area turn end damage save =
| area turn end damage save effect =
| area condition =
| area condition save =
| area condition2 =
| area condition2 save =
| area condition3 =
| area condition3 save =
| area condition4 =
| area condition4 save =
| X learns at level X =
| granted by feats =
| granted by items = 
| granted by spells = 
| used by creatures =
| notes =
| video =
}}
Bg3 content hr.png

This generates pages that don't fit other generators, automatically formatting and categorizing the page. Don't be daunted by the number of parameters/options and fill in what you need.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Action summarysummary

The summary of the action and its effects. This goes at the top of the article. Use description for the in-game text description.

Example
This action allows the caster to unleash a streak of fire from their hands that ignites into a large explosion at a chosen point within range.
Contentrequired
Action descriptiondescription

The raw in-game description of the action. Use summary for summarizing the action and its effects.

Example
Shoot a bright flame from your fingers that explodes upon contact, torching everything in the vicinity for 8d6 Fire damage.
Stringrequired
Action image/iconimage

The page's main image. [[File:NoImage Icon.webp|x40px]] will be used if empty.

Example
Fireball Icon.png
Stringsuggested
costcost

A comma separated list of resources used to perform the action. Use a colon and a number to specify > 1 cost. Valid resources are any resource available in the Resource Template.

Suggested values
action bonus reaction movement half movement ki supdie
Example
action, ki:2
Stringsuggested
hit costhit cost

A comma separated list of resources used only if the action is successful. Any resource defined in [[Template:Resource]] can be used

Suggested values
action bonus reaction supdie ki
Example
ki, bonus
Stringsuggested
damagedamage

The damage of the action.

  • amount: amount in number or die like 1d8
  • amounttext: if your amount is text instead of a number or die you need to do this instead
  • type: damage type, i.e. Healing

    Suggested values
    amounttext:Weapon, type:Physical
    Example
    amount:3d6, type:Acid
Stringoptional
damage2damage2

The secondary damage of the action. Will be output as damage + damage2. Same params as damage.

Suggested values
amounttext:Weapon, type:Physical
Example
amount:6d20, type:Radiant
Stringoptional
rechargerecharge

Action recharge time, if applicable

Example
Long Rest
Stringoptional
durationduration

Duration in turns of the action. Generally you will use condition duration instead.

Example
10
Stringoptional
attack rollattack roll

Whether the action is reliant on a attack roll. Leave blank if no attack roll is made.

Suggested values
Yes
Default
No
Example
Yes
Stringoptional
savesave

The save (if any) that a target must roll against the damage effect of the action, with the result after the comma.

Suggested values
Strength, half damage Dexterity, negated Constitution Intelligence Wisdom Charisma
Example
Dexterity
Stringoptional
concentrationconcentration

Whether or not the action requires concentration. Blank = No, otherwise = Yes.

Suggested values
Yes
Default
No
Example
Yes
Stringoptional
rangerange

The range of the action.

Suggested values
ranged melee self
Example
ranged
Stringoptional
range mrange m

Use this parameter if the action's range does not fit into one of the presets, "melee", "ranged", or "self". Indicates the range in meters.

Example
5
Numberoptional
range ftrange ft

Use this parameter if the action's range does not fit into one of the presets, "melee", "ranged", or "self". Indicates the range in feet.

Example
35
Numberoptional
aoeaoe

Indicates if the action affects an area, and what type of shape its effect is.

Suggested values
radius cone cube line
Example
cone
Stringoptional
aoe maoe m

This indicates the range of the action's aoe shape, in meters.

Example
5
Numberoptional
aoe ftaoe ft

This indicates the range of the action's aoe shape, in feet.

Example
15
Numberoptional
additional propertiesadditional

Any additional properties about the skill that are not covered by template go here, which goes under damage in properties

Contentoptional
conditioncondition

The full name of the condition (if any) that this action applies to its target/s. Leave blank if there is no condition.

Example
Hastened
Stringoptional
condition durationcondition duration

The duration in turns of the action's applied condition. Leave blank if the duration is unlimited.

Example
5
Numberoptional
condition savecondition save

The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
condition dccondition dc

The optional fixed DC of the condition that targets have to pass to apply it

Example
12
Numberoptional
condition2condition2

The full name of the condition (if any) that is applied if there is a second condition.

Example
Hastened
Stringoptional
condition2 durationcondition2 duration

The duration in turns of the action's second condition. Leave blank if the duration is unlimited.

Example
5
Numberoptional
condition2 savecondition2 save

The save that the action's target must roll to avoid or reduce the effects of the second condition. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
condition2 dccondition2 dc

The optional fixed DC of the second condition that targets have to pass to apply it

Example
12
Numberoptional
Action area namearea

Indicates the name of a special area/field/surface/cloud created by the action (if any). Leave blank if there is none.

Example
Hunger of Hadar
Stringoptional
area categoryarea category

This indicates the type of area created by the action.

Suggested values
cloud surface area
Default
area
Example
surface
Stringoptional
area shapearea shape

This indicates the shape that the special area created by the action takes.

Suggested values
Radius Cone Cube
Example
Radius
Stringoptional
area range marea range m

Indicates the range of the area created by action, in meters.

Example
5
Numberoptional
area range ftarea range ft

Indicates the range of the area created by action, in feet.

Example
12
Numberoptional
area durationarea duration

This indicates how long the area created by the action lasts, in turns.

Example
6
Numberoptional
area turn start damagearea turn start damage

How much damage this area does to an entity starting its turn in it.

Example
2d4
Stringoptional
area turn start damage typearea turn start damage type

The type of damage dealt to a creature starting its turn in the area created by this action.

Example
Cold
Stringoptional
area turn start damage savearea turn start damage save

The saving throw an entity starting its turn in the area created by this action must roll in order to reduce or negate its damage.

Suggested values
Strength Dexterity Constitution Intelligence WIsdom Charisma
Example
Dexterity
Stringoptional
area turn start damage save effectarea turn start damage save effect

This indicates what effect a successful saving throw has on the damage applied to a creature starting its turn in this action's area. Leave blank to default to "negate".

Suggested values
half negate
Default
negate
Example
half
Stringoptional
area turn end damagearea turn end damage

How much damage this area does to an entity ending its turn in it.

Example
2d4
Stringoptional
area turn end damage typearea turn end damage type

The type of damage dealt to a creature ending its turn in the area created by this action.

Example
Necrotic
Stringoptional
area turn end damage savearea turn end damage save

The saving throw an entity ending its turn in the area created by this action must roll in order to reduce or negate its damage.

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
Dexterity
Stringoptional
area turn end damage save effectarea turn end damage save effect

This indicates what effect a successful saving throw has on the damage applied to a creature ending its turn in this action's area. Leave blank to default to "negate".

Suggested values
half negate
Default
negate
Stringoptional
area conditionarea condition

The full name of the condition applied by this action's area, leave blank if no condition is applied.

Example
Burning
Stringoptional
area condition savearea condition save

The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
area condition2area condition2

The full name of the second condition applied by this action's area, leave blank if no second condition is applied.

Example
Burning
Stringoptional
area condition2 savearea condition2 save

The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
area condition3area condition3

The full name of the third condition applied by this action's area, leave blank if no third condition is applied.

Example
Burning
Stringoptional
area condition3 savearea condition3 save

The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
area condition4area condition4

The full name of the fourth condition applied by this action's area, leave blank if no fourth condition is applied.

Example
Burning
Stringoptional
area condition4 savearea condition4 save

The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
higher levelshigher levels

If the action changes at higher levels, put info about that here

Example
At level 10 with [[File:Generic Damage Icon.png|frameless|25px]] '''Improved Superiority Dice''' the damage bonus increases to {{C|[[File:D10 Physical.png|frameless|40px]]1d10}}.
Contentoptional
variantsvariants

Comma-separated list of variants of the action, like the element types of Chromatic Orb.

Example
Chromatic Orb: Fire, Chromatic Orb: Ice, Chromatic Orb: Acid, ...
Stringoptional
variant ofvariant of

The spell that is the parent of this spell

Example
Chromatic Orb
Stringoptional
class learns at level 1class learns at level 1

This specifies what level the classes get access to this action at level 1. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 2class learns at level 2

This specifies what level the classes get access to this action at level 2. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 3class learns at level 3

This specifies what level the classes get access to this action at level 3. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 4class learns at level 4

This specifies what level the classes get access to this action at level 4. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 5class learns at level 5

This specifies what level the classes get access to this action at level 5. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 6class learns at level 6

This specifies what level the classes get access to this action at level 6. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 7class learns at level 7

This specifies what level the classes get access to this action at level 7. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 8class learns at level 8

This specifies what level the classes get access to this action at level 8. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 9class learns at level 9

This specifies what level the classes get access to this action at level 9. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 10class learns at level 10

This specifies what level the classes get access to this action at level 10. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 11class learns at level 11

This specifies what level the classes get access to this action at level 11. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
class learns at level 12class learns at level 12

This specifies what level the classes get access to this action at level 12. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.

Example
Sorcerer, Wizard, Fiend, Light Domain
Stringoptional
race learns at level 1race learns at level 1

This specifies what level the races get access to this action at level 1. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 2race learns at level 2

This specifies what level the races get access to this action at level 2. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 3race learns at level 3

This specifies what level the races get access to this action at level 3. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 4race learns at level 4

This specifies what level the races get access to this action at level 4. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 5race learns at level 5

This specifies what level the races get access to this action at level 5. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 6race learns at level 6

This specifies what level the races get access to this action at level 6. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 7race learns at level 7

This specifies what level the races get access to this action at level 7. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 8race learns at level 8

This specifies what level the races get access to this action at level 8. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 9race learns at level 9

This specifies what level the races get access to this action at level 9. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 10race learns at level 10

This specifies what level the races get access to this action at level 10. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 11race learns at level 11

This specifies what level the races get access to this action at level 11. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
race learns at level 12race learns at level 12

This specifies what level the races get access to this action at level 12. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.

Example
Elf, Seldarine Drow
Stringoptional
granted by featsgranted by feats

This specifies what feats get access to this action. Similar to the class and race arguments, this list can be comma-separated as well.

Example
Magic Initiate: Druid
Stringoptional
granted by itemsgranted by items

This specifies what items get access to this action. Similar to the class and race arguments, this list can be comma-separated as well.

Example
Poisoner's Ring
Stringoptional
granted by spellsgranted by spells

This specifies what spells get access to or trigger this action. Similar to the class and race arguments, this list can be comma-separated as well.

Example
Poisoner's Ring
Stringoptional
used by creaturesused by creatures

This specifies which creatures use this action.

Example
Magma Mephit
Stringoptional
notesnotes

Any extra or related information about the action.

Contentoptional
videovideo

Name of an uploaded video file showcasing the action.

Fileoptional
If this is an examplethis is an example

If this is an example and you don't want the page to be categorized and related.

Example
yes
Stringoptional
higherlevelshigherlevels

no description

Unknownoptional
other ways to learnother ways to learn

Other ways to learn. These will be inserted as-is at the end of the how to learn field.

Stringoptional

Example

{{ActionPage| this is an example = yes
| description = abc
| image = Fly Icon.png
| summary = fly you fools
| cost = action
| hit cost = ki
| hit cost amount = 2
| damage = amounttext: 1d4+1, type:Bludgeoning
| damage2 = amount: 1d6, per:beam, type: Fire
| recharge = Long Rest
| range = melee
| duration = LR
| save = DEX, abc
| additional = * abcd
| higherlevels = go far
| condition = Flight
| condition duration = 1
| area = Darkness
| area category = cloud
| area shape = Radius
| area range m = 5
| area range ft = 17
| area duration = 10
| area condition = Blinded
| area condition save = STR
| class learns at level 3 = Monk
| race learns at level 5 = Wood Elf
| notes = * bar
| video = Fireball-showcase.mp4
}}


Fly Icon.png

fly you fools

Description

abc

Properties

Cost:
Ki Point
Cost on hit:
Sorcery Point
Damage:
1d4+1 Damage TypesBludgeoning
+
D6 Fire.png 1d6 (1~6) Damage TypesFire per beam
Details:
 Melee: 1.5 m / 5  ft
Creates Area: Darkness
Recharge: Long rest
Duration: LR turns
DEX, abc Save
  • abcd

Condition: Flight

Flight Flight

Duration: 1 turn

  • Fly up to target position, up to 18 m / 60 ft each turn using your Movement Speed.

Area: Darkness

Darkness Darkness

Duration: 10 turns

AoE: 5 m / 17 ft (Radius)

A shroud of magical darkness that Heavily Obscures and Blinds creatures within. Creatures cannot make ranged attacks into or out of the darkness.

Type: Cloud

Condition: Blinded

Blinded Blinded

How to learn

Classes:

Races:

(Character level is the sum of all class levels for a multi-classed character.)

Notes

  • bar

Visuals

another example

Fly Icon.png

fly you fools 2

Description

abc

Properties

Cost:
Action
Damage:
1d4+1 Damage TypesBludgeoning
Details:
 Melee: 1.5 m / 5  ft
Recharge: Long rest
Duration: LR turns
DEX, abc Save
  • abcd

How to learn

Other ways to learn:

  • By ticking a giant space hamster
  • Carameldansen under the Mouth of Bhaal