JavaScriptObject.xml 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="JavaScriptObject" inherits="Reference" version="3.4">
  3. <brief_description>
  4. A wrapper class for native JavaScript objects.
  5. </brief_description>
  6. <description>
  7. JavaScriptObject is used to interact with JavaScript objects retrieved or created via [method JavaScript.get_interface], [method JavaScript.create_object], or [method JavaScript.create_callback].
  8. Example:
  9. [codeblock]
  10. extends Node
  11. var _my_js_callback = JavaScript.create_callback(self, "myCallback") # This reference must be kept
  12. var console = JavaScript.get_interface("console")
  13. func _init():
  14. var buf = JavaScript.create_object("ArrayBuffer", 10) # new ArrayBuffer(10)
  15. print(buf) # prints [JavaScriptObject:OBJECT_ID]
  16. var uint8arr = JavaScript.create_object("Uint8Array", buf) # new Uint8Array(buf)
  17. uint8arr[1] = 255
  18. prints(uint8arr[1], uint8arr.byteLength) # prints 255 10
  19. console.log(uint8arr) # prints in browser console "Uint8Array(10) [ 0, 255, 0, 0, 0, 0, 0, 0, 0, 0 ]"
  20. # Equivalent of JavaScript: Array.from(uint8arr).forEach(myCallback)
  21. JavaScript.get_interface("Array").from(uint8arr).forEach(_my_js_callback)
  22. func myCallback(args):
  23. # Will be called with the parameters passed to the "forEach" callback
  24. # [0, 0, [JavaScriptObject:1173]]
  25. # [255, 1, [JavaScriptObject:1173]]
  26. # ...
  27. # [0, 9, [JavaScriptObject:1180]]
  28. print(args)
  29. [/codeblock]
  30. Note: Only available in the "HTML5" platform.
  31. </description>
  32. <tutorials>
  33. </tutorials>
  34. <methods>
  35. </methods>
  36. <constants>
  37. </constants>
  38. </class>