
#######
Manager
#######

.. js:class:: Animation.Manager

   Top-level interface for the animation system.
   
   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Animation.Manager.clear`
   * :js:meth:`~Animation.Manager.createPlayer`
   * :js:meth:`~Animation.Manager.removePlayer`
   * :js:meth:`~Animation.Manager.removePlayerByIndex`
   * :js:meth:`~Animation.Manager.setTickInterval`
   
   




Methods
=======

.. js:method:: Animation.Manager.clear

   .. rst-class:: sig-pretty-signature
   
      | clear(): *void*
   
   Removes all players from control of the manager.
   
   **Returns**\ : *void*
   



.. js:method:: Animation.Manager.createPlayer

   .. rst-class:: sig-pretty-signature
   
      | createPlayer(**animation**\ : :js:class:`Animation <Animation.Animation>`\ ): :js:class:`Player <Animation.Player>`
   
   Creates a new animation player for the supplied animation.
   
   **Parameters**
   
      **animation**\ : :js:class:`Animation <Animation.Animation>`
   
   
   **Returns**\ : :js:class:`Player <Animation.Player>`
   



.. js:method:: Animation.Manager.removePlayer

   .. rst-class:: sig-pretty-signature
   
      | removePlayer(**player**\ : :js:class:`Player <Animation.Player>`\ ): *boolean*
   
   Removes the provided player from control of the manager. Returns ``true`` is a player was removed
   
   **Parameters**
   
      **player**\ : :js:class:`Player <Animation.Player>`
   
   
   **Returns**\ : *boolean*
   



.. js:method:: Animation.Manager.removePlayerByIndex

   .. rst-class:: sig-pretty-signature
   
      | removePlayerByIndex(**index**\ : *number*\ ): *boolean*
   
   Removes the player at the provided index from control of the manager. Returns ``true`` if a player was removed
   
   **Parameters**
   
      **index**\ : *number*
   
   
   **Returns**\ : *boolean*
   



.. js:method:: Animation.Manager.setTickInterval

   .. rst-class:: sig-pretty-signature
   
      | setTickInterval(**milliseconds**\ : *number*\ ): *void*
   
   Sets the interval at which animations are updated.
   
   **Parameters**
   
      **milliseconds**\ : *number*
   
         number of milliseconds between update intervals
   
   
   
   **Returns**\ : *void*
   





