Class SaveWriter

Hierarchy

ContextWriter
- SaveWriter

Constructors

constructor

new SaveWriter(): SaveWriter
Returns SaveWriter
Overrides ContextWriter.constructor
- Defined in src/parser/satisfactory/save/save-writer.ts:12

Properties

alignment

alignment: Alignment

`Protected`bufferArray

bufferArray: ArrayBuffer

`Protected`bufferView

bufferView: DataView

context

context: ReaderWriterContext = ...

`Protected`currentByte

currentByte: number

Methods

endWriting

endWriting(): ArrayBuffer
Returns ArrayBuffer
Inherited from ContextWriter.endWriting
- Defined in src/parser/byte/byte-writer.class.ts:156

`Protected`extendBufferIfNeeded

extendBufferIfNeeded(countNeededBytes, factor?): void
automatically extends the current buffer if the given space exceeds the available rest capacity of the current buffer.
Parameters
- countNeededBytes: number
  the needed space
- factor: number = 1.5
  how big the appended buffer should be in comparison to the current one. Values >= 1 make sense.
Returns void
Inherited from ContextWriter.extendBufferIfNeeded
- Defined in src/parser/byte/byte-writer.class.ts:145

generateChunks

generateChunks(compressionInfo, posAfterHeader, onBinaryBeforeCompressing, onHeader, onChunk): ChunkSummary[]
Parameters
- compressionInfo: ChunkCompressionInfo
- posAfterHeader: number
- onBinaryBeforeCompressing: ((binary: ArrayBuffer) => void)
  - - (binary): void
    - Parameters
      binary: ArrayBuffer
      Returns void
- onHeader: ((header: Uint8Array) => void)
  - - (header): void
    - Parameters
      header: Uint8Array
      Returns void
- onChunk: ((chunk: Uint8Array) => void)
  - - (chunk): void
    - Parameters
      chunk: Uint8Array
      Returns void
Returns ChunkSummary[]
- Defined in src/parser/satisfactory/save/save-writer.ts:62

getBufferLength

getBufferLength(): number
Returns number
Inherited from ContextWriter.getBufferLength
- Defined in src/parser/byte/byte-writer.class.ts:128

getBufferPosition

getBufferPosition(): number
Returns number
Inherited from ContextWriter.getBufferPosition
- Defined in src/parser/byte/byte-writer.class.ts:124

getBufferProgress

getBufferProgress(): number
Returns number
Inherited from ContextWriter.getBufferProgress
- Defined in src/parser/byte/byte-writer.class.ts:130

getBufferSlice

getBufferSlice(start, end?): ArrayBuffer
Parameters
- start: number
- Optionalend: number
Returns ArrayBuffer
Inherited from ContextWriter.getBufferSlice
- Defined in src/parser/byte/byte-writer.class.ts:126

skipBytes

skipBytes(count?): void
Parameters
- count: number = 1
Returns void
Inherited from ContextWriter.skipBytes
- Defined in src/parser/byte/byte-writer.class.ts:24

`Protected`truncateBuffer

truncateBuffer(): void
Returns void
Inherited from ContextWriter.truncateBuffer
- Defined in src/parser/byte/byte-writer.class.ts:152

writeBinarySizeFromPosition

writeBinarySizeFromPosition(lenIndicatorPos, start): void
Parameters
- lenIndicatorPos: number
- start: number
Returns void
Inherited from ContextWriter.writeBinarySizeFromPosition
- Defined in src/parser/byte/byte-writer.class.ts:132

writeByte

writeByte(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeByte
- Defined in src/parser/byte/byte-writer.class.ts:32

writeBytes

writeBytes(bytes): void
Parameters
- bytes: Uint8Array
Returns void
Inherited from ContextWriter.writeBytes
- Defined in src/parser/byte/byte-writer.class.ts:40

writeBytesArray

writeBytesArray(bytes): void
Parameters
- bytes: number[]
Returns void
Inherited from ContextWriter.writeBytesArray
- Defined in src/parser/byte/byte-writer.class.ts:37

writeDouble

writeDouble(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeDouble
- Defined in src/parser/byte/byte-writer.class.ts:93

writeFloat32

writeFloat32(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeFloat32
- Defined in src/parser/byte/byte-writer.class.ts:88

writeInt16

writeInt16(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeInt16
- Defined in src/parser/byte/byte-writer.class.ts:52

writeInt32

writeInt32(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeInt32
- Defined in src/parser/byte/byte-writer.class.ts:62

writeInt32Zero

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

Returns void
Inherited from ContextWriter.writeInt32Zero
- Defined in src/parser/byte/byte-writer.class.ts:70

writeInt64

writeInt64(value): void
Parameters
- value: bigint
Returns void
Inherited from ContextWriter.writeInt64
- Defined in src/parser/byte/byte-writer.class.ts:78

writeInt8

writeInt8(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeInt8
- Defined in src/parser/byte/byte-writer.class.ts:44

writeString

writeString(value): void
Parameters
- value: string
Returns void
Inherited from ContextWriter.writeString
- Defined in src/parser/byte/byte-writer.class.ts:98

writeUint16

writeUint16(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeUint16
- Defined in src/parser/byte/byte-writer.class.ts:57

writeUint32

writeUint32(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeUint32
- Defined in src/parser/byte/byte-writer.class.ts:73

writeUint64

writeUint64(value): void
Parameters
- value: bigint
Returns void
Inherited from ContextWriter.writeUint64
- Defined in src/parser/byte/byte-writer.class.ts:83

writeUint8

writeUint8(value): void
Parameters
- value: number
Returns void
Inherited from ContextWriter.writeUint8
- Defined in src/parser/byte/byte-writer.class.ts:49

`Static`AppendBuffer

AppendBuffer(buffer1, buffer2): ArrayBuffer
Parameters
- buffer1: ArrayBuffer
- buffer2: ArrayBuffer
Returns ArrayBuffer
Inherited from ContextWriter.AppendBuffer
- Defined in src/parser/byte/byte-writer.class.ts:170

`Static`GenerateCompressedChunksFromData

GenerateCompressedChunksFromData(bufferArray, compressionInfo, onBinaryBeforeCompressing, onChunk, alignment?): ChunkSummary[]
Parameters
- bufferArray: ArrayBuffer
- compressionInfo: ChunkCompressionInfo
- onBinaryBeforeCompressing: ((binary: ArrayBuffer) => void)
  - - (binary): void
    - Parameters
      binary: ArrayBuffer
      Returns void
- onChunk: ((chunk: Uint8Array) => void)
  - - (chunk): void
    - Parameters
      chunk: Uint8Array
      Returns void
- alignment: Alignment = Alignment.LITTLE_ENDIAN
Returns ChunkSummary[]
- Defined in src/parser/satisfactory/save/save-writer.ts:51

`Static`IsASCIICompatible

IsASCIICompatible(value): boolean
Parameters
- value: string
Returns boolean
Inherited from ContextWriter.IsASCIICompatible
- Defined in src/parser/byte/byte-writer.class.ts:122

`Static`ToInt32

ToInt32(num): Uint8Array
Parameters
- num: number
Returns Uint8Array
Inherited from ContextWriter.ToInt32
- Defined in src/parser/byte/byte-writer.class.ts:161

`Static`WriteGrids

WriteGrids(writer, grids): void
Parameters
- writer: ContextWriter
- grids: Grids
Returns void
- Defined in src/parser/satisfactory/save/save-writer.ts:27

`Static`WriteLevels

WriteLevels(writer, save): void
Parameters
- writer: ContextWriter
- save: SatisfactorySave
Returns void
- Defined in src/parser/satisfactory/save/save-writer.ts:41

`Static`WriteSaveBodyHash

WriteSaveBodyHash(writer, saveBodyValidation): void
Parameters
- writer: ContextWriter
- saveBodyValidation: SaveBodyValidation
Returns void
- Defined in src/parser/satisfactory/save/save-writer.ts:16

Class SaveWriter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SaveWriter

Properties

alignment

ProtectedbufferArray

ProtectedbufferView

context

ProtectedcurrentByte

Methods

endWriting

Returns ArrayBuffer

ProtectedextendBufferIfNeeded

Parameters

Returns void

generateChunks

Parameters

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Returns ChunkSummary[]

getBufferLength

Returns number

getBufferPosition

Returns number

getBufferProgress

Returns number

getBufferSlice

Parameters

Returns ArrayBuffer

jumpTo

Parameters

Returns void

skipBytes

Parameters

Returns void

ProtectedtruncateBuffer

Returns void

writeBinarySizeFromPosition

Parameters

Returns void

writeByte

Parameters

Returns void

writeBytes

Parameters

Returns void

writeBytesArray

Parameters

Returns void

writeDouble

Parameters

Returns void

writeFloat32

Parameters

Returns void

writeInt16

Parameters

Returns void

writeInt32

Parameters

Returns void

writeInt32Zero

Returns void

writeInt64

Parameters

Returns void

writeInt8

Parameters

Returns void

writeString

`Protected`bufferArray

`Protected`bufferView

`Protected`currentByte

`Protected`extendBufferIfNeeded

`Protected`truncateBuffer

`Static`AppendBuffer

`Static`GenerateCompressedChunksFromData

`Static`IsASCIICompatible

`Static`ToInt32

`Static`WriteGrids

`Static`WriteLevels

`Static`WriteSaveBodyHash