Skip to content

VimpUiBridge

@vimp-mp/types 2.0.1

Interface · CEF UI API

Root bridge installed as window.vimp inside a VIMP CEF page.

ts
interface VimpUiBridge

Members

emitClient

ts
emitClient<K extends never>(event: K, data: VimpClientInboundEvents[K]): void
ts
emitClient(event: string, data?: unknown): void

Sends a typed event to the client script that owns this CEF page.

emitServer

ts
emitServer<K extends never>(event: K, data: VimpServerInboundEvents[K]): void
ts
emitServer(event: string, data: unknown): void

Sends a typed event from the CEF page to the server script.

on

ts
on(event: string, handler: VimpUiEventHandler): () => void

Registers a handler and returns a function that unsubscribes it.

VIMP developer documentation