Class Exe

Provides information from the WL.EXE file.

See

Methods

getCharacterCreationStrings

getCharacterCreationStrings(): string[]
Returns the strings used during character creation.

Returns string[]
Character creation strings.
- Defined in exe/Exe.ts:225

getEndingStrings

getEndingStrings(): string[]
Returns string[]
Strings used in the ending sequence.
- Defined in exe/Exe.ts:260

getInfirmaryStrings

getInfirmaryStrings(): string[]
Returns string[]
Strings used in infirmaries.
- Defined in exe/Exe.ts:253

getIntroStrings

getIntroStrings(): string[]
Returns the intro strings. They are used in the title of the game and contain the copyright message and the small introduction before the game starts.

Returns string[]
The intro strings.
- Defined in exe/Exe.ts:197

getInventoryStrings

getInventoryStrings(): string[]
Returns various strings which mostly have something to do with the players inventory but also contains strings for skills and attributes.

Returns string[]
Various strings mostly used in inventory, skills and attribute screens.
- Defined in exe/Exe.ts:216

getLibraryStrings

getLibraryStrings(): string[]
Returns string[]
Strings used in libraries.
- Defined in exe/Exe.ts:239

getLocation

getLocation(disk: number, map: number): number
Returns the location index of the given map.
Parameters
- disk: number
  The disk index (0 or 1).
- map: number
  The map index (0-19 for disk 0 and 0-21 for disk 1)
Returns number
The location index (0-49)
- Defined in exe/Exe.ts:306

getLocationDisk

getLocationDisk(location: number): number
Returns the disk index of the specified location.
Parameters
- location: number
  The location (0-49, but there are also invalid locations within this range).
Returns number
The disk index (0 or 1).
- Defined in exe/Exe.ts:326

getLocationMap

getLocationMap(location: number): number
Returns the map index of the specified location.
Parameters
- location: number
  The location index (0-49, but there are also invalid locations within this range).
Returns number
The map index (0-19 for disk 0 and 0-21 for disk 1).

Throws
RangeError if the location index is invalid.
- Defined in exe/Exe.ts:341

getMapOffset

getMapOffset(disk: number, map: number): number
Returns the map offset of the given map.
Parameters
- disk: number
  The disk index (0 or 1).
- map: number
  The map index (0-19 for disk 0 and 0-21 for disk 1).
Returns number
The map offset.
- Defined in exe/Exe.ts:295

getMapSize

getMapSize(disk: number, map: number): number
Returns the map size of the given map. This information is needed to load a map because the maps itself do not know their size until the map info is read which is only available AFTER the map data has been parsed.
Parameters
- disk: number
  The disk index (0 or 1).
- map: number
  The map index (0-19 for disk 0 and 0-21 for disk 1).
Returns number
The map size.
- Defined in exe/Exe.ts:272

getMessageStrings

getMessageStrings(): string[]
Returns various unsorted strings like some encounter messages, loot messages, weapon reloading and more.

Returns string[]
Various unsorted strings.
- Defined in exe/Exe.ts:206

getPortraitIndex

getPortraitIndex(disk: number, portraitId: number): number
Returns the portrait index in ALLPICS1 (when disk is 0) or ALLPICS2 (when disk is 1) for the given portrait ID.
Parameters
- disk: number
  The disk index (0 for ALLPICS1, 1 for ALLPICS2).
- portraitId: number
  The portrait ID as used in the game files.
Returns number
The portrait index in ALLPICS1 or ALLPICS2 (depending on disk parameter).
- Defined in exe/Exe.ts:376

getPortraitOffset

getPortraitOffset(disk: number, portraitId: number): number
Returns the portrait record offset within ALLPICS1 (when disk is 0) or ALLPICS2 (when disk is 1) for the given portrait ID.
Parameters
- disk: number
  The disk index (0 for ALLPICS1, 1 for ALLPICS2).
- portraitId: number
  The portrait ID as used in the game files.
Returns number
The portrait record offset within the corresponding ALLPICS file.
- Defined in exe/Exe.ts:392

getPromotionStrings

getPromotionStrings(): string[]
Returns string[]
Strings used during promotions.
- Defined in exe/Exe.ts:232

getSavegameOffset

getSavegameOffset(disk: number): number
Returns the offset of the savegame data in either GAME1 or GAME2.
Parameters
- disk: number
  The disk index (0 for GAME1, 1 for GAME2).
Returns number
The savegame offset
- Defined in exe/Exe.ts:355

getSharedLocation

getSharedLocation(derelictLocation: number): number
Returns the actual shared location for the specified derelict building location.
Parameters
- derelictLocation: number
  The derelict location (lower 7 bit).
Returns number
The actual shared location.
- Defined in exe/Exe.ts:316

getShopItemListOffset

getShopItemListOffset(shop: number): number
Returns the shop item list offset in GAME1 or GAME2 for the specified shop number.
Parameters
- shop: number
  The shop number (0-3 in GAME1, 4 in GAME2, 3 is actually invalid because it does not exist and is not used in the game).
Returns number
The shop item list offset
- Defined in exe/Exe.ts:365

getShopStrings

getShopStrings(): string[]
Returns string[]
Strings used in shops.
- Defined in exe/Exe.ts:246

getSkills

getSkills(): Skill[]
Returns the skill list. Note that the indices in the returned array are zero-based while skill IDs are one-based. So if you need to access skill 2 for example then you have to access skills[1].

Returns Skill[]
The skill list.
- Defined in exe/Exe.ts:436

getTileMapOffset

getTileMapOffset(disk: number, map: number): number
Returns the offset from the beginning of the huffman compressed tile map within the map data. This information is needed to load a map because the maps itself do not know where the tile map section begins.
Parameters
- disk: number
  The disk index (0 or 1).
- map: number
  The map index (0-19 for disk 0 and 0-21 for disk 1).
Returns number
The tile map offset.
- Defined in exe/Exe.ts:284

getTilesetDisk

getTilesetDisk(tilesetId: number): number
Returns the disk number of the given tileset ID.
Parameters
- tilesetId: number
  The global tileset ID (0-8).
Returns number
0 for ALLHTDS1 and 1 for ALLHTDS2.
- Defined in exe/Exe.ts:415

getTilesetOffset

getTilesetOffset(tilesetId: number): number
Returns the tileset offset within the corresponding ALLHTDS file for the given tileset ID.
Parameters
- tilesetId: number
  The global tileset ID (0-8).
Returns number
The tileset offset within ALLHTDS1 or ALLHTDS2.
- Defined in exe/Exe.ts:403

getTilesetSize

getTilesetSize(tilesetId: number): number
Returns the compressed tileset size for the given tileset ID.
Parameters
- tilesetId: number
  The global tileset ID (0-8).
Returns number
The compressed tileset size in bytes.
- Defined in exe/Exe.ts:426

`Static`fromArray

fromArray(data: Uint8Array): Exe
Parses a WL.exe file and returns the information from it.
Parameters
- data: Uint8Array
  The array containing the packed content of the WL.EXE file.
Returns Exe
The parsed information from the exe file.
- Defined in exe/Exe.ts:177

`Static`fromBlob

fromBlob(blob: Blob): Promise<Exe>
Reads information from the given WL.EXE blob and returns it.
Parameters
- blob: Blob
  The WL.EXE blob.
Returns Promise<Exe>
The exe information.
- Defined in exe/Exe.ts:187