matchservice

Documentation

Index

• type MatchInfo
• type Player
• type Team

Types

type MatchInfo

type MatchInfo struct {
	Id                 string   // Unwindia Match ID
	MsID               string   // MatchService Match-ID
	Team1              Team     // Team 1
	Team2              Team     // Team 2
	PlayerAmount       uint     // Amount of players in the match
	Game               string   // Game name
	Map                string   // Map name
	ServerAddress      string   // Server address
	ServerPassword     string   // Server password
	ServerPasswordMgmt string   // Server password for management
	ServerTvAddress    string   // Server TV address
	ServerTvPassword   string   // Server TV password
	TournamentName     string   // MatchService name of the tournament
	MatchTitle         string   // MatchService title of the match
	MapList            []string // List of available maps for the match
	NumberOfMaps       int      // Matchservice amount of maps which should be played
	Ready              bool     // Match is ready to start, typically all teams are ready
	Finished           bool     // Match is finished
}

MatchInfo represents the information of a match

type Player

type Player struct {
	Id             string // The id of the player in the external tournament system
	Name           string // Name of the player in the external tournament system
	GameProviderID string // Id of an game provider, e.g. SteamId for CS:GO
	Picture        []byte `json:"picture,omitempty"` // Picture of the player, optional
	Captain        bool   // This player is the team captain
}

Player represents a player which is a part of a team

type Team

type Team struct {
	Id      string   // The id of the team in the external tournament system
	Name    string   // Name of the team in the external tournament system
	Players []Player // List of players in the team
	Picture []byte   `json:"picture,omitempty"` // Picture of the team, optional
	Ready   bool     // Ready indicates that the team is in ready state in match service
}

Team represents a team which is a part of a match