Homebrew: Action

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

๐ŸบBuilding an action

The action object defines of what can be done within the system's action economy time units.

An Example:

The _Meta is normally included in a full JSON, for this example it has been removed. See the link for how to develop the _meta.

	"action": [
		{
			"name": "Extinguish",
			"entries": [
				"When you take the Extinguish action, you may end the {@condition On Fire} condition for a creature within 5 feet of you, or within reach of your unarmed strikes (whichever is greater)."
			],
			"source": "json_in_meta"
			"page": 0,
			"time": [
				{
					"unit": "action",
					"number": 1
				}
			]
		}
	]
Learn More
In the example; the "action" is defined. The first entry in the action array name is defined as Extinguish. The player facing description of the action are defined in the entries section (see Renderer Demo for how to format that). The "source" is the string value "json" field which you will have defined in the header's _meta. Add the "page" number for the page upon which the action is defined from the source; when you are not sure or do not have the page number. set the value to 0. (When "page": 0 the page value doesn't get displayed.)
The "time" object is now defined. As 1 action; ie the time "unit" is defined as an action (options are action; bonus; or reaction); the "number" is the total value of such; in this case only 1 action; but you define it as 2, 10, 10000 as the required number of Actions are spent for the action to occur.

Field List (action)

If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.

Field Name Data Type Description Required
name String The action's title True
source String json (_meta's json value) True
entries Array of Strings action description True
page Integer page number within source False
fromVariant Object descript False
time Array of Objects descript False


Objects

time:



๐Ÿ—„๏ธ Reference Files:
๐Ÿ›ข๏ธ Requirements Specs (Schemata)
[[ |๐Ÿงพ Blank Template]]
๐Ÿ“– Sample JSON
๐Ÿ’พ No Functional Example
๐Ÿ“š Repository of Other Examples


Reference Tag: (how to link to entries within the strings)
"{@action <name_of_action> | <json_source> | <optional_text_information>}":)


Example:
{@action Tumble|DMG}
{@action Tumble|DMG| acrobatically avoid }


Homebrew Support


Known Issues
Looks like its perfect... (Did we miss anything?)


FAQ
Nothing's here (Do you have any suggestions?)
Best Practices
None as yet (Do you have any suggestions?)



Related Features



Did that answer your question(s)?

If not please check the under Support; Troubleshooting or the Known Issues page for further guidance, or go to the Discord community and leave a comment in the issues channel.

If you enjoy the project, please follow this link to see how you can contribute and help make it even better.