Difference between revisions of "Homebrew: Hazard"

From 5etools Community Wiki
Jump to: navigation, search
m (==)
(Completed page)
 
Line 1: Line 1:
__NOTOC__
 
 
{{HomebrewHeader}}
 
{{HomebrewHeader}}
  
==🍺hazard ==
+
==Building a hazard==
<description_of_the_homebrew_category_and_use>
+
===Basic skeleton===
 +
To start, copy the following code block and fill the empty <code>""</code> values.
 +
<div class="toccolours mw-collapsible mw-collapsed" overflow:auto;">
 +
<div style="font-weight:bold;line-height:2;">Hazard code block</div>
 +
<div class="mw-collapsible-content">
 +
"hazard": [
 +
    {
 +
        "name": "",
 +
        "source": "",
 +
        "page": 0,
 +
        "entries": [
 +
            ""
 +
        ],
 +
        "trapHazType": "HAZ"
 +
    }
 +
]
 +
</div></div>
 +
 
 +
:* <code>"name"</code> — the name of the hazard.
 +
:* <code>"source"</code> — make sure it is the same as the <code>"json"</code> key in the '''_meta'''.
 +
:* <code>"page"</code> — page of the document the hazard appears at (leave at 0 if not applicable).
 +
:* <code>"entries"</code> — consists of text strings ("") separated by commas.
 +
:* <code>"trapHazType"</code> — to see the different types of hazards, see below:
 +
 
 +
<center>
 +
{| border="0" cellspacing="1" cellpadding="1" style="width:500px;" " class="article-table"
 +
|-
 +
! scope="col"|<p style="text-align:left;font-size:120%;">trapHazType Value</p> !! scope="col"| <p style="text-align:left;font-size:120%;"> Description </p> !! Examples
 +
|-
 +
| <code>"WTH"</code> || Weather || Sandstorm; Hurricanes
 +
|-
 +
| <code>"ENV"</code> || Enviromental || Lava Pool; Acid Vents
 +
|-
 +
| <code>"WLD"</code> || Wilderness Threat || Desecrated ground; quicksand
 +
|-
 +
| <code>"GEN"</code> || Generic Threat || Improved damage
 +
|-
 +
| <code>"HAZ"</code> || Hazard ||
 +
|}
 +
</center>
 +
 
  
====An Example:====
 
The [[Homebrew: Meta|'''_Meta''']] is normally included in a full JSON, for this example it has been removed. See [[Homebrew: Meta|the link]] for how to develop the _meta.
 
  
"hazard": [
+
==Reference Tag==
{
+
How to link to entries within the <code>"entries":</code>
"name": "Quicksand",
+
::<code>{@hazard <name_of_hazard> | <json_source> | <option_display_text> } </code>
"entries": [
+
 
"A natural phenomenon, quicksand is like regular sand, but weaponized. Any creature unlucky enough to wander into a pool of quicksand is restrained. If the creature has a handhold to pull themselves out with, they may use an action to make a DC 10 Strength (Athletics) check. On a success, they pull themselves free, and must expend movement to leave the quicksand. Another creature may instead pull a trapped creature out, provided they are not stuck within the quicksand themselves. The DC to do so is the same.",
+
:: Example:
"If a creature is well-versed in the ways of nature's deadliest sand variety, they may opt to drop prone to float on the quicksand. If they do so, they are no longer restrained, and may move through the quicksand, provided they remain prone. While prone, Each foot of movement through the quicksand costs 5 feet of movement."
+
:::{@hazard russet mold|vgm}
],
+
:::{@hazard russet mold|vgm|and optional link text added with another pipe}
"source": "json_in_meta"
 
}
 
]
 
  
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
 
<div style="font-weight:bold;line-height:1.6;">Learn More</div>
 
<div class="mw-collapsible-content">
 
: In the example; <description_of_results/fields>
 
</div></div>
 
  
== Field List ('''Sources''') ==  
+
==Field List Sources==  
 
<small>If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.</small>
 
<small>If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.</small>
  
Line 41: Line 70:
 
|}
 
|}
  
<br/>
 
<center>
 
====
 
{| border="0" cellspacing="1" cellpadding="1" style="width:500px;" class="article-table"
 
|-
 
! scope="col"|<p style="text-align:left;font-size:120%;">trapHazType Value</p> !! scope="col"| <p style="text-align:left;font-size:120%;"> Description </p> !! Examples
 
|-
 
| WTH || Weather || Sandstorm; Hurricanes
 
|-
 
| ENV || Enviromental || Lava Pool; Acid Vents
 
|-
 
| WLD || Wilderness Threat ||
 
|-
 
| GEN || Generic Threat ||
 
|-
 
| HAZ || Hazard ||
 
|}
 
</center>
 
 
<br/>
 
 
----
 
----
 
<div style="font-weight:bold;line-height:1.6;font-size:140%">🗄️ Reference Files:</div>
 
<div style="font-weight:bold;line-height:1.6;font-size:140%">🗄️ Reference Files:</div>
Line 70: Line 79:
 
----
 
----
  
<br/>
 
: <font color="#2e7bab">Reference Tag:</font> (how to link to entries within the <code>"entries":</code>)
 
::<code>{@hazard <name_of_hazard> | <json_source> | <option_display_text> } </code>
 
<br/>
 
:: Example:
 
 
{@hazard russet mold|vgm}
 
{@hazard russet mold|vgm|and optional link text added with another pipe}
 
  
<br/>
+
==Homebrew Support==
=== Homebrew Support===
 
 
----
 
----
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
Line 100: Line 100:
 
<br/>
 
<br/>
 
----
 
----
==='''Related Features'''===
+
==Related Features==
 
----
 
----
 
:*[[Homebrew]]
 
:*[[Homebrew]]

Latest revision as of 12:35, 28 July 2020

framless
v1.1.0

Building a hazard

Basic skeleton

To start, copy the following code block and fill the empty "" values.

Hazard code block
"hazard": [
    {
        "name": "",
        "source": "",
        "page": 0,
        "entries": [
            ""
        ],
        "trapHazType": "HAZ"
    }
]
  • "name" — the name of the hazard.
  • "source" — make sure it is the same as the "json" key in the _meta.
  • "page" — page of the document the hazard appears at (leave at 0 if not applicable).
  • "entries" — consists of text strings ("") separated by commas.
  • "trapHazType" — to see the different types of hazards, see below:

trapHazType Value

Description

Examples
"WTH" Weather Sandstorm; Hurricanes
"ENV" Enviromental Lava Pool; Acid Vents
"WLD" Wilderness Threat Desecrated ground; quicksand
"GEN" Generic Threat Improved damage
"HAZ" Hazard


Reference Tag

How to link to entries within the "entries":

{@hazard <name_of_hazard> | <json_source> | <option_display_text> }
Example:
{@hazard russet mold|vgm}
{@hazard russet mold|vgm|and optional link text added with another pipe}


Field List Sources

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
trapHazType String "MECH" or "MAG" True
source String json (_meta's json value) True
page Integer page number it appears upon False
entries Array of Strings description of trap & its functions True

🗄️ Reference Files:
🛢️Requirements Specs (Schemata)
[[ |🧾 Blank Template]]
📖 Sample JSON
💾 No Functional Examples exist
📚 Repository of Other Examples


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.