sc2_datasets.replay_parser.tracker_events.events.upgrade
========================================================

.. py:module:: sc2_datasets.replay_parser.tracker_events.events.upgrade


Classes
-------

.. autoapisummary::

   sc2_datasets.replay_parser.tracker_events.events.upgrade.Upgrade


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

.. py:class:: Upgrade

   Bases: :py:obj:`sc2_datasets.replay_parser.tracker_events.tracker_event.TrackerEvent`


   Upgrade type containing some "details" information
   on which player is doing an upgrade, game loop, upgrade in game name etc.

   :param count: Specifies a number, highly likely this parameter serves
                 for adding value of upgrades to summary. Default value of the parameter is 1.
   :type count: int, optional
   :param id: Specifies an event unique number.
   :type id: int
   :param loop: Specifies a game loop when the upgrade was started in the game.
   :type loop: int
   :param playerId: Specifies an id of the player who was doing the upgrade in the game.
   :type playerId: int
   :param upgradeTypeName: Specifies a name that upgrade has in the game.
   :type upgradeTypeName: str


   .. py:attribute:: count
      :type:  int


   .. py:attribute:: id
      :type:  int


   .. py:attribute:: loop
      :type:  int


   .. py:attribute:: playerId
      :type:  int


   .. py:attribute:: upgradeTypeName
      :type:  str


   .. py:method:: from_dict(d: dict) -> Upgrade
      :staticmethod:


      Static method returning initialized Upgrade class from a dictionary.
      This helps with the original JSON parsing.

      :param d: Specifies a dictionary as available in the JSON file that
                is a result of pre-processing some .SC2Replay file.
      :type d: dict

      :returns: Returns an initialized Upgrade class.
      :rtype: Upgrade