Home Reference Source

Variable

Static Public Summary
public
public
public
public
public
public

CHANGELOG: Array<{version: string, date: string, entries: Array<String>}>

public
public
public
public
public

Used for the bug reporter, and the click detector which both have no handles to this.

public
public

IS_MAC: *

public
public
public
public
public

KEYMAPPINGS: {"general": *, "ingame": *, "navigation": *, "buildings": *, "placement": *, "massSelect": *, "placementModifiers": *}

public

LANGUAGES: Object<string, {name: string, data: any, code: string, region: string}>

public
public
public

MUSIC: {"theme": *, "menu": string}

public
public
public

SOUNDS: {"uiClick": string, "uiError": string, "dialogError": string, "dialogOk": string, "swishHide": string, "swishShow": string, "badgeNotification": string, "levelComplete": string, "destroyBuilding": string, "placeBuilding": string, "placeBelt": string, "copy": string}

public
public
public

T: *

public

THEME: *

public

THIRDPARTY_URLS: {"discord": string, "github": string, "reddit": string, "shapeViewer": string, "standaloneStorePage": string, "levelTutorialVideos": *}

public
public
public
public

VANILLA_THEMES: {"dark": *, "light": *}

public
public
public

atlasFiles: AtlasDefinition[]

public
public

clickDetectorGlobals: {"lastTouchTime": *}

public

codes: {"1": *, "2": *, "3": *, "4": *, "5": *, "6": *, "47": *, "48": *, "7": *, "8": *, "9": *, "10": *, "11": *, "12": *, "13": *, "14": *, "15": *, "16": *, "17": *, "18": *, "19": *, "20": *, "21": *, "22": *, "23": *, "24": *, "25": *, "26": *, "27": *, "28": *, "29": *, "30": *, "52": *, "53": *, "54": *, "55": *, "31": *, "32": *, "34": *, "35": *, "36": *, "38": *, "60": *, "33": *, "37": *, "39": *, "40": *, "42": *, "44": *, "45": *, "50": *, "51": *, "46": *, "43": *, "49": *, "61": *}

public
public
public

enumAnalyticsDataSource: {"produced": string, "stored": string, "delivered": string}

public

enumAngleToDirection: {"0": *, "90": *, "180": *, "270": *}

public

enumCategories: {"general": string, "userInterface": string, "performance": string, "advanced": string, "debug": string}

public

enumClippedBeltUnderlayType: {"full": string, "bottomOnly": string, "topOnly": string, "none": string}

Store which type an underlay is, this is cached so we can easily render it.

public

enumColorMixingResults: {"undefined": *}

public

enumColorToShortcode: {"undefined": string}

public

enumColors: {"red": string, "green": string, "blue": string, "yellow": string, "purple": string, "cyan": string, "white": string, "uncolored": string}

public

enumColorsToHexCode: {"undefined": string}

public

enumDirection: {"top": string, "right": string, "bottom": string, "left": string}

public

enumDirectionToAngle: {"undefined": number}

public

enumDirectionToVector: {"top": *, "right": *, "bottom": *, "left": *}

Mapping from string direction to actual vector

public

enumDisplayMode: {"icons": string, "detailed": string}

public

enumHubGoalRewards: {"reward_cutter_and_trash": string, "reward_rotater": string, "reward_painter": string, "reward_mixer": string, "reward_stacker": string, "reward_balancer": string, "reward_tunnel": string, "reward_rotater_ccw": string, "reward_rotater_180": string, "reward_miner_chainable": string, "reward_underground_belt_tier_2": string, "reward_belt_reader": string, "reward_splitter": string, "reward_cutter_quad": string, "reward_painter_double": string, "reward_storage": string, "reward_merger": string, "reward_wires_painter_and_levers": string, "reward_display": string, "reward_constant_signal": string, "reward_logic_gates": string, "reward_virtual_processing": string, "reward_filter": string, "reward_demo_end": string, "reward_blueprints": string, "reward_freeplay": string, "no_reward": string, "no_reward_freeplay": string}

Don't forget to also update tutorial_goals_mappings.js as well as the translations!

public

Stores which reward unlocks what

public

enumInvertedDirections: {"undefined": *}

public
public

enumItemProcessorTypes: {"balancer": string, "cutter": string, "cutterQuad": string, "rotater": string, "rotaterCCW": string, "rotater180": string, "stacker": string, "trash": string, "mixer": string, "painter": string, "painterDouble": string, "painterQuad": string, "hub": string, "filter": string, "reader": string}

public

enumLocalSavegameStatus: {"offline": string, "synced": string}

public

enumLogicGateType: {"and": string, "not": string, "xor": string, "or": string, "transistor": string, "analyzer": string, "rotater": string, "unstacker": string, "cutter": string, "compare": string, "stacker": string, "painter": string}

public

enumMouseButton: {"left": string, "middle": string, "right": string}

public

enumNotificationType: {"saved": string, "upgrade": string, "success": string}

public

enumPinSlotType: {"logicalEjector": string, "logicalAcceptor": string}

public

enumSavePriority: {"regular": number, "asap": number}

public
public
public

enumSubShape: {"rect": string, "circle": string, "star": string, "windmill": string}

public
public

enumUndergroundBeltMode: {"sender": string, "receiver": string}

public

enumWireType: {"forward": string, "turn": string, "split": string, "cross": string}

public

Stores a lookup table for all building variants (for better performance)

public

gBuildingsByCategory: Object<string, Array<Class<import("../game/meta_building").MetaBuilding>>>

public

gComponentRegistry: FactoryTemplate<import("../game/component").Component>

public

gGameModeRegistry: FactoryTemplate<GameMode>

public

gGameSpeedRegistry: FactoryTemplate<import("../game/time/base_game_speed").BaseGameSpeed>

public

gItemRegistry: FactoryTemplate<import("../game/base_item").BaseItem>

public

gMetaBuildingRegistry: SingletonFactoryTemplate<import("../game/meta_building").MetaBuilding>

public

gameCreationAction: {"new": string, "resume": string}

public

globalConfig: {"tileSize": number, "halfTileSize": number, "assetsDpi": *, "assetsSharpness": number, "shapesSharpness": number, "statisticsGraphDpi": number, "statisticsGraphSlices": number, "analyticsSliceDurationSeconds": *, "minimumTickRate": number, "maximumTickRate": number, "mapChunkSize": number, "mapChunkOverviewMinZoom": number, "mapChunkWorldSize": *, "beltSpeedItemsPerSecond": number, "minerSpeedItemsPerSecond": *, "defaultItemDiameter": number, "itemSpacingOnBelts": number, "wiresSpeedItemsPerSecond": number, "undergroundBeltMaxTilesByTier": *, "readerAnalyzeIntervalSeconds": number, "buildingSpeeds": *, "initialZoom": number, "minZoomLevel": number, "maxZoomLevel": number, "gameSpeed": number, "warmupTimeSecondsFast": number, "warmupTimeSecondsRegular": number, "smoothing": *, "rendering": *, "debug": *, "info": *}

public
public

layers: Array<Layer>

public
public

queryParamOptions: {"embedProvider": *, "fullVersion": *, "sandboxMode": *}

public

savegameInterfaces: Object<any, typeof BaseSavegameInterface>

public
public

Stores how many seconds one unit is

public
public

types: {"int": *, "uint": *, "float": *, "ufloat": *, "string": *, "entity": *, "weakEntityRef": *, "vector": *, "tileVector": *, "bool": *, "nullable": function, "classId": function, "keyValueMap": function, "enum": function, "obj": function, "objData": function, "knownType": function, "array": function, "fixedSizeArray": function, "classRef": function, "structured": function, "pair": function, "classWithMetaclass": function}

public

Static Public

public APPLICATION_ERROR_OCCURED: boolean source

import {APPLICATION_ERROR_OCCURED} from 'shapez.io/js/core/error_handler.js'
import {A_B_TESTING_LINK_TYPE} from 'shapez.io/js/core/config.js'

public BELT_ANIM_COUNT: number source

import {BELT_ANIM_COUNT} from 'shapez.io/js/game/systems/belt.js'

public BOOL_FALSE_SINGLETON: BooleanItem source

import {BOOL_FALSE_SINGLETON} from 'shapez.io/js/game/items/boolean_item.js'

public BOOL_TRUE_SINGLETON: BooleanItem source

import {BOOL_TRUE_SINGLETON} from 'shapez.io/js/game/items/boolean_item.js'

public CHANGELOG: Array<{version: string, date: string, entries: Array<String>}> source

import {CHANGELOG} from 'shapez.io/js/changelog.js'

public CHUNK_OVERLAY_RES: number source

import {CHUNK_OVERLAY_RES} from 'shapez.io/js/game/map_chunk_view.js'

public CRC_PREFIX: * source

public FILE_NOT_FOUND: string source

import {FILE_NOT_FOUND} from 'shapez.io/js/platform/storage.js'

public FULL_CLIP_RECT: Rectangle source

import {FULL_CLIP_RECT} from 'shapez.io/js/core/sprites.js'

public GLOBAL_APP: Application source

import {GLOBAL_APP} from 'shapez.io/js/core/globals.js'

Used for the bug reporter, and the click detector which both have no handles to this. It would be nicer to have no globals, but this is the only one. I promise!

public IS_DEBUG: * source

import {IS_DEBUG} from 'shapez.io/js/core/config.js'

public IS_MAC: * source

import {IS_MAC} from 'shapez.io/js/core/config.js'

public IS_MOBILE: * source

import {IS_MOBILE} from 'shapez.io/js/core/config.js'

public KEYCODE_LMB: number source

import {KEYCODE_LMB} from 'shapez.io/js/game/key_action_mapper.js'

public KEYCODE_MMB: number source

import {KEYCODE_MMB} from 'shapez.io/js/game/key_action_mapper.js'

public KEYCODE_RMB: number source

import {KEYCODE_RMB} from 'shapez.io/js/game/key_action_mapper.js'

public KEYMAPPINGS: {"general": *, "ingame": *, "navigation": *, "buildings": *, "placement": *, "massSelect": *, "placementModifiers": *} source

import {KEYMAPPINGS} from 'shapez.io/js/game/key_action_mapper.js'

public LANGUAGES: Object<string, {name: string, data: any, code: string, region: string}> source

import {LANGUAGES} from 'shapez.io/js/languages.js'

public Loader: LoaderImpl source

import {Loader} from 'shapez.io/js/core/loader.js'

public MAX_MOVE_DISTANCE_PX: * source

import {MAX_MOVE_DISTANCE_PX} from 'shapez.io/js/core/click_detector.js'

public MUSIC: {"theme": *, "menu": string} source

import {MUSIC} from 'shapez.io/js/platform/sound.js'

public ORIGINAL_SPRITE_SCALE: string source

import {ORIGINAL_SPRITE_SCALE} from 'shapez.io/js/core/sprites.js'

public PROMISE_ABORTED: string source

import {PROMISE_ABORTED} from 'shapez.io/js/core/request_channel.js'

public SOUNDS: {"uiClick": string, "uiError": string, "dialogError": string, "dialogOk": string, "swishHide": string, "swishShow": string, "badgeNotification": string, "levelComplete": string, "destroyBuilding": string, "placeBuilding": string, "placeBelt": string, "copy": string} source

import {SOUNDS} from 'shapez.io/js/platform/sound.js'

public STOP_PROPAGATION: string source

import {STOP_PROPAGATION} from 'shapez.io/js/core/signal.js'

public SUPPORT_TOUCH: boolean source

import {SUPPORT_TOUCH} from 'shapez.io/js/core/config.js'

public T: * source

public THEME: * source

import {THEME} from 'shapez.io/js/game/theme.js'

public THIRDPARTY_URLS: {"discord": string, "github": string, "reddit": string, "shapeViewer": string, "standaloneStorePage": string, "levelTutorialVideos": *} source

import {THIRDPARTY_URLS} from 'shapez.io/js/core/config.js'

public USER_INTERACT_MOVE: string source

import {USER_INTERACT_MOVE} from 'shapez.io/js/game/camera.js'

public USER_INTERACT_TOUCHEND: string source

import {USER_INTERACT_TOUCHEND} from 'shapez.io/js/game/camera.js'

public USER_INTERACT_ZOOM: string source

import {USER_INTERACT_ZOOM} from 'shapez.io/js/game/camera.js'

public VANILLA_THEMES: {"dark": *, "light": *} source

import {VANILLA_THEMES} from 'shapez.io/js/game/theme.js'

public arrayAllDirections: Array<enumDirection> source

import {arrayAllDirections} from 'shapez.io/js/core/vector.js'

public asyncCompressor: * source

import {asyncCompressor} from 'shapez.io/js/core/async_compression.js'

public atlasFiles: AtlasDefinition[] source

import {atlasFiles} from 'shapez.io/js/core/atlas_definitions.js'

public autosaveIntervals: undefined[] source

import {autosaveIntervals} from 'shapez.io/js/profile/application_settings.js'

public clickDetectorGlobals: {"lastTouchTime": *} source

import {clickDetectorGlobals} from 'shapez.io/js/core/click_detector.js'

public codes: {"1": *, "2": *, "3": *, "4": *, "5": *, "6": *, "47": *, "48": *, "7": *, "8": *, "9": *, "10": *, "11": *, "12": *, "13": *, "14": *, "15": *, "16": *, "17": *, "18": *, "19": *, "20": *, "21": *, "22": *, "23": *, "24": *, "25": *, "26": *, "27": *, "28": *, "29": *, "30": *, "52": *, "53": *, "54": *, "55": *, "31": *, "32": *, "34": *, "35": *, "36": *, "38": *, "60": *, "33": *, "37": *, "39": *, "40": *, "42": *, "44": *, "45": *, "50": *, "51": *, "46": *, "43": *, "49": *, "61": *} source

public compressionPrefix: * source

import {compressionPrefix} from 'shapez.io/js/core/async_compression.js'

public defaultBuildingVariant: string source

import {defaultBuildingVariant} from 'shapez.io/js/game/meta_building.js'

public enumAnalyticsDataSource: {"produced": string, "stored": string, "delivered": string} source

import {enumAnalyticsDataSource} from 'shapez.io/js/game/production_analytics.js'

public enumAngleToDirection: {"0": *, "90": *, "180": *, "270": *} source

import {enumAngleToDirection} from 'shapez.io/js/core/vector.js'

public enumCategories: {"general": string, "userInterface": string, "performance": string, "advanced": string, "debug": string} source

import {enumCategories} from 'shapez.io/js/profile/application_settings.js'

public enumClippedBeltUnderlayType: {"full": string, "bottomOnly": string, "topOnly": string, "none": string} source

import {enumClippedBeltUnderlayType} from 'shapez.io/js/game/components/belt_underlays.js'

Store which type an underlay is, this is cached so we can easily render it.

Full: Render underlay at top and bottom of tile Bottom Only: Only render underlay at the bottom half Top Only:

public enumColorMixingResults: {"undefined": *} source

import {enumColorMixingResults} from 'shapez.io/js/game/colors.js'

public enumColorToShortcode: {"undefined": string} source

import {enumColorToShortcode} from 'shapez.io/js/game/colors.js'

public enumColors: {"red": string, "green": string, "blue": string, "yellow": string, "purple": string, "cyan": string, "white": string, "uncolored": string} source

import {enumColors} from 'shapez.io/js/game/colors.js'

public enumColorsToHexCode: {"undefined": string} source

import {enumColorsToHexCode} from 'shapez.io/js/game/colors.js'

public enumDirection: {"top": string, "right": string, "bottom": string, "left": string} source

import {enumDirection} from 'shapez.io/js/core/vector.js'

public enumDirectionToAngle: {"undefined": number} source

import {enumDirectionToAngle} from 'shapez.io/js/core/vector.js'

public enumDirectionToVector: {"top": *, "right": *, "bottom": *, "left": *} source

import {enumDirectionToVector} from 'shapez.io/js/core/vector.js'

Mapping from string direction to actual vector

public enumDisplayMode: {"icons": string, "detailed": string} source

import {enumDisplayMode} from 'shapez.io/js/game/hud/parts/statistics_handle.js'

public enumHubGoalRewards: {"reward_cutter_and_trash": string, "reward_rotater": string, "reward_painter": string, "reward_mixer": string, "reward_stacker": string, "reward_balancer": string, "reward_tunnel": string, "reward_rotater_ccw": string, "reward_rotater_180": string, "reward_miner_chainable": string, "reward_underground_belt_tier_2": string, "reward_belt_reader": string, "reward_splitter": string, "reward_cutter_quad": string, "reward_painter_double": string, "reward_storage": string, "reward_merger": string, "reward_wires_painter_and_levers": string, "reward_display": string, "reward_constant_signal": string, "reward_logic_gates": string, "reward_virtual_processing": string, "reward_filter": string, "reward_demo_end": string, "reward_blueprints": string, "reward_freeplay": string, "no_reward": string, "no_reward_freeplay": string} source

import {enumHubGoalRewards} from 'shapez.io/js/game/tutorial_goals.js'

Don't forget to also update tutorial_goals_mappings.js as well as the translations!

public enumHubGoalRewardsToContentUnlocked: {"undefined": *} source

import {enumHubGoalRewardsToContentUnlocked} from 'shapez.io/js/game/tutorial_goals_mappings.js'

Stores which reward unlocks what

public enumInvertedDirections: {"undefined": *} source

import {enumInvertedDirections} from 'shapez.io/js/core/vector.js'

public enumItemProcessorRequirements: {"painterQuad": string} source

import {enumItemProcessorRequirements} from 'shapez.io/js/game/components/item_processor.js'

public enumItemProcessorTypes: {"balancer": string, "cutter": string, "cutterQuad": string, "rotater": string, "rotaterCCW": string, "rotater180": string, "stacker": string, "trash": string, "mixer": string, "painter": string, "painterDouble": string, "painterQuad": string, "hub": string, "filter": string, "reader": string} source

import {enumItemProcessorTypes} from 'shapez.io/js/game/components/item_processor.js'

public enumLocalSavegameStatus: {"offline": string, "synced": string} source

import {enumLocalSavegameStatus} from 'shapez.io/js/savegame/savegame_manager.js'

public enumLogicGateType: {"and": string, "not": string, "xor": string, "or": string, "transistor": string, "analyzer": string, "rotater": string, "unstacker": string, "cutter": string, "compare": string, "stacker": string, "painter": string} source

import {enumLogicGateType} from 'shapez.io/js/game/components/logic_gate.js'

public enumMouseButton: {"left": string, "middle": string, "right": string} source

import {enumMouseButton} from 'shapez.io/js/game/camera.js'

public enumNotificationType: {"saved": string, "upgrade": string, "success": string} source

import {enumNotificationType} from 'shapez.io/js/game/hud/parts/notifications.js'

public enumPinSlotType: {"logicalEjector": string, "logicalAcceptor": string} source

import {enumPinSlotType} from 'shapez.io/js/game/components/wired_pins.js'

public enumSavePriority: {"regular": number, "asap": number} source

import {enumSavePriority} from 'shapez.io/js/game/automatic_save.js'

public enumShortcodeToColor: {} source

import {enumShortcodeToColor} from 'shapez.io/js/game/colors.js'

public enumShortcodeToSubShape: {} source

import {enumShortcodeToSubShape} from 'shapez.io/js/game/shape_definition.js'

public enumSubShape: {"rect": string, "circle": string, "star": string, "windmill": string} source

import {enumSubShape} from 'shapez.io/js/game/shape_definition.js'

public enumSubShapeToShortcode: {"undefined": string} source

import {enumSubShapeToShortcode} from 'shapez.io/js/game/shape_definition.js'

public enumUndergroundBeltMode: {"sender": string, "receiver": string} source

import {enumUndergroundBeltMode} from 'shapez.io/js/game/components/underground_belt.js'

public enumWireType: {"forward": string, "turn": string, "split": string, "cross": string} source

import {enumWireType} from 'shapez.io/js/game/components/wire.js'

public gBuildingVariants: Object<number, BuildingVariantIdentifier> source

import {gBuildingVariants} from 'shapez.io/js/game/building_codes.js'

Stores a lookup table for all building variants (for better performance)

public gBuildingsByCategory: Object<string, Array<Class<import("../game/meta_building").MetaBuilding>>> source

import {gBuildingsByCategory} from 'shapez.io/js/core/global_registries.js'

public gComponentRegistry: FactoryTemplate<import("../game/component").Component> source

import {gComponentRegistry} from 'shapez.io/js/core/global_registries.js'

public gGameModeRegistry: FactoryTemplate<GameMode> source

import {gGameModeRegistry} from 'shapez.io/js/core/global_registries.js'

public gGameSpeedRegistry: FactoryTemplate<import("../game/time/base_game_speed").BaseGameSpeed> source

import {gGameSpeedRegistry} from 'shapez.io/js/core/global_registries.js'

public gItemRegistry: FactoryTemplate<import("../game/base_item").BaseItem> source

import {gItemRegistry} from 'shapez.io/js/core/global_registries.js'

public gMetaBuildingRegistry: SingletonFactoryTemplate<import("../game/meta_building").MetaBuilding> source

import {gMetaBuildingRegistry} from 'shapez.io/js/core/global_registries.js'

public gameCreationAction: {"new": string, "resume": string} source

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

public globalConfig: {"tileSize": number, "halfTileSize": number, "assetsDpi": *, "assetsSharpness": number, "shapesSharpness": number, "statisticsGraphDpi": number, "statisticsGraphSlices": number, "analyticsSliceDurationSeconds": *, "minimumTickRate": number, "maximumTickRate": number, "mapChunkSize": number, "mapChunkOverviewMinZoom": number, "mapChunkWorldSize": *, "beltSpeedItemsPerSecond": number, "minerSpeedItemsPerSecond": *, "defaultItemDiameter": number, "itemSpacingOnBelts": number, "wiresSpeedItemsPerSecond": number, "undergroundBeltMaxTilesByTier": *, "readerAnalyzeIntervalSeconds": number, "buildingSpeeds": *, "initialZoom": number, "minZoomLevel": number, "maxZoomLevel": number, "gameSpeed": number, "warmupTimeSecondsFast": number, "warmupTimeSecondsRegular": number, "smoothing": *, "rendering": *, "debug": *, "info": *} source

import {globalConfig} from 'shapez.io/js/core/config.js'

public globalJsonSchemaDefs: {} source

import {globalJsonSchemaDefs} from 'shapez.io/js/savegame/serialization_data_types.js'

public layers: Array<Layer> source

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

public movementSpeeds: undefined[] source

import {movementSpeeds} from 'shapez.io/js/profile/application_settings.js'

public queryParamOptions: {"embedProvider": *, "fullVersion": *, "sandboxMode": *} source

import {queryParamOptions} from 'shapez.io/js/core/query_parameters.js'

public savegameInterfaces: Object<any, typeof BaseSavegameInterface> source

import {savegameInterfaces} from 'shapez.io/js/savegame/savegame_interface_registry.js'

public scrollWheelSensitivities: undefined[] source

import {scrollWheelSensitivities} from 'shapez.io/js/profile/application_settings.js'

public statisticsUnitsSeconds: Object<string, number> source

import {statisticsUnitsSeconds} from 'shapez.io/js/game/hud/parts/statistics_handle.js'

Stores how many seconds one unit is

public typeItemSingleton: * source

import {typeItemSingleton} from 'shapez.io/js/game/item_resolver.js'

public types: {"int": *, "uint": *, "float": *, "ufloat": *, "string": *, "entity": *, "weakEntityRef": *, "vector": *, "tileVector": *, "bool": *, "nullable": function, "classId": function, "keyValueMap": function, "enum": function, "obj": function, "objData": function, "knownType": function, "array": function, "fixedSizeArray": function, "classRef": function, "structured": function, "pair": function, "classWithMetaclass": function} source

public uiScales: undefined[] source