Home Reference Source
import {AboutState} from 'shapez.io/js/states/about.js'
public class | source

AboutState

Extends:

GameStateTextualGameState → AboutState

Constructor Summary

Public Constructor
public

Method Summary

Public Methods
public
public
public
public

Inherited Summary

From class GameState
public
public
public
public
public
public
public

key: *

public
public

Cancels all promises on the api as well as our async channel

public

getDivElement(): HTMLElement

Returns the html element of the state

public

Should return whether to fade in the game state.

public

Should return whether to fade out the game state.

public

Returns if the state has an unload confirmation, this is the "Are you sure you want to leave the page" message.

public

Should return how many mulliseconds to fade in / out the state.

public

Should return the html code of the state.

public

Returns the states key

public

Returns if this state should get paused if it does not have focus

public

Should return the theme music for this state

public

Cleans up all click detectors

public

internalEnterCallback(payload: any, callCallback: boolean)

Internal callback when entering the state.

public

Internal method to compute the time to fade in / out

public

Internal method to get the HTML of the game state.

public

Internal callback when the state is left.

public

Internal app pause callback

public

Internal app resume callback

public

Internal callback before the state is left.

public

Internal callback from the manager.

public

moveToState(stateKey: string)

Transfers to a new state

public

Callback when the app got paused (on android, this means in background)

public

Callback when the app got resumed (on android, this means in foreground again)

public

Internal backbutton handler, called when the hardware back button is pressed or the escape key is pressed

public

Background tick callback, called while the game is inactiev

public

Callback before leaving the game state or when the page is unloaded

public

onEnter(payload: any)

Callback when entering the state, to be overriddemn

public

Callback when leaving the state

public

Render callback

public

Called when the screen resized

public

trackClicks(element: Element, handler: function(): void, args: import("./click_detector").ClickDetectorConstructorArgs=)

Tracks clicks on a given element and calls the given callback on this state.

public

watchAdAndMoveToState(nextStateId: string, nextStatePayload: object=)

From class TextualGameState
public
public
public
public

dialogs: *

public
public

Removes all click detectors, except the one on the back button.

public

Returns the default state to go back to

public

Should return the states inner html.

public

Should return the states HTML content.

public

Should return the title of the game state.

public

internalEnterCallback(payload: any)

Overrides the GameState enter callback to setup required stuff

public

Overrides the GameState implementation to provide our own html

public

Overrides the GameState leave callback to cleanup stuff

public

moveToStateAddGoBack(stateId: string, payload: object)

Goes to a new state, telling him to go back to this state later

public

Back button handler, can be overridden.

Public Constructors

public constructor() source

Constructs a new state with the given id

Override:

GameState#constructor

Public Methods

public getDefaultPreviousState(): string source

Returns the default state to go back to

Override:

TextualGameState#getDefaultPreviousState

Return:

string

public getMainContentHTML(): string source

Should return the states HTML content.

Override:

TextualGameState#getMainContentHTML

Return:

string

public getStateHeaderTitle(): * source

Should return the title of the game state. If null, no title and back button will get created

Override:

TextualGameState#getStateHeaderTitle

Return:

*

public onEnter() source

Callback when entering the state, to be overriddemn

Override:

GameState#onEnter