dmapdata#

Load with Game->LoadDMapData().

Variables#

const int

ID

int

Map

int

Level

int

Offset

int

Compass

int

Palette

int

MIDI

int

Continue

int

Type

int

Script

int

MusicTrack

int

ActiveSubscreen

int

PassiveSubscreen

int

OverlaySubscreen

int[]

Grid

int[]

MiniMapTile

int[]

MiniMapCSet

int[]

InitD

int[]

MapTile

int[]

MapCSet

bool[]

DisabledItems

int[]

Flagset

bool

Sideview

int

ASubScript

int

PSubScript

untyped[]

SubInitD

int

MapScript

untyped[]

MapInitD

int[]

Charted

int

MirrorDMap

int

Flags

int

MusicLoopStart

int

MusicLoopEnd

int

MusicCrossfadeIn

int

MusicCrossfadeOut

int

IntroStringID

Functions#

void

GetName(char32[] buffer)

void

SetName(char32[] buffer)

void

GetTitle(char32[] buf)

void

SetTitle(char32[] buf)

void

GetIntro(char32[] buffer)

void

SetIntro(char32[] buffer)

void

GetMusic(char32[] buffer)

void

SetMusic(char32[] filename)

Variable descriptions#

const int ID πŸ”— Source

The DMap’s ID number.


int Map πŸ”— Source

Which map this DMap is associated with.


int Level πŸ”— Source

The Level Number of this dmap.


int Offset πŸ”— Source

The DMap offset.


int Compass πŸ”— Source

The compass marker and continue screen numbers.


int Palette πŸ”— Source

The level palette to use for this DMap


int MIDI πŸ”— Source

The MIDI set to play on this dmap.


int Continue πŸ”— Source

The compass marker and continue screen numbers.


int Type πŸ”— Source

The type of the dmap, using the DmapType (DMAP_) constants.


int Script πŸ”— Source

The dmapdata script to run on this dmap.


int MusicTrack πŸ”— Source

The track number to use for enhanced music. See GetMusic().


int ActiveSubscreen πŸ”— Source

Which engine active subscreen to use on this dmap.


int PassiveSubscreen πŸ”— Source

Which engine passive subscreen to use on this dmap.


int OverlaySubscreen πŸ”— Source

Which engine overlay subscreen to use on this dmap.


int[] Grid πŸ”— Source

Bitwise values representing the state of the map grid. Make use of the functions in std_zh/dmapgrid.zh to access these values.


int[] MiniMapTile πŸ”— Source

The tile used for the engine subscreen Small Map. The [0] index tile is used without the dungeon map, and the [1] index with the dungeon map.


int[] MiniMapCSet πŸ”— Source

The csets used for the engine subscreen Small Map, to go along with the MiniMapTile[].


int[] InitD πŸ”— Source

The 8 InitD values for the active dmap script.


int[] MapTile πŸ”— Source

The tile used for the engine subscreen Large Map. The [0] index tile is used without the dungeon map, and the [1] index with the dungeon map.


int[] MapCSet πŸ”— Source

The csets used for the engine subscreen Large Map, to go along with the MapTile[].


bool[] DisabledItems πŸ”— Source

If each item on the dmap is disabled.


int[] Flagset πŸ”— Source

The flags for the dmap. Uses the DMFS_ constants.


bool Sideview πŸ”— Source

If true, the dmap is treated as sideview by default; screens with the sideview flag enabled will toggle sideview back *off*.


int ASubScript πŸ”— Source

Which dmapdata script to use as a replacement for the engine active subscreen (0 for none).


int PSubScript πŸ”— Source

Which dmapdata script to run for passive subscreen draws.


untyped[] SubInitD πŸ”— Source

The 8 InitD values shared by the Active and Passive Subscreen Scripts.


int MapScript πŸ”— Source

Which dmapdata script to use as a replacement for the engine fullscreen map (0 for none).


untyped[] MapInitD πŸ”— Source

The 8 InitD values used by the Map Script.


int[] Charted πŸ”— Source

Stores the large map exploration data for each screen on the dmap. <todo>Test if works on overworld dmaps.</todo>


int MirrorDMap πŸ”— Source

The DMap ID that using a Mirror will take you to. If this is -1, Mirrors will not be able to warp you to another dmap. If the Flagset[] β€˜Mirror Continues instead of Warping’ is set, the mirror dmap setting is not used.


int Flags πŸ”— Source

The flags used by the DMap. These are OR’d together.

  • CAVES 0x0001

  • 3STAIR 0x0002

  • WHIRLWIND 0x0004

  • GUYCAVES 0x0008

  • NOCOMPASS 0x0010

  • WAVY 0x0020

  • WHIRLWINDRET 0x0040

  • ALWAYSMSG 0x0080

  • VIEWMAP 0x0100

  • DMAPMAP 0x0200

  • MINIMAPCOLORFIX 0x0400

  • SCRIPT1 0x0800

  • SCRIPT2 0x1000

  • SCRIPT3 0x2000

  • SCRIPT4 0x4000

  • SCRIPT5 0x8000


int MusicLoopStart πŸ”— Source

The starting loop point for enhanced music in seconds.


int MusicLoopEnd πŸ”— Source

The ending loop point for enhanced music in seconds.


int MusicCrossfadeIn πŸ”— Source

The number of frames enhanced music fades in for.


int MusicCrossfadeOut πŸ”— Source

The number of frames enhanced music fades out for.


int IntroStringID πŸ”— Source

The ID in the string editor for the dmap’s intro string.


Function descriptions#

void GetName(char32[] buffer) πŸ”— Source

Fills the buffer with the dmap’s name.


void SetName(char32[] buffer) πŸ”— Source

Sets the DMap’s name to the buffer contents.


void GetTitle(char32[] buf) πŸ”— Source

Fills the buffer with the dmap’s title.


void SetTitle(char32[] buf) πŸ”— Source

Sets the DMap’s title to the buffer contents.


void GetIntro(char32[] buffer) πŸ”— Source

Fills the buffer with the dmap’s intro.


void SetIntro(char32[] buffer) πŸ”— Source

Sets the DMap’s intro to the buffer contents.


void GetMusic(char32[] buffer) πŸ”— Source

Fills the buffer with the dmap’s enhanced music filename. See MusicTrack.


void SetMusic(char32[] filename) πŸ”— Source

Sets the DMap’s enhanced music filename to the buffer contents. See MusicTrack.