===============================================
Bot (class)
===============================================


.. contents::
   :local:

.. js:class:: Bot (name)

      
   
   .. ============================== constructor details ====================
   
   
   
   
   
   
   
   
   This is a class with no other purpose
   but being an example and for testing.
   
   Second paragraph just to show off:
   
   
   * One
   * Two
   
   
   As for the HTML elements, template has a limited support
   for transforming them into **bold** and *italic*
   elements.
   
   
   
   
   :param string name:
     
   
       Unique name for the bot
   
   
   
   :author: Juha Mustonen
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   .. code-block:: javascript
   
      var android = new Bot("Android");
      android.speak();
   
   
   
   .. code-block:: javascript
   
      // Extend bot
      subapp = new Bot;
      subapp.prototype.walk = function(direction) {
        // ...
      };
   
   
   
   
   
   
   
   
   
   
   
   .. ============================== properties summary =====================
   
   
   
   .. ============================== events summary ========================
   
   
   
   
   
   .. ============================== field details ==========================
   
   
   
   .. ============================== method details =========================
   
   
   
   
   
   
   .. js:function:: Bot.talk()
   
       
   
       
   
       This function really does the thing.
   
       
       
   
       .. code-block:: javascript
   
          var bot = new Bot('bot');
          bot.talk({x:123, y:2});
   
       
       
   
   
     
   
     
   
     
   
     
   
     
   
     
   
   
   
   
   .. js:function:: Bot.walk(direction)
   
       
   
       
       
       :param Direction direction:
   
         X and Y coordiates
   
         
       
       
   
       This function really does the thing.
   
       
       
   
       .. code-block:: javascript
   
          var bot = new Bot('bot');
          bot.walk({x:123, y:2});
   
       
       
   
   
     
   
     
   
     
   
     
   
     
   
     
   
   
   
   .. ============================== event details =========================
   
   

.. container:: footer

   Documentation generated by jsdoc-toolkit_  2.4.0 using jsdoc-toolkit-rst-template_

.. _jsdoc-toolkit: http://code.google.com/p/jsdoc-toolkit/
.. _jsdoc-toolkit-rst-template: http://code.google.com/p/jsdoc-toolkit-rst-template/
.. _sphinx: http://sphinx.pocoo.org/




.. vim: set ft=rst :