import {GameRoot} from 'shapez.io/js/game/root.js'

public class | source

GameRoot

The game root is basically the whole game state at a given point, combining all important classes. We don't have globals, but this class is passed to almost all game classes.

Constructor Summary

Public Constructor
public	constructor(app: Application) Constructs a new game root

Member Summary

Public Members
public	app: *
public	automaticSave: AutomaticSave
public	buffers: BufferMaintainer
public	bulkOperationRunning: boolean Whether a bulk operation is running
public	camera: Camera
public	canvas: HTMLCanvasElement
public	context: CanvasRenderingContext2D
public	currentLayer: Layer
public	dynamicTickrate: DynamicTickrate
public	entityMgr: EntityManager
public	gameHeight: number
public	gameInitialized: boolean
public	gameIsFresh: boolean
public	gameMode: GameMode
public	gameState: InGameState
public	gameWidth: number
public	hubGoals: HubGoals
public	hud: GameHUD
public	keyMapper: KeyActionMapper
public	logic: GameLogic
public	logicInitialized: boolean
public	map: MapView
public	productionAnalytics: ProductionAnalytics
public	queue: {"requireRedraw": *}
public	rngs: Object<string, Object<string, RandomNumberGenerator>>
public	savegame: Savegame
public	shapeDefinitionMgr: ShapeDefinitionManager
public	signals: {"entityManuallyPlaced": , "entityAdded": , "entityChanged": , "entityGotNewComponent": , "entityComponentRemoved": , "entityQueuedForDestroy": , "entityDestroyed": , "resized": , "readyToRender": , "aboutToDestruct": , "gameSaved": , "gameRestored": , "gameFrameStarted": , "storyGoalCompleted": , "upgradePurchased": , "postLoadHook": , "shapeDelivered": , "itemProduced": , "bulkOperationFinished": , "editModeChanged": , "prePlacementCheck": , "freeEntityAreaBeforeBuild": }
public	soundProxy: SoundProxy
public	systemMgr: GameSystemManager
public	time: GameTime

Method Summary

Public Methods
public	destruct() Destructs the game root
public	reset() Resets the whole root and removes all properties

Public Constructors

public constructor(app: Application) source

Constructs a new game root

Params:

Name	Type	Attribute	Description
app	Application

Public Members

public app: * source

public automaticSave: AutomaticSave source

public buffers: BufferMaintainer source

public bulkOperationRunning: boolean source

Whether a bulk operation is running

public camera: Camera source

public canvas: HTMLCanvasElement source

public context: CanvasRenderingContext2D source

public currentLayer: Layer source

public dynamicTickrate: DynamicTickrate source

public entityMgr: EntityManager source

public gameHeight: number source

public gameInitialized: boolean source

public gameIsFresh: boolean source

public gameMode: GameMode source

public gameState: InGameState source

public gameWidth: number source

public hubGoals: HubGoals source

public hud: GameHUD source

public keyMapper: KeyActionMapper source

public logic: GameLogic source

public logicInitialized: boolean source

public map: MapView source

public productionAnalytics: ProductionAnalytics source

public queue: {"requireRedraw": *} source

public rngs: Object<string, Object<string, RandomNumberGenerator>> source

public savegame: Savegame source

public shapeDefinitionMgr: ShapeDefinitionManager source

public signals: {"entityManuallyPlaced": , "entityAdded": , "entityChanged": , "entityGotNewComponent": , "entityComponentRemoved": , "entityQueuedForDestroy": , "entityDestroyed": , "resized": , "readyToRender": , "aboutToDestruct": , "gameSaved": , "gameRestored": , "gameFrameStarted": , "storyGoalCompleted": , "upgradePurchased": , "postLoadHook": , "shapeDelivered": , "itemProduced": , "bulkOperationFinished": , "editModeChanged": , "prePlacementCheck": , "freeEntityAreaBeforeBuild": } source