chenlin/Mujoco_WASM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add note that XML saving requires that the spec first be compiled. Fixes #1832

Browse Source 
PiperOrigin-RevId: 671046666
Change-Id: If5885545d5316537147d293fbe854caa568558b2
This commit is contained in:
Yuval Tassa
2024-09-04 11:46:34 -07:00
committed by Copybara-Service
parent 79a5bd0915
commit b502ceef00
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/APIreference/functions.rst
+2 -2
View File
@@ -103,7 +103,7 @@ mj_saveXMLString
.. mujoco-include:: mj_saveXMLString .. mujoco-include:: mj_saveXMLString
Save spec to XML string, return 1 on success, 0 otherwise. Save spec to XML string, return 1 on success, 0 otherwise. XML saving requires that the spec first be compiled.
.. _mj_saveXML: .. _mj_saveXML:
@@ -112,7 +112,7 @@ mj_saveXML
.. mujoco-include:: mj_saveXML .. mujoco-include:: mj_saveXML
Save spec to XML file, return 1 on success, 0 otherwise. Save spec to XML file, return 1 on success, 0 otherwise. XML saving requires that the spec first be compiled.
.. _Mainsimulation: .. _Mainsimulation:
doc/APIreference/functions_override.rst
+8
View File
@@ -47,6 +47,14 @@ struct pointers while editing the model programmatically.
:ref:`mj_recompile` returns 0 if compilation succeed. In the case of failure, the given :ref:`mjModel` and :ref:`mjData` :ref:`mj_recompile` returns 0 if compilation succeed. In the case of failure, the given :ref:`mjModel` and :ref:`mjData`
instances will be deleted; as in :ref:`mj_compile`, the compilation error can be read with :ref:`mjs_getError`. instances will be deleted; as in :ref:`mj_compile`, the compilation error can be read with :ref:`mjs_getError`.
.. _mj_saveXMLString:
Save spec to XML string, return 1 on success, 0 otherwise. XML saving requires that the spec first be compiled.
.. _mj_saveXML:
Save spec to XML file, return 1 on success, 0 otherwise. XML saving requires that the spec first be compiled.
.. _Mainsimulation: .. _Mainsimulation:
These are the main entry points to the simulator. Most users will only need to call :ref:`mj_step`, which computes These are the main entry points to the simulator. Most users will only need to call :ref:`mj_step`, which computes