import {Savegame} from 'shapez.io/js/savegame/savegame.js'

public class | source

Savegame

Extends:

ReadWriteProxy → Savegame

Static Method Summary

Static Public Methods
public static	getCurrentVersion(): any
public static	getReaderClass(): typeof BaseSavegameInterface

Constructor Summary

Public Constructor
public	constructor(app: import("../application").Application, param0: object)

Member Summary

Public Members
public	currentData: import("./savegame_typedefs").SavegameData
public	internalId: *
public	metaDataRef: *

Method Summary

Public Methods
public	getCurrentDump(): import("./savegame_typedefs").SerializedGame Returns the current game dump
public	getCurrentVersion(): number
public	getDefaultData(): import("./savegame_typedefs").SavegameData Returns the savegames default data
public	getDumpReader(): BaseSavegameInterface Returns a reader to access the data
public	getDumpReaderForExternalData(data: *): BaseSavegameInterface Returns a reader to access external data
public	getRealLastUpdate(): * Returns the real last update of the savegame, not the one of the metadata which could also be the servers one
public	getStatistics(): import("./savegame_typedefs").SavegameStats Returns the statistics of the savegame
public	hasGameDump(): * Returns if this game has a serialized game dump
public	isSaveable(): boolean Returns if this game can be saved on disc
public	migrate(data: import("./savegame_typedefs").SavegameData): * Migrates the savegames data
public	saveMetadata(): * Updates the savegames metadata
public	setLastUpdate(time: *) Updates the last update field so we can send the savegame to the server, WITHOUT Saving!
public	updateData(root: import("../game/root").GameRoot): boolean
public	verify(data: import("./savegame_typedefs").SavegameData): * Verifies the savegames data
public	writeAsync(): Promise<any>
public	writeSavegameAndMetadata(): * Writes the savegame as well as its metadata

Inherited Summary

From class ReadWriteProxy
public static	deserializeObject(text: object): *
public static	serializeObject(obj: object): *
public	app: Application
public	currentData: object
public	debouncedWrite: * Store a debounced handler to prevent double writes
public	filename: *
public	deleteAsync(): Promise<void> Deletes the file
public	doWriteAsync(): Promise<void> Actually writes the data asychronously
public	getCurrentVersion(): number
public	getDefaultData(): {}
public	internalVerifyBasicStructure(data: *): ExplainedResult
public	internalVerifyEntry(data: *): ExplainedResult
public	migrate(data: *): ExplainedResult
public	readAsync(): *
public	resetEverythingAsync(): *
public	verify(data: *): ExplainedResult
public	writeAsync(): Promise<void> Writes the data asychronously, fails if verify() fails.

Static Public Methods

public static getCurrentVersion(): any source

Override:

ReadWriteProxy#getCurrentVersion

Return:

any

public static getReaderClass(): typeof BaseSavegameInterface source

Return:

typeof BaseSavegameInterface

Public Constructors

public constructor(app: import("../application").Application, param0: object) source

Override:

ReadWriteProxy#constructor

Params:

Name	Type	Attribute	Description
app	import("../application").Application
param0	object
param0.internalId	string
param0.metaDataRef	import("./savegame_typedefs").SavegameMetadata		Handle to the meta data

Public Members

public currentData: import("./savegame_typedefs").SavegameData source

Override:

ReadWriteProxy#currentData

public internalId: * source

public metaDataRef: * source

Public Methods

public getCurrentDump(): import("./savegame_typedefs").SerializedGame source

Returns the current game dump

Return:

import("./savegame_typedefs").SerializedGame

public getCurrentVersion(): number source

Override:

ReadWriteProxy#getCurrentVersion

Return:

number

public getDefaultData(): import("./savegame_typedefs").SavegameData source

Returns the savegames default data

Override:

ReadWriteProxy#getDefaultData

Return:

import("./savegame_typedefs").SavegameData

public getDumpReader(): BaseSavegameInterface source

Returns a reader to access the data

Return:

BaseSavegameInterface

public getDumpReaderForExternalData(data: *): BaseSavegameInterface source

Returns a reader to access external data

Params:

Name	Type	Attribute	Description
data	*

Return:

BaseSavegameInterface

public getRealLastUpdate(): * source

Returns the real last update of the savegame, not the one of the metadata which could also be the servers one

Return:

public getStatistics(): import("./savegame_typedefs").SavegameStats source

Returns the statistics of the savegame

Return:

import("./savegame_typedefs").SavegameStats

public hasGameDump(): * source

Returns if this game has a serialized game dump

Return:

public isSaveable(): boolean source

Returns if this game can be saved on disc

Return:

boolean

public migrate(data: import("./savegame_typedefs").SavegameData): * source

Migrates the savegames data

Override:

ReadWriteProxy#migrate

Params:

Name	Type	Attribute	Description
data	import("./savegame_typedefs").SavegameData

Return:

public saveMetadata(): * source

Updates the savegames metadata

Return:

public setLastUpdate(time: *) source

Updates the last update field so we can send the savegame to the server, WITHOUT Saving!

Params:

Name	Type	Attribute	Description
time	*

public updateData(root: import("../game/root").GameRoot): boolean source

Params:

Name	Type	Attribute	Description
root	import("../game/root").GameRoot

Return:

boolean

public verify(data: import("./savegame_typedefs").SavegameData): * source

Verifies the savegames data

Override:

ReadWriteProxy#verify

Params:

Name	Type	Attribute	Description
data	import("./savegame_typedefs").SavegameData

Return:

public writeAsync(): Promise<any> source

Writes the data asychronously, fails if verify() fails. Debounces the operation by up to 50ms

public writeSavegameAndMetadata(): * source

Writes the savegame as well as its metadata

Savegame

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static getCurrentVersion(): any source

Override:

Return:

public static getReaderClass(): typeof BaseSavegameInterface source

Return:

Public Constructors

public constructor(app: import("../application").Application, param0: object) source

Override:

Params:

Public Members

public currentData: import("./savegame_typedefs").SavegameData source

Override:

public internalId: * source

public metaDataRef: * source

Public Methods

public getCurrentDump(): import("./savegame_typedefs").SerializedGame source

Return:

public getCurrentVersion(): number source

Override:

Return:

public getDefaultData(): import("./savegame_typedefs").SavegameData source

Override:

Return:

public getDumpReader(): BaseSavegameInterface source

Return:

public getDumpReaderForExternalData(data: *): BaseSavegameInterface source

Params:

Return:

public getRealLastUpdate(): * source

Return:

public getStatistics(): import("./savegame_typedefs").SavegameStats source

Return:

public hasGameDump(): * source

Return:

public isSaveable(): boolean source

Return:

public migrate(data: import("./savegame_typedefs").SavegameData): * source

Override:

Params:

Return:

public saveMetadata(): * source

Return:

public setLastUpdate(time: *) source

Params:

public updateData(root: import("../game/root").GameRoot): boolean source

Params:

Return:

public verify(data: import("./savegame_typedefs").SavegameData): * source

Override:

Params:

Return:

public writeAsync(): Promise<any> source

Override:

Return:

See:

public writeSavegameAndMetadata(): * source

Return: