Rpg Client Engine

Reference for the RpgClientEngine class.

Members

activeRoom
activeRoomSceneComponent
activeSceneKind
addComponentAnimation
addEventComponentResolver
addSound
addSpriteComponentBehind
addSpriteComponentInFront
cameraFollowRevision
cameraFollowSmoothMove
cameraFollowTargetId
clear
clearClientPredictionStates
connect
dashDefaults
disconnect
flash
getAvailableLocales
getComponentAnimation
getCurrentRoom
getLocale
getLocalePreference
getSound
getSoundVolume
getSpriteComponent
getSpriteSheet
interactions
interruptCurrentPlayerMovement
mapShakeTrigger
music
playClientVisual
playSound
pointer
processAction
processDash
registerClientVisual
registerClientVisuals
registerSpriteComponent
resolveEventComponent
sceneRoom
setCameraFollow
setKeyboardControls
setLocale
setSoundResolver
setSoundVolume
setSpritesheetResolver
startTransition
stopAllSounds
stopSound
visualPause

activeRoom

Authoritative descriptor of the active room.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

activeRoom

activeRoomSceneComponent

CanvasEngine component selected for a custom gameplay room.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

activeRoomSceneComponent

activeSceneKind

Active room kind; map keeps the historical map pipeline enabled.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

activeSceneKind

addComponentAnimation

Add a component animation to the engine Component animations are temporary visual effects that can be displayed on sprites or objects, such as hit indicators, spell effects, or status animations.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

addComponentAnimation(componentAnimation: {
    component: any,
    id: string
  })

Parameters

componentAnimation: { component: any, id: string }

Returns

The added component animation configuration

Examples

// Add a hit animation component
engine.addComponentAnimation({
  id: 'hit',
  component: HitComponent
});

// Add an explosion effect component
engine.addComponentAnimation({
  id: 'explosion',
  component: ExplosionComponent
});

addEventComponentResolver

Register a custom event component resolver. The last resolver returning a component wins. This lets later modules override earlier defaults without replacing the whole map scene.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

addEventComponentResolver(resolver: EventComponentResolver)

Parameters

resolver: EventComponentResolver

Returns

The registered resolver

addSound

Add a sound to the engine Adds a sound to the engine’s sound cache. The sound can be:

A simple object with id and src properties
A Howler instance
An object with a play() method

If the sound has a src property, a Howler instance will be created automatically.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

addSound(sound: any, id?: string): any

Parameters

sound: any
id?: string

Returns

The added sound

Examples

// Simple sound object
engine.addSound({ id: 'click', src: 'click.mp3' });

// With explicit ID
engine.addSound({ src: 'music.mp3' }, 'background-music');

addSpriteComponentBehind

Add a component to render behind sprites Components added with this method will be displayed with a lower z-index than the sprite Supports multiple formats:

Direct component: ShadowComponent
Configuration object: { component: LightHalo, props: {...} }
With dynamic props: { component: LightHalo, props: (object) => {...} }
With dependencies: { component: HealthBar, dependencies: (object) => [object.hp, object.param.maxHp] }

Components with dependencies will only be displayed when all dependencies are resolved (!= undefined). The object (sprite) is passed to the dependencies function to allow sprite-specific dependency resolution.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

addSpriteComponentBehind(component: any)

Parameters

component: any

Returns

The added component or configuration

Examples

// Add a shadow component behind all sprites
engine.addSpriteComponentBehind(ShadowComponent);

// Add a component with static props
engine.addSpriteComponentBehind({ 
  component: LightHalo, 
  props: { radius: 30 } 
});

// Add a component with dynamic props and dependencies
engine.addSpriteComponentBehind({ 
  component: HealthBar, 
  props: (object) => ({ hp: object.hp(), maxHp: object.param.maxHp() }),
  dependencies: (object) => [object.hp, object.param.maxHp]
});

addSpriteComponentInFront

Add a component to render in front of sprites Components added with this method will be displayed with a higher z-index than the sprite Supports multiple formats:

Direct component: HealthBarComponent
Configuration object: { component: StatusIndicator, props: {...} }
With dynamic props: { component: HealthBar, props: (object) => {...} }
With dependencies: { component: HealthBar, dependencies: (object) => [object.hp, object.param.maxHp] }

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

addSpriteComponentInFront(component: any | { component: any, props: (object: any) => any, dependencies?: (object: any) => any[] })

Parameters

component: any | { component: any, props: (object: any) => any, dependencies?: (object: any) => any[] }

Returns

The added component or configuration

Examples

// Add a health bar component in front of all sprites
engine.addSpriteComponentInFront(HealthBarComponent);

// Add a component with static props
engine.addSpriteComponentInFront({ 
  component: StatusIndicator, 
  props: { type: 'poison' } 
});

// Add a component with dynamic props and dependencies
engine.addSpriteComponentInFront({ 
  component: HealthBar, 
  props: (object) => ({ hp: object.hp(), maxHp: object.param.maxHp() }),
  dependencies: (object) => [object.hp, object.param.maxHp]
});

cameraFollowRevision

Incremented for each camera follow command so repeated commands on the same target are applied

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

cameraFollowRevision

cameraFollowSmoothMove

Camera follow transition options used by character components when the target changes

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

cameraFollowSmoothMove: CameraFollowSmoothMove

cameraFollowTargetId

ID of the sprite that the camera should follow. null means follow the current player

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

cameraFollowTargetId

clear

Clear all client resources and reset state This method should be called to clean up all client-side resources when shutting down or resetting the client engine. It:

Destroys the PIXI renderer
Stops all sounds
Cleans up subscriptions and event listeners
Resets scene map
Stops ping/pong interval
Clears prediction states

Design

This method is used primarily in testing environments to ensure clean state between tests. In production, the client engine typically persists for the lifetime of the application.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

clear(): void

Examples

// In test cleanup
afterEach(() => {
  clientEngine.clear();
});

clearClientPredictionStates

Clear client prediction states for cleanup Removes old prediction states and input history to prevent memory leaks. Should be called when changing maps or disconnecting.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

clearClientPredictionStates()

Examples

// Clear prediction states when changing maps
engine.clearClientPredictionStates();

connect

Open the initial MMORPG connection after a deferred account flow. Concurrent calls share the same attempt. Standalone and normal MMORPG starts call this automatically.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

connect

Returns

A promise resolved after the RPGJS server accepts the connection.

dashDefaults

Runtime defaults used by modules that specialize the built-in dash.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

dashDefaults: Partial<RpgDashInput>

disconnect

Close the current physical connection without destroying the rendered client. Account modules can return to a pre-connection GUI and call connect() again.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

disconnect

Returns

Nothing.

flash

Trigger a flash animation on a sprite This method allows you to trigger a flash effect on any sprite from client-side code. The flash can be configured with various options including type (alpha, tint, or both), duration, cycles, and color.

Design

The flash is applied directly to the sprite object using its flash trigger. This is useful for client-side visual feedback, UI interactions, or local effects that don’t need to be synchronized with the server.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

flash(spriteId?: string, options?: {
      type?: 'alpha' | 'tint' | 'both';
      duration?: number;
      cycles?: number;
      alpha?: number;
      tint?: number | string;
    }): void

Parameters

spriteId?: string
options?: { type?: 'alpha' | 'tint' | 'both'; duration?: number; cycles?: number; alpha?: number; tint?: number | string; }

Examples

// Flash the current player with default settings
engine.flash();

// Flash a specific sprite with red tint
engine.flash('sprite-id', { type: 'tint', tint: 0xff0000 });

// Flash with both alpha and tint for dramatic effect
engine.flash(undefined, { 
  type: 'both', 
  alpha: 0.5, 
  tint: 0xff0000,
  duration: 200,
  cycles: 2
});

// Quick damage flash on current player
engine.flash(undefined, { 
  type: 'tint', 
  tint: 'red', 
  duration: 150,
  cycles: 1
});

getAvailableLocales

Game catalogue locales only, in both standalone and MMORPG mode.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

getAvailableLocales

Returns

Registered game locales; defaultLocale if there are no catalogues.

Examples

client.getAvailableLocales() // ['en', 'fr']

getComponentAnimation

Get a component animation by its ID Retrieves the EffectManager instance for a specific component animation, which can be used to display the animation on sprites or objects.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

getComponentAnimation(id: string): AnimationManager

Parameters

id: string

Returns

The EffectManager instance for the animation

Examples

// Get the hit animation and display it
const hitAnimation = engine.getComponentAnimation('hit');
hitAnimation.displayEffect({ text: "Critical!" }, player);

getCurrentRoom

Return the active map scene or synchronized custom gameplay room.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

getCurrentRoom(): RpgClientMap | RpgClientRoom

getLocale

Read the resolved client locale, reactively inside CanvasEngine computations. Works in standalone RPG and MMORPG modes.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

getLocale

Returns

The resolved game locale, never auto.

Examples

client.getLocale() // 'fr'

getLocalePreference

Current client preference in standalone RPG and MMORPG modes.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

getLocalePreference

Returns

Locale preference, reactive in client components.

Examples

client.getLocalePreference() // 'auto'

getSound

Get a sound by ID, using resolver if not found in cache This method first checks if the sound exists in the cache. If not found and a resolver is set, it calls the resolver to create the sound. The resolved sound is automatically cached for future use.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

getSound(id: string): any | Promise<any>

Parameters

id: string

Returns

The sound if found or created, or undefined if not found and no resolver

Examples

// Synchronous usage
const sound = engine.getSound('my-sound');

// Asynchronous usage (when resolver returns Promise)
const sound = await engine.getSound('dynamic-sound');

getSoundVolume

Read the persisted volume of one sound channel for the current project. Calls made inside a CanvasEngine computed value remain reactive.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

getSoundVolume(channel: RpgAudioChannel): number

Parameters

channel: RpgAudioChannel

Returns

Volume between 0 and 1.

Examples

const musicVolume = engine.getSoundVolume('music')

getSpriteComponent

Get a reusable sprite component by id.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

getSpriteComponent(id: string)

Parameters

id: string

Returns

The CanvasEngine component, or undefined when missing

getSpriteSheet

Get a spritesheet by ID, using resolver if not found in cache This method first checks if the spritesheet exists in the cache. If not found and a resolver is set, it calls the resolver to create the spritesheet. The resolved spritesheet is automatically cached for future use.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

getSpriteSheet(id: string | number): any | Promise<any>

Parameters

id: string | number

Returns

The spritesheet if found or created, or undefined if not found and no resolver

Examples

// Synchronous usage
const spritesheet = engine.getSpriteSheet('my-sprite');

// Asynchronous usage (when resolver returns Promise)
const spritesheet = await engine.getSpriteSheet('dynamic-sprite');

interactions

Register client-only pointer behaviors for map sprites. Interactions remain local unless a behavior explicitly sends an action to the server. See the client interactions guide for hover, selection, hit testing, drag-and-drop, overlays, and network rules.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

interactions: RpgClientInteractions

Examples

engine.interactions.use('Guard', {
  cursor: 'pointer',
  click(ctx) {
    ctx.action('guard:talk', { eventId: ctx.target.id })
  }
})

interruptCurrentPlayerMovement

Stop local movement immediately and discard pending predicted movement. Use this before a blocking action such as an A-RPG attack, dialog, dash startup, or any client-side state where already buffered movement inputs must not be replayed after server reconciliation.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

interruptCurrentPlayerMovement(player?: any): boolean

Parameters

player?: any

Returns

true when a player was found and interrupted.

Examples

engine.interruptCurrentPlayerMovement();

mapShakeTrigger

Trigger for map shake animation

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

mapShakeTrigger: ConfigurableTrigger<MapShakeOptions>

music

Client-only controller for temporary looping music and map BGM crossfades.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

music

playClientVisual

Play a registered client visual locally. This is also used by the websocket listener when the server calls player.clientVisual() or map.clientVisual().

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

playClientVisual(packet: ClientVisualPacket)

Parameters

packet: ClientVisualPacket

playSound

Play a sound by its ID This method retrieves a sound from the cache or resolver and plays it. If the sound is not found, it will attempt to resolve it using the soundResolver. Uses Howler.js for audio playback instead of native Audio elements. The existing API remains the single entry point for ordinary, channel-aware, and spatial sounds. Playback is client-owned in both standalone and MMORPG games; server calls only ask the receiving client to play a registered ID.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

playSound(soundId: string, options?: RpgPlaySoundOptions): Promise<void>

Parameters

soundId: string
options?: RpgPlaySoundOptions

Returns

Resolves after the sound has been resolved and started when available.

Examples

// Play a sound synchronously
engine.playSound('item-pickup');

// Play a sound with volume and loop
engine.playSound('background-music', { volume: 0.5, loop: true });

// Play a sound asynchronously (when resolver returns Promise)
await engine.playSound('dynamic-sound', { volume: 0.8 });

// Play a spatial sound without exposing CanvasEngine signals
await engine.playSound('enemy-hit', {
  channel: 'sfx',
  position: { x: enemy.x(), y: enemy.y() },
  listener: { x: player.x(), y: player.y() },
});

pointer

Read the latest pointer position tracked by the client canvas. World coordinates are suitable for action payloads and map interactions.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

pointer: ClientPointerContext

Examples

const target = engine.pointer.world()
if (target) engine.processAction('projectile:shoot', { target })

processAction

Send an action intent to the authoritative server. Client-provided data must be validated by the receiving player input handler or action.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

processAction(action: RpgActionName | RpgActionInput, data?: any): void

Parameters

action: RpgActionName
data?: any

Returns

Nothing.

Examples

engine.processAction('projectile:shoot', {
  target: engine.pointer.world(),
  source: 'map-click',
})

processDash

Start a predicted dash for the current player and send it through the authoritative movement channel.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

processDash(input?: Partial<RpgDashInput>): Promise<void>

Parameters

input?: Partial<RpgDashInput>

Returns

A promise resolved after the dash input has been processed locally.

Examples

await engine.processDash({
  direction: { x: 1, y: 0 },
  additionalSpeed: 10,
  duration: 220,
  cooldown: 600,
})

registerClientVisual

Register a named client visual macro. Client visuals are small client-side functions that group existing visual primitives such as flash, sound, component animations, sprite animation, or map shake. The server sends only the visual name and a serializable payload.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

registerClientVisual(name: string, handler: ClientVisualHandler)

Parameters

name: string
handler: ClientVisualHandler

Returns

The registered handler

registerClientVisuals

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

registerClientVisuals(visuals: ClientVisualMap)

Parameters

visuals: ClientVisualMap

registerSpriteComponent

Register a reusable sprite component that can be addressed by the server. Server-side component definitions only carry the component id and serializable props. The client registry maps that id to the CanvasEngine component that performs the actual rendering.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

registerSpriteComponent(id: string, component: any)

Parameters

id: string
component: any

Returns

The registered component

Examples

engine.registerSpriteComponent('guildBadge', GuildBadgeComponent);

resolveEventComponent

Resolve the custom CanvasEngine component for an event, if any.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

resolveEventComponent(event: RpgClientEvent): EventComponentConfig | null

Parameters

event: RpgClientEvent

Returns

The component/config returned by the last matching resolver

sceneRoom

Synchronized state for the active non-map gameplay room.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

sceneRoom

setCameraFollow

Set the camera to follow a specific sprite This method changes which sprite the camera viewport should follow. The camera can smoothly animate to the target sprite before continuous follow starts.

Design

The camera follow target is stored in a signal that is read by sprite components. Each sprite checks if it should be followed by comparing its ID with the target ID. When smoothMove options are provided, the transition is handled by pixi-viewport’s animation plugin, then continuous follow is handled by CanvasEngine’s viewport system.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

setCameraFollow(targetId: string | null, smoothMove?: CameraFollowSmoothMove): void

Parameters

targetId: string | null
smoothMove?: CameraFollowSmoothMove

Examples

// Follow another player with default smooth animation
engine.setCameraFollow(otherPlayerId, true);

// Follow an event with custom smooth animation
engine.setCameraFollow(eventId, {
  time: 1000,
  ease: "easeInOutQuad"
});

// Follow without animation (instant)
engine.setCameraFollow(targetId, false);

// Return to following current player
engine.setCameraFollow(null);

setKeyboardControls

Registers the current player’s live CanvasEngine controls on the client. Used automatically when the player component mounts in standalone RPG and MMORPG modes. Destroyed directives are ignored so a retiring component cannot overwrite replacement controls during streamed map updates. Input handling remains client-side; this does not change server movement authority.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

setKeyboardControls

Parameters

controlInstance: ControlsDirective

Returns

Nothing.

Examples

// Inside the current player's CanvasEngine mount callback:
client.setKeyboardControls(element.directives.controls)

setLocale

Select and persist a game language, or auto for browser negotiation. Updates client labels and the connected player’s future translations.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

setLocale

Parameters

locale: string

Returns

Nothing.

Examples

client.setLocale('fr')

setSoundResolver

Set a resolver function for sounds The resolver is called when a sound is requested but not found in the cache. It can be synchronous (returns directly) or asynchronous (returns a Promise). The resolved sound is automatically cached for future use.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

setSoundResolver(resolver: (id: string) => any | Promise<any>): void

Parameters

resolver: (id: string) => any | Promise<any>

Examples

// Synchronous resolver
engine.setSoundResolver((id) => {
  if (id === 'dynamic-sound') {
    return { id: 'dynamic-sound', src: 'path/to/sound.mp3' };
  }
  return undefined;
});

// Asynchronous resolver (loading from API)
engine.setSoundResolver(async (id) => {
  const response = await fetch(`/api/sounds/${id}`);
  const data = await response.json();
  return data;
});

setSoundVolume

Set the persisted volume of one sound channel for the current project. Master volume is applied through Howler, including sounds controlled through the legacy RpgSound.global facade. This client-owned preference behaves the same in standalone and MMORPG games and never changes server state.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Member of: RpgClientEngine
Defined in: RpgClientEngine

Signature

setSoundVolume(channel: RpgAudioChannel, value: number): void

Parameters

channel: RpgAudioChannel
value: number

Examples

engine.setSoundVolume('music', 0.6)
engine.setSoundVolume('master', 0.8)

setSpritesheetResolver

Set a resolver function for spritesheets The resolver is called when a spritesheet is requested but not found in the cache. It can be synchronous (returns directly) or asynchronous (returns a Promise). The resolved spritesheet is automatically cached for future use.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

setSpritesheetResolver(resolver: (id: string | number) => any | Promise<any>): void

Parameters

resolver: (id: string | number) => any | Promise<any>

Examples

// Synchronous resolver
engine.setSpritesheetResolver((id) => {
  if (id === 'dynamic-sprite') {
    return { id: 'dynamic-sprite', image: 'path/to/image.png', framesWidth: 32, framesHeight: 32 };
  }
  return undefined;
});

// Asynchronous resolver (loading from API)
engine.setSpritesheetResolver(async (id) => {
  const response = await fetch(`/api/spritesheets/${id}`);
  const data = await response.json();
  return data;
});

startTransition

Start a transition Convenience method to display a transition by its ID using the GUI system.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

startTransition(id: string, props?: any): Promise<void>

Parameters

id: string
props?: any

Examples

// Start a fade transition
engine.startTransition('fade', { duration: 1000, color: 'black' });

// Start with onFinish callback
engine.startTransition('fade', {
  duration: 1000,
  onFinish: () => console.log('Fade complete')
});

// Wait until the transition component calls onFinish
await engine.startTransition('fade', { duration: 1000 });

stopAllSounds

Stop all currently playing sounds This method stops all sounds that are currently playing. Useful when changing maps to prevent sound overlap.

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

stopAllSounds(): void

Examples

// Stop all sounds
engine.stopAllSounds();

stopSound

Stop a sound that is currently playing This method stops a sound that was previously started with playSound().

Source: packages/client/src/RpgClientEngine.ts
Kind: method
Defined in: RpgClientEngine

Signature

stopSound(soundId: string): void

Parameters

soundId: string

Examples

// Start a looping sound
engine.playSound('background-music', { loop: true });

// Later, stop it
engine.stopSound('background-music');

visualPause

Freezes map rendering for short presentation-only beats such as combat hit-stop. It is deliberately separate from menu/gameplay pause ownership.

Source: packages/client/src/RpgClientEngine.ts
Kind: property
Defined in: RpgClientEngine

Signature

visualPause

​Rpg Client Engine

​Members

​activeRoom

​Signature

​activeRoomSceneComponent

​Signature

​activeSceneKind

​Signature

​addComponentAnimation

​Signature

​Parameters

​Returns

​Examples

​addEventComponentResolver

​Signature

​Parameters

​Returns

​addSound

​Signature

​Parameters

​Returns

​Examples

​addSpriteComponentBehind

​Signature

​Parameters

​Returns

​Examples

​addSpriteComponentInFront

​Signature

​Parameters

​Returns

​Examples

​cameraFollowRevision

​Signature

​cameraFollowSmoothMove

​Signature

​cameraFollowTargetId

​Signature

​clear

​Design

​Signature

​Examples

​clearClientPredictionStates

​Signature

​Examples

​connect

​Signature

​Returns

​dashDefaults

​Signature

​disconnect

​Signature

​Returns

​flash

​Design

​Signature

​Parameters

​Examples

​getAvailableLocales

​Signature

​Returns

​Examples

​getComponentAnimation

​Signature

​Parameters

​Returns

​Examples

​getCurrentRoom

​Signature

​getLocale

​Signature

​Returns

​Examples

​getLocalePreference

​Signature

​Returns

​Examples

​getSound

​Signature

​Parameters

Rpg Client Engine

Members

activeRoom

Signature

activeRoomSceneComponent

Signature

activeSceneKind

Signature

addComponentAnimation

Signature

Parameters

Returns

Examples

addEventComponentResolver

Signature

Parameters

Returns

addSound

Signature

Parameters

Returns

Examples

addSpriteComponentBehind

Signature

Parameters

Returns

Examples

addSpriteComponentInFront

Signature

Parameters

Returns

Examples

cameraFollowRevision

Signature

cameraFollowSmoothMove

Signature

cameraFollowTargetId

Signature

clear

Design

Signature

Examples

clearClientPredictionStates

Signature

Examples

connect

Signature

Returns

dashDefaults

Signature

disconnect

Signature

Returns

flash

Design

Signature

Parameters

Examples

getAvailableLocales

Signature

Returns

Examples

getComponentAnimation

Signature

Parameters

Returns

Examples

getCurrentRoom

Signature

getLocale

Signature

Returns

Examples

getLocalePreference

Signature

Returns

Examples

getSound

Signature

Parameters