clothing

Documentation

Overview

Package clothing provides methods and tools for generating fantasy clothing styles.

Index

• type Item
  • func GenerateOutfit(temperature int, gender string) ([]Item, error)
  • func (item Item) Describe() string
• type ItemTemplate
• type SimplifiedStyle
• type Style
  • func GenerateStyle(temperature int, resources []resource.Resource) (Style, error)
  • func Random() (Style, error)
  • func (style Style) Describe() string
  • func (style Style) Simplify() SimplifiedStyle

Types

type Item

type Item struct {
	Name           string `json:"name"`
	Type           string `json:"type"`
	MaterialType   string `json:"material_type"`
	PrefixModifier string `json:"prefix_modifier"`
	SuffixModifier string `json:"suffix_modifier"`
}

Item is a type of clothing item

func GenerateOutfit

func GenerateOutfit(temperature int, gender string) ([]Item, error)

GenerateOutfit generates a random outfit based on environment temperature and gender

func (Item) Describe

func (item Item) Describe() string

Describe creates a prose description for an item

type ItemTemplate

type ItemTemplate struct {
	Name            string   `json:"name"`
	Type            string   `json:"type"`
	MaterialType    string   `json:"material_type"`
	PrefixModifiers []string `json:"prefix_modifiers"`
	SuffixModifiers []string `json:"suffix_modifiers"`
}

ItemTemplate is a pattern for constructing an item

type SimplifiedStyle

type SimplifiedStyle struct {
	FemaleOutfit    []string `json:"female_outfit"`
	MaleOutfit      []string `json:"male_outfit"`
	CommonJewelry   []string `json:"common_jewelry"`
	CommonColors    []string `json:"common_colors"`
	DecorativeStyle string   `json:"decorative_style"`
}

SimplifiedStyle is a simplified version of clothing style for display

type Style

type Style struct {
	Description     string   `json:"description"`
	FemaleOutfit    []Item   `json:"female_outfit"`
	MaleOutfit      []Item   `json:"male_outfit"`
	CommonJewelry   []string `json:"common_jewelry"`
	CommonColors    []string `json:"common_colors"`
	DecorativeStyle string   `json:"decorative_style"`
}

Style describes what kind of clothing the culture wears

func GenerateStyle

func GenerateStyle(temperature int, resources []resource.Resource) (Style, error)

GenerateStyle generates a random clothing style based on a climate

func Random

func Random() (Style, error)

Random generates a completely random clothing style

func (Style) Describe

func (style Style) Describe() string

Describe creates a prose description for a clothing style

func (Style) Simplify

func (style Style) Simplify() SimplifiedStyle

Simplify returns a simplified style for display