Add comment to food file

This commit is contained in:
Blade Barringer
2015-10-01 12:31:08 -05:00
parent ee2134dcb7
commit 3c933eaf4e

View File

@@ -4,6 +4,29 @@ import {
merge merge
} from '../helpers'; } from '../helpers';
//--------------------------------------------------
// Food are series objects that have defaults applied if not provided
//
// <food_key> : {
// key: <food_key>,
// text: t(food<formatted_key>),
// notes: t(foodNotes),
// article: <article>,
// target: <target_key>,
// value: <value>,
// canBuy: <canBuy_boolean>,
// canDrop: <canDrop_boolean>,
// }
//
// <food_key> is the name of the food
// <formatted_key> is a screeaming camelCase version of the key
// <article> is whether the food requires an indefinite article ('a', 'an', '')
// <target_key> is the potion key that this food targets
// <value> is the price of the food - defaults to 1
// <canBuy_boolean> is a boolean passed in as part of an options object
// <canDrop_boolean> is a boolean passed in as part of an options object
//--------------------------------------------------
import baseFood from './base'; import baseFood from './base';
import saddle from './saddle'; import saddle from './saddle';
import cake from './birthday'; import cake from './birthday';