mapdata#

Represents a single map screen.

Depending on how the mapdata was loaded, it may represent: - a temporary copy of the current screen (Game->LoadTempScreen()) - a temporary copy of a scrolling screen (Game->LoadScrollingScreen()) - the canonical copy of a screen (Game->LoadMapData())

Variables#

int

Valid

int

Guy

int

String

int

RoomType

int

Item

int[]

TileWarpType

int

Script

untyped[]

InitD

bool[]

TileWarpOverlay

int

DoorComboSet

int[]

WarpReturnX

int[]

WarpReturnY

int

StairsX

int

StairsY

int

ItemX

int

ItemY

int

Palette

int[]

Door

int[]

TileWarpDMap

int[]

TileWarpScreen

int

ExitDir

int[]

Enemy

int

Pattern

int[]

SideWarpType

int[]

SideWarpOverlay

int

WarpArrivalX

int

WarpArrivalY

int[]

MazePath

int[]

SideWarpScreen

int[]

SideWarpID

int[]

TileWarpReturnSquare

int[]

SideWarpReturnSquare

int[]

SideWarpDMap

int

UnderCombo

int

UnderCSet

int

Catchall

int

CSensitive

int

NoReset

int

NoCarry

int[]

LayerMap

int[]

LayerScreen

int[]

LayerOpacity

bool[]

LayerInvisible

bool[]

ScriptDraws

int

TimedWarpTimer

int

NextMap

int

NextScreen

int[]

SecretCombo

int[]

SecretCSet

int[]

SecretFlags

int[]

FFCData

int[]

FFCCSet

int[]

FFCDelay

int[]

FFCX

int[]

FFCY

int[]

FFCVx

int[]

FFCVy

int[]

FFCAx

int[]

FFCAy

int[]

FFCFlags

int[]

FFCEffectWidth

int[]

FFCEffectHeight

int[]

FFCTileWidth

int[]

FFCTileHeight

int[]

FFCLink

int[]

FFCScript

int

AmbientSFX

int

BossSFX

int

SecretSFX

int

ItemSFX

int

MIDI

int[]

Flags

int[]

ComboD

int[]

ComboC

int[]

ComboF

int[]

ComboI

int[]

ComboT

int[]

ComboS

int[]

ComboE

bool[]

State

bool[]

ExState

const int[]

EFlags

const int

Map

const int

Screen

bool[]

LensShows

bool[]

LensHides

int

DataSize

untyped[]

Data

int

GuyCount

bool[]

FFCRunning

int

OceanSFX

int

CSet

int

CarryoverMap

const int

CarryoverScreen

untyped[]

D deprecated

int

HasItem deprecated

const int[]

SFlags deprecated

int

WarpReturnC deprecated

int

EnemyFlags deprecated

int

SideWarpIndex deprecated

int

EntryX deprecated

int

EntryY deprecated

const bool[]

NumFFCs deprecated

int

LensLayer deprecated

Functions#

bool

isSolid(int x, int y)

bool

isSolidLayer(int x, int y, int layer)

untyped

GetFFCInitD(int ffc_index, int n)

void

SetFFCInitD(int ffc_index, int n, untyped value)

bool

GetExDoor(int dir, int index)

void

SetExDoor(int dir, int index, bool state)

int

GetFFCInitA(int ffc_index, int n)

int

SetFFCInitA(int ffc_index, int init_a, int value)

Variable descriptions#

int Valid 🔗 Source

Returns true if the screen is ‘valid’. Screens that appear with the default blue background in ZQuest are ‘invalid’. Modifying a combo on a screen makes it become ‘valid’. If a layer is ‘invalid’, it will not be drawn.

int Guy 🔗 Source

The screen guy.

int String 🔗 Source

The screen string.

int RoomType 🔗 Source

The screen room type. Use the RT_ constants for this value.

int Item 🔗 Source

The item placed on the screen. -1 if no item placed.

int[] TileWarpType 🔗 Source

The Tile Warp type for Tile Warps A, B, C, and D; [0], [1], [2], and [3] respectively.

Valid values: WarpType (WT_).

int Script 🔗 Source

The screen script that runs on this screen.

untyped[] InitD 🔗 Source

The 8 script arguments for the script that runs on this screen.

bool[] TileWarpOverlay 🔗 Source

Set or get the overlay state for the warp ID corresponding to the index of this array.

int DoorComboSet 🔗 Source

The Door Set used for the NES dungeon doors on this screen.

int[] WarpReturnX 🔗 Source

The X-component for each of the four 2.50+ (blue) warp return squares.

int[] WarpReturnY 🔗 Source

The Y-component for each of the four 2.50+ (blue) warp return squares.

int StairsX 🔗 Source

The X/Y position of the ‘Stairs’ secret on the screen.

int StairsY 🔗 Source

The X/Y position of the ‘Stairs’ secret on the screen.

int ItemX 🔗 Source

The X/Y position the screen’s item spawns at.

int ItemY 🔗 Source

The X/Y position the screen’s item spawns at.

int Palette 🔗 Source

The palette set in the F4 menu in ZQuest for this screen. Has no effect during play, but can be read and written.

int[] Door 🔗 Source

The 4 door states of the screen.

Valid indices: DIR_UP, DIR_DOWN, DIR_LEFT, DIR_RIGHT

int[] TileWarpDMap 🔗 Source

The destination DMap for each of the four warp types.

int[] TileWarpScreen 🔗 Source

The destination screen for each of the four warp types.

int ExitDir 🔗 Source

The Maze Path ‘Exit Direction’.

int[] Enemy 🔗 Source

The 10 enemies that appear on this screen.

int Pattern 🔗 Source

The spawn pattern for the screen enemies.

Valid values: EnemyPattern (PATTERN_).

int[] SideWarpType 🔗 Source

The Sidewarp type for Sidewarps A, B, C, and D; [0], [1], [2], and [3] respectively.

Valid values: WarpType (WT_).

int[] SideWarpOverlay 🔗 Source

Set or get the overlay state for the warp ID corresponding to the index of this array.

int WarpArrivalX 🔗 Source

The X-component for the pre-2.50 (green) arrival square.

int WarpArrivalY 🔗 Source

The X-component for the pre-2.50 (green) arrival square.

int[] MazePath 🔗 Source

The four directions you must go for the maze path.

Valid indices: DIR_UP, DIR_DOWN, DIR_LEFT, DIR_RIGHT

int[] SideWarpScreen 🔗 Source

The destination screen for each of the four sidewarps.

int[] SideWarpID 🔗 Source

Returns the sidewarp ID for a given screen edge, as SideWarpID``dir``;

Returns SIDEWARP_NONE if there is no sidewarp in that direction.

Valid indices: DIR_UP, DIR_DOWN, DIR_LEFT, DIR_RIGHT Valid values: SideWarpIndex (SIDEWARP_)

int[] TileWarpReturnSquare 🔗 Source

The return square used by the Tile Warp (A, B, C, D).

int[] SideWarpReturnSquare 🔗 Source

The return square used by the Side Warp (A, B, C, D).

int[] SideWarpDMap 🔗 Source

The destination DMap for each of the four sidewarps.

int UnderCombo 🔗 Source

The screen’s undercombo, which will appear as a result of various combo interactions, such as pushing blocks, awakening armos, etc.

int UnderCSet 🔗 Source

The CSet associated with the undercombo.

int Catchall 🔗 Source

The screen’s ‘catchall’ value. This is the roomtype-specific data, such as the ‘Special Item’ in a ‘Special Item’ room.

int CSensitive 🔗 Source

The value of damage combo sensitivity for the screen.

int NoReset 🔗 Source

The No Reset carryover flags.

int NoCarry 🔗 Source

The No Carry Over carryover flags.

int[] LayerMap 🔗 Source

The map and screen for each layer. Index [0] of these arrays does nothing, and is invalid to access.

int[] LayerScreen 🔗 Source

The map and screen for each layer. Index [0] of these arrays does nothing, and is invalid to access.

int[] LayerOpacity 🔗 Source

The opacity value (OP_OPAQUE or OP_TRANS) for each layer. Index [0] does nothing, and is invalid to access.

bool[] LayerInvisible 🔗 Source

If true, the given layer is invisible and will not be drawn.

bool[] ScriptDraws 🔗 Source

If false, the given layer of script draws will be disabled on this screen.

int TimedWarpTimer 🔗 Source

The timer used by ‘Time Warp Tics’ in Screen Data->T.Warp

int NextMap 🔗 Source

The map and screen that screen states carry over to.

int NextScreen 🔗 Source

The map and screen that screen states carry over to.

int[] SecretCombo 🔗 Source

The combo that will be placed for each secret type.

int[] SecretCSet 🔗 Source

The cset that will be placed for each secret type.

int[] SecretFlags 🔗 Source

The screen flags that will be placed for each secret type.

int[] FFCData 🔗 Source

The Data (combo ID) variable for each of the ffcs on the screen.

See ffc::Data for more details.

int[] FFCCSet 🔗 Source

The CSet variable for each of the ffcs on the screen.

See ffc::CSet for more details.

int[] FFCDelay 🔗 Source

The Delay variable for each of the ffcs on the screen.

See ffc::Delay for more details.

int[] FFCX 🔗 Source

The X variable for each of the ffcs on the screen.

See ffc::X for more details.

int[] FFCY 🔗 Source

The Y variable for each of the ffcs on the screen.

See ffc::Y for more details.

int[] FFCVx 🔗 Source

The Vx variable for each of the ffcs on the screen.

See ffc::Vx for more details.

int[] FFCVy 🔗 Source

The Vy variable for each of the ffcs on the screen.

See ffc::Vy for more details.

int[] FFCAx 🔗 Source

The Ax variable for each of the ffcs on the screen.

See ffc::Ax for more details.

int[] FFCAy 🔗 Source

The Vy variable for each of the ffcs on the screen.

See ffc::Vy for more details.

int[] FFCFlags 🔗 Source

The Flags variable for each of the ffcs on the screen.

See ffc::Flags[] for more details.

int[] FFCEffectWidth 🔗 Source

The EffectWidth variable for each of the ffcs on the screen.

See ffc::EffectWidth for more details.

int[] FFCEffectHeight 🔗 Source

The EffectHeight variable for each of the ffcs on the screen.

See ffc::EffectHeight for more details.

int[] FFCTileWidth 🔗 Source

The TileWidth variable for each of the ffcs on the screen.

See ffc::TileWidth for more details.

int[] FFCTileHeight 🔗 Source

The TileHeighr variable for each of the ffcs on the screen.

See ffc::TileHeight for more details.

The Link variable for each of the ffcs on the screen.

See ffc::Link for more details.

int[] FFCScript 🔗 Source

The Script variable for each of the ffcs on the screen.

See ffc::Script for more details.

int AmbientSFX 🔗 Source

The SFX for the ambient sound of the screen.

int BossSFX 🔗 Source

The SFX for the boss roar on this screen.

int SecretSFX 🔗 Source

The SFX that will play when secrets are triggered on this screen.

int ItemSFX 🔗 Source

The SFX that will play when an item is held up on this screen.

int MIDI 🔗 Source

The ‘Screen MIDI’ to play for this screen.

int[] Flags 🔗 Source

Arrays containing flag data for each screen.

int[] ComboD 🔗 Source

The Combo ID placed at each position on the screen.

int[] ComboC 🔗 Source

The CSet of the combo placed at each position on the screen.

int[] ComboF 🔗 Source

The mapflag placed at each position on the screen.

int[] ComboI 🔗 Source

The inherent flag of the combo placed at each position on the screen.

int[] ComboT 🔗 Source

The combo type of the combo placed at each position on the screen.

int[] ComboS 🔗 Source

The solidity map of the combo placed at each position on the screen.

int[] ComboE 🔗 Source

The effect map of the combo placed at each position on the screen.

bool[] State 🔗 Source

The screen states used for this screen. Use the ST_ constants to access this.

bool[] ExState 🔗 Source

The 32 ‘Extra States’ used for this screen.

const int[] EFlags 🔗 Source

Arrays containing flag data for each screen.

const int Map 🔗 Source

Returns the map this mapdata points to.

const int Screen 🔗 Source

Returns the screen this mapdata points to.

bool[] LensShows 🔗 Source

Arrays of the 7 layer show/hide values for the lens of truth.

bool[] LensHides 🔗 Source

Arrays of the 7 layer show/hide values for the lens of truth.

int DataSize 🔗 Source

Read-write, the size of the Data[] array.

untyped[] Data 🔗 Source

Resizable array of data for scripts to use. All changes are saved to the save file.

int GuyCount 🔗 Source

Number of enemies remaining alive on this screen.

bool[] FFCRunning 🔗 Source

Returns true if the specified ffc is running a script?

May be used to pause/resume ffc script execution?

This needs to be cloned over to ffc->Running

int OceanSFX 🔗 Source

The ‘Ambient Sound’ under S.Data2.

Rename this to AmbientSFX, or just SFX.

int CSet 🔗 Source

The screen palette.

int CarryoverMap 🔗 Source

const int CarryoverScreen 🔗 Source

untyped[] D 🔗 Source

Improperly implemented. Was meant to relate as Screen->D, except that

Screen->D is not bound to layermap.

Warning

Deprecated! mapdata->D[] has never worked!

int HasItem 🔗 Source

If not zero, then the item for this screen will be shown.

When Link takes the item on a screen, this is set to 0.

Warning

Deprecated! Check ‘->Item > -1’ instead!

const int[] SFlags 🔗 Source

Warning

Deprecated! Use Flags[] instead!

int WarpReturnC 🔗 Source

Stores the information on warp returns, butwise.

The bits are DDCCBBAADDCCBBAA, where the left section is sidewarp returns, and the right is tilewarp returns.

Warning

Deprecated! by SideWarpReturnSquare[4] and TileWarpReturnSquare[4]

int EnemyFlags 🔗 Source

A flagset for enemies on the screen (E.Flags).

Valid values (ORd) together, are:

TODO: write the values here

Warning

Deprecated!

int SideWarpIndex 🔗 Source

The warp return IDs.

Warning

Deprecated! by SideWarpID[].

int EntryX 🔗 Source

Warning

Deprecated! Use Hero->RespawnX instead!

int EntryY 🔗 Source

Warning

Deprecated! Use Hero->RespawnY instead!

const bool[] NumFFCs 🔗 Source

Warning

Deprecated!

int LensLayer 🔗 Source

Warning

Deprecated!

Function descriptions#

bool isSolid(int x, int y) 🔗 Source

Returns true if the given x,y position on the screen is ‘solid’.

bool isSolidLayer(int x, int y, int layer) 🔗 Source

Returns true if the given x,y position on the screen is ‘solid’.

untyped GetFFCInitD(int ffc_index, int n) 🔗 Source

Returns the value of InitD``n`` for the ffc on the screen with an ID of ffc_index.

This needs to be converted to the type ‘untyped’ to comply with the change of float ffc->InitD[] to untyped ffc->InitD[]

Note: Expressed as a function due to lack of 2D arrays in ZScript.

With 2D arrays, this would simply be FFCInitD[32][8].

void SetFFCInitD(int ffc_index, int n, untyped value) 🔗 Source

Sets the value of InitD``n`` for the ffc on the screen with an ID of ffc_index.

‘int value’ needs to be converted to the type ‘untyped’ to comply with the change of float ffc->InitD[] to untyped ffc->InitD[]

Note: Expressed as a function due to lack of 2D arrays in ZScript.

With 2D arrays, this would simply be FFCInitD[32][8].

bool GetExDoor(int dir, int index) 🔗 Source

Returns a door state for the screen.

void SetExDoor(int dir, int index, bool state) 🔗 Source

Sets a door state for the screen.

int GetFFCInitA(int ffc_index, int n) 🔗 Source

Returns the value of InitA``n`` for the ffc on the screen with an ID of ffc_index.

Note: Expressed as a function due to lack of 2D arrays in ZScript.

With 2D arrays, this would simply be FFCInitA[32][2].

int SetFFCInitA(int ffc_index, int init_a, int value) 🔗 Source

Sets the value of InitA``n`` for the ffc on the screen with an ID of ffc_index.

Note: Expressed as a function due to lack of 2D arrays in ZScript.

With 2D arrays, this would simply be FFCInitA[32][2].