Class SaveReader

Hierarchy (View Summary)

ContextReader
- SaveReader

Constructors

constructor

new SaveReader(
fileBuffer: ArrayBufferLike,
onProgressCallback?: (progress: number, msg?: string) => void,
): SaveReader
Parameters
- fileBuffer: ArrayBufferLike
- onProgressCallback: (progress: number, msg?: string) => void = ...
Returns SaveReader
Overrides ContextReader.constructor
- Defined in src/parser/satisfactory/save/save-reader.ts:21

Properties

alignment

alignment: Alignment

`Protected`bufferView

bufferView: DataView

context

context: ReaderWriterContext = ...

`Protected`currentByte

currentByte: number = 0

`Protected`fileBuffer

fileBuffer: ArrayBufferLike

`Protected`handledByte

handledByte: number = 0

`Protected`maxByte

maxByte: number = 0

onProgressCallback

onProgressCallback: (progress: number, msg?: string) => void = ...

`Static` `Readonly`EPOCH_TICKS

EPOCH_TICKS: 621355968000000000n

Methods

bytesToHexRepresentation

bytesToHexRepresentation(bytes: number[]): string[]
Parameters
- bytes: number[]
Returns string[]
Inherited from ContextReader.bytesToHexRepresentation
- Defined in src/parser/byte/byte-reader.class.ts:51

getBuffer

getBuffer(): ArrayBufferLike
Returns ArrayBufferLike
Inherited from ContextReader.getBuffer
- Defined in src/parser/byte/byte-reader.class.ts:154

getBufferLength

getBufferLength(): number
Returns number
Inherited from ContextReader.getBufferLength
- Defined in src/parser/byte/byte-reader.class.ts:152

getBufferPosition

getBufferPosition(): number
Returns number
Inherited from ContextReader.getBufferPosition
- Defined in src/parser/byte/byte-reader.class.ts:146

getBufferProgress

getBufferProgress(): number
Returns number
Inherited from ContextReader.getBufferProgress
- Defined in src/parser/byte/byte-reader.class.ts:150

getBufferSlice

getBufferSlice(begin: number, end: number | undefined): ArrayBufferLike
Parameters
- begin: number
- end: number | undefined
Returns ArrayBufferLike
Inherited from ContextReader.getBufferSlice
- Defined in src/parser/byte/byte-reader.class.ts:148

inflateChunks

inflateChunks(): { compressionInfo: ChunkCompressionInfo }
Returns { compressionInfo: ChunkCompressionInfo }
- Defined in src/parser/satisfactory/save/save-reader.ts:48

jumpTo

jumpTo(pos: number): void
Parameters
- pos: number
Returns void
Inherited from ContextReader.jumpTo
- Defined in src/parser/byte/byte-reader.class.ts:41

readByte

readByte(): number
Returns number
Inherited from ContextReader.readByte
- Defined in src/parser/byte/byte-reader.class.ts:45

readBytes

readBytes(count: number): Uint8Array
Parameters
- count: number
Returns Uint8Array
Inherited from ContextReader.readBytes
- Defined in src/parser/byte/byte-reader.class.ts:48

readDouble

readDouble(): number
Returns number
Inherited from ContextReader.readDouble
- Defined in src/parser/byte/byte-reader.class.ts:110

readFloat32

readFloat32(): number
Returns number
Inherited from ContextReader.readFloat32
- Defined in src/parser/byte/byte-reader.class.ts:105

readHex

readHex(byteLength: number, hexSeparator?: string): string
Parameters
- byteLength: number
- hexSeparator: string = ' '
Returns string
Inherited from ContextReader.readHex
- Defined in src/parser/byte/byte-reader.class.ts:54

readInt16

readInt16(): number
Returns number
Inherited from ContextReader.readInt16
- Defined in src/parser/byte/byte-reader.class.ts:65

readInt32

readInt32(): number
Returns number
Inherited from ContextReader.readInt32
- Defined in src/parser/byte/byte-reader.class.ts:75

readInt32Zero

readInt32Zero(): void
Reads an int32 and we dismiss it, because its always 0.

Returns void
Inherited from ContextReader.readInt32Zero
- Defined in src/parser/byte/byte-reader.class.ts:83

readInt64

readInt64(): bigint
Returns bigint
Inherited from ContextReader.readInt64
- Defined in src/parser/byte/byte-reader.class.ts:96

readInt8

readInt8(): number
Returns number
Inherited from ContextReader.readInt8
- Defined in src/parser/byte/byte-reader.class.ts:57

readLevels

readLevels(): { [levelName: string]: Level }
Returns { [levelName: string]: Level }
- Defined in src/parser/satisfactory/save/save-reader.ts:69

readLong

readLong(): bigint
Returns bigint
Inherited from ContextReader.readLong
- Defined in src/parser/byte/byte-reader.class.ts:91

readString

readString(): string
Returns string
Inherited from ContextReader.readString
- Defined in src/parser/byte/byte-reader.class.ts:115

readUint16

readUint16(): number
Returns number
Inherited from ContextReader.readUint16
- Defined in src/parser/byte/byte-reader.class.ts:70

readUint32

readUint32(): number
Returns number
Inherited from ContextReader.readUint32
- Defined in src/parser/byte/byte-reader.class.ts:86

readUint64

readUint64(): bigint
Returns bigint
Inherited from ContextReader.readUint64
- Defined in src/parser/byte/byte-reader.class.ts:99

readUint8

readUint8(): number
Returns number
Inherited from ContextReader.readUint8
- Defined in src/parser/byte/byte-reader.class.ts:61

reset

reset(newFileBuffer: ArrayBufferLike): void
Resets the reader on the given arraybuffer to start from the beginning.
Parameters
- newFileBuffer: ArrayBufferLike
  the new array buffer to be read.
Returns void
Inherited from ContextReader.reset
- Defined in src/parser/byte/byte-reader.class.ts:26

skipBytes

skipBytes(byteLength?: number): void
Parameters
- byteLength: number = 1
Returns void
Inherited from ContextReader.skipBytes
- Defined in src/parser/byte/byte-reader.class.ts:37

`Static`GetApproximateSaveVersion

GetApproximateSaveVersion(saveVersion: number): RoughSaveVersion
Parameters
- saveVersion: number
Returns RoughSaveVersion
- Defined in src/parser/satisfactory/save/save-reader.ts:26

`Static`IsGameVersionAtLeast_U1

IsGameVersionAtLeast_U1(saveVersion: number): boolean
Parameters
- saveVersion: number
Returns boolean
- Defined in src/parser/satisfactory/save/save-reader.ts:44

`Static`IsGameVersionAtLeast_U1_1

IsGameVersionAtLeast_U1_1(saveVersion: number): boolean
Parameters
- saveVersion: number
Returns boolean
- Defined in src/parser/satisfactory/save/save-reader.ts:43

`Static`IsGameVersionAtLeast_U1_2

IsGameVersionAtLeast_U1_2(saveVersion: number): boolean
Parameters
- saveVersion: number
Returns boolean
- Defined in src/parser/satisfactory/save/save-reader.ts:42

`Static`IsGameVersionAtLeast_U6_U7

IsGameVersionAtLeast_U6_U7(saveVersion: number): boolean
Parameters
- saveVersion: number
Returns boolean
- Defined in src/parser/satisfactory/save/save-reader.ts:46

`Static`IsGameVersionAtLeast_U8

IsGameVersionAtLeast_U8(saveVersion: number): boolean
Parameters
- saveVersion: number
Returns boolean
- Defined in src/parser/satisfactory/save/save-reader.ts:45