simfile.notes.timed
===================

.. py:module:: simfile.notes.timed


Classes
-------

.. autoapisummary::

   simfile.notes.timed.TimedNote


Functions
---------

.. autoapisummary::

   simfile.notes.timed.time_notes
   simfile.notes.timed.time_chart


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

.. py:class:: TimedNote

   Bases: :py:obj:`NamedTuple`


   A note with its song time attached.


   .. py:attribute:: time
      :type:  simfile.timing.engine.SongTime


   .. py:attribute:: note
      :type:  simfile.notes.Note


   .. py:attribute:: hittable
      :type:  bool


.. py:function:: time_notes(note_data: simfile.notes.NoteData, timing_data: simfile.timing.TimingData) -> Iterator[TimedNote]

   Generate a stream of timed notes from the supplied note & timing data.


.. py:function:: time_chart(chart: simfile.types.AttachedChart) -> Iterator[TimedNote]

   Generate a stream of timed notes from the supplied chart.