Options
All
  • Public
  • Public/Protected
  • All
Menu

Client side entry point for the player

Hierarchy

  • AbstractExperience
    • ClientPlayerExperience

Index

Constructors

constructor

  • Parameters

    • client: any

      A soundworks client instance.

    • config: any

      A soundworks client config that was used to instantiate the client instance.

    • $container: null | Element

      The html container that is used to render this class' lit elements.

    Returns ClientPlayerExperience

Properties

$container

$container: any

The html container that is used to render this class' lit elements. Defined by soundworks-template.

activeModuleCollection

activeModuleCollection: ModuleCollection

The currently active modules. A copy from the StateManager.

config

config: any

A soundworks client config that was used to instantiate the client instance. Defined by soundworks-template.

rafId

rafId: number

Id to cancel and request the animation frame. Defined by soundworks-template.

stateGuard

stateGuard: ClientStateGuard

Used to ensure strongly typed StateManagers defined in Schemas.ts. Communcation with the server is handled here.

Methods

composeCurrentModuleView

  • composeCurrentModuleView(): TemplateResult<ResultType>[]
  • This function builds the view of every currentlyActiveModule.

    Returns TemplateResult<ResultType>[]

    A list of every modules' view.

handleAppState

  • Called every time there is an update for the SharedAppState.

    Parameters

    Returns void

handleInput

  • Called when there are user inputs that were made inside the modules

    Parameters

    Returns void

handlePlayerState

  • Called every time there is an update for the SharedPlayerState.

    Parameters

    Returns void

render

  • render(): void
  • Renders the whole controller view.

    Returns void

setupStateManagement

  • setupStateManagement(): Promise<void>
  • Setup the stateGuard that is used for communication with the server.

    Returns Promise<void>

start

  • start(): Promise<void>
  • Start routine for contrllern

    Returns Promise<void>

Generated using TypeDoc