geography

Documentation

Index

• type Area
  • func Generate() (Area, error)
  • func GenerateSpecific(temperature int, humidity int, altitude int, distance int) (Area, error)
  • func (area Area) Describe() (string, error)
  • func (area Area) GetResources() []resource.Resource

Types

type Area

type Area struct {
	Description string            `json:"description"`
	Region      region.Region     `json:"region"`
	Climate     climate.Climate   `json:"climate"`
	Biome       biome.Biome       `json:"biome"`
	Seasons     []season.Season   `json:"seasons"`
	Animals     []species.Species `json:"animals"`
	Plants      []species.Species `json:"plants"`
	Minerals    []mineral.Mineral `json:"minerals"`
	Soils       []soil.Soil       `json:"soils"`
}

Area is a geographic area and all of its component parts

func Generate

func Generate() (Area, error)

Generate procedurally generates a region, its climate, and its biome

func GenerateSpecific

func GenerateSpecific(temperature int, humidity int, altitude int, distance int) (Area, error)

GenerateSpecific generates a specific type of area based on parameters

func (Area) Describe

func (area Area) Describe() (string, error)

Describe provides a prose description of an area

func (Area) GetResources

func (area Area) GetResources() []resource.Resource

GetResources returns all resources for a given area