API Reference

Types

Important public types exported from @onmax/phaser-vue and @onmax/nuxt-phaser.

Vue runtime types

PhaserGameProps
PhaserGameExpose
PhaserSceneDefinition
PhaserSceneContext
PhaserBridge
PhaserObjectRef
PhaserGameRuntimeDefaults
PhaserVuePluginOptions
PhaserHmrStrategy
AssetManifest

Nuxt module types

NuxtPhaserModuleOptions
ResolvedNuxtPhaserModuleOptions

PhaserSceneDefinition and PhaserBridge are the two most important types to thread through app code. They let you keep scene behavior and Vue orchestration strongly typed without inventing a second object model on top of Phaser.

Edit this pageorReport an issue

Composables

Public composables for game lookup, scene lookup, bridge events, input helpers, and low-frequency registry state.

Nuxt Module Options

Configure the Nuxt wrapper through the supported public module surface.

Types

Vue runtime types

Nuxt module types

Why these types matter