Class SaveWriter

Hierarchy (View Summary)

ContextWriter
- SaveWriter

Constructors

constructor

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

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:171

`Protected`extendBufferIfNeeded

extendBufferIfNeeded(countNeededBytes: number, factor?: number): 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:160

generateChunks

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

getBufferLength

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

getBufferPosition

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

getBufferProgress

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

getBufferSlice

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

hexStringRepresentationToBytes

hexStringRepresentationToBytes(hex: string, hexSeparator?: string): number[]
Parameters
- hex: string
- hexSeparator: string = ' '
Returns number[]
Inherited from ContextWriter.hexStringRepresentationToBytes
- Defined in src/parser/byte/byte-writer.class.ts:44

skipBytes

skipBytes(count?: number): 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:167

writeBinarySizeFromPosition

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

writeByte

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

writeBytes

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

writeBytesArray

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

writeDouble

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

writeFloat32

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

writeHex

writeHex(hex: string, hexSeparator?: string): void
Parameters
- hex: string
- hexSeparator: string = ' '
Returns void
Inherited from ContextWriter.writeHex
- Defined in src/parser/byte/byte-writer.class.ts:49

writeInt16

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

writeInt32

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

writeInt32At

writeInt32At(position: number, value: number): void
Parameters
- position: number
- value: number
Returns void
Inherited from ContextWriter.writeInt32At
- Defined in src/parser/byte/byte-writer.class.ts:148

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:78

writeInt64

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

writeInt8

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

writeString

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

writeUint16

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

writeUint32

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

writeUint64

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

writeUint8

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

`Static`AppendBuffer

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

`Static`GenerateCompressedChunksFromData

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

`Static`IsASCIICompatible

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

`Static`ToInt32

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

`Static`WriteLevels

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

Class SaveWriter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SaveWriter

Properties

alignment

ProtectedbufferArray

ProtectedbufferView

context

ProtectedcurrentByte

Methods

endWriting

Returns ArrayBuffer

ProtectedextendBufferIfNeeded

Parameters

Returns void

generateChunks

Parameters

Returns ChunkSummary[]

getBufferLength

Returns number

getBufferPosition

Returns number

getBufferProgress

Returns number

getBufferSlice

Parameters

Returns ArrayBuffer

hexStringRepresentationToBytes

Parameters

Returns number[]

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

writeHex

Parameters

Returns void

writeInt16

Parameters

Returns void

writeInt32

Parameters

Returns void

writeInt32At

Parameters

Returns void

writeInt32Zero

Returns void

writeInt64

Parameters

Returns void

writeInt8

`Protected`bufferArray

`Protected`bufferView

`Protected`currentByte

`Protected`extendBufferIfNeeded

`Protected`truncateBuffer

`Static`AppendBuffer

`Static`GenerateCompressedChunksFromData

`Static`IsASCIICompatible

`Static`ToInt32

`Static`WriteLevels