sc2_datasets.replay_parser.game_events.events.cmd
=================================================

.. py:module:: sc2_datasets.replay_parser.game_events.events.cmd


Classes
-------

.. autoapisummary::

   sc2_datasets.replay_parser.game_events.events.cmd.Cmd


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

.. py:class:: Cmd

   Bases: :py:obj:`sc2_datasets.replay_parser.game_events.game_event.GameEvent`


   Cmd contains specific details about command interface events.

   :param id: Specifies the ID of an event corresponding to its name.
   :type id: int
   :param loop: Specifies the game loop number (game-engine tick) at which the event occurred.
   :type loop: int
   :param otherUnit: Specific information unavailable about this parameter.
   :type otherUnit: NoneType
   :param sequence: Likely specifies an ID parameter representing        the sequence the user typed in the console.
                    Specific information about this parameter is unavailable.
   :type sequence: int
   :param unitGroup: Specific information unavailable about this parameter.
   :type unitGroup: NoneType or int
   :param userid: Likely specifies the user's ID using the interface.
                  Specific information about this parameter is unavailable.
   :type userid: int


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


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


   .. py:attribute:: otherUnit
      :type:  types.NoneType


   .. py:attribute:: sequence
      :type:  int


   .. py:attribute:: unitGroup
      :type:  types.NoneType | int


   .. py:attribute:: userid
      :type:  int


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


      Static method returning an initialized Cmd class from a dictionary.
      This aids in parsing the original JSON.

      :param d: Dictionary available in the JSON file, typically a result            of pre-processing an .SC2Replay file.
      :type d: dict

      :returns: Initialized Cmd class.
      :rtype: Cmd