import {HubGoals} from 'shapez.io/js/game/hub_goals.js'

public class | source

HubGoals

Extends:

BasicSerializableObject → HubGoals

Static Method Summary

Static Public Methods
public static	getId(): string
public static	getSchema(): {"level": , "storedShapes": , "upgradeLevels": *}

Constructor Summary

Public Constructor
public	constructor(root: GameRoot)

Member Summary

Public Members
public	currentGoal: {"definition": , "required": , "reward": , "throughputOnly": }
public	gainedRewards: Object<string, number> Which story rewards we already gained
public	level: *
public	root: *
public	storedShapes: Object<string, number> Mapping from shape hash -> amount
public	upgradeImprovements: Object<string, number> Stores the improvements for all upgrades
public	upgradeLevels: Object<string, number> Stores the levels for all upgrades

Method Summary

Public Methods
public	canUnlockUpgrade(upgradeId: string): boolean Returns whether a given upgrade can be unlocked
public	computeFreeplayShape(level: number): ShapeDefinition Creates a (seeded) random shape
public	computeNextGoal() Creates the next goal
public	deserialize(data: , root: GameRoot):
public	generateRandomColorSet(rng: RandomNumberGenerator): * Picks random colors which are close to each other
public	getAvailableUpgradeCount(): number Returns the number of available upgrades
public	getBeltBaseSpeed(): number Belt speed
public	getCurrentGoalDelivered(): * Returns how much of the current goal was already delivered
public	getMinerBaseSpeed(): number Miner speed
public	getProcessorBaseSpeed(processorType: enumItemProcessorTypes): number Processor speed
public	getShapesStored(definition: ShapeDefinition): number Returns how much of the current shape is stored
public	getShapesStoredByKey(key: string): number Returns how much of the current shape is stored
public	getUndergroundBeltBaseSpeed(): number Underground belt speed
public	getUpgradeLevel(upgradeId: string): * Returns the current level of a given upgrade
public	handleDefinitionDelivered(definition: ShapeDefinition) Handles the given definition, by either accounting it towards the goal or otherwise granting some points
public	isEndOfDemoReached(): boolean Returns whether the end of the demo is reached
public	isFreePlay(): * Returns whether we are playing in free-play
public	isRewardUnlocked(reward: enumHubGoalRewards): * Returns whether the given reward is already unlocked
public	onGoalCompleted() Called when the level was completed
public	takeShapeByKey(key: string, amount: number)
public	tryUnlockUpgrade(upgradeId: string): boolean Tries to unlock the given upgrade

Inherited Summary

From class BasicSerializableObject
public static	getCachedSchema(): Schema
public static	getId()
public static	getSchema(): Schema Should return the serialization schema
public static	verify(data: *): string \| void
public	deserialize(data: any, root: import("./savegame_serializer").GameRoot): string \| void
public	serialize(): object

Static Public Methods

public static getId(): string source

Override:

BasicSerializableObject#getId

Return:

string

public static getSchema(): {"level": , "storedShapes": , "upgradeLevels": *} source

Should return the serialization schema

Override:

BasicSerializableObject#getSchema

Return:

{"level": *, "storedShapes": *, "upgradeLevels": *}

Public Constructors

public constructor(root: GameRoot) source

Fixes typeof DerivedComponent is not assignable to typeof Component, compiled out in non-dev builds

Override:

BasicSerializableObject#constructor

Params:

Name	Type	Attribute	Description
root	GameRoot

Public Members

public currentGoal: {"definition": , "required": , "reward": , "throughputOnly": } source

public gainedRewards: Object<string, number> source

Which story rewards we already gained

public level: * source

public root: * source

public storedShapes: Object<string, number> source

Mapping from shape hash -> amount

public upgradeImprovements: Object<string, number> source

Stores the improvements for all upgrades

public upgradeLevels: Object<string, number> source

Stores the levels for all upgrades

Public Methods

public canUnlockUpgrade(upgradeId: string): boolean source

Returns whether a given upgrade can be unlocked

Params:

Name	Type	Attribute	Description
upgradeId	string

Return:

boolean

public computeFreeplayShape(level: number): ShapeDefinition source

Creates a (seeded) random shape

Params:

Name	Type	Attribute	Description
level	number

Return:

ShapeDefinition

public computeNextGoal() source

Creates the next goal

public deserialize(data: , root: GameRoot): source

Override:

BasicSerializableObject#deserialize

Params:

Name	Type	Attribute	Description
data	*
root	GameRoot

Return:

public generateRandomColorSet(rng: RandomNumberGenerator): * source

Picks random colors which are close to each other

Params:

Name	Type	Attribute	Description
rng	RandomNumberGenerator

Return:

public getAvailableUpgradeCount(): number source

Returns the number of available upgrades

Return:

number

public getBeltBaseSpeed(): number source

Belt speed

Return:

number

items / sec

public getCurrentGoalDelivered(): * source

Returns how much of the current goal was already delivered

Return:

public getMinerBaseSpeed(): number source

Miner speed

Return:

number

items / sec

public getProcessorBaseSpeed(processorType: enumItemProcessorTypes): number source

Processor speed

Params:

Name	Type	Attribute	Description
processorType	enumItemProcessorTypes

Return:

number

items / sec

public getShapesStored(definition: ShapeDefinition): number source

Returns how much of the current shape is stored

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

number

public getShapesStoredByKey(key: string): number source

Returns how much of the current shape is stored

Params:

Name	Type	Attribute	Description
key	string

Return:

number

public getUndergroundBeltBaseSpeed(): number source

Underground belt speed

Return:

number

items / sec

public getUpgradeLevel(upgradeId: string): * source

Returns the current level of a given upgrade

Params:

Name	Type	Attribute	Description
upgradeId	string

Return:

public handleDefinitionDelivered(definition: ShapeDefinition) source

Handles the given definition, by either accounting it towards the goal or otherwise granting some points

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

public isEndOfDemoReached(): boolean source

Returns whether the end of the demo is reached

Return:

boolean

public isFreePlay(): * source

Returns whether we are playing in free-play

Return:

public isRewardUnlocked(reward: enumHubGoalRewards): * source

Returns whether the given reward is already unlocked

Params:

Name	Type	Attribute	Description
reward	enumHubGoalRewards

Return:

public onGoalCompleted() source

Called when the level was completed

public takeShapeByKey(key: string, amount: number) source

Params:

Name	Type	Attribute	Description
key	string
amount	number

public tryUnlockUpgrade(upgradeId: string): boolean source

Tries to unlock the given upgrade

Params:

Name	Type	Attribute	Description
upgradeId	string

Return:

boolean

HubGoals

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static getId(): string source

Override:

Return:

public static getSchema(): {"level": *, "storedShapes": *, "upgradeLevels": *} source

Override:

Return:

Public Constructors

public constructor(root: GameRoot) source

Override:

Params:

Public Members

public currentGoal: {"definition": *, "required": *, "reward": *, "throughputOnly": *} source

public gainedRewards: Object<string, number> source

public level: * source

public root: * source

public storedShapes: Object<string, number> source

public upgradeImprovements: Object<string, number> source

public upgradeLevels: Object<string, number> source

Public Methods

public canUnlockUpgrade(upgradeId: string): boolean source

Params:

Return:

public computeFreeplayShape(level: number): ShapeDefinition source

Params:

Return:

public computeNextGoal() source

public deserialize(data: *, root: GameRoot): * source

Override:

Params:

Return:

public generateRandomColorSet(rng: RandomNumberGenerator): * source

Params:

Return:

public getAvailableUpgradeCount(): number source

Return:

public getBeltBaseSpeed(): number source

Return:

public getCurrentGoalDelivered(): * source

Return:

public getMinerBaseSpeed(): number source

Return:

public getProcessorBaseSpeed(processorType: enumItemProcessorTypes): number source

Params:

Return:

public getShapesStored(definition: ShapeDefinition): number source

Params:

Return:

public getShapesStoredByKey(key: string): number source

Params:

Return:

public getUndergroundBeltBaseSpeed(): number source

Return:

public getUpgradeLevel(upgradeId: string): * source

Params:

Return:

public handleDefinitionDelivered(definition: ShapeDefinition) source

Params:

public isEndOfDemoReached(): boolean source

Return:

public isFreePlay(): * source

Return:

public isRewardUnlocked(reward: enumHubGoalRewards): * source

Params:

Return:

public onGoalCompleted() source

public takeShapeByKey(key: string, amount: number) source

Params:

public tryUnlockUpgrade(upgradeId: string): boolean source

Params:

Return:

public static getSchema(): {"level": , "storedShapes": , "upgradeLevels": *} source

public currentGoal: {"definition": , "required": , "reward": , "throughputOnly": } source

public deserialize(data: , root: GameRoot): source