Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: a9ccac82ea
Branches Tags
godot-docs
/
classes
/
class_javascript.rst

class_javascript.rst 2.0 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the JavaScript.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_JavaScript:
    6. 

  6. 

  7. JavaScript
    8. 

  8. ==========
    9. 

  9. 

  10. **Inherits:** :ref:`Object<class_Object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Singleton that connects the engine with the browser's JavaScript context in HTML5 export.
    18. 

  18. 

  19. Methods
    20. 

  20. -------
    21. 

  21. 

  22. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`Variant<class_Variant>` | :ref:`eval<class_JavaScript_method_eval>` **(** :ref:`String<class_String>` code, :ref:`bool<class_bool>` use_global_execution_context=false **)** |
    24. 

  24. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. 

  26. Description
    27. 

  27. -----------
    28. 

  28. 

  29. The JavaScript singleton is implemented only in HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs.
    30. 

  30. 

  31. Tutorials
    32. 

  32. ---------
    33. 

  33. 

  34. - `#calling-javascript-from-script <../getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script>`_ in :doc:`../getting_started/workflow/export/exporting_for_web`
    35. 

  35. 

  36. Method Descriptions
    37. 

  37. -------------------
    38. 

  38. 

  39. .. _class_JavaScript_method_eval:
    40. 

  40. 

  41. - :ref:`Variant<class_Variant>` **eval** **(** :ref:`String<class_String>` code, :ref:`bool<class_bool>` use_global_execution_context=false **)**
    42. 

  42. 

  43. Execute the string ``code`` as JavaScript code within the browser window. This is a call to the actual global JavaScript function ``eval()``.
    44. 

  44. 

  45. If ``use_global_execution_context`` is ``true``, the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment.
    46. 

  46.