drink

Documentation

Overview

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

Index

• type Drink
  • func Random(resources []resource.Resource) (Drink, error)
  • func RandomSet(numberOfDrinks int, resources []resource.Resource) ([]Drink, error)
• type Method
• type Pattern
• type Style
  • func Generate(lang language.Language, resources []resource.Resource) (Style, error)

Types

type Drink

type Drink struct {
	Description string   `json:"description"`
	Appearance  string   `json:"appearance"`
	Type        string   `json:"type"`
	Strength    string   `json:"strength"`
	Base        string   `json:"base"`
	Ingredients []string `json:"ingredients"`
}

Drink is an alcoholic drink

func Random

func Random(resources []resource.Resource) (Drink, error)

Random returns a random alcoholic drink

func RandomSet

func RandomSet(numberOfDrinks int, resources []resource.Resource) ([]Drink, error)

RandomSet generates some alcoholic drinks

type Method

type Method struct {
	Name            string `json:"name"`
	BaseResourceTag string `json:"base_resource_tag"`
	Producer        string `json:"producer"`
}

Method is a way of making an alcoholic beverage

type Pattern

type Pattern struct {
	Name         string
	RequiredBase string
	BaseStrength int
	Descriptors  []string
}

Pattern is a pattern for making a drink

type Style

type Style struct {
	TheToast           string          `json:"the_toast"`
	ToastingRules      []string        `json:"toasting_rules"`
	UniqueDrinkPattern pattern.Pattern `json:"unique_drink_pattern"`
	SocialRules        []string        `json:"social_rules"`
}

Style is a type of drinking culture

func Generate

func Generate(lang language.Language, resources []resource.Resource) (Style, error)

Generate procedurally generates a drinking style based on a set of available resources