Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PlatformWrapperInterface

Hierarchy

Index

Constructors

constructor

Methods

exitApp

  • exitApp(): void
  • Attempt to exit the app

    Returns void

getAutomaticLoginProviderStateId

  • getAutomaticLoginProviderStateId(): any
  • Returns the state id which will perform the automatic login

    Returns any

getDpiMultiplicator

  • getDpiMultiplicator(): number
  • Returns at which resolutions we should generated cached images to make sure they don't look blurry

    Returns number

getHasAutomaticLoginProvider

  • getHasAutomaticLoginProvider(): boolean
  • If this platform has an automatic login, e.g. on steam we login the user with his steam id

    Returns boolean

getId

  • getId(): string
  • Returns string

getMaximumZoom

  • getMaximumZoom(): number
  • Should return the maximum supported zoom level

    Returns number

getMinimumZoom

  • getMinimumZoom(): number
  • Should return the minimum supported zoom level

    Returns number

getRecaptchaToken

  • getRecaptchaToken(): Promise<any>
  • Should return the recaptcha token, or null if recaptcha is not supported or not loaded

    Returns Promise<any>

getSupportsAds

  • getSupportsAds(): boolean
  • Should return if this platform supports ads at all

    Returns boolean

getSupportsRestart

  • getSupportsRestart(): boolean
  • Returns boolean

getTouchPanStrength

  • getTouchPanStrength(): number
  • Returns the strength of touch pans with the mouse

    Returns number

getUiScale

  • getUiScale(): number
  • Returns the UI scale, called on every resize

    Returns number

getUnsupportedAchievementIds

  • getUnsupportedAchievementIds(): any[]
  • Should return which achievment ids are unsupported by this platform

    Returns any[]

initRecaptcha

  • initRecaptcha(recaptchaElem: any): void
  • Should initialize recaptcha in case its supported into the given element

    Parameters

    • recaptchaElem: any

    Returns void

initialize

  • initialize(): Promise<void>
  • Returns Promise<void>

initializeAdProvider

  • initializeAdProvider(): Promise<void>
  • Should initialize the apps ad provider in case supported @returns {Promise}

    Returns Promise<void>

openExternalLink

  • openExternalLink(url: any): void
  • Attempt to open an external url

    Parameters

    • url: any

    Returns void

performRestart

  • performRestart(): void
  • Attempt to restart the app

    Returns void

synchronizeAchievementsToPlatform

  • synchronizeAchievementsToPlatform(unlockedIds: any): void
  • Should synchronize the achivements with the platform we are running on (e.g. steam)

    Parameters

    • unlockedIds: any

    Returns void