GenericApparel

This is all changing, and this info isn't correct. It will be updated once the code is done.

Apparel.GenericApparel provides the barebones base class from which all other Apparel types are derived. GenericApparel is generally unisex. GenericMenswear and GenericWomenswear derive from GenericApparel and provide barebones base classes for masculine and feminine apparel (currently mostly unimplemented).

Several specific apparel types are also provided, deriving from GenericApparel, GenericMenswear, and GenericWomenswear, which offer defaults for ClothingSlots, genericName, and other properties in some cases. These are the classes that you generally want to use in your defaults JS when you define objects.

Articles of Apparel may have various properties. Some specific apparel types implement some properties, as listed later on. All properties may be set in your defaults JS when you define objects. Even those provided by the specific apparel types may be overridden.

The generic name of an object, printed when it is obvious what the item is but no details can be seen. The most obvious example would be a bra printing through a tight tshirt being referred to as just a “bra” (its genericName) rather than a “lacy purple bra”.

The specific Apparel types all implement this property, but you may override it in defaults.

• Type: String
• Required

The specific name of the apparel, printed when the apparel can be plainly seen. “A green peacoat” or “a long floral print skirt,” for example.

• Type: String
• Required

An array of the ClothingSlots that the object occupies. Only one article of apparel my occupy a particular ClothingSlot at a time (see above). Setting this to an empty array will allow the article of apparel to be worn without occupying any ClothingSlots.

• Type: Array of ClothingSlot enumerations
• Required

The category into which InventoryUI sorts the object. If this property is omitted, it will be sorted into the “Other” category.

• Type: String
• Optional

The category into which ApparelUI sorts the object. If this property is omitted, it will be sorted into the “Other” category.

• Type: String
• Optional

If this property is true, the article of apparel will be considered “long” and possibly conceal more underlayers. Knee length long skirts and pants. Trenchcoats. Etc. See the section on ClothingSlots for more details.

• Type: Boolean
• Optional

If this property is true, the article of apparel will be considered “short” and possibly conceal fewer underlayers.. Crop tops. Booty shorts. Minidresses. Etc. See the section on ClothingSlots for more details.

• Type: Boolean
• Optional
• Currently unimplemented

If this property is true, the article of apparel will be considered “high” and possibly conceal more underlayers.. Turtleneck shirts. High-top shoes and boots. Etc. See the section on ClothingSlots for more details.

• Type: Boolean
• Optional

If this property is true, the article of apparel will be considered “low” and possibly conceal fewer underlayers.. Off-shoulder and swoop tops. Low-rise jeans. Etc. See the section on ClothingSlots for more details.

• Type: Boolean
• Optional
• Currently unimplemented

If this property is true, the article of apparel will reveal whatever is worn beneath it regardless of what ClothingSlots is occupies. A fishnet top or translucent wraparound, for example.

• Type: Boolean
• Optional

The “thin” property, when set to true, is used to denote tight-fitting articles of apparel made with thin fabric. A tight-fitting t-shirt, for example. The articles of apparel worn below will “show an outline” through this article of apparel, and will be listed with their genericName in worn apparel descriptions, without showing the specific details of the item. For example, wearing a “pink polka-dot bra” beneath a “tight red t-shirt” will list in descriptions as “a tight red t-shirt and a bra (printing through the tight red t-shirt),” rather than specifically as a “pink polka-dot bra”.

• Type: Boolean
• Optional

A couple of generic Apparel types are provided. GenericApparel provides a bare-bones Apparel implementation from which which all other Apparel types are derived. GenericMenswear and GenericWomenswear provide implementations which reference the potential wearer's femininity stat to determine whether or not they can be worn, and provide some default adjustments to that stat (currently unimplemented).

Unless you are actually extending the library, you probably don't need to use any of these GenericApparel classes. If you are just using the library in your game, you're probably better off using the specific Apparel classes.

However, if you need to create an article of Apparel that does not easily fit into any of the specific types, one of the generic types may be useful to you.

• Inherits from: PersistentObject

This is the generic Apparel type from which all other Apparel is derived. Objects that specify this type in their defaults must also explicitly provide a ClothingSlots field and all genericName properties.

• Inherits from: GenericApparel

This is a generic Apparel type that will at some point provide defaults that associate it with masculine People. Depending on the type of Transformations that are enabled, People with too much femininity might not be able to equip this type of Apparel, and/or equipping it may gradually cause the Person to transform towards being more masculine.

At the current time, however, none of this is implemented, as the Transformation mechanics are still being worked on.

As with GenericApparel, objects that specify this type in their defaults must also explicitly provide a ClothingSlots field and all genericName properties.

• Inherits from: GenericApparel

This is a generic Apparel type that will at some point provide defaults that associate it with feminine People. Depending on the type of Transformations that are enabled, People with too much masculinity might not be able to equip this type of Apparel, and/or equipping it may gradually cause the Person to transform towards being more feminine.

At the current time, however, none of this is implemented, as the Transformation mechanics are still being worked on.

As with GenericApparel, objects that specify this type in their defaults must also explicitly provide a ClothingSlots field and all genericName properties.

Several specific Apparel types are provided, which ought to cover most use-cases, simplifying the structure of the defaults files. Unisex apparel has no specific masculine or feminine bent; it can be worn by anyone. Menswear and Womenswear are gender-specific clothing types and may be restricted accordingly depending on game settings and/or transformation level. Currently, all Jewelry is considered unisex, but this needs to be fixed .

Unisex short coats, jackets, etc. need to implement LongCoat.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.OVER
• .genericName: “coat”
• .wardrobeCategory: Other

Unisex headgear.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.HEAD
• .genericName: “hat”
• .wardrobeCategory: Other

Unisex long pants.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.LEGS
• .genericName: “pair of pants”
• .wardrobeCategory: Bottoms
• .long: true

Unisex shirt.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.TORSO
• .genericName: “shirt”
• .wardrobeCategory: Tops

Unisex low-top shoes.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.FEET
• .genericName: “pair of shoes”
• .wardrobeCategory: Shoes

Unisex high-top shoes and boots.

• Inherits from: Shoes
• .high: true

Unisex shorts.

• Inherits from: Pants
• .genericName: “pair of shorts”
• .long: false

Unisex socks.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.UNDERLEGS
• .genericName: “pair of socks”
• .wardrobeCategory: Underwear

Men's boxers.

• Inherits from: GenericMenswear
• ClothingSlots: ClothingSlot.UNDERPANTS
• .genericName: “pair of boxers”
• .wardrobeCategory: Underwear

Men's briefs.

• Inherits from: GenericMenswear
• ClothingSlots: ClothingSlot.UNDERPANTS
• .genericName: “pair of briefs”
• .wardrobeCategory: Underwear

Women's bra.

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.UNDERSHIRT
• .genericName: “bra”
• .wardrobeCategory: Underwear

Women's short or mid-length dress (does not cover all the way down to feet).

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.TORSO, ClothingSlot.LEGS
• .genericName: “dress”
• .wardrobeCategory: Dresses

Women's long dress (goes all the way down to feet).

• Inherits from: Dress
• .genericName: “long dress”
• .long: true

Women's panties.

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.UNDERPANTS
• .genericName: “pair of panties”
• .wardrobeCategory: Underwear

Women's long pants and slacks.

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.LEGS
• .genericName: “pair of pants”
• .wardrobeCategory: Bottoms
• .long: true

Women's shirts and blouses.

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.TORSO
• .genericName: “shirt”
• .wardrobeCategory: Tops

Women's low-top shoes.

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.FEET
• .genericName: “pair of shoes”
• .wardrobeCategory: Shoes

Women's high-top shoes and boots.

• Inherits from: ShoesWomens
• .high: true

Women's shorts, capris, stc.

• Inherits from: PantsWomens
• .genericName: “pair of shorts”
• .long: false

Women's short or mid-length skirt (does not cover all the way down to feet).

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.LEGS
• .genericName: “skirt”
• .wardrobeCategory: Bottoms

Women's long skirt (goes all the way down to feet).

• Inherits from: Skirt
• .genericName: “long skirt”
• .long: true

Women's stockings and hoisery.

• Inherits from: GenericWomenswear
• ClothingSlots: ClothingSlot.UNDERLEGS
• .genericName: “pair of stockings”
• .wardrobeCategory: Underwear

Bracelets.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.WRIST
• .genericName: “bracelet”
• .wardrobeCategory: Jewelry

Earrings.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.EARS
• .genericName: “pair of earrings”
• .wardrobeCategory: Jewelry

Necklaces.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.NECK
• .genericName: “necklace”
• .wardrobeCategory: Jewelry

Rings.

• Inherits from: GenericApparel
• ClothingSlots: ClothingSlot.FINGER
• .genericName: “ring”
• .wardrobeCategory: Jewelry

• Apparel
• SmutBook Class Reference