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

class_javascript.rst 9.6 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132 
  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. | :ref:`bool<class_bool>`                         | :ref:`pwa_needs_update<class_JavaScript_method_pwa_needs_update>` **(** **)** |const|                                                                                                                                           |
    43. 

  43. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`Error<enum_@GlobalScope_Error>`           | :ref:`pwa_update<class_JavaScript_method_pwa_update>` **(** **)**                                                                                                                                                               |
    45. 

  45. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. 

  47. Signals
    48. 

  48. -------
    49. 

  49. 

  50. .. _class_JavaScript_signal_pwa_update_available:
    51. 

  51. 

  52. - **pwa_update_available** **(** **)**
    53. 

  53. 

  54. Emitted when an update for this progressive web app has been detected but is waiting to be activated because a previous version is active. See :ref:`pwa_update<class_JavaScript_method_pwa_update>` to force the update to take place immediately.
    55. 

  55. 

  56. Method Descriptions
    57. 

  57. -------------------
    58. 

  58. 

  59. .. _class_JavaScript_method_create_callback:
    60. 

  60. 

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

  62. 

  63. 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.
    64. 

  64. 

  65. ----
    66. 

  66. 

  67. .. _class_JavaScript_method_create_object:
    68. 

  68. 

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

  70. 

  71. 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.
    72. 

  72. 

  73. ----
    74. 

  74. 

  75. .. _class_JavaScript_method_download_buffer:
    76. 

  76. 

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

  78. 

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

  80. 

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

  82. 

  83. \ **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).
    84. 

  84. 

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

  86. 

  87. ----
    88. 

  88. 

  89. .. _class_JavaScript_method_eval:
    90. 

  90. 

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

  92. 

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

  94. 

  95. 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.
    96. 

  96. 

  97. ----
    98. 

  98. 

  99. .. _class_JavaScript_method_get_interface:
    100. 

  100. 

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

  102. 

  103. 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.
    104. 

  104. 

  105. ----
    106. 

  106. 

  107. .. _class_JavaScript_method_pwa_needs_update:
    108. 

  108. 

  109. - :ref:`bool<class_bool>` **pwa_needs_update** **(** **)** |const|
    110. 

  110. 

  111. Returns ``true`` if a new version of the progressive web app is waiting to be activated.
    112. 

  112. 

  113. \ **Note:** Only relevant when exported as a Progressive Web App.
    114. 

  114. 

  115. ----
    116. 

  116. 

  117. .. _class_JavaScript_method_pwa_update:
    118. 

  118. 

  119. - :ref:`Error<enum_@GlobalScope_Error>` **pwa_update** **(** **)**
    120. 

  120. 

  121. Performs the live update of the progressive web app. Forcing the new version to be installed and the page to be reloaded.
    122. 

  122. 

  123. \ **Note:** Your application will be **reloaded in all browser tabs**.
    124. 

  124. 

  125. \ **Note:** Only relevant when exported as a Progressive Web App and :ref:`pwa_needs_update<class_JavaScript_method_pwa_needs_update>` returns ``true``.
    126. 

  126. 

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

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

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

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

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

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