import {ShapezGameAnalytics} from 'shapez.io/js/platform/browser/game_analytics.js'

public class | source

ShapezGameAnalytics

Extends:

GameAnalyticsInterface → ShapezGameAnalytics

Member Summary

Public Members
public get	environment: string
public	syncKey: *

Method Summary

Public Methods
public	generateGameDump(root: GameRoot): {"shapes": , "upgrades": , "belts": , "buildings": } Generates a game dump
public	handleGameResumed()
public	handleGameStarted()
public	handleLevelCompleted(level: number) Handles the given level completed
public	handleUpgradeUnlocked(id: string, level: number) Handles the given upgrade completed
public	initialize(): Promise<void>
public	isInterestingShape(root: GameRoot, key: string): boolean Returns true if the shape is interesting
public	sendGameEvent(category: string, value: string) Sends a game event to the analytics
public	sendTimePoints()
public	sendToApi(endpoint: string, data: object): Promise<any> Sends a request to the api

Inherited Summary

From class GameAnalyticsInterface
public	app: import("../application").Application
public	handleGameResumed() Handles a resumed game
public	handleGameStarted() Handles a new game which was started
public	handleLevelCompleted(level: number) Handles the given level completed
public	handleUpgradeUnlocked(id: string, level: number) Handles the given upgrade completed
public	initialize(): Promise<void> Initializes the analytics

Public Members

public get environment: string source

public syncKey: * source

Public Methods

public generateGameDump(root: GameRoot): {"shapes": , "upgrades": , "belts": , "buildings": } source

Generates a game dump

Params:

Name	Type	Attribute	Description
root	GameRoot

Return:

{"shapes": *, "upgrades": *, "belts": *, "buildings": *}

public handleGameResumed() source

Handles a resumed game

Override:

GameAnalyticsInterface#handleGameResumed

public handleGameStarted() source

Handles a new game which was started

Override:

GameAnalyticsInterface#handleGameStarted

public handleLevelCompleted(level: number) source

Handles the given level completed

Override:

GameAnalyticsInterface#handleLevelCompleted

Params:

Name	Type	Attribute	Description
level	number

public handleUpgradeUnlocked(id: string, level: number) source

Handles the given upgrade completed

Override:

GameAnalyticsInterface#handleUpgradeUnlocked

Params:

Name	Type	Attribute	Description
id	string
level	number

public initialize(): Promise<void> source

Initializes the analytics

Override:

GameAnalyticsInterface#initialize

Return:

Promise<void>

public isInterestingShape(root: GameRoot, key: string): boolean source

Returns true if the shape is interesting

Params:

Name	Type	Attribute	Description
root	GameRoot
key	string

Return:

boolean

public sendGameEvent(category: string, value: string) source

Sends a game event to the analytics

Params:

Name	Type	Attribute	Description
category	string
value	string

public sendTimePoints() source

public sendToApi(endpoint: string, data: object): Promise<any> source

Sends a request to the api

Params:

Name	Type	Attribute	Description
endpoint	string		Endpoint without base url
data	object		payload

Return:

Promise<any>

ShapezGameAnalytics

Extends:

Member Summary

Method Summary

Inherited Summary

Public Members

public get environment: string source

public syncKey: * source

Public Methods

public generateGameDump(root: GameRoot): {"shapes": *, "upgrades": *, "belts": *, "buildings": *} source

Params:

Return:

public handleGameResumed() source

Override:

public handleGameStarted() source

Override:

public handleLevelCompleted(level: number) source

Override:

Params:

public handleUpgradeUnlocked(id: string, level: number) source

Override:

Params:

public initialize(): Promise<void> source

Override:

Return:

public isInterestingShape(root: GameRoot, key: string): boolean source

Params:

Return:

public sendGameEvent(category: string, value: string) source

Params:

public sendTimePoints() source

public sendToApi(endpoint: string, data: object): Promise<any> source

Params:

Return:

public generateGameDump(root: GameRoot): {"shapes": , "upgrades": , "belts": , "buildings": } source