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
Branch: 3.1
Branches Tags
godot-docs
/
classes
/
class_javascript.rst

class_javascript.rst 2.0 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the JavaScript.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_JavaScript:
    8. 

  8. 

  9. JavaScript
    10. 

  10. ==========
    11. 

  11. 

  12. **Inherits:** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Singleton that connects the engine with the browser's JavaScript context in HTML5 export.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

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

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

  26. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. 

  28. Description
    29. 

  29. -----------
    30. 

  30. 

  31. 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.
    32. 

  32. 

  33. Tutorials
    34. 

  34. ---------
    35. 

  35. 

  36. - `#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`
    37. 

  37. 

  38. Method Descriptions
    39. 

  39. -------------------
    40. 

  40. 

  41. .. _class_JavaScript_method_eval:
    42. 

  42. 

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

  44. 

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

  46. 

  47. 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.
    48. 

  48.