1# vitamin
2
3## definition
4
5```JSON
6{
7  "id": "iron",
8  "type": "vitamin",
9  "vit_type": "vitamin",
10  "name": "Iron",
11  "excess": "hypervitaminosis",
12  "deficiency": "anemia",
13  "min": -12000,
14  "max": 3600,
15  "rate": "15 m",
16  "flags": [ "FOO" ],
17  "disease": [ [ -4800, -5600 ], [ -5601, -6400 ], [ -6401, -12000 ] ],
18  "disease_excess": [ [ 10, 19 ], [ 20, 29 ], [ 30, 40 ] ]
19},
20```
21### `id`
22Mandatory. The id of the vitamin.
23
24### `type`
25Mandatory. Must be `vitamin`.
26
27### `vit_type`
28The type of the vitamin. Valid values are:
29
30#### `vitamin`
31When simplified nutrition is enabled, this vitamin will not be added to any items and any time the game attempts to retrieve it from the player it will give 0.
32Only nutritional vitamins should have this type.
33
34#### `toxin`
35This is some toxic chemical or component. This currently has no effect.
36
37#### `drug`
38This is a drug. This currently has no effect.
39
40#### `counter`
41This is a counter for something, that is neither a toxin, vitamin, or drug.
42
43### `name`
44What the vitamin shows up as where vitamins are displayed, such as the vitamins display in the item menu.
45
46### `deficiency`
47The id of an effect that is triggered by a deficiency of this vitamin.
48
49### `excess`
50The id of an effect that is triggered by a excess of this vitamin.
51
52### `min`
53The smallest amount of this vitamin that the player can have.
54
55### `max`
56The highest amount of this vitamin that the avatar can have.
57
58### `rate`
59How long it takes to lose one unit of this vitamin.
60
61### `flags`
62An array of string flags; see the flags section below for valid ones.
63
64### `disease`
65What the thresholds of deficiency of this vitamin are.
66Each pair in the list determines the start and end points of that tier of deficiency.
67Each tier of deficiency corresponds to the intensity level of the effect defined in `deficiency`.
68
69### `disease_excess`
70What the thresholds of excess of this vitamin are.
71Each pair in the list determines the start and end points of that tier of excess.
72Each tier of excess corresponds to the intensity level of the effect defined in `excess`.
73
74## flags
75
76- ```NO_DISPLAY``` - This vitamin will not be shown when examining a food.
77