dmapdata#

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)

Enumerations#

enum DMapType: 🔗 Source

DMap Types for used with dmapdata::Type

DMapType DMAP_DUNGEON = 0

DMapType DMAP_OVERWORLD = 1

DMapType DMAP_CAVE = 2

DMapType DMAP_BSOVERWORLD = 3

enum DMapFlag: 🔗 Source

Used with dmapdata::Flagset[].

DMapFlag DMFS_CAVESNOTCELLARS = 0

Use caves instead of item cellars

DMapFlag DMFS_3STAIRWARPS = 1

Allow 3-stair warps

DMapFlag DMFS_WWIND = 2

Allow whistle whirlwinds

DMapFlag DMFS_GUYCAVES = 3

Special rooms and guys are in caves only

DMapFlag DMFS_NOCOMPASS = 4

Don’t display compass marker in minimap

DMapFlag DMFS_WAVY = 5

Underwater wave effect

DMapFlag DMFS_WWINDRET = 6

Whistle whirlwind returns Link to beginning

DMapFlag DMFS_ALWAYSINTROMSG = 7

Always display intro string

DMapFlag DMFS_VIEWMAP = 8

View overworld map by pressing ‘Map’

DMapFlag DMFS_DMAPMAP = 9

…But only show screens marked in minimap

DMapFlag DMFS_MINIMAPCOLORFIX = 10

Use minimap foreground color 2

DMapFlag DMFS_MINIMAPCOLOURFIX = 10

Use minimap foreground color 2

DMapFlag DMFS_SCRIPT1 = 11

DMap Script Flag 1

DMapFlag DMFS_SCRIPT2 = 12

DMap Script Flag 2

DMapFlag DMFS_SCRIPT3 = 13

DMap Script Flag 3

DMapFlag DMFS_SCRIPT4 = 14

DMap Script Flag 4

DMapFlag DMFS_SCRIPT5 = 15

DMap Script Flag 5

DMapFlag DMFS_RESERVED = 16

RESERVED DO NOT USE

DMapFlag DMFS_LAYER3ISBACKGROUND = 17

Layer 3 is Background

DMapFlag DMFS_LAYER2ISBACKGROUND = 18

Layer 2 is Background

DMapFlag DMFS_TRUECELLARENEMIES = 19

True Cellar Enemies

DMapFlag DMFS_BUNNY = 20

Become Bunny with no Pearl

DMapFlag DMFS_MIRRORCONTINUE = 21

Mirror Continues instead of Warping

DMapFlag DMFS_MAX = 22

enum DMapBitflags: 🔗 Source

Used with Game->DMapFlags[] and dmapdata::Flags.

Deprecated: Use DMapFlag (DMFS_) and dmapdata::Flagset[] instead!

DMapBitflags DMF_CAVESNOTCELLARS = 1

Use caves instead of item cellars.

DMapBitflags DMF_3STAIRWARPS = 2

Allow 3-stair warps.

DMapBitflags DMF_WWIND = 4

Allow whistle whirlwinds.

DMapBitflags DMF_GUYCAVES = 8

Special rooms and guys are in caves only.

DMapBitflags DMF_NOCOMPASS = 16

Don’t display compass marker in minimap.

DMapBitflags DMF_WAVY = 32

Underwater wave effect.

DMapBitflags DMF_WWINDRET = 64

Whistle whirlwind returns Link to beginning.

DMapBitflags DMF_ALWAYSINTROMSG = 128

Always display intro string.

DMapBitflags DMF_VIEWMAP = 256

View overworld map by pressing ‘Map’.

DMapBitflags DMF_DMAPMAP = 512

…But only show screens marked in minimap.

DMapBitflags DMF_MINIMAPCOLORFIX = 1024

Use minimap foreground color 2.

DMapBitflags DMF_MINIMAPCOLOURFIX = 1024

Use minimap foreground color 2.

DMapBitflags DMF_SCRIPT1 = 2048

DMap Script Flags.

DMapBitflags DMF_SCRIPT2 = 4096

DMapBitflags DMF_SCRIPT3 = 8192

DMapBitflags DMF_SCRIPT4 = 16384

DMapBitflags DMF_SCRIPT5 = 32768

DMapBitflags DMF_SIDEVIEW = 65536

DMapBitflags DMF_LAYER3ISBACKGROUND = 131072

enum DMapChartedBitflags: 🔗 Source

DMapChartedBitflags CHRT_VISITED = 128

DMapChartedBitflags CHRT_UP = 1

DMapChartedBitflags CHRT_DOWN = 2

DMapChartedBitflags CHRT_LEFT = 4

DMapChartedBitflags CHRT_RIGHT = 8

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

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.

See SetVisibleOnDungeonMap(), VisibleOnDungeonMap().

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

index DMapFlag (DMFS_)

All of the dmap’s flags.

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

value DMapBitflags (DMF_)

The flags used by the DMap. These are OR’d together. See DMapBitflags (DMF_).

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.