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

class_javascript.rst 7.4 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.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. Singleton that connects the engine with the browser's JavaScript context in HTML5 export.
    15. 

  15. 

  16. Description
    17. 

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

  18. 

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

  20. 

  21. **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScript singleton is enabled. Official export templates also have the JavaScript singleton enabled. See :doc:`Compiling for the Web <../development/compiling/compiling_for_web>` in the documentation for more information.
    22. 

  22. 

  23. Tutorials
    24. 

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

  25. 

  26. - `Exporting for the Web: Calling JavaScript from script <../tutorials/export/exporting_for_web.html#calling-javascript-from-script>`__
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`JavaScriptObject<class_JavaScriptObject>` | :ref:`create_callback<class_JavaScript_method_create_callback>` **(** :ref:`Callable<class_Callable>` callable **)**                                                                                                            |
    33. 

  33. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Variant<class_Variant>`                   | :ref:`create_object<class_JavaScript_method_create_object>` **(** :ref:`String<class_String>` object, ... **)** |vararg|                                                                                                        |
    35. 

  35. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | void                                            | :ref:`download_buffer<class_JavaScript_method_download_buffer>` **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`String<class_String>` name, :ref:`String<class_String>` mime="application/octet-stream" **)** |
    37. 

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

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

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

  40. | :ref:`JavaScriptObject<class_JavaScriptObject>` | :ref:`get_interface<class_JavaScript_method_get_interface>` **(** :ref:`String<class_String>` interface **)**                                                                                                                   |
    41. 

  41. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. 

  43. Method Descriptions
    44. 

  44. -------------------
    45. 

  45. 

  46. .. _class_JavaScript_method_create_callback:
    47. 

  47. 

  48. - :ref:`JavaScriptObject<class_JavaScriptObject>` **create_callback** **(** :ref:`Callable<class_Callable>` callable **)**
    49. 

  49. 

  50. Creates a reference to a :ref:`Callable<class_Callable>` that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See :ref:`JavaScriptObject<class_JavaScriptObject>` for usage.
    51. 

  51. 

  52. ----
    53. 

  53. 

  54. .. _class_JavaScript_method_create_object:
    55. 

  55. 

  56. - :ref:`Variant<class_Variant>` **create_object** **(** :ref:`String<class_String>` object, ... **)** |vararg|
    57. 

  57. 

  58. Creates a new JavaScript object using the ``new`` constructor. The ``object`` must a valid property of the JavaScript ``window``. See :ref:`JavaScriptObject<class_JavaScriptObject>` for usage.
    59. 

  59. 

  60. ----
    61. 

  61. 

  62. .. _class_JavaScript_method_download_buffer:
    63. 

  63. 

  64. - void **download_buffer** **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`String<class_String>` name, :ref:`String<class_String>` mime="application/octet-stream" **)**
    65. 

  65. 

  66. Prompts the user to download a file containing the specified ``buffer``. The file will have the given ``name`` and ``mime`` type.
    67. 

  67. 

  68. **Note:** The browser may override the `MIME type <https://en.wikipedia.org/wiki/Media_type>`__ provided based on the file ``name``'s extension.
    69. 

  69. 

  70. **Note:** Browsers might block the download if :ref:`download_buffer<class_JavaScript_method_download_buffer>` is not being called from a user interaction (e.g. button click).
    71. 

  71. 

  72. **Note:** Browsers might ask the user for permission or block the download if multiple download requests are made in a quick succession.
    73. 

  73. 

  74. ----
    75. 

  75. 

  76. .. _class_JavaScript_method_eval:
    77. 

  77. 

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

  79. 

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

  81. 

  82. 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.
    83. 

  83. 

  84. ----
    85. 

  85. 

  86. .. _class_JavaScript_method_get_interface:
    87. 

  87. 

  88. - :ref:`JavaScriptObject<class_JavaScriptObject>` **get_interface** **(** :ref:`String<class_String>` interface **)**
    89. 

  89. 

  90. Returns an interface to a JavaScript object that can be used by scripts. The ``interface`` must be a valid property of the JavaScript ``window``. The callback must accept a single :ref:`Array<class_Array>` argument, which will contain the JavaScript ``arguments``. See :ref:`JavaScriptObject<class_JavaScriptObject>` for usage.
    91. 

  91. 

  92. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    93. 

  93. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    94. 

  94. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    95. 

  95. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    96. 

  96. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    97. 

  97. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    98.