godot.gen.godot.JavaScriptObject.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of godot-library-debug Show documentation

Contains godot api as kotlin classes and jvm cpp interaction code.

The newest version!

// THIS FILE IS GENERATED! DO NOT EDIT IT MANUALLY!
@file:Suppress("PackageDirectoryMismatch", "unused", "FunctionName", "RedundantModalityModifier",
    "UNCHECKED_CAST", "JoinDeclarationAndAssignment", "USELESS_CAST",
    "RemoveRedundantQualifierName", "NOTHING_TO_INLINE", "NON_FINAL_MEMBER_IN_OBJECT",
    "RedundantVisibilityModifier", "RedundantUnitReturnType", "MemberVisibilityCanBePrivate")

package godot

import godot.`annotation`.GodotBaseType
import kotlin.Int
import kotlin.Suppress
import kotlin.Unit

/**
 * JavaScriptObject is used to interact with JavaScript objects retrieved or created via
 * [JavaScriptBridge.getInterface], [JavaScriptBridge.createObject], or
 * [JavaScriptBridge.createCallback].
 * **Example:**
 * [codeblock]
 * extends Node
 *
 * var _my_js_callback = JavaScriptBridge.create_callback(myCallback) # This reference must be kept
 * var console = JavaScriptBridge.get_interface("console")
 *
 * func _init():
 *     var buf = JavaScriptBridge.create_object("ArrayBuffer", 10) # new ArrayBuffer(10)
 *     print(buf) # prints [JavaScriptObject:OBJECT_ID]
 *     var uint8arr = JavaScriptBridge.create_object("Uint8Array", buf) # new Uint8Array(buf)
 *     uint8arr[1] = 255
 *     prints(uint8arr[1], uint8arr.byteLength) # prints 255 10
 *     console.log(uint8arr) # prints in browser console "Uint8Array(10) [ 0, 255, 0, 0, 0, 0, 0, 0,
 * 0, 0 ]"
 *
 *     # Equivalent of JavaScriptBridge: Array.from(uint8arr).forEach(myCallback)
 *     JavaScriptBridge.get_interface("Array").from(uint8arr).forEach(_my_js_callback)
 *
 * func myCallback(args):
 *     # Will be called with the parameters passed to the "forEach" callback
 *     # [0, 0, [JavaScriptObject:1173]]
 *     # [255, 1, [JavaScriptObject:1173]]
 *     # ...
 *     # [0, 9, [JavaScriptObject:1180]]
 *     print(args)
 * [/codeblock]
 * **Note:** Only available in the Web platform.
 */
@GodotBaseType
public open class JavaScriptObject internal constructor() : RefCounted() {
  public override fun new(scriptIndex: Int): Unit {
    callConstructor(ENGINECLASS_JAVASCRIPTOBJECT, scriptIndex)
  }

  public companion object

  internal object MethodBindings
}