Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
anothersimulacrum committed Apr 14, 2020
1 parent cdd5484 commit 830b657
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
5 changes: 5 additions & 0 deletions data/json/flags.json
Original file line number Diff line number Diff line change
Expand Up @@ -707,6 +707,11 @@
"context": [ ],
"type": "json_flag"
},
{
"id": "EFFECT_BULLET_IMMUNE",
"context": [ ],
"type": "json_flag"
},
{
"id": "EFFECT_ACID_IMMUNE",
"context": [ ],
Expand Down
1 change: 1 addition & 0 deletions doc/JSON_FLAGS.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ Some armor flags, such as `WATCH` and `ALARMCLOCK` are compatible with other ite
- ```BELTED``` Layer for backpacks and things worn over outerwear.
- ```BLIND``` Blinds the wearer while worn, and provides nominal protection v. flashbang flashes.
- ```BLOCK_WHILE_WORN``` Allows worn armor or shields to be used for blocking attacks.
- ```BULLET_IMMNUE``` Wearing an item with this flag makes you immune to bullet damage
- ```CLIMATE_CONTROL``` This piece of clothing has climate control of some sort, keeping you warmer or cooler depending on ambient and bodily temperature.
- ```COLLAR``` This piece of clothing has a wide collar that can keep your mouth warm.
- ```DEAF``` Makes the player deaf.
Expand Down
6 changes: 5 additions & 1 deletion doc/JSON_INFO.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,7 @@ This section describes each json file and their contents. Each json has their ow
| env_protec | (_optional_) How much environmental protection does this bionic provide on the specified body parts.
| bash_protec | (_optional_) How much bash protection does this bionic provide on the specified body parts.
| cut_protec | (_optional_) How much cut protection does this bionic provide on the specified body parts.
| bullet_protect | (_optional_) How much bullet protect does this bionic provide on the specified body parts.
| occupied_bodyparts | (_optional_) A list of body parts occupied by this bionic, and the number of bionic slots it take on those parts.
| capacity | (_optional_) Amount of power storage added by this bionic. Strings can be used "1 kJ"/"1000 J"/"1000000 mJ" (default: `0`)
| fuel_options | (_optional_) A list of fuel that this bionic can use to produce bionic power.
Expand Down Expand Up @@ -480,6 +481,7 @@ This section describes each json file and their contents. Each json has their ow
"env_protec": [ [ "MOUTH", 7 ] ],
"bash_protec": [ [ "LEG_L", 3 ], [ "LEG_R", 3 ] ],
"cut_protec": [ [ "LEG_L", 3 ], [ "LEG_R", 3 ] ],
"bullet_protec": [ [ "LEG_L", 3 ], [ "LEG_R", 3 ] ],
"flags": [ "BIONIC_NPC_USABLE" ]
}
```
Expand Down Expand Up @@ -590,6 +592,7 @@ When you sort your inventory by category, these are the categories that are disp
| `name` | In-game name displayed.
| `bash_resist` | How well a material resists bashing damage.
| `cut_resist` | How well a material resists cutting damage.
| `bullet_resist` | How well a material resists bullet damage.
| `acid_resist` | Ability of a material to resist acid.
| `elec_resist` | Ability of a material to resist electricity.
| `fire_resist` | Ability of a material to resist fire.
Expand Down Expand Up @@ -624,6 +627,7 @@ There are six -resist parameters: acid, bash, chip, cut, elec, and fire. These a
"rotting": true,
"bash_resist": 1,
"cut_resist": 1,
"bullet_resist": 1,
"acid_resist": 1,
"fire_resist": 1,
"elec_resist": 1,
Expand Down Expand Up @@ -2841,7 +2845,7 @@ A flat multiplier on the harvest count of the plant. For numbers greater than on
"restricted": true, // (optional) If true, clothing must list this mod's flag in "valid_mods" list to use it. Defaults to false.
"mod_value": [ // List of mod effect.
{
"type": "bash", // "bash", "cut", "fire", "acid", "warmth", "storage", and "encumbrance" is available.
"type": "bash", // "bash", "cut", "bullet", "fire", "acid", "warmth", "storage", and "encumbrance" is available.
"value": 1, // value of effect.
"round_up": false // (optional) round up value of effect. defaults to false.
"proportion": [ // (optional) value of effect propotions to clothing's parameter.
Expand Down

0 comments on commit 830b657

Please sign in to comment.