simfile.notes.counter
=====================

.. py:module:: simfile.notes.counter


Functions
---------

.. autoapisummary::

   simfile.notes.counter.count_taps
   simfile.notes.counter.count_steps
   simfile.notes.counter.count_jumps
   simfile.notes.counter.count_hands
   simfile.notes.counter.count_holds
   simfile.notes.counter.count_rolls
   simfile.notes.counter.count_mines
   simfile.notes.counter.count_fakes


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

.. py:function:: count_taps(chart: simfile.types.AttachedChart)

   Reproduce the StepMania editor's tap note count,
   which includes all taps, hold heads, roll heads, and lifts.


.. py:function:: count_steps(chart: simfile.types.AttachedChart)

   Reproduce StepMania's step count,
   which includes taps, hold heads, roll heads, and lifts.
   Steps are grouped by beat, meaning e.g. jumps are counted as single steps.


.. py:function:: count_jumps(chart: simfile.types.AttachedChart)

   Reproduce StepMania's jump count,
   which includes taps, hold heads, roll heads, and lifts.
   Jumps consist of 2 or more of the above note types on the same beat.


.. py:function:: count_hands(chart: simfile.types.AttachedChart)

   Reproduce StepMania's hand count.
   Hands consist of 3 or more *active notes* on a given step,
   where active notes consist of steps and active hold/roll notes
   (whether their bodies or tails).


.. py:function:: count_holds(chart: simfile.types.AttachedChart)

   Reproduce StepMania's hold count.
   This is a straightforward tally of hold heads in the chart.


.. py:function:: count_rolls(chart: simfile.types.AttachedChart)

   Reproduce StepMania's roll count.
   This is a straightforward tally of roll heads in the chart.


.. py:function:: count_mines(chart: simfile.types.AttachedChart)

   Reproduce StepMania's mine count.
   This is a straightforward tally of mines in the chart.


.. py:function:: count_fakes(chart: simfile.types.AttachedChart)

   Reproduce the StepMania editor's fake count.
   Fakes consist of all notes that aren't hittable,
   whether due to a warp region, fake segment,
   or being a literal fake note type (``F`` in note data).