Skip to content

Commit

Permalink
Documentation of iexamine and flags
Browse files Browse the repository at this point in the history
  • Loading branch information
ifreund committed Apr 11, 2019
1 parent f160ee2 commit 1217c0b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
7 changes: 6 additions & 1 deletion doc/JSON_FLAGS.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ List of known flags, used in both terrain.json and furniture.json
- ```FLAMMABLE_ASH``` Burns to ash rather than rubble.
- ```FLAMMABLE_HARD``` Harder to light on fire, but still possible.
- ```FLAT``` Player can build and move furniture on.
- ```FLAT_SURF``` Furniture or terrain or vehicle part with flat hard surface (ex. table, but not chair; tree stump, etc.).
- ```FLAT_SURF``` Furniture or terrain with flat hard surface (e.g. table, but not chair; tree stump, etc.).
- ```GOES_DOWN``` Can use <kbd>></kbd> to go down a level.
- ```GOES_UP``` Can use <kbd><</kbd> to go up a level.
- ```HARVESTED``` Marks the harvested version of a terrain type (e.g. harvesting an apple tree turns it into a harvested tree, which later becomes an apple tree again).
Expand Down Expand Up @@ -152,6 +152,7 @@ List of known flags, used in both terrain.json and furniture.json
- ```toilet``` Either drink or get water out of the toilet.
- ```trap``` Interact with a trap.
- ```water_source``` Drink or get water from a water source.
- ```workbench``` Craft items on the furniture, or continue an in progress craft. Should be paired with a ```WORKBENCH1```/```WORKBENCH2```/```WORKBENCH3``` flag.
### Currently only used for Fungal conversions
Expand All @@ -165,6 +166,8 @@ List of known flags, used in both terrain.json and furniture.json
### Furniture only
- ```BLOCKSDOOR``` This will boost map terrain's resistance to bashing if `str_*_blocked` is set (see `map_bash_info`)
- ```WORKBENCH1```/```WORKBENCH2```/```WORKBENCH3``` This is an adequate/good/great workbench for crafting. Should be paired with a workbench iexamine.
## Monsters
Expand Down Expand Up @@ -510,6 +513,7 @@ These branches are also the valid entries for the categories of `dreams` in `dre
- ```EVENTURN``` Only on during even turns.
- ```EXTRA_DRAG``` tells the vehicle that the part exerts engine power reduction.
- ```FAUCET```
- ```FLAT_SURF``` Part with flat hard surface (e.g. table).
- ```FOLDABLE```
- ```FORGE``` Acts as a forge for crafting.
- ```FRIDGE``` Can refrigerate items.
Expand Down Expand Up @@ -576,6 +580,7 @@ These branches are also the valid entries for the categories of `dreams` in `dre
- ```WASHING_MACHINE``` Can be used to wash filthy clothes en masse.
- ```WATER_WHEEL``` Recharges vehicle batteries when in flowing water.
- ```WINDOW``` Can see through this part and can install curtains over it.
- ```WORKBENCH1```/```WORKBENCH2``` Craft items on the vehicle part, or continue an in progress craft.
## Ammo
Expand Down
4 changes: 2 additions & 2 deletions src/mapdata.h
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ struct map_deconstruct_info {
* EASY_DECONSTRUCT - Player can deconstruct this without tools
* HIDE_PLACE - Creature on this tile can't be seen by other creature not standing on adjacent tiles
* BLOCK_WIND - This tile will partially block wind
* FLAT_SURF - Furniture or terrain or vehicle part with flat hard surface (ex. table, but not chair; tree stump, etc.).
*
* Currently only used for Fungal conversions
* WALL - This terrain is an upright obstacle
Expand All @@ -122,8 +123,7 @@ struct map_deconstruct_info {
*
* Furniture only:
* BLOCKSDOOR - This will boost map terrain's resistance to bashing if str_*_blocked is set (see map_bash_info)
* FLAT_SURF - This is required for full butchery and gives a morale bonus while eating.
* WORKBENCH1/WORKBENCH2/WORKBENCH3 - This is an adequate/good/great workbench for crafting. Should be paired with a workbench iexamine.
* WORKBENCH1/WORKBENCH2/WORKBENCH3 - This is an adequate/good/great workbench for crafting. Must be paired with a workbench iexamine.
*/

/*
Expand Down

0 comments on commit 1217c0b

Please sign in to comment.