diff --git a/common/script/src/content/gear/index.js b/common/script/src/content/gear/index.js index 245e73fd74..7c2a3a0751 100644 --- a/common/script/src/content/gear/index.js +++ b/common/script/src/content/gear/index.js @@ -2,6 +2,53 @@ import {translator as t} from '../helpers'; import {each, defaults} from 'lodash'; import moment from 'moment'; +//-------------------------------------------------- +// Gear is structured by equipment type, but organized by set. Each set exports the equipment for each type that it has +// +// The class sets have numbered key values, as they are purchased sequentially +// +// : { +// key: __, +// type: , +// klass: , +// index: , +// text: t(Text), +// notes: t(Notes { +// +// }), +// con: , +// int: , +// per: , +// str: , +// value: , +// last: , +// +// event: , +// canOwn: , +// mystery: +// } +// +// - What type of euqipment it is (armor, head, weapon, etc) +// - What set this gear is a part of (special, mystery, warrior, etc) +// - The order in this particular set +// - CamelCased version of key +// +// - if gear has stat bonuses, they are automatically applied to notes +// +// - Boost to con, defaults to 0 +// - Boost to int, defaults to 0 +// - Boost to per, defaults to 0 +// - Boost to str, defaults to 0 +// +// - Price in gold +// - whether this is the last in a particular class set +// +// - the event key, present if gear is part of an event +// - a function that determines whether or not gear can be purchased in the rewards column +// - the mystery set key, present if item is a mystery item +// +//-------------------------------------------------- + import classes from '../classes'; import weapon from './weapon';