.. _albehaviormanager:

ALBehaviorManager 
===================

.. toctree::
   :hidden:
   :maxdepth: 1

   albehaviormanager-api

Overview | :ref:`API <albehaviormanager-api>`


What it does
------------

ALBehaviorManager is intended to manage behaviors. With this module, you can:

* load, start, stop behaviors:
    * :cpp:func:`ALBehaviorManagerProxy::playDefaultProject`
    * :cpp:func:`ALBehaviorManagerProxy::preloadBehavior`
    * :cpp:func:`ALBehaviorManagerProxy::removeBehavior`
    * :cpp:func:`ALBehaviorManagerProxy::runBehavior`
    * :cpp:func:`ALBehaviorManagerProxy::stopAllBehaviors`
    * :cpp:func:`ALBehaviorManagerProxy::stopBehavior`

* add default behaviors or remove them.
    * :cpp:func:`ALBehaviorManagerProxy::addDefaultBehavior`
    * :cpp:func:`ALBehaviorManagerProxy::removeDefaultBehavior`

* get information about behaviors:
    * :cpp:func:`ALBehaviorManagerProxy::getBehaviorNames`
    * :cpp:func:`ALBehaviorManagerProxy::getDefaultBehaviors`
    * :cpp:func:`ALBehaviorManagerProxy::getInstalledBehaviors`
    * :cpp:func:`ALBehaviorManagerProxy::getRunningBehaviors`
    * :cpp:func:`ALBehaviorManagerProxy::getSystemBehaviorNames`
    * :cpp:func:`ALBehaviorManagerProxy::getUserBehaviorNames`
    * :cpp:func:`ALBehaviorManagerProxy::isBehaviorInstalled`
    * :cpp:func:`ALBehaviorManagerProxy::isBehaviorPresent`
    * :cpp:func:`ALBehaviorManagerProxy::isBehaviorRunning`

How it works
------------

Default behaviors
+++++++++++++++++

Some behaviors can be marked as "Default", which means they will be automatically
started when NAOqi launches. ALBehaviorManager allows the user to add or remove
such behaviors, or to launch and stop them.

Getting started
---------------

The following Python script shows how to use ALBehaviorManager. To use it,
upload a behavior from Choregraphe on the robot. Then run the python script
giving the NAO's IP and the behavior name as argument: ::

  python albehaviormanager_example.py robotIp behaviorName

:download:`albehaviormanager_example.py </examples/python/albehaviormanager/albehaviormanager_example.py>`

.. literalinclude:: /examples/python/albehaviormanager/albehaviormanager_example.py
   :language: py