deity

Documentation

Index

• type Deity
  • func ByName(name string, set []Deity) (Deity, error)
  • func Exclude(deity Deity, set []Deity) []Deity
  • func Generate(lang language.Language, possibleDomains []domain.Domain) (Deity, error)
  • func Random(set []Deity) (Deity, error)
  • func Replace(deity Deity, set []Deity) []Deity
  • func (deity Deity) Describe() string
  • func (deity Deity) Simplify() SimplifiedDeity
• type SimplifiedDeity

Types

type Deity

type Deity struct {
	Name              string                      `json:"name"`
	Description       string                      `json:"description"`
	Domains           []domain.Domain             `json:"domains"`
	Appearance        string                      `json:"appearance"`
	Gender            gender.Gender               `json:"gender"`
	PersonalityTraits []string                    `json:"personality_traits"`
	Relationships     []relationship.Relationship `json:"relationships"`
	HolyItem          string                      `json:"holy_item"`
	HolySymbol        string                      `json:"holy_symbol"`
}

Deity is a fictional god or goddess

func ByName

func ByName(name string, set []Deity) (Deity, error)

ByName returns a deity with the given name from the given set

func Exclude

func Exclude(deity Deity, set []Deity) []Deity

Exclude returns a set of deities with the given one removed

func Generate

func Generate(lang language.Language, possibleDomains []domain.Domain) (Deity, error)

Generate generates a random deity

func Random

func Random(set []Deity) (Deity, error)

Random returns a random deity from a set

func Replace

func Replace(deity Deity, set []Deity) []Deity

Replace replaces an existing deity in a given set

func (Deity) Describe

func (deity Deity) Describe() string

Describe describes a deity

func (Deity) Simplify

func (deity Deity) Simplify() SimplifiedDeity

Simplify returns a simplified version of a deity

type SimplifiedDeity

type SimplifiedDeity struct {
	Name        string   `json:"name"`
	Gender      string   `json:"gender"`
	Domains     []string `json:"domains"`
	Description string   `json:"description"`
}

SimplifiedDeity is a display version of deity