region

Documentation

Index

• func GetHumidity(altitude int, oceanDistance int) int
• func GetTemperature(distanceToEquator int, altitude int) int
• type Region
  • func Generate() Region
  • func GenerateSpecific(temperature int, humidity int, altitude int, distance int) Region
  • func RandomTemperate() Region
  • func (region Region) Describe() string

Functions

func GetHumidity

func GetHumidity(altitude int, oceanDistance int) int

GetHumidity calculates a region's humidity based on its altitude and its distance from the nearest ocean

func GetTemperature

func GetTemperature(distanceToEquator int, altitude int) int

GetTemperature calculates a temperature for a region given its distance from the equator and its altitude

Types

type Region

type Region struct {
	Description               string `json:"description"`
	Altitude                  int    `json:"altitude"`    // -99-99, 0 is sea level
	Humidity                  int    `json:"humidity"`    // 0-99
	Temperature               int    `json:"temperature"` // 0-99
	NearestOceanDistance      int    `json:"nearest_ocean_distance"`
	NearestOceanDirection     int    `json:"nearest_ocean_direction"`
	NearestMountainsDistance  int    `json:"nearest_mountains_distance"`
	NearestMountainsDirection int    `json:"nearest_mountains_direction"`
	DistanceToEquator         int    `json:"distance_to_equator"` // 0 is on equator, -99 is south pole, 99 is north pole
}

Region is a geographic area.

func Generate

func Generate() Region

Generate procedurally generates a random region.

func GenerateSpecific

func GenerateSpecific(temperature int, humidity int, altitude int, distance int) Region

GenerateSpecific generates a region based on specific characteristics

func RandomTemperate

func RandomTemperate() Region

RandomTemperate returns a random region that is appropriate for life

func (Region) Describe

func (region Region) Describe() string

Describe provides a prose description of a region