.. index:: pair: namespace; server_callbacks
.. _doxid-namespaceserver__callbacks:

namespace server_callbacks
==========================

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	namespace server_callbacks {

	// global variables

	 :target:`script<doxid-namespaceserver__callbacks_1a873d7aa45ea0b107778a448668d33642>` =  None;

	// global functions

	str :ref:`get_engine_name<doxid-namespaceserver__callbacks_1afd251dbe0fda14b81d20db26a3d1bcfa>`();
	dict :ref:`initialize<doxid-namespaceserver__callbacks_1aff902dd86fb2e89c241d038efe1f7937>`(dict request_json);
	dict :ref:`run_loop<doxid-namespaceserver__callbacks_1a7e5ea6c3a2ec85cca2d458a8df3b6f41>`(dict request_json);
	None :ref:`set_datapacks<doxid-namespaceserver__callbacks_1a41c6c98910f0b7c3dd5056e6f5f6c8dd>`(dict request_json);
	None :ref:`set_datapack<doxid-namespaceserver__callbacks_1a3818898ecb15f94496d8dad93c5523cc>`(str datapack_name, dict datapack);
	list :ref:`get_registered_datapack_names<doxid-namespaceserver__callbacks_1a9232a0696a9010ad10a188654e5b4288>`();
	dict :ref:`get_datapacks<doxid-namespaceserver__callbacks_1abce2e4db8b2e5cab87663016fe588c93>`(dict request_json);
	dict :ref:`get_datapack<doxid-namespaceserver__callbacks_1af2c95c10cbebac1b6a4299c6f64cafa7>`(str datapack_name);
	dict :ref:`reset<doxid-namespaceserver__callbacks_1a400b03f955edfeadb3a5bc845a167870>`(dict request_json);
	None :ref:`shutdown<doxid-namespaceserver__callbacks_1a9b68e82a4c3ad7eb2a992c0e08a4d58d>`(dict request_json);

	} // namespace server_callbacks
.. _details-namespaceserver__callbacks:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Global Functions
----------------

.. index:: pair: function; get_engine_name
.. _doxid-namespaceserver__callbacks_1afd251dbe0fda14b81d20db26a3d1bcfa:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	str get_engine_name()

.. code-block:: cpp

	Returns Engine name

.. index:: pair: function; initialize
.. _doxid-namespaceserver__callbacks_1aff902dd86fb2e89c241d038efe1f7937:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	dict initialize(dict request_json)

.. code-block:: cpp

	Imports module containing the Script class, instantiates it, and runs its initialize() method

.. index:: pair: function; run_loop
.. _doxid-namespaceserver__callbacks_1a7e5ea6c3a2ec85cca2d458a8df3b6f41:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	dict run_loop(dict request_json)

.. code-block:: cpp

	Advances the simulation time and runs the runLoop method of the Script object

.. index:: pair: function; set_datapacks
.. _doxid-namespaceserver__callbacks_1a41c6c98910f0b7c3dd5056e6f5f6c8dd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	None set_datapacks(dict request_json)

.. code-block:: cpp

	Sets given data on requested datapacks stored in the Script object

.. index:: pair: function; set_datapack
.. _doxid-namespaceserver__callbacks_1a3818898ecb15f94496d8dad93c5523cc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	None set_datapack(str datapack_name, dict datapack)

.. code-block:: cpp

	Sets given data on requested datapack stored in the Script object

.. index:: pair: function; get_registered_datapack_names
.. _doxid-namespaceserver__callbacks_1a9232a0696a9010ad10a188654e5b4288:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	list get_registered_datapack_names()

.. code-block:: cpp

	Returns the list of registered datapack names

.. index:: pair: function; get_datapacks
.. _doxid-namespaceserver__callbacks_1abce2e4db8b2e5cab87663016fe588c93:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	dict get_datapacks(dict request_json)

.. code-block:: cpp

	Returns requested datapacks stored in the Script object

.. index:: pair: function; get_datapack
.. _doxid-namespaceserver__callbacks_1af2c95c10cbebac1b6a4299c6f64cafa7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	dict get_datapack(str datapack_name)

.. code-block:: cpp

	Returns requested datapack stored in the Script object

.. index:: pair: function; reset
.. _doxid-namespaceserver__callbacks_1a400b03f955edfeadb3a5bc845a167870:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	dict reset(dict request_json)

.. code-block:: cpp

	Calls the reset() method of the Script object

.. index:: pair: function; shutdown
.. _doxid-namespaceserver__callbacks_1a9b68e82a4c3ad7eb2a992c0e08a4d58d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	None shutdown(dict request_json)

.. code-block:: cpp

	Calls the shutdown() method of the Script object