Options
All
  • Public
  • Public/Protected
  • All
Menu

Manage settings used by the activity

Hierarchy

  • Settings

Index

Accessors

activity

activityAssetsRootPath

  • get activityAssetsRootPath(): string
  • Get root path for the activity's assets

    Returns string

assetsRootPath

  • get assetsRootPath(): string
  • Get root path for all assets

    Returns string

backgroundDuckingVolume

  • get backgroundDuckingVolume(): number
  • set backgroundDuckingVolume(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

defaultBackgroundVolume

  • get defaultBackgroundVolume(): number
  • set defaultBackgroundVolume(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

forceOrientationThreshold

  • get forceOrientationThreshold(): number
  • The max screen size (in pixels) for forcing a requested device orientation

    Returns number

globalAssets

  • Get required global media

    Returns AssetCollection

globalAssetsRootPath

  • get globalAssetsRootPath(): string
  • Get root path for global global assets (accessible to all activities)

    Returns string

preloadAnimation

  • get preloadAnimation(): string
  • set preloadAnimation(path: string): void
  • Returns string

  • Parameters

    • path: string

    Returns void

userProfile

Static instance

  • Returns Settings

Methods

initActivityAssets

  • initActivityAssets(): void
  • Read the config file and assemble the activity's asset collection

    Returns void

setBackgroundVolumes

  • setBackgroundVolumes(defaultVolume: number, duckingVolume: number): void
  • Parameters

    • defaultVolume: number
    • duckingVolume: number

    Returns void