brevity

type AlphaCheckRequest struct {
	// Callsign of the friendly aircraft requesting the ALPHA CHECK.
	Callsign string
}

type AlphaCheckResponse struct {
	// Callsign of the friendly aircraft requesting the ALPHA CHECK.
	Callsign string
	// Status is true if the ALPHA CHECK was correlated to an aircraft on frequency, otherwise false.
	Status bool
	// Location of the friendly aircraft. If Status is false, this may be nil.
	Location Bullseye
}

type Aspect string

type BRA interface {
	// Bearing is the heading from the fighter to the contact, rounded to the nearest degree.
	Bearing() bearings.Bearing
	// Range is the distance from the fighter to the contact, rounded to the nearest nautical mile.
	Range() unit.Length
	// Altitude of the contact above sea level, rounded to the nearest thousands of feet.
	Altitude() unit.Length
	// Altitude STACKS of the contact above sea level, rounded to the nearest thousands of feet.
	Stacks() []Stack
}

type BRAA interface {
	BRA
	// Aspect of the contact.
	Aspect() Aspect
}

type BogeyDopeRequest struct {
	// Callsign of the friendly aircraft requesting the BOGEY DOPE.
	Callsign string
	// Filter for the type of aircraft to include in the BOGEY DOPE.
	Filter ContactCategory
}

type BogeyDopeResponse struct {
	// Callsign of the friendly aircraft requesting the BOGEY DOPE.
	Callsign string
	// Group which is closest to the fighter. If there are no eligible groups, this may be nil.
	Group Group
}

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

type CheckInRequest struct {
	Callsign string
}

type CheckInResponse struct {
	Callsign string
}

type ContactCategory int

type Declaration string

type DeclareRequest struct {
	// Callsign of the friendly aircraft requesting DECLARE.
	Callsign string
	// Sour indicates if the player attempted a DECLARE request without
	// providing coordinates for the contact.
	Sour bool
	// IsBRAA indicates if the contact is provided using Bullseye (false) or BRAA (true).
	IsBRAA bool
	// IsAmbiguous indicates if the requestor did not explicitly state if they
	// were providing Bullseye or BRAA coordinates.
	IsAmbiguous bool
	// Bullseye of the contact, if provided using Bullseye.
	Bullseye Bullseye
	// Bearing of the contact, if provided using BRAA.
	Bearing bearings.Bearing
	/// Range to the contact, if provided using BRAA.
	Range unit.Length
	// Altitude of the contact above sea level, rounded to the nearest thousands of feet.
	Altitude unit.Length
	// Track direction. Optional, used to discriminate between multiple contacts at the same location.
	Track Track
}

type DeclareResponse struct {
	// Callsign of the friendly aircraft requesting DECLARE.
	Callsign string
	// Sour indicates if the controller is unable to provide a declaration
	// because the friendly aircraft did not provide coordinates for the
	// contact.
	Sour bool
	// If readback is not nil, the controller should read back the coordinate
	// in the response.
	Readback *Bullseye
	// Declaration of the contact.
	Declaration Declaration
	// Group that was identified, if a specific one was identifiable.
	// This may be nil if Declaration is Furball, Unable, or Clean.
	Group Group
}

type FadedCall struct {
	// Group which has faded.
	Group Group
}

type Group interface {
	// Threat indicates if the THREAT criteria is met.
	Threat() bool
	// SetThreat sets the THREAT status.
	SetThreat(bool)
	// Contacts is the number of contacts in the group.
	Contacts() int
	// Bullseye is the location of the group. This may be nil for BOGEY DOPE, SNAPLOCK, and THREAT calls.
	Bullseye() *Bullseye
	// Altitude is the group's highest altitude. This may be zero for BOGEY DOPE, SNAPLOCK, and THREAT calls.
	Altitude() unit.Length
	// Stacks are the group's altitude STACKS, ordered from highest to lowest in intervals of at least 10,000 feet.
	// This may be empty for BOGEY DOPE, SNAPLOCK, SPIKED, STROBE and THREAT calls.
	Stacks() []Stack
	// Track is the group's track direction. This may be UnknownDirection for BOGEY DOPE, SNAPLOCK, SPIKED, STROBE and THREAT calls.
	Track() Track
	// Aspect is the group's aspect angle relative to another aircraft. This may be nil for BOGEY DOPE, SNAPLOCK, SPIKED, STROBE and some THREAT calls.
	Aspect() Aspect
	// BRAA is an alternate format for the group's location. This is nil except for BOGEY DOPE, SNAPLOCK, SPIKED, STROBE and some THREAT calls.
	BRAA() BRAA
	// Declaration of the group's friend or foe status.
	Declaration() Declaration
	// SetDeclaration sets the group's friend or foe status.
	SetDeclaration(Declaration)
	// Heavy is true if the group contacts 3 or more contacts.
	Heavy() bool
	// Platforms are the NATO reporting names of the group's aircraft platforms (for Soviet/Russian/Chinese aircraft) or
	// alternative names for other aircraft. Skyeye supports mixed-platform groups, so this returns multiple values.
	Platforms() []string
	// High is true if the aircraft altitude is above 40,000 feet.
	High() bool
	// Fast is true if the group's speed is 600-900kts ground speed or 1.0-1.5 Mach.
	Fast() bool
	// VeryFast is true is the group's speed is above 900kts ground speed or 1.5 Mach.
	VeryFast() bool
	// MergedWith is the number of friendlies this group is merged with.
	MergedWith() int
	// SetMergedWith sets the number of friendlies this group is merged with.
	SetMergedWith(int)
	// String returns a human-readable description of the group.
	String() string
	// ObjectIDs returns the object IDs of all contacts in the group.
	ObjectIDs() []uint64
}

type MergedCall struct {
	// Callsigns of the friendly aircraft in the merge.
	Callsigns []string
}

type NegativeRadarContactResponse struct {
	// Callsign of the friendly aircraft that made the request.
	Callsign string
}

type PictureRequest struct {
	// Callsign of the friendly aircraft requesting the PICTURE.
	Callsign string
}

type PictureResponse struct {
	// Count is the total number of groups in the PICTURE.
	Count int
	// Groups included in the PICTURE. This is a maximum of 3 groups.
	Groups []Group
}

type RadioCheckRequest struct {
	// Callsign of the friendly aircraft requesting the RADIO CHECK.
	Callsign string
}

type RadioCheckResponse struct {
	// Callsign of the friendly aircraft requesting the RADIO CHECK.
	// If the callsign was misheard, this may not be the actual callsign of any actual aircraft.
	Callsign string
	// RadarContact indicates whether the callsign was found on the radar scope.
	RadarContact bool
}

type SayAgainResponse struct {
	// Callsign of the friendly aircraft that made the request.
	// This may be empty if the GCI is unsure of the caller's identity.
	Callsign string
}

type ShoppingRequest struct {
	Callsign string
}

type ShoppingResponse struct {
	Callsign string
}

type SnaplockRequest struct {
	// Callsign of the friendly aircraft requesting the SNAPLOCK.
	Callsign string
	// BRA is the location of the contact.
	BRA BRA
}

type SnaplockResponse struct {
	// Callsign of the friendly aircraft requesting the SNAPLOCK.
	Callsign string
	// Declaration of the contact.
	Declaration Declaration
	// Group that was identified. If Declaration is Unable or Furball, this may be nil.
	Group Group
}

type SpikedRequest struct {
	// Callsign of the friendly aircraft calling SPIKED.
	Callsign string
	// Bearing to the radar spike.
	Bearing bearings.Bearing
}

type SpikedResponseV2 struct {
	// Callsign of the friendly aircraft calling SPIKED.
	Callsign string
	// Reported spike bearing. This is used if the response did not correlate to a group.
	Bearing bearings.Bearing
	// True if the spike was correlated to a contact. False otherwise.
	Status bool
	// Correleted contact group. If Status is false, this may be nil.
	Group Group
}

type Stack struct {
	Altitude unit.Length
	Count    int
}

type StrobeRequest struct {
	// Callsign of the friendly aircraft calling STROBE..
	Callsign string
	// Bearing to the electromagnetic attack.
	Bearing bearings.Bearing
}

type StrobeResponse struct {
	// Callsign of the friendly aircraft calling STROBE..
	Callsign string
	// Reported attack bearing. This is used if the response did not correlate to a group.
	Bearing bearings.Bearing
	// True if the attack was correlated to a contact. False otherwise.
	Status bool
	// Correleted contact group. If Status is false, this may be nil.
	Group Group
}

type SunriseCall struct {
	// Frequency which the GCI is listening on.
	Frequencies []unit.Frequency
}

type ThreatCall struct {
	// Callsigns of the friendly aircraft under threat.
	Callsigns []string
	// Group that is threatening the friendly aircraft.
	Group Group
}

type Track string

type TripwireRequest struct {
	Callsign string
}

type TripwireResponse struct {
	Callsign string
}

type UnableToUnderstandRequest struct {
	// Callsign of the friendly aircraft that made the request.
	// If the callsign was unclear, this field will be empty.
	Callsign string
}