Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document burn_data for materials #65409

Merged
merged 1 commit into from
May 2, 2023
Merged

Document burn_data for materials #65409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions doc/JSON_INFO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Use the `Home` key to return to the top.
- [Item Variables](#item-variables)
- [Materials](#materials)
- [Fuel data](#fuel-data)
- [Burn data](#burn-data)
- [Monster Groups](#monster-groups)
- [Group definition](#group-definition)
- [Monster/Subgroup definition](#monstersubgroup-definition)
Expand Down Expand Up @@ -1419,6 +1420,24 @@ If a fuel has the PERPETUAL flag, engines powered by it never use any fuel. Thi
}
```

#### Burn data

Every material can have burn data that determines how it interacts with fire. Fundamentally, the intensity, smoke production, and longevity of fires depends on the volume of consumed items. However, these values allow for certain items to burn more for a given volume, or even put out or inhibit the growth of fires.

Note that burn_data is defined per material, but items may be made of multiple materials. For such cases, each material of the item will be calculated separately, as if it was multiple items each corresponding to a single material.

```C++
"burn_data": [
{ "immune": true, // Defaults to false, optional boolean. If true, makes the resulting material immune to fire. As such it can neither provide fuel nor be burned or damaged.
"fuel": 300, // Float value that determines how much time and intensity this material adds to a fire. Negative values will subtract fuel from the fire, smothering it.
// Items with a phase ID of liquid should be made of materials with a value of >= 200 if they are intended to be flammable.
"smoke": 0, // Float value, determines how much smoke this material produces when burning.
"volume_per_turn": "750 ml", // If non-zero and lower than item's volume, scale burning by volume_per_turn / volume
"burn": 1 } // Float value, determines how quickly a fire will convert items made of this material to fuel. Does not affect the total fuel provided by a given
// volume of a given material.
],
```

### Monster Groups

#### Group definition
Expand Down