This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
libecho:classes:start [2022/05/19 17:31] – lee | libecho:classes:start [2023/08/06 18:25] – lee | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | * [[libecho: |
- | + | | |
- | I was originally doing this automagically with JSDoc, but it made the source code a mess. So here it all is redone by hand in markdown. | + | |
- | + | * [[libecho: | |
- | I do my best to keep this up-to-date, but the [[http://svn.echohollow.net/ | + | |
- | + | | |
- | This file is meant to be dry technical documentation of the class implementation for reference purposes. | + | |
- | + | ||
- | ===== Apparel ===== | + | |
- | + | ||
- | Apparel in LibEcho | + | |
- | + | ||
- | An article of Apparel may occupy one or more ClothingSlots. This prevents a character from wearing a dozen coats at the same time, for example. A shirt would occupy ClothingSlot.TORSO and a pair of pants would occupy ClothingSlot.LEGS. A dress would occupy both ClothingSlot.TORSO and ClothingSlot.LEGS. | + | |
- | + | ||
- | When a Person wears a particular article of Apparel, any currently worn articles that occupy the same ClothingSlots are removed. | + | |
- | + | ||
- | In general, you probably needn' | + | |
- | + | ||
- | A couple of generic Apparel types are provided. GenericApparel provides a bare-bones Apparel implementation from which which all other Apparel types are derived. | + | |
- | + | ||
- | Additionally, | + | |
- | + | ||
- | The Apparel system also provides the Wardrobe and WornApparel | + | |
- | + | ||
- | In general, you may use a Wardrobe interchangeably with a GeneralInventory with the InventoryUI macro. | + | |
- | + | ||
- | FIXME: Document how WornApparel and Wardrobe interact as far as items technically remaining in the Wardrobe while they are worn by a Person. | + | |
- | + | ||
- | ==== Clothing Slots ==== | + | |
- | + | ||
- | === LibEcho.Apparel.ClothingSlot === | + | |
- | + | ||
- | ==== Apparel Types ==== | + | |
- | + | ||
- | === LibEcho.Apparel.GenericApparel === | + | |
- | + | ||
- | === LibEcho.Apparel.GenericMenswear === | + | |
- | + | ||
- | === LibEcho.Apparel.GenericWomenswear === | + | |
- | + | ||
- | === LibEcho.Apparel.Unisex.NNN === | + | |
- | + | ||
- | === LibEcho.Apparel.Menswear.NNN === | + | |
- | + | ||
- | === LibEcho.Apparel.Womenswear.NNN === | + | |
- | + | ||
- | === LibEcho.Apparel.Jewelry.NNN === | + | |
- | + | ||
- | ==== Wardrobes ==== | + | |
- | + | ||
- | === LibEcho.Apparel.Wardrobe === | + | |
- | + | ||
- | ==== Worn Apparel ==== | + | |
- | + | ||
- | === LibEcho.Apparel.WornApparel === | + | |
- | + | ||
- | ==== The Apparel UI ==== | + | |
- | + | ||
- | === LibEcho.Apparel.ApparelUI === | + | |