Class SoundsObject

SoundsObject parses data from "war3map.w3s" file and can dump back.

Hierarchy

SoundsObject

Implements

ReadDumpObject

Index

Properties

Accessors

Methods

Properties

Protected _fileVersion

_fileVersion: number = 1

Protected _sounds

_sounds: SoundDefinition[] = []

Accessors

fileVersion

get fileVersion(): number
set fileVersion(fileVersion: number): void

- Defined in SoundsObject.ts:283
Returns number
- Defined in SoundsObject.ts:286
Parameters
- fileVersion: number
Returns void

sounds

get sounds(): SoundDefinition[]
set sounds(_sounds: SoundDefinition[]): void

- Defined in SoundsObject.ts:276
Returns SoundDefinition[]
- Defined in SoundsObject.ts:279
Parameters
- _sounds: SoundDefinition[]
Returns void

Methods

dump

dump(): Buffer

Implementation of ReadDumpObject.dump
- Defined in SoundsObject.ts:206
Returns Buffer

read

read(buffer: Buffer): void

Implementation of ReadDumpObject.read
- Defined in SoundsObject.ts:119
Parameters
- buffer: Buffer
Returns void

Static Protected defaultEditorMetadata

defaultEditorMetadata(): SoundEditorMetadata

- Defined in SoundsObject.ts:253
Returns SoundEditorMetadata

Static flagsToObject

flagsToObject(flags: number): SoundFlags

- Defined in SoundsObject.ts:290
Parameters
- flags: number
Returns SoundFlags

Static Protected floatFromRaw

floatFromRaw(raw: number): number

- Defined in SoundsObject.ts:243
Parameters
- raw: number
Returns number

Static Protected getFloatValue

getFloatValue(value: number | undefined, raw: number | undefined, fallback: number): number

- Defined in SoundsObject.ts:249
Parameters
- value: number | undefined
- raw: number | undefined
- fallback: number
Returns number

Static objectToFlags

objectToFlags(flags: SoundFlags): number

- Defined in SoundsObject.ts:300
Parameters
- flags: SoundFlags
Returns number

Static Protected writeVersion3Tail

writeVersion3Tail(sound: SoundDefinition): Buffer

- Defined in SoundsObject.ts:264
Parameters
- sound: SoundDefinition
Returns Buffer

Generated using TypeDoc