Class MapArchiveObject

MapArchiveObject reads and writes Warcraft III .w3m/.w3x/.mpq archives through node-stormlib.

Hierarchy

MapArchiveObject

Index

Constructors

constructor

Properties

Accessors

files

Methods

Constructors

constructor

new MapArchiveObject(storm?: StormArchiveModule): MapArchiveObject

- Defined in MapArchiveObject.ts:218
Parameters
- Default value storm: StormArchiveModule = loadStormArchiveModule()
Returns MapArchiveObject

Properties

Protected _files

_files: MapArchiveFile[] = []

Protected _storm

_storm: StormArchiveModule

Accessors

files

get files(): MapArchiveFile[]
set files(files: MapArchiveFile[]): void

- Defined in MapArchiveObject.ts:293
Returns MapArchiveFile[]
- Defined in MapArchiveObject.ts:296
Parameters
- files: MapArchiveFile[]
Returns void

Methods

getFile

getFile(name: string): MapArchiveFile | undefined

- Defined in MapArchiveObject.ts:300
Parameters
- name: string
Returns MapArchiveFile | undefined

readArchive

readArchive(archivePath: string, options?: MapArchiveReadOptions): void

- Defined in MapArchiveObject.ts:224
Parameters
- archivePath: string
- Default value options: MapArchiveReadOptions = {}
Returns void

Protected readPathmapFirst

readPathmapFirst(buffers: Map<string, Buffer>): PathmapObject | undefined

- Defined in MapArchiveObject.ts:317
Parameters
- buffers: Map<string, Buffer>
Returns PathmapObject | undefined

setFile

setFile(name: string, object: ReadDumpObject, raw?: boolean): void

- Defined in MapArchiveObject.ts:305
Parameters
- name: string
- object: ReadDumpObject
- Default value raw: boolean = object instanceof RawFileObject
Returns void

writeArchive

writeArchive(archivePath: string, options?: MapArchiveWriteOptions): void

- Defined in MapArchiveObject.ts:267
Parameters
- archivePath: string
- Default value options: MapArchiveWriteOptions = {}
Returns void

Generated using TypeDoc