App

Allows users to interact with the core app.

When extending BasePlugin, these functions can be accessed via this.app.*

When extending BaseComponent, these functions can be accessed via this.plugin.app.*

Functions

hasInputCapture(id: string) : Promise<boolean>

Returns true if the object matching the given identifier has its input captured by a plugin, false otherwise.

const hasCapture = await this.app.hasInputCapture('042ed071-649c-4601-9a30-669a59c9e1ee')
console.log(hasCapture) // => false

requestInputCapture(id: string, callback: Function) : Promise<void>

Requests full input event capture of the object matching the given identifier, sending all input events to the given callback function.

While capture is active, all pointer and keyboard events will be sent to the callback function, and will not be processed by the app. When capturing ends, the callback function will receive one last message with type equal to 'input-capture-ended'.

All events sent to the callback function contain the standard PointerEvent and KeyboardEvent fields, as well as the following extra fields:

• windowWidth: number - Width of the app window in pixels
• windowHeight: number - Height of the app window in pixels
• objectID: string - Identifier of the object that was specified when the request started
• point: Vector3 - World coordinates of the hit point, in the form { x: number, y: number, z: number }
• uv: Vector2 - UV coordinates of the hit point, in the form { x: number, y: number }

function onEvent(event) {
  console.log(event)
}
//
await this.app.requestInputCapture('042ed071-649c-4601-9a30-669a59c9e1ee', onEvent)

stopInputCapture() : void

Stops the current input capture, if it exists.

this.app.stopInputCapture()