:py:mod:`masterblaster.match`
=============================

.. py:module:: masterblaster.match


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   masterblaster.match.MatchSettings
   masterblaster.match.GameSettings
   masterblaster.match.CompetitionStatus
   masterblaster.match.MatchStatus
   masterblaster.match.MatchGameServer
   masterblaster.match.MatchConnectionInfo
   masterblaster.match.Match




.. py:class:: MatchSettings(useVeto: bool = None, useVetoSide: bool = None, useBestOfX: bool = None, mapVetoId: Optional[str] = None, numberOfMaps: int = None, isVetoCompleted: bool = None, isTwitchStreamingEnabled: bool = None, twitchStreamingUrl: Optional[str] = None, enableForfeitTimer: bool = None, timeToReadyUpBeforeForfeitInSeconds: int = None, scoreConfigId: Optional[str] = None)



.. py:class:: GameSettings(locationId: str = None, useAutoForfeit: bool = None, forfeitTimeoutInSeconds: int = None, customConfigFile: Optional[str] = None, plugins: list = None, insecureServer: bool = None)



.. py:class:: CompetitionStatus(status: int = 0)



.. py:class:: MatchStatus(status: int = 0)



.. py:class:: MatchGameServer(serverId: str = None, host: str = None, port: int = None, usedAt: Optional[datetime.datetime] = None)



.. py:class:: MatchConnectionInfo(host: str = None, port: int = None, paused: bool = None, status: int = None, readyAt: datetime.datetime = None, location: str = None, password: str = None, serverId: str = None, launchUrl: str = None, failedReason: str = None, launchGotvUrl: str = None, shutdownDelay: int = None, usedGameServers: list[dict] = [{}], connectionString: str = None, gotvConnectionString: str = None)



.. py:class:: Match(competitionStatus: int, competitionFormat: int, competitionName: str, parentLeagueId: str, parentLeagueName: str, parentLeagueGroupId: str, parentLeagueSortOrder: Optional[str], teams: list[dict], series: list, startId: Optional[str], competitionId: str, roundIndex: int, matchIndex: int, name: str, game: int, gameId: str, status: int, statusChangedAt: Optional[datetime.datetime], settings: dict, matchType: int, type: int, format: int, enteredPostgameAt: Optional[datetime.datetime], completedAt: Optional[datetime.datetime], failedReason: Optional[str], pauseReason: Optional[str], pausedBy: Optional[str], pausedAt: Optional[datetime.datetime], markForDeletion: bool, isMatchReschedulingEnabled: bool, lastPossibleMatchRescheduleDate: Optional[datetime.datetime], matchScheduleProposals: list, startingAt: Optional[datetime.datetime], startedAt: Optional[datetime.datetime], createdBy: str, teamScores: list, connectionInfo: dict, gameSettings: dict, hasValidTeams: bool, playerIds: list, teamIds: list, hasForfeited: bool, hasDisqualified: bool, forfeitedOrDisqualified: bool, id: str, createdAt: datetime.datetime)


   Class holding all information about a match


   .. py:method:: get_teams() -> list[masterblaster.team.Team]


   .. py:method:: get_date_and_time() -> datetime.datetime


   .. py:method:: get_game_settings() -> GameSettings


   .. py:method:: get_connection_info() -> Optional[MatchConnectionInfo]


   .. py:method:: get_match_settings() -> MatchSettings


   .. py:method:: get_match_status() -> MatchStatus


   .. py:method:: get_competition_status() -> CompetitionStatus