models

type CSDetail struct {
	CS           *ColonyOrShip
	EffTurn      *Turn // turn record becomes active
	EndTurn      *Turn // turn record ceases to be active
	Name         string
	TechLevel    int
	ControlledBy *Player
}

type CSHull struct {
	CS              *ColonyOrShip
	EffTurn         *Turn // turn record becomes active
	EndTurn         *Turn // turn record ceases to be active
	Unit            *Unit
	TechLevel       int
	QtyOperational  int
	MassOperational int
	TotalMass       int
}

type CSInventory struct {
	CS              *ColonyOrShip
	EffTurn         *Turn // turn record becomes active
	EndTurn         *Turn // turn record ceases to be active
	Unit            *Unit
	TechLevel       int
	QtyOperational  int
	MassOperational int
	QtyStowed       int
	MassStowed      int
	TotalMass       int
	EnclosedMass    int
}

type CSLocation struct {
	CS       *ColonyOrShip
	EffTurn  *Turn // turn record becomes active
	EndTurn  *Turn // turn record ceases to be active
	Location *Planet
}

type CSPay struct {
	CS              *ColonyOrShip
	EffTurn         *Turn // turn record becomes active
	EndTurn         *Turn // turn record ceases to be active
	ProfessionalPct float64
	SoldierPct      float64
	UnskilledPct    float64
	UnemployedPct   float64
}

type CSPopulation struct {
	CS                  *ColonyOrShip
	EffTurn             *Turn // turn record becomes active
	EndTurn             *Turn // turn record ceases to be active
	QtyProfessional     int
	QtySoldier          int
	QtyUnskilled        int
	QtyUnemployed       int
	QtyConstructionCrew int
	QtySpyTeam          int
	RebelPct            float64
	Births              int
	Deaths              int
}

type CSRations struct {
	CS              *ColonyOrShip
	EffTurn         *Turn // turn record becomes active
	EndTurn         *Turn // turn record ceases to be active
	ProfessionalPct float64
	SoldierPct      float64
	UnskilledPct    float64
	UnemployedPct   float64
}

type Claim struct {
	User       string
	PlayerId   int
	PlayerName string
	NationNo   int
}

type ColonyOrShip struct {
	Game       *Game
	Planet     *Planet
	Id         int    // unique identifier
	MSN        int    // manufacturer serial number; in game id for the colony or ship
	Kind       string // surface colony, enclosed colony, orbital colony, ship
	HomeColony bool
	BuiltBy    *Nation
	Details    []*CSDetail
	Locations  []*CSLocation
	Hull       []*CSHull
	Inventory  []*CSInventory
	Population []*CSPopulation
	Rations    []*CSRations
	Pay        []*CSPay
	Factories  []*FactoryGroup
	Farms      []*FarmGroup
	Mines      []*MiningGroup
}

type Coordinates struct {
	X int
	Y int
	Z int
}

type FactoryGroup struct {
	CS      *ColonyOrShip
	Id      int // unique identifier
	No      int
	EffTurn *Turn                // turn record becomes active
	EndTurn *Turn                // turn record ceases to be active
	Unit    *Unit                // unit being manufactured
	Units   []*FactoryGroupUnits // factory units in the group
	Stages  []*FactoryGroupStages
}

type FactoryGroupStages struct {
	Group     *FactoryGroup
	Turn      *Turn
	QtyStage1 int
	QtyStage2 int
	QtyStage3 int
	QtyStage4 int
}

type FactoryGroupUnits struct {
	Group          *FactoryGroup
	EffTurn        *Turn // turn record becomes active
	EndTurn        *Turn // turn record ceases to be active
	Unit           *Unit // factory unit doing the manufacturing
	QtyOperational int
}

type FarmGroup struct {
	CS      *ColonyOrShip
	Id      int // unique identifier
	No      int
	EffTurn *Turn             // turn record becomes active
	EndTurn *Turn             // turn record ceases to be active
	Unit    *Unit             // unit being farmed
	Units   []*FarmGroupUnits // farm units in the group
	Stages  []*FarmGroupStages
}

type FarmGroupStages struct {
	Group     *FarmGroup
	Turn      *Turn
	QtyStage1 int
	QtyStage2 int
	QtyStage3 int
	QtyStage4 int
}

type FarmGroupUnits struct {
	Group          *FarmGroup
	EffTurn        *Turn // turn record becomes active
	EndTurn        *Turn // turn record ceases to be active
	Unit           *Unit // farm unit
	QtyOperational int
}

type Game struct {
	Id          int // unique identifier
	ShortName   string
	Name        string
	Description string
	CurrentTurn *Turn
	Colonies    map[int]*ColonyOrShip
	CorS        map[int]*ColonyOrShip
	Nations     map[int]*Nation
	Planets     map[int]*Planet
	Players     map[int]*Player
	Resources   map[int]*NaturalResource
	Ships       map[int]*ColonyOrShip
	Stars       map[int]*Star
	Systems     map[int]*System
	Turns       map[string]*Turn
	Units       map[int]*Unit
	Users       map[int]*User
}

type GameClaim struct {
	Id           int    // game id
	ShortName    string // game code
	EffTurn      *Turn  // game's turn that is effective as of the claim date
	PlayerId     int    // player id
	PlayerHandle string // player handle in game
	NationId     int    // nation id
	NationNo     int    // nation player is aligned with
	NationName   string // nation government name
}

type MiningGroup struct {
	CS      *ColonyOrShip
	Id      int // unique identifier
	No      int
	EffTurn *Turn // turn record becomes active
	EndTurn *Turn // turn record ceases to be active
	Deposit *NaturalResource
	Units   []*MiningGroupUnits // mine units in the group
	Stages  []*MiningGroupStages
}

type MiningGroupStages struct {
	Group     *MiningGroup
	Turn      *Turn
	QtyStage1 int
	QtyStage2 int
	QtyStage3 int
	QtyStage4 int
}

type MiningGroupUnits struct {
	Group          *MiningGroup
	EffTurn        *Turn // turn record becomes active
	EndTurn        *Turn // turn record ceases to be active
	Unit           *Unit // unit mining
	QtyOperational int
}

type Nation struct {
	Game        *Game
	Id          int // unique identifier
	No          int // nation number in the game, starts at 1
	HomePlanet  *Planet
	Speciality  string
	Description string
	Details     []*NationDetail
	Research    []*NationResearch
	Skills      []*NationSkills
	Player      *Player // player currently controlling the nation
	CorS        []*ColonyOrShip
	Colonies    []*ColonyOrShip
	Ships       []*ColonyOrShip
	Players     []*Player
}

type NationDetail struct {
	Nation       *Nation
	EffTurn      *Turn // turn record becomes active
	EndTurn      *Turn // turn record ceases to be active
	Name         string
	GovtName     string
	GovtKind     string
	ControlledBy *Player
}

type NationResearch struct {
	Nation             *Nation
	EffTurn            *Turn // turn record becomes active
	EndTurn            *Turn // turn record ceases to be active
	TechLevel          int   //
	ResearchPointsPool int   //
}

type NationSkills struct {
	Nation        *Nation
	EffTurn       *Turn // turn record becomes active
	EndTurn       *Turn // turn record ceases to be active
	Biology       int   // not used currently
	Bureaucracy   int   // not used currently
	Gravitics     int   // not used currently
	LifeSupport   int   // not used currently
	Manufacturing int   // not used currently
	Military      int   // not used currently
	Mining        int   // not used currently
	Shields       int   // not used currently
}

type NaturalResource struct {
	Planet     *Planet
	Id         int     // unique identifier
	No         int     // number of deposit on planet
	Unit       *Unit   // fuel, gold, metallic, non-metallic
	QtyInitial int     // in mass units
	YieldPct   float64 // percentage of each mass unit that yields units
	Details    []*NaturalResourceDetail
}

type NaturalResourceDetail struct {
	NaturalResource *NaturalResource
	EffTurn         *Turn   // turn record becomes active
	EndTurn         *Turn   // turn record ceases to be active
	ControlledBy    *Nation // nation currently controlling the resource
	QtyRemaining    int     // in mass units
}

type Planet struct {
	Star       *Star
	Id         int    // unique identifier
	OrbitNo    int    // 1..10
	Kind       string // asteroid belt, gas giant, terrestrial
	HomePlanet bool
	Deposits   []*NaturalResource
	Details    []*PlanetDetail
	Colonies   []*ColonyOrShip // colonies on or orbiting the planet
	Ships      []*ColonyOrShip // ships orbiting the planet
}

type PlanetDetail struct {
	Planet         *Planet
	EffTurn        *Turn   // turn record becomes active
	EndTurn        *Turn   // turn record ceases to be active
	ControlledBy   *Nation // nation currently controlling the planet
	HabitabilityNo int
}

type Player struct {
	Game     *Game
	Id       int
	MemberOf *Nation
	Details  []*PlayerDetail
}

type PlayerDetail struct {
	Player       *Player
	EffTurn      *Turn // turn record becomes active
	EndTurn      *Turn // turn record ceases to be active
	Handle       string
	ControlledBy *User
	SubjectOf    *Player // set if the player is a viceroy or regent
}

type PlayerPosition struct {
	Id           int
	UserHandle   string
	PlayerHandle string
	Nation       struct {
		Name       string
		Speciality string
		HomeWorld  string
		GovtKind   string
		GovtName   string
	}
}

type Star struct {
	System   *System
	Id       int    // unique identifier
	Sequence string // A, B, etc
	Kind     string
	HomeStar bool
	Orbits   []*Planet // each orbit may or may not contain a planet
}

type Store struct {
	// contains filtered or unexported fields
}

type System struct {
	Game       *Game
	Id         int // unique identifier
	Coords     Coordinates
	HomeSystem bool
	Ring       int // ring is light years from the origin
	Stars      []*Star
}

type SystemScan struct {
	X, Y, Z  int
	QtyStars int
}

type Turn struct {
	No      int       // 0+
	Year    int       // 1...9999
	Quarter int       // 1...4
	StartDt time.Time // moment turn starts
	EndDt   time.Time // moment turn ends
}

type Unit struct {
	Id                  int // unique identifier
	Code                string
	TechLevel           int
	Name                string
	Description         string
	MassPerUnit         float64 // mass (in mass units) of a single unit
	VolumePerUnit       float64 // volume (in enclosed mass units) of a single unit
	Hudnut              bool    // true if unit can be disassembled for storage
	StowedVolumePerUnit float64 // half mass if unit is hudnut
}

type User struct {
	Id           int    // unique identifier
	Handle       string // unique handle, forced to lower-case
	HashedSecret string
	Profiles     []*UserProfile
}

type UserClaim struct {
	Id     int       // user id
	Handle string    // user handle
	AsOf   time.Time // as of date for pulling claims
	Games  []*GameClaim
}

type UserProfile struct {
	User   *User
	EffDt  time.Time // moment record becomes effective
	EndDt  time.Time // moment record ceases to be effective
	Email  string    // email, forced to lower-case
	Handle string    // display version of handle
}