Home Reference Source

import {PlatformWrapperInterface} from 'shapez.io/js/platform/wrapper.js'

public class | source

PlatformWrapperInterface

Direct Subclass:

PlatformWrapperImplBrowser

Indirect Subclass:

PlatformWrapperImplElectron

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	app: Application

Method Summary

Public Methods
public	exitApp() Attempts to quit the app
public	getId(): string
public	getMaximumZoom(): number Should return the maximum supported zoom level
public	getMinimumZoom(): number Should return the minimum supported zoom level
public	getScreenScale(): *
public	getSupportsAds(): boolean Should return if this platform supports ads at all
public	getSupportsAppExit(): boolean Returns whether this platform supports quitting the app
public	getSupportsFullscreen(): boolean Returns whether this platform supports a toggleable fullscreen
public	getSupportsKeyboard(): * Whether this platform supports a keyboard
public	getSupportsRestart(): boolean
public	getTouchPanStrength(): number Returns the strength of touch pans with the mouse
public	getUiScale(): number Returns the UI scale, called on every resize
public	initialize(): Promise<void>
public	initializeAdProvider(): Promise<void> Should initialize the apps ad provider in case supported
public	openExternalLink(url: string, force: boolean=) Attempt to open an external url
public	performRestart() Attempt to restart the app
public	setFullscreen(flag: boolean) Should set the apps fullscreen state to the desired state

Public Constructors

public constructor() source

Public Members

public app: Application source

Public Methods

public exitApp() source

Attempts to quit the app

public getId(): string source

Return:

public getMaximumZoom(): number source

Should return the maximum supported zoom level

Return:

public getMinimumZoom(): number source

Should return the minimum supported zoom level

Return:

public getScreenScale(): * source

Return:

*

public getSupportsAds(): boolean source

Should return if this platform supports ads at all

Return:

public getSupportsAppExit(): boolean source

Returns whether this platform supports quitting the app

Return:

public getSupportsFullscreen(): boolean source

Returns whether this platform supports a toggleable fullscreen

Return:

public getSupportsKeyboard(): * source

Whether this platform supports a keyboard

Return:

*

public getSupportsRestart(): boolean source

Return:

public getTouchPanStrength(): number source

Returns the strength of touch pans with the mouse

Return:

public getUiScale(): number source

Returns the UI scale, called on every resize

Return:

public initialize(): Promise<void> source

Return:

public initializeAdProvider(): Promise<void> source

Should initialize the apps ad provider in case supported

Return:

public openExternalLink(url: string, force: boolean=) source

Attempt to open an external url

Params:

Name	Type	Attribute	Description
url	string
force	boolean=		Whether to always open the url even if not allowed

public performRestart() source

Attempt to restart the app

public setFullscreen(flag: boolean) source

Should set the apps fullscreen state to the desired state

Params:

Name	Type	Attribute	Description
flag	boolean