GamePush | game-score-sdk

Hierarchy

EventEmitter<GPEvents>
- GamePush

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new GamePush(): GamePush

Overrides EventEmitter.constructor
- Defined in GamePush.ts:340
Returns GamePush

Properties

Private #apiClient

#apiClient: default

Private #debugConfig

#debugConfig: DebugConfig

Private #projectConfig

#projectConfig: PlayerProjectConfig

Private #serverTime

#serverTime: number

Private _achievementsService

_achievementsService: default

Private _channelsService

_channelsService: default

Private _documentsService

_documentsService: default

Private _events

_events: EventLite = ...

Private _eventsService

_eventsService: default

Private _filesService

_filesService: default

Private _gamesCollectionsService

_gamesCollectionsService: default

Private _imagesService

_imagesService: default

Private _leaderboardsService

_leaderboardsService: default

Private _paymentsService

_paymentsService: default

Private _playerService

_playerService: default

_pointersManager

_pointersManager: PointersManager

Private _projectService

_projectService: default

Private _rewardsService

_rewardsService: default

Private _schedulersService

_schedulersService: default

Private _storage

_storage: Storage

achievements

achievements: Achievements

Achievements manager

ads: Ads

Ads manager

analytics

analytics: Analytics

Analytics manager

app

app: default

App manager

avatarGenerator

avatarGenerator: string

Current selected avatar generator

avatarGeneratorTemplate

avatarGeneratorTemplate: string

Current selected avatar generator template URL

channels

channels: default

Channels manager

device

device: default

Provides info about user's device

devtools

devtools: { addShortcut: any; changeLanguage: any; closeSticky: any; purchaseProduct: any; requestReview: any; resumeSubscription: any; showCounter: any; showFullscreen: any; showPreloader: any; showRewardedVideo: any; showSticky: any; showToast: any; unsubscribe: any }

Devtools manager, only in dev

Type declaration

addShortcut:function
- addShortcut(): Promise<boolean>
- - Defined in devtools/createDevtools.ts:57
  Returns Promise<boolean>
changeLanguage:function
- changeLanguage(language: Lang): Promise<void>
- - Defined in devtools/createDevtools.ts:130
  Parameters
  - language: Lang
  Returns Promise<void>
closeSticky:function
- closeSticky(): void
- - Defined in devtools/createDevtools.ts:103
  Returns void
purchaseProduct:function
- purchaseProduct(product: Product): Promise<boolean>
- - Defined in devtools/createDevtools.ts:106
  Parameters
  - product: Product
  Returns Promise<boolean>
requestReview:function
- requestReview(): Promise<RequestReviewResult>
- - Defined in devtools/createDevtools.ts:65
  Returns Promise<RequestReviewResult>
resumeSubscription:function
- resumeSubscription(product: Product, purchase: PlayerPurchase): Promise<boolean>
- - Defined in devtools/createDevtools.ts:114
  Parameters
  - product: Product
  - purchase: PlayerPurchase
  Returns Promise<boolean>
showCounter:function
- showCounter(apiReqCounter: number): void
- - Defined in devtools/createDevtools.ts:139
  Parameters
  - apiReqCounter: number
  Returns void
showFullscreen:function
- showFullscreen(): Promise<boolean>
- - Defined in devtools/createDevtools.ts:33
  Returns Promise<boolean>
showPreloader:function
- showPreloader(): Promise<boolean>
- - Defined in devtools/createDevtools.ts:49
  Returns Promise<boolean>
showRewardedVideo:function
- showRewardedVideo(): Promise<boolean>
- - Defined in devtools/createDevtools.ts:41
  Returns Promise<boolean>
showSticky:function
- showSticky(): Promise<boolean>
- - Defined in devtools/createDevtools.ts:92
  Returns Promise<boolean>
showToast:function
- showToast(__namedParameters: Toast): void
- - Defined in devtools/createDevtools.ts:73
  Parameters
  - __namedParameters: Toast
  Returns void
unsubscribe:function
- unsubscribe(product: Product, purchase: PlayerPurchase): Promise<boolean>
- - Defined in devtools/createDevtools.ts:122
  Parameters
  - product: Product
  - purchase: PlayerPurchase
  Returns Promise<boolean>

documents

documents: Documents

Documents manager

events

events: default

Events manager

experiments

experiments: default

AB experiments manager

files

files: Files

Images manager

fullscreen

fullscreen: Fullscreen

Fullscreen manager

gamesCollections

gamesCollections: GamesCollections

Games Collections manager

images

images: Images

Images manager

isGameStarted

isGameStarted: boolean = false

Check is game started (load is finished)

isGameplay

isGameplay: boolean = false

Check is in gameplay

isMobile

isMobile: boolean

Is on mobile device

isPaused

isPaused: boolean = false

Check game paused

language

language: Lang

Current selected language

leaderboard

leaderboard: Leaderboard

Leaderboard manager

loader

loader: { dec: any; inc: any }

Global loader manager

Type declaration

dec:function
- dec(): void
- - Defined in components/Loader/createLoader.ts:25
  Returns void
inc:function
- inc(): void
- - Defined in components/Loader/createLoader.ts:20
  Returns void

logger

logger: Logger = logger

Logger

overlay

overlay: { changeAvatarGenerator: any; changeLanguage: any; close: any; closeOrientationOverlay: any; closePreAdCountdownOverlay: any; closePreAdCountdownOverlayFinish: any; closeRewardedFailedOverlay: any; login: any; openAchievements: any; openChat: any; openDocument: any; openGamesCollections: any; openLeaderboard: any; openProductPurchase: any; pickPlayerOnConflict: any; setSizeOffsets: any; setUnsupportedDeviceOverlay: any; share: any; showOrientationOverlay: any; showPreAdCountdownOverlay: any; showPreAdCountdownOverlayFinish: any; showRewardedFailedOverlay: any; unlockAchievement: any }

Overlay manager

Type declaration

changeAvatarGenerator:function
- changeAvatarGenerator(avatarGenerator: string): void
- - Defined in app/createOverlay.ts:57
  Parameters
  - avatarGenerator: string
  Returns void
changeLanguage:function
- changeLanguage(lang: Lang): Promise<void>
- - Defined in app/createOverlay.ts:51
  Parameters
  - lang: Lang
  Returns Promise<void>
close:function
- close(): void
- - Defined in app/createOverlay.ts:165
  Returns void
closeOrientationOverlay:function
- closeOrientationOverlay(): void
- - Defined in app/createOverlay.ts:207
  Returns void
closePreAdCountdownOverlay:function
- closePreAdCountdownOverlay(): void
- - Defined in app/createOverlay.ts:215
  Returns void
closePreAdCountdownOverlayFinish:function
- closePreAdCountdownOverlayFinish(): void
- - Defined in app/createOverlay.ts:224
  Returns void
closeRewardedFailedOverlay:function
- closeRewardedFailedOverlay(): void
- - Defined in app/createOverlay.ts:234
  Returns void
login:function
- login(options?: { withSecretCode?: boolean }): Promise<{ secretCode?: string; type: string }>
- - Defined in app/createOverlay.ts:38
  Parameters
  - options: { withSecretCode?: boolean } = {}
    - Optional withSecretCode?: boolean
  Returns Promise<{ secretCode?: string; type: string }>
openAchievements:function
- openAchievements(achievementsInfo: FetchPlayerAchievementsOutput, __namedParameters?: { scrollTo?: string | number }): Promise<void>
- - Defined in app/createOverlay.ts:74
  Parameters
  - achievementsInfo: FetchPlayerAchievementsOutput
  - __namedParameters: { scrollTo?: string | number } = {}
    - Optional scrollTo?: string | number
  Returns Promise<void>
openChat:function
- openChat(channel: Channel, channelMessages: FetchOutput<ChannelMessage>, personalChannelData?: PersonalChannelData): Promise<void>
- - Defined in app/createOverlay.ts:91
  Parameters
  - channel: Channel
  - channelMessages: FetchOutput<ChannelMessage>
  - Optional personalChannelData: PersonalChannelData
  Returns Promise<void>
openDocument:function
- openDocument(document: Document): Promise<void>
- - Defined in app/createOverlay.ts:113
  Parameters
  - document: Document
  Returns Promise<void>
openGamesCollections:function
- openGamesCollections(gamesCollection: GamesCollection): Promise<void>
- - Defined in app/createOverlay.ts:151
  Parameters
  - gamesCollection: GamesCollection
  Returns Promise<void>
openLeaderboard:function
- openLeaderboard(query: GetLeaderboardQuery, leaderbordInfo: RatingData): Promise<void>
- - Defined in app/createOverlay.ts:60
  Parameters
  - query: GetLeaderboardQuery
  - leaderbordInfo: RatingData
  Returns Promise<void>
openProductPurchase:function
- openProductPurchase(product: Product): Promise<void>
- - Defined in app/createOverlay.ts:128
  Parameters
  - product: Product
  Returns Promise<void>
pickPlayerOnConflict:function
- pickPlayerOnConflict(conflictInfo: Omit<PlayerSyncConflict, "__typename">): Promise<PlayerState>
- - Defined in app/createOverlay.ts:25
  Parameters
  - conflictInfo: Omit<PlayerSyncConflict, "__typename">
  Returns Promise<PlayerState>
setSizeOffsets:function
- setSizeOffsets(sizeOffsets: { bottom: number; top: number }): void
- - Defined in app/createOverlay.ts:238
  Parameters
  - sizeOffsets: { bottom: number; top: number }
    - bottom: number
    - top: number
  Returns void
setUnsupportedDeviceOverlay:function
- setUnsupportedDeviceOverlay(__namedParameters: { allowed: TargetOs[]; detected: TargetOs }): void
- - Defined in app/createOverlay.ts:199
  Parameters
  - __namedParameters: { allowed: TargetOs[]; detected: TargetOs }
    - allowed: TargetOs[]
    - detected: TargetOs
  Returns void
share:function
- share(shareType: ShareType, options: ShareOptions): Promise<boolean>
- - Defined in app/createOverlay.ts:178
  Parameters
  - shareType: ShareType
  - options: ShareOptions
  Returns Promise<boolean>
showOrientationOverlay:function
- showOrientationOverlay(orientationRequired: GameOrientation): void
- - Defined in app/createOverlay.ts:192
  Parameters
  - orientationRequired: GameOrientation
  Returns void
showPreAdCountdownOverlay:function
- showPreAdCountdownOverlay(): void
- - Defined in app/createOverlay.ts:212
  Returns void
showPreAdCountdownOverlayFinish:function
- showPreAdCountdownOverlayFinish(wasInFullscreen: boolean): Promise<any>
- - Defined in app/createOverlay.ts:218
  Parameters
  - wasInFullscreen: boolean
  Returns Promise<any>
showRewardedFailedOverlay:function
- showRewardedFailedOverlay(): Promise<any>
- - Defined in app/createOverlay.ts:228
  Returns Promise<any>
unlockAchievement:function
- unlockAchievement(achievement: Achievement): void
- - Defined in app/createOverlay.ts:143
  Parameters
  - achievement: Achievement
  Returns void

payments

payments: Payments

Payments manager

platform

platform: Platform

Platform info

player

player: MyPlayer

Player manager

players

players: Players

Players manager

projectId

projectId: number

ready

ready: Promise<GamePush>

Resolves when all platform and project data was loaded

platform SDK loaded

rewards

rewards: default

Rewards manager

schedulers

schedulers: default

Schedulers manager

segments

segments: Segments

Segments manager

setBackground

setBackground: ((__namedParameters: Partial<BackgroundSettings>) => void) = setBackground

Type declaration

- (__namedParameters: Partial<BackgroundSettings>): void
- Parameters
  - __namedParameters: Partial<BackgroundSettings>
  Returns void

socials

socials: Socials

Socials manager

triggers

triggers: default

Triggers manager

variables

variables: GameVariables

Game variables manager

Accessors

_overlaySizeOffsets

get _overlaySizeOffsets(): { bottom: number; top: number }

- Defined in GamePush.ts:664
Returns { bottom: number; top: number }
- bottom: number
- top: number

isAllowedOrigin

get isAllowedOrigin(): boolean

- Defined in GamePush.ts:602
Is on development origin

Returns boolean

isDev

get isDev(): boolean

- Defined in GamePush.ts:595
Is on development origin

Returns boolean

isPortrait

get isPortrait(): boolean

- Defined in GamePush.ts:613
Returns boolean

locale

get locale(): string

- Defined in GamePush.ts:609
Language locale

Returns string

nativeSDK

get nativeSDK(): any

- Defined in GamePush.ts:581
SDK provided by the platform

Returns any

serverTime

get serverTime(): string

- Defined in GamePush.ts:588
Server time in ISO 8601 format

Returns string

Methods

Private #checkDeviceCompatibility

#checkDeviceCompatibility(): Promise<void>

- Defined in GamePush.ts:761
Returns Promise<void>

Private #initOrientation

#initOrientation(): void

- Defined in GamePush.ts:737
Returns void

Private #setup

#setup(): Promise<void>

- Defined in GamePush.ts:345
Returns Promise<void>

changeAvatarGenerator

changeAvatarGenerator(): Promise<void>

- Defined in GamePush.ts:691
Returns Promise<void>

changeLanguage

changeLanguage(lang: Lang): Promise<void>

- Defined in GamePush.ts:671
Parameters
- lang: Lang
Returns Promise<void>

gameStart

gameStart(): Promise<void>

- Defined in GamePush.ts:713
Returns Promise<void>

gameplayStart

gameplayStart(): Promise<void>

- Defined in GamePush.ts:721
Returns Promise<void>

gameplayStop

gameplayStop(): Promise<void>

- Defined in GamePush.ts:729
Returns Promise<void>

generateAvatar

generateAvatar(hash: any, size: number): string

- Defined in GamePush.ts:695
Parameters
- hash: any
- size: number
Returns string

Private init

init(transaction: Transaction<GamePush>): Promise<void>

- Defined in GamePush.ts:620
Parameters
- transaction: Transaction<GamePush>
Returns Promise<void>

loadOverlay

loadOverlay(): Promise<void>

- Defined in GamePush.ts:653
You can preload overlay to fast open when required

Returns Promise<void>

off

off<ET>(type: ET, handler: ((event: GPEvents[ET]) => void)): void

Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12
Type Parameters
- ET extends keyof GPEvents
Parameters
- type: ET
- handler: ((event: GPEvents[ET]) => void)
  - - (event: GPEvents[ET]): void
    - Parameters
      - event: GPEvents[ET]
      Returns void
Returns void

on

on<ET>(type: ET, handler: ((event: GPEvents[ET]) => void)): void

Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9
Type Parameters
- ET extends keyof GPEvents
Parameters
- type: ET
- handler: ((event: GPEvents[ET]) => void)
  - - (event: GPEvents[ET]): void
    - Parameters
      - event: GPEvents[ET]
      Returns void
Returns void

once

once<ET>(type: ET, handler: ((event: GPEvents[ET]) => void)): void

Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15
Type Parameters
- ET extends keyof GPEvents
Parameters
- type: ET
- handler: ((event: GPEvents[ET]) => void)
  - - (event: GPEvents[ET]): void
    - Parameters
      - event: GPEvents[ET]
      Returns void
Returns void

pause

pause(): void

- Defined in GamePush.ts:699
Returns void

resume

resume(): void

- Defined in GamePush.ts:706
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GamePush

Properties

Private #apiClient

Private #debugConfig

Private #projectConfig

Private #serverTime

Private _achievementsService

Private _channelsService

Private _documentsService

Private _events

Private _eventsService

Private _filesService

Private _gamesCollectionsService

Private _imagesService

Private _leaderboardsService

Private _paymentsService

Private _playerService

_pointersManager

Private _projectService

Private _rewardsService

Private _schedulersService

Private _storage

achievements

ads

analytics

app

avatarGenerator

avatarGeneratorTemplate

channels

device

devtools

Type declaration

addShortcut:function

Returns Promise<boolean>

changeLanguage:function

Parameters

language: Lang

Returns Promise<void>

closeSticky:function

Returns void

purchaseProduct:function

Parameters

product: Product

Returns Promise<boolean>

requestReview:function

Returns Promise<RequestReviewResult>

resumeSubscription:function

Parameters

product: Product

purchase: PlayerPurchase

Returns Promise<boolean>

showCounter:function

Parameters

apiReqCounter: number

Returns void

showFullscreen:function

Returns Promise<boolean>

showPreloader:function

Returns Promise<boolean>

showRewardedVideo:function

Returns Promise<boolean>

showSticky:function

Returns Promise<boolean>

showToast:function

Parameters

__namedParameters: Toast

Returns void

unsubscribe:function

Parameters

product: Product

purchase: PlayerPurchase

Returns Promise<boolean>