import {InGameState} from 'shapez.io/js/states/ingame.js'

public class | source

InGameState

Extends:

GameState → InGameState

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	boundInputFilter: *
public	core: GameCore
public	creationPayload: GameCreationPayload
public	currentSavePromise: * Whether we are currently saving the game @TODO: This doesn't realy fit here
public	keyActionMapper: KeyActionMapper
public	loadingOverlay: GameLoadingOverlay
public	savegame: Savegame
public	stage: string
public	syncer: *
public	warmupTimeSeconds: *

Method Summary

Public Methods
public	doSave(): * Saves the game
public	filterInput(): * Filters the input (keybindings)
public	getHasFadeIn(): boolean
public	getHasUnloadConfirmation(): boolean
public	getInnerHTML(): string
public	getPauseOnFocusLost(): boolean
public	getThemeMusic(): *
public	goBackToMenu() Goes back to the menu state
public	goToKeybindings() Goes back to the settings state
public	goToSettings() Goes back to the settings state
public	onAppPause()
public	onBackButton()
public	onBackgroundTick(dt: *)
public	onBeforeExit()
public	onEnter(payload: GameCreationPayload)
public	onInitializationFailure(err: string) Called when the game somehow failed to initialize.
public	onLeave()
public	onRender(dt: number) Render callback
public	onResized(w: , h: )
public	saveThenGoToState(stateId: string, payload: any=) Moves to a state outside of the game
public	stage10GameRunning() The final stage where this game is running and updating regulary.
public	stage3CreateCore() Creates the game core instance, and thus the root
public	stage4aInitEmptyGame() Initializes a new empty game
public	stage4bResumeGame() Resumes an existing game
public	stage5FirstUpdate() Performs the first game update on the game which initializes most caches
public	stage6PostLoadHook() Call the post load hook, this means that we have loaded the game, and all systems can operate and start to work now.
public	stage7Warmup() This makes the game idle and draw for a while, because we run most code this way the V8 engine can already start to optimize it.
public	stageDestroyed() This stage destroys the whole game, used to cleanup
public	stageLeavingGame() When leaving the game
public	switchStage(stage: string): boolean Switches the game into another sub-state

Inherited Summary

From class GameState
public	app: Application
public	asyncChannel: *
public	clickDetectors: Array<ClickDetectorConstructorArgs>
public	fadingOut: boolean
public	htmlElement: *
public	inputReciever: *
public	key: *
public	stateManager: StateManager
public	cancelAllAsyncOperations() Cancels all promises on the api as well as our async channel
public	getDivElement(): HTMLElement Returns the html element of the state
public	getHasFadeIn(): boolean Should return whether to fade in the game state.
public	getHasFadeOut(): boolean Should return whether to fade out the game state.
public	getHasUnloadConfirmation(): boolean Returns if the state has an unload confirmation, this is the "Are you sure you want to leave the page" message.
public	getInOutFadeTime(): number Should return how many mulliseconds to fade in / out the state.
public	getInnerHTML(): string Should return the html code of the state.
public	getKey(): string Returns the states key
public	getPauseOnFocusLost(): boolean Returns if this state should get paused if it does not have focus
public	getThemeMusic(): string \| null Should return the theme music for this state
public	internalCleanUpClickDetectors() Cleans up all click detectors
public	internalEnterCallback(payload: any, callCallback: boolean) Internal callback when entering the state.
public	internalGetFadeInOutTime(): number Internal method to compute the time to fade in / out
public	internalGetFullHtml(): string Internal method to get the HTML of the game state.
public	internalLeaveCallback() Internal callback when the state is left.
public	internalOnAppPauseCallback() Internal app pause callback
public	internalOnAppResumeCallback() Internal app resume callback
public	internalOnBeforeExitCallback() Internal callback before the state is left.
public	internalRegisterCallback(stateManager: StateManager) Internal callback from the manager.
public	moveToState(stateKey: string) Transfers to a new state
public	onAppPause() Callback when the app got paused (on android, this means in background)
public	onAppResume() Callback when the app got resumed (on android, this means in foreground again)
public	onBackButton() Internal backbutton handler, called when the hardware back button is pressed or the escape key is pressed
public	onBackgroundTick(dt: number) Background tick callback, called while the game is inactiev
public	onBeforeExit() 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	onLeave() Callback when leaving the state
public	onRender(dt: number) Render callback
public	onResized(w: number, h: number) 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=)

Public Constructors

public constructor() source

Constructs a new state with the given id

Override:

GameState#constructor

Public Members

public boundInputFilter: * source

public core: GameCore source

public creationPayload: GameCreationPayload source

public currentSavePromise: * source

Whether we are currently saving the game @TODO: This doesn't realy fit here

public keyActionMapper: KeyActionMapper source

public loadingOverlay: GameLoadingOverlay source

public savegame: Savegame source

public stage: string source

public syncer: * source

public warmupTimeSeconds: * source

Public Methods

public doSave(): * source

Saves the game

Return:

public filterInput(): * source

Filters the input (keybindings)

Return:

public getHasFadeIn(): boolean source

Should return whether to fade in the game state. This will then apply the right css classes for the fadein.

Override:

GameState#getHasFadeIn

Return:

boolean

public getHasUnloadConfirmation(): boolean source

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

Override:

GameState#getHasUnloadConfirmation

Return:

boolean

public getInnerHTML(): string source

Should return the html code of the state.

Override:

GameState#getInnerHTML

Return:

string

public getPauseOnFocusLost(): boolean source

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

Override:

GameState#getPauseOnFocusLost

Return:

boolean

public getThemeMusic(): * source

Should return the theme music for this state

Override:

GameState#getThemeMusic

Return:

public goBackToMenu() source

Goes back to the menu state

public goToKeybindings() source

Goes back to the settings state

public goToSettings() source

Goes back to the settings state

public onAppPause() source

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

Override:

GameState#onAppPause

public onBackButton() source

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

Override:

GameState#onBackButton

public onBackgroundTick(dt: *) source

Background tick callback, called while the game is inactiev

Override:

GameState#onBackgroundTick

Params:

Name	Type	Attribute	Description
dt	*

public onBeforeExit() source

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

Override:

GameState#onBeforeExit

public onEnter(payload: GameCreationPayload) source

Callback when entering the state, to be overriddemn

Override:

GameState#onEnter

Params:

Name	Type	Attribute	Description
payload	GameCreationPayload

public onInitializationFailure(err: string) source

Called when the game somehow failed to initialize. Resets everything to basic state and then goes to the main menu, showing the error

Params:

Name	Type	Attribute	Description
err	string

public onLeave() source

Callback when leaving the state

Override:

GameState#onLeave

public onRender(dt: number) source

Render callback

Override:

GameState#onRender

Params:

Name	Type	Attribute	Description
dt	number

public onResized(w: , h: ) source

Called when the screen resized

Override:

GameState#onResized

Params:

Name	Type	Attribute	Description
w	*
h	*

public saveThenGoToState(stateId: string, payload: any=) source

Moves to a state outside of the game

Params:

Name	Type	Attribute	Description
stateId	string
payload	any=

public stage10GameRunning() source

The final stage where this game is running and updating regulary.

public stage3CreateCore() source

Creates the game core instance, and thus the root

public stage4aInitEmptyGame() source

Initializes a new empty game

public stage4bResumeGame() source

Resumes an existing game

public stage5FirstUpdate() source

Performs the first game update on the game which initializes most caches

public stage6PostLoadHook() source

Call the post load hook, this means that we have loaded the game, and all systems can operate and start to work now.

public stage7Warmup() source

This makes the game idle and draw for a while, because we run most code this way the V8 engine can already start to optimize it. Also this makes sure the resources are in the VRAM and we have a smooth experience once we start.

public stageDestroyed() source

This stage destroys the whole game, used to cleanup

public stageLeavingGame() source

When leaving the game

public switchStage(stage: string): boolean source

Switches the game into another sub-state

Params:

Name	Type	Attribute	Description
stage	string

Return:

boolean

InGameState

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public boundInputFilter: * source

public core: GameCore source

public creationPayload: GameCreationPayload source

public currentSavePromise: * source

public keyActionMapper: KeyActionMapper source

public loadingOverlay: GameLoadingOverlay source

public savegame: Savegame source

public stage: string source

public syncer: * source

public warmupTimeSeconds: * source

Public Methods

public doSave(): * source

Return:

public filterInput(): * source

Return:

public getHasFadeIn(): boolean source

Override:

Return:

public getHasUnloadConfirmation(): boolean source

Override:

Return:

public getInnerHTML(): string source

Override:

Return:

public getPauseOnFocusLost(): boolean source

Override:

Return:

public getThemeMusic(): * source

Override:

Return:

public goBackToMenu() source

public goToKeybindings() source

public goToSettings() source

public onAppPause() source

Override:

public onBackButton() source

Override:

public onBackgroundTick(dt: *) source

Override:

Params:

public onBeforeExit() source

Override:

public onEnter(payload: GameCreationPayload) source

Override:

Params:

public onInitializationFailure(err: string) source

Params:

public onLeave() source

Override:

public onRender(dt: number) source

Override:

Params:

public onResized(w: *, h: *) source

Override:

Params:

public saveThenGoToState(stateId: string, payload: any=) source

Params:

public stage10GameRunning() source

public stage3CreateCore() source

public stage4aInitEmptyGame() source

public stage4bResumeGame() source

public stage5FirstUpdate() source

public stage6PostLoadHook() source

public stage7Warmup() source

public stageDestroyed() source

public stageLeavingGame() source

public switchStage(stage: string): boolean source

Params:

Return:

public onResized(w: , h: ) source