=============================
Modules and Top-level Methods
=============================


Modules
=======

.. toctree::
   :maxdepth: 2
   :hidden:

   dbus <dbus>
   evdev <evdev>
   event <event>
   file <file>
   hwinfo <hwinfo>
   log <log>
   lua <lua>
   misc <misc>
   os <os>
   spawn <spawn>
   udev <udev>
   xorg <xorg>
.. list-table::
   :header-rows: 0

   * - :doc:`dbus <dbus>`
     - D-Bus
   * - :doc:`evdev <evdev>`
     - evdev
   * - :doc:`event <event>`
     - Core events
   * - :doc:`file <file>`
     - File events
   * - :doc:`hwinfo <hwinfo>`
     - hwinfo
   * - :doc:`log <log>`
     - Logging
   * - :doc:`lua <lua>`
     - Lua scripting
   * - :doc:`misc <misc>`
     - misc
   * - :doc:`os <os>`
     - OS environment
   * - :doc:`roots <roots>`
     - Get roots
   * - :doc:`spawn <spawn>`
     - Spawn child processes
   * - :doc:`udev <udev>`
     - udev
   * - :doc:`xorg <xorg>`
     - Xorg

Methods
=======

.. list-table::
   :header-rows: 0

   * - :lua:meth:`chdir(dir) <chdir>`
     - Change working directory
   * - :lua:meth:`exec(argv) <exec>`
     - Execute another binary
   * - :lua:meth:`exit(exit_code) <exit>`
     - Exit deai
   * - :lua:meth:`load_plugin(file) <load_plugin>`
     - Load a single plugin
   * - :lua:meth:`load_plugin_from_dir(path) <load_plugin_from_dir>`
     - Load plugins from a directory
   * - :lua:meth:`quit() <quit>`
     - Exit deai
   * - :lua:meth:`register_module(name, module) <register_module>`
     - Register a module

.. lua:method:: chdir(dir) -> integer

   :rtype: integer
   :type dir: string
   :param dir:

   Change working directory 

.. lua:method:: exec(argv) -> integer

   :rtype: integer
   :type argv: [string]
   :param argv:

   Execute another binary 

   This call replaces the current process by running another binary. One use case for
   this is to restart deai.

.. lua:method:: exit(exit_code) -> void

   :rtype: void
   :type exit_code: integer
   :param exit_code:

   Exit deai 

   Instruct deai to exit. deai won't exit immediately when the function is called, it
   will exit next time the control returns to the mainloop. (e.g. after your script
   finished running).

.. lua:method:: load_plugin(file) -> void

   :rtype: void
   :type file: string
   :param file:

   Load a single plugin 

.. lua:method:: load_plugin_from_dir(path) -> integer

   :rtype: integer
   :type path: string
   :param path:

   Load plugins from a directory 

.. lua:method:: quit() -> void

   :rtype: void

   Exit deai 

   Equivalent to :code:`exit(0)`

.. lua:method:: register_module(name, module) -> integer

   :rtype: integer
   :type name: string
   :param name:
   :type module: :lua:mod:`module <deai.module>`
   :param module:

   Register a module