Screen#
Contains functionality related to the currently loaded mapdata screen, including functions for drawing and creating/loading objects belonging to the screen.
Many variables in Screen refer to a single mapdata screen (such as Screen->UnderCombo).
For a scrolling Region with multiple screens, which screen these variables refer to
depends on the context of the running script. See Screen->Index for more.
The combo array variables (such as Screen->ComboD[]) may access any combo position
in the current region. Use ComboAt() to translate (x, y) world coordinates to a
combo position. The size of these arrays is NUM_COMBO_POS.
For accessing specific screens, see mapdata.
Access with Screen->.
Tutorials#
Variables#
const int |
|
untyped[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
bool[] |
|
bool[] |
|
bool |
|
int |
|
int |
|
const int |
|
const int |
|
const int |
|
const int |
|
const int |
|
const int |
|
int[] |
|
int[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int[] |
|
bool[] |
|
int |
|
int[] |
|
int[] |
|
int |
|
int |
|
int |
|
int |
|
int[] |
|
int[] |
|
int |
|
int[] |
|
int |
|
int[] |
|
bool[] |
|
int |
|
int |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int[] |
|
int[] |
|
int[] |
|
bool[] |
|
bool[] |
|
int |
|
int |
|
int |
|
int[] |
|
int[] |
|
int[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
untyped[] |
|
const bool |
|
const int |
|
const npc[] |
|
const itemsprite[] |
|
const lweapon[] |
|
const eweapon[] |
|
const ffc[] |
|
const portal[] |
|
bool[] |
|
bool[] |
|
int |
|
untyped[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
HasItem deprecated |
int[] |
ScreenFlags deprecated |
int |
EnemyFlags deprecated |
int |
SideWarpIndex deprecated |
bool[] |
NumFFCs deprecated |
int |
EntryX deprecated |
int |
EntryY deprecated |
int |
LensLayer deprecated |
Functions#
int |
NumItems() deprecated |
LoadItem(int n) |
|
CreateItem(int id) |
|
LoadFFC(int id) |
|
LoadFFC(int screen, int index) |
|
int |
NumNPCs() deprecated |
LoadNPC(int n) |
|
CreateNPC(int id) |
|
void |
ClearSprites(int spritelist) |
void |
Rectangle(int layer, int x, int y, int x2, int y2, int color, int scale = |
void |
Circle(int layer, int x, int y, int radius, int color, int scale = |
void |
Arc(int layer, int x, int y, int radius, int start_degrees, int end_degrees, int color, int scale = |
void |
Ellipse(int layer, int x, int y, int xradius, int yradius, int color, int scale = |
void |
Line(int layer, int x, int y, int x2, int y2, int color, int scale = |
void |
Spline(int layer, int x1, int y1, int x2, int y2, int x3, int y3, int x4, int y4, int color, int opacity = |
void |
PutPixel(int layer, int x, int y, int color, int rx = |
void |
PutPixels(int layer, int ptr, int rx, int ry, int rot_degrees) |
void |
DrawTiles(int layer, int ptr) |
void |
DrawCombos(int layer, int ptr) |
void |
Lines(int layer, int ptr) |
void |
DrawCharacter(int layer, int x, int y, int font, int color, int bg_color, int width, int height, char32 c, int opacity = |
void |
DrawInteger(int layer, int x, int y, int font, int color, int bg_color, int width, int height, int value, int num_decimal_places = |
void |
DrawTile(int layer, int x, int y, int tile, int block_w, int block_h, int cset, int xscale = |
void |
DrawTileCloaked(int layer, int x, int y, int tile, int blockw, int blockh, int flip = |
void |
DrawCombo(int layer, int x, int y, int combo, int w, int h, int cset, int xscale = |
void |
DrawComboCloaked(int layer, int x, int y, int combo, int tilewidth, int tileheight, int flip = |
void |
Quad(int layer, int x1, int y1, int x2, int y2, int x3, int y3, int x4, int y4, int w, int h, int cset, int flip, int texture, int render_mode) |
void |
Triangle(int layer, int x1, int y1, int x2, int y2, int x3, int y3, int w, int h, int cset, int flip, int texture, int render_mode) |
void |
Quad3D(int layer, int[] pos, int[] uv, int[] csets, int[] size, int flip, int texture, int render_mode) |
void |
Triangle3D(int layer, int[] pos, int[] uv, int[] csets, int[] size, int flip, int tile, int polytype) |
void |
FastTile(int layer, int x, int y, int tile, int cset, int opacity = |
void |
FastCombo(int layer, int x, int y, int combo, int cset, int opacity = |
void |
DrawString(int layer, int x, int y, int font, int color, int background_color, int format, char32[] str, int opacity = |
void |
DrawString(int layer, int x, int y, int font, int color, int background_color, int format, char32[] str, int opacity, int shadow_type, int shadow_color) |
void |
DrawLayer(int layer, int source_map, int source_screen, int source_layer, int x, int y, int rotation = |
void |
DrawScreen(int layer, int map, int screen, int x, int y, int rotation = |
void |
DrawBitmap(int layer, int bitmap_id, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation, bool mask) |
void |
DrawBitmapEx(int layer, int bitmap_id, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation = |
void |
TileBlit(int layer, int tile, int cset, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation = |
void |
ComboBlit(int layer, int combo, int cset, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation = |
void |
SetRenderTarget(int rt) |
void |
Message(int message_id) |
int |
NumLWeapons() deprecated |
LoadLWeapon(int n) |
|
CreateLWeapon(int type) |
|
int |
NumEWeapons() deprecated |
LoadEWeapon(int n) |
|
CreateEWeapon(int type) |
|
bool |
isSolid(int x, int y) |
bool |
isSolidLayer(int x, int y, int layer) |
void |
|
void |
TriggerSecrets(int screen) |
void |
ZapIn() |
void |
ZapOut() |
void |
WavyIn() |
void |
WavyOut() |
void |
|
void |
|
void |
OpeningWipe(int effect) |
void |
ClosingWipe(int effect) |
void |
Polygon(int layer, int num_points, int vertices, int color, int opacity = |
void |
DrawFrame(int layer, int x, int y, int tile, int cset, int width, int height, bool overlay = |
bool |
SecretsTriggered() deprecated |
bool |
|
bool |
TriggerCombo(int layer, int pos) |
int |
NumPortals() deprecated |
LoadPortal(int n) |
|
void |
DrawLightSquare(int cx, int cy, int radius = |
void |
DrawLightCircle(int cx, int cy, int radius = |
void |
DrawLightCone(int cx, int cy, int dir, int length = |
bool |
GetExDoor(int dir, int index) |
void |
SetExDoor(int dir, int index, bool state) |
void |
SetSideWarp(int warp_id, int screen, int dmap, int type) |
void |
SetTileWarp(int warp_id, int screen, int dmap, int type) |
CreateLWeaponDx(int type, int baseitem) |
|
LoadNPCByUID(int uid) deprecated |
|
LoadLWeaponByUID(int uid) deprecated |
|
LoadEWeaponByUID(int uid) deprecated |
|
int |
LayerMap(int layer) deprecated |
int |
LayerScreen(int layer) deprecated |
int |
GetSideWarpDMap(int warp_id) deprecated |
int |
GetSideWarpScreen(int warp_id) deprecated |
int |
GetSideWarpType(int warp_id) deprecated |
int |
GetTileWarpDMap(int warp_id) deprecated |
int |
GetTileWarpScreen(int warp_id) deprecated |
int |
GetTileWarpType(int warp_id) deprecated |
Enumerations#
WipeEffect WIPE_CIRCLE = 0
WipeEffect WIPE_OVAL = 1
WipeEffect WIPE_TRIANGLE = 2
WipeEffect WIPE_SMAS = 3
WipeEffect WIPE_FADEBLACK = 4
WipeEffect WIPE_MAX = 5
Determines how to interpret coordinates given to Screen draw functions.
DrawOrigin DRAW_ORIGIN_DEFAULT = 0L
Equal to DRAW_ORIGIN_REGION, unless in a scrolling region (or scrolling to/from one), in which case this is equal to DRAW_ORIGIN_PLAYING_FIELD.
DrawOrigin DRAW_ORIGIN_PLAYING_FIELD = 1L
The origin (0, 0) is the top-left pixel of the playing field (where screen combos are drawn).
Normally, this is just below the passive subscreen. But in extended height mode,
this is the top-left pixel of the screen and so is equivalent to DRAW_ORIGIN_SCREEN.
Use this to draw overlay effects across the playing field.
DrawOrigin DRAW_ORIGIN_SCREEN = 2L
The origin (0, 0) is the top-left pixel of the screen.
Use this to draw overlay effects across the entire screen.
DrawOrigin DRAW_ORIGIN_REGION = 3L
The origin (0, 0) is the top-left pixel of the current region. Use this to draw with a
sprite’s coordinates.
When scrolling, this is treated as DRAW_ORIGIN_REGION_SCROLLING_NEW for new screens and DRAW_ORIGIN_REGION_SCROLLING_OLD for old screens.
DrawOrigin DRAW_ORIGIN_REGION_SCROLLING_NEW = 4L
The origin (0, 0) is the top-left pixel of the new region being scrolled to.
Equivalent to DRAW_ORIGIN_REGION when not scrolling.
DrawOrigin DRAW_ORIGIN_REGION_SCROLLING_OLD = 5L
The origin (0, 0) is the top-left pixel of the old region being scrolled away from.
Equivalent to DRAW_ORIGIN_REGION when not scrolling.
DrawOrigin DRAW_ORIGIN_SPRITE = 6L
The origin (0, 0) is the top-left pixel of the sprite Screen->DrawOriginTarget.
If the sprite no longer exists at time of drawing, then the draw command will be ignored.
enum ScreenEnemyFlagGroup: 🔗 Source
Screen enemy flag groups. Used with Screen->EFlags[].
ScreenEnemyFlagGroup SEF_SPAWN = 0
Corresponds to ScreenEnemyFlagSpawn (SEFSP_).
ScreenEnemyFlagGroup SEF_LIST1 = 1
Corresponds to ScreenEnemyFlagList1 (SEFL1_).
ScreenEnemyFlagGroup SEF_LIST2 = 2
Corresponds to ScreenEnemyFlagList2 (SEFL2_).
enum PolygonRenderMode: 🔗 Source
Polygon rendering modes. Use with Screen->”Psuedo 3D” or “*3D” drawing functions. ie; Polygon, Quad, or Triangle For more detail on these polygon rendering modes, see https://github.com/ZQuestClassic/ZQuestClassic/blob/main/third_party/allegro_legacy/docs/src/allegro._tx#L7808.
PolygonRenderMode PT_FLAT = 0
Single color shading.
PolygonRenderMode PT_FLATSHADED = 1
“” with flat shading (*3D only).
PolygonRenderMode PT_COLSHADED = 2
“” with color shading (*3D only).
PolygonRenderMode PT_TEXTURE = 3
Texture mapped polygon using 2d linear interpolation.
PolygonRenderMode PT_PTEXTURE = 4
“”.
PolygonRenderMode PT_MASKTEXTURE = 5
Transparent texture mapped polygon using 2d linear interpolation.
PolygonRenderMode PT_MASKPTEXTURE = 6
“”.
PolygonRenderMode PT_LITTEXTURE = 7
“” with lighting (*3D only).
PolygonRenderMode PT_LITPTEXTURE = 8
“” (*3D only).
PolygonRenderMode PT_MASKLITTEXTURE = 9
“” with transparency.
PolygonRenderMode PT_MASKLITPTEXTURE = 10
“”.
PolygonRenderMode PT_TRANSTEXTURE = 11
Translucent texture mapped polygon using 2d linear interpolation.
PolygonRenderMode PT_TRANSPTEXTURE = 12
“”.
PolygonRenderMode PT_MASKTRANSTEXTURE = 13
Translucent and transparent texture mapped polygon using 2d linear interpolation.
PolygonRenderMode PT_MASKTRANSPTEXTURE = 14
“”.
Sprite lists. Used with Screen->ClearSprites().
SpriteList SL_GUYS = 0
Enemies.
SpriteList SL_ITEMS = 1
Items.
SpriteList SL_EWPNS = 2
Enemy weapons.
SpriteList SL_LWPNS = 3
Link’s weapons.
SpriteList SL_DECORATIONS = 4
Grass clippings, Hover boots glow, etc.
SpriteList SL_PARTICLES = 5
Farore’s Wind particles.
enum ScreenFlagGroup: 🔗 Source
Screen Flag groups, used with Screen->Flags[]. See Screen Data dialog for what flags are contained in each group.
ScreenFlagGroup SF_ROOMTYPE = 0
Corresponds to ScreenFlagRoomType (SFR_).
ScreenFlagGroup SF_VIEW = 1
Corresponds to ScreenFlagView (SFV_).
ScreenFlagGroup SF_SECRETS = 2
Corresponds to ScreenFlagSecrets (SFS_).
ScreenFlagGroup SF_WARP = 3
Corresponds to ScreenFlagWarp (SFW_).
ScreenFlagGroup SF_ITEMS = 4
Corresponds to ScreenFlagItems (SFI_).
ScreenFlagGroup SF_COMBOS = 5
Corresponds to ScreenFlagCombos (SFC_).
ScreenFlagGroup SF_SAVE = 6
Corresponds to ScreenFlagSave (SFSV_).
ScreenFlagGroup SF_FFC = 7
Corresponds to ScreenFlagFFC (SFF_).
ScreenFlagGroup SF_WHISTLE = 8
Corresponds to ScreenFlagWhistle (SFWH_).
ScreenFlagGroup SF_MISC = 9
Corresponds to ScreenFlagMisc (SFM_).
ScreenFlagGroup SF_LAST = 10
enum ScreenFlagRoomType: 🔗 Source
ScreenFlagRoomType SFR_INTERIOR = 0
ScreenFlagRoomType SFR_DUNGEON = 1
ScreenFlagRoomType SFR_SIDEVIEW = 2
ScreenFlagRoomType SFR_LAST = 3
ScreenFlagView SFV_INVISLINK = 0
ScreenFlagView SFV_NOLINKMARKER = 1
ScreenFlagView SFV_NOSUBSCREEN = 2
ScreenFlagView SFV_NOOFFSET = 3
‘…but don’t offset’
ScreenFlagView SFV_LAYER2BG = 4
Layer 2 is Background
ScreenFlagView SFV_LAYER3BG = 5
ScreenFlagView SFV_DARKROOM = 6
ScreenFlagView SFV_DARK_DITHER = 7
ScreenFlagView SFV_DARK_TRANS = 8
ScreenFlagView SFV_LAST = 9
enum ScreenFlagSecrets: 🔗 Source
ScreenFlagSecrets SFS_BLOCKSHUT = 0
Block->Shutters
ScreenFlagSecrets SFS_TEMPSECRETS = 1
Secrets are temporary.
ScreenFlagSecrets SFS_TRIGPERM = 2
All Triggers->Perm Secret
ScreenFlagSecrets SFS_ALLTRIGFLAGS = 3
All triggers->16-31
ScreenFlagSecrets SFS_LAST = 4
ScreenFlagWarp SFW_AUTODIRECT = 0
Auto Warps are Direct
ScreenFlagWarp SFW_SENDSIRECT = 1
Sensitive Warps are direct.
ScreenFlagWarp SFW_MAZEPATHS = 2
Use maze Path
ScreenFlagWarp SFW_MAZEOVERRIDE = 3
maze Overrides Sidewarps
ScreenFlagWarp SFW_SPRITECARRY = 4
Sprites carry over.
ScreenFlagWarp SFW_DISABLE_MIRROR = 5
Disable Magic Mirror
ScreenFlagWarp SFW_MAZE_CAN_GET_LOST = 6
Maze Can Get Lost
ScreenFlagWarp SFW_MAZE_LOOPY = 7
Maze Loopy
ScreenFlagWarp SFW_LAST = 8
enum ScreenFlagItems: 🔗 Source
ScreenFlagItems SFI_HOLDUP = 0
Hold up item.
ScreenFlagItems SFI_FALLS = 1
Falls from ceiling
ScreenFlagItems SFI_SECRETSITEM = 2
Secret reveals item
ScreenFlagItems SFI_ITEMSECRET = 3
Item triggers secrets
ScreenFlagItems SFI_ITEMSECRETPERM = 4
Item triggering secrets is permanent
ScreenFlagItems SFI_ITEMRETURNS = 5
Regular item always returns
ScreenFlagItems SFI_SPECIALITEMRETURNS = 6
Special item always returns
ScreenFlagItems SFI_LAST = 7
enum ScreenFlagCombos: 🔗 Source
ScreenFlagCombos SFC_MIDAIR = 0
Combos affect midair Link
ScreenFlagCombos SFC_CYCLEINIT = 1
Cycle combos on screen init.
ScreenFlagCombos SFC_IGNOREBOOTS = 2
Damage combos ignore boots.
ScreenFlagCombos SFC_TOGGLERINGS = 3
Toggle ‘Rings Affect Combos’
ScreenFlagCombos SFC_LAST = 4
ScreenFlagSave SFSV_SAVECONTHERE = 0
Save Point->ontinue here.
ScreenFlagSave SFSV_SAVEONENTRY = 1
Save game on entry.
ScreenFlagSave SFSV_CONTHERE = 2
Comtinue here.
ScreenFlagSave SFSV_NOCONTINUEWARP = 3
No continue Here after warp.
ScreenFlagSave SFSV_LAST = 4
ScreenFlagFFC SFF_WRAP = 0
Freeform Combos Wrap Around
ScreenFlagFFC SFF_NOCARRYOVER = 1
No FFC carry over.
ScreenFlagFFC SFF_LAST = 2
ScreenFlagMisc SFM_ALLOW_LADDER = 0
Toggle ‘Allow Ladder’
ScreenFlagMisc SFM_NO_DIVING = 1
Toggle ‘No Diving’
ScreenFlagMisc SFM_SCRIPT1 = 2
General use 1 (Scripts)
ScreenFlagMisc SFM_SCRIPT2 = 3
General use 2 (Scripts)
ScreenFlagMisc SFM_SCRIPT3 = 4
General use 3 (Scripts)
ScreenFlagMisc SFM_SCRIPT4 = 5
General use 4 (Scripts)
ScreenFlagMisc SFM_SCRIPT5 = 6
General use 5 (Scripts)
ScreenFlagMisc SFM_LAST = 7
enum ScreenFlagWhistle: 🔗 Source
ScreenFlagWhistle SFWH_STAIRS = 0
Whistle->Stairs
ScreenFlagWhistle SFWH_PALCHANGE = 1
Whistle->Palette Change
ScreenFlagWhistle SFWH_DRYLAKE = 2
Whistle->Dry lake
ScreenFlagWhistle SFWH_LAST = 3
enum ScreenEnemyFlagSpawn: 🔗 Source
See ScreenEnemyFlagGroup (SEF_).
ScreenEnemyFlagSpawn SEFSP_ZORA = 0
ScreenEnemyFlagSpawn SEFSP_CORNERTRAP = 1
ScreenEnemyFlagSpawn SEFSP_MIDDLETRAP = 2
ScreenEnemyFlagSpawn SEFSP_ROCK = 3
ScreenEnemyFlagSpawn SEFSP_SHOOTER = 4
ScreenEnemyFlagSpawn SEFSP_LAST = 5
enum ScreenEnemyFlagList1: 🔗 Source
See ScreenEnemyFlagGroup (SEF_).
ScreenEnemyFlagList1 SEFL1_RINGLEADER = 0
ScreenEnemyFlagList1 SEFL1_CARRYITEM = 1
ScreenEnemyFlagList1 SEFL1_INVIS = 2
ScreenEnemyFlagList1 SEFL1_BOSS = 3
ScreenEnemyFlagList1 SEFL1_TRAPS_IGNORE_SOLID = 4
ScreenEnemyFlagList1 SEFL1_LAST = 5
enum ScreenEnemyFlagList2: 🔗 Source
See ScreenEnemyFlagGroup (SEF_).
ScreenEnemyFlagList2 SEFL2_ALWAYSRET = 0
ScreenEnemyFlagList2 SEFL2_ENEMIES_ITEM = 1
ScreenEnemyFlagList2 SEFL2_ENEMEIS_SECRET = 2
ScreenEnemyFlagList2 SEFL2_ENEMIES_SECRET_PERM = 3
ScreenEnemyFlagList2 SEFL2_CHAIN_ENEMIES_TRIGGERS = 4
ScreenEnemyFlagList2 SEFL2_LAST = 5
Render Targets. Used with Screen->”*RenderTarget” and Screen->”Bitmap” drawing functions.
RenderTarget RT_CURRENT = -2
Used with Blit(). mode7(), and RevBlit() for the current RT as dest.
RenderTarget RT_SCREEN = -1
Draws to screen.
RenderTarget RT_BITMAP0 = 0
Draws to off-screen bitmap 0.
RenderTarget RT_BITMAP1 = 1
Draws to off-screen bitmap 1.
RenderTarget RT_BITMAP2 = 2
Draws to off-screen bitmap 2.
RenderTarget RT_BITMAP3 = 3
Draws to off-screen bitmap 3.
RenderTarget RT_BITMAP4 = 4
Draws to off-screen bitmap 4.
RenderTarget RT_BITMAP5 = 5
Draws to off-screen bitmap 5.
RenderTarget RT_BITMAP6 = 6
Draws to off-screen bitmap 6.
Variable descriptions#
Added in version 2.55.9: equivalent to Game->CurScreen
The index for the underlying screen. This determines which screen some variables refer to (such as UnderCombo, Valid, or Guy, just to name a few).
In a non-scrolling Region, this is equal to Game->CurScreen.
In a scrolling Region, the default is equal to Game->CurScreen (the top-left screen). However, many script types use a more relevant screen instead. For example:
screendata scripts use the screen they are assigned to
ffc, npc, eweapon, lweapon, itemsprite, combo - all use the screen they were spawned on (sprite::SpawnScreen)
player - uses Game->HeroScreen, which updates as the player moves around
A set of 8 misc values for each screen.
The combo ID of each of the NUM_COMBO_POS combo positions on the screen.
The CSet of each of the NUM_COMBO_POS combo positions on the screen.
The placed (map) flag of each of the NUM_COMBO_POS combo positions on the screen.
The inherent flag of each of the NUM_COMBO_POS combo positions on the screen.
value ComboType (CT_)
The combo type of each of the NUM_COMBO_POS combo positions on the screen.
value ComboSolidityBitflags (CMB_)
The solidity bitflags of each of the NUM_COMBO_POS combo positions on the screen.
The effect area bitflags of each of the NUM_COMBO_POS combo positions on the screen.
index ScreenState (ST_)
The 32 screen states used by this screen.
The ‘Extra States’ used by this screen.
Whether or not the current Region is ‘lit’. Applies to Classic Darkrooms.
The remaining time, in frames, of the ‘Wavy’ visual effect. Decrements by 1 each frame.
The remaining time, in frames, of the ‘Quake’ visual effect. Decrements by 1 each frame.
Returns the number of the given object type that are present on the current screen.
const int GetRenderTarget 🔗 Source
value RenderTarget (RT_)
Gets/sets the current “Render Target”. Most times this should be ‘RT_SCREEN’, though versions older than 2.55 required using this for bitmap drawing. 2.55’s bitmap effectively obsolete the render target system, and should be used instead of this.
Returns the number of the given object type that are present on the current screen.
const int ShowingMessage 🔗 Source
The message ID of the currently active message. 0 if no message is displayed.
const int NumLWeapons 🔗 Source
Returns the number of the given object type that are present on the current screen.
const int NumEWeapons 🔗 Source
Returns the number of the given object type that are present on the current screen.
index ScreenFlagGroup (SF_)
value Varies based on ScreenFlagGroup (SF_)
Multiple bitflags, split into groups.
index ScreenEnemyFlagGroup (SEF_)
value Varies based on ScreenEnemyFlagGroup (SEF_)
Multiple bitflags related to screen enemies, split into groups.
value RoomType
The special room type.
The layer of a currently moving pushblock. Is -1 and ignores writes if there is no pushblock currently moving. Allows values 0-6; the block will “settle into place” on this layer.
The undercombo ID used by the screen.
The CSet of the undercombo used by the screen.
The screen guy.
The screen string.
The screen item.
To determine if there is an item on the screen, if you ever assigned item 0 as a valid screen item in your quest, you will also want to read HasItem for that screen.
Note: The NULL value is 0, which is a valid item.
index TileWarpIndex (TILEWARP_)
value WarpType (WT_)
The Tile Warp type for Tile Warps A, B, C, and D; [0], [1], [2], and [3] respectively.
bool[] TileWarpOverlay 🔗 Source
Set or get the overlay state for the warp ID corresponding to the index of this array.
The doorset used by the screen, for NES dungeon doors.
The X-component for each of the four 2.50+ (blue) warp return squares.
The Y-component for each of the four 2.50+ (blue) warp return squares.
The X component for where a Stairs secret appears on the screen.
The Y component for where a Stairs secret appears on the screen.
The X component for the item location on the screen.
The Y component for the item location on the screen.
The destination DMap for each of the four warp types.
The destination screen for each of the four warp types.
The Maze Path ‘Exit Direction’.
The IDs of the enemies that spawn on the screen.
value EnemyPattern (PATTERN_)
The enemy ‘Spawn Pattern’.
index SideWarpIndex
value WarpType (WT_)
The Sidewarp type for Sidewarps A, B, C, and D; [0], [1], [2], and [3] respectively.
bool[] SideWarpOverlay 🔗 Source
Set or get the overlay state for the warp ID corresponding to the index of this array.
The X-component for the pre-2.50 (green) arrival square.
The X-component for the pre-2.50 (green) arrival square.
The four Maze Path directions.
The destination screen for each of the four sidewarps.
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
int[] TileWarpReturnSquare 🔗 Source
The return square used by Tile Warp (A, B, C, D).
int[] SideWarpReturnSquare 🔗 Source
The return square used by Side Warp (A, B, C, D).
The destination DMap for each of the four sidewarps.
The palette for the screen set via ‘F4’ or ‘Screen>>Palette’ in ZQuest
The screen ‘Catchall’ value.
The value of Damage Combo Sensitivity for the screen.
value NoResetBitflags (NORESET_)
Which parts of the screen state that won’t reset on reentry.
value NoCarryBitflags (NOCARRY_)
For screen state carryovers, which parts of the screen state that won’t carry over to the target screen.
The Map IDs used by screen layers 1 through 6, represented as [1] through [6].
Index [0] does nothing, and trying to access it will report an error to the log.
This only refers to the screen denoted by Index.
The Screen IDs used by screen layers 1 through 6, represented as [1] through [6].
Index [0] does nothing, and trying to access it will report an error to the log.
This only refers to the screen denoted by Index.
The opacity value for each layer used by this screen.
Valid layers are 1 through 6, represented as [1] through [6].
Index [0] does nothing, and trying to access it will report an error to the log.
bool[] LayerInvisible 🔗 Source
If true, the current layer is invisible.
Writing this true for layers 1 through 6 will make those layers invisible.
If true, the ZC engine will perform script draws on the given queue layer.
Each queue layer returns true by default.
Writing this false disables script draws targetted to a specific layer queue.
The timer used by ‘Time Warp Tics’ in Screen Data->T.Warp
The map to where secrets on the current mapscreen carry over.
Corresponds to the Screen Data>>>Screen State Carryover ‘Next Map’ selection in the ZQ Editor.
The screen to where secrets on the current mapscreen carry over.
Corresponds to the Screen Data>>>Screen State Carryover ‘Next Screen’ selection in the ZQ Editor.
index SecretComboIndex (SECCMB_)
The Combo IDs used by ‘Secret Combos’ on this screen.
index SecretComboIndex (SECCMB_)
The CSets used by ‘Secret Combos’ on this screen.
index SecretComboIndex (SECCMB_)
value ComboFlag (CF_)
The Combo Flags used by ‘Secret Combos’ on this screen.
The ‘Ambient Sound’ under S.Data2.
The Boss Roar sound for this screen.
The sound that will play on this screen, when secrets are triggered.
The sound that will play if Link holds an item over his head on this screen.
The MIDI that plays on this screen.
The screendata script used for the current screen.
The eight D args used by the screendata script for the current screen.
const bool SecretsTriggered 🔗 Source
Returns true if secrets have been triggered on this screen (including temp).
Returns the number of the given object type that are present on the current screen.
Internal Array pointers to arrays containing all of each respective type of object on the screen. These arrays are 0-indexed.
const itemsprite[] Items 🔗 Source
Internal Array pointers to arrays containing all of each respective type of object on the screen. These arrays are 0-indexed.
const lweapon[] LWeapons 🔗 Source
Internal Array pointers to arrays containing all of each respective type of object on the screen. These arrays are 0-indexed.
const eweapon[] EWeapons 🔗 Source
Internal Array pointers to arrays containing all of each respective type of object on the screen. These arrays are 0-indexed.
Internal Array pointers to arrays containing all of each respective type of object on the screen. These arrays are 0-indexed.
const portal[] Portals 🔗 Source
Internal Array pointers to arrays containing all of each respective type of object on the screen. These arrays are 0-indexed.
Arrays of the layers which the lens shows, and hides, respectively.
Arrays of the layers which the lens shows, and hides, respectively.
The size of the Data[] array.
Changes save to the save file.
Resizable array of data for scripts to use.
Changes save to the save file.
Number of enemies remaining alive on this screen.
The palette for the screen set via ‘F4’ or ‘Screen>>Palette’ in ZQuest
If not zero, then the item for this screen will be shown.
When the Hero takes the item on a screen, this is set to 0.
Deprecated: Check ->Item > -1 instead!
Deprecated.
A flagset for enemies on the screen (E.Flags).
Deprecated: Use EFlags[] instead!
The warp return IDs. Deprecated by SideWarpID[].
Deprecated.
Deprecated.
Deprecated: Use Hero->RespawnX instead!
Deprecated: Use Hero->RespawnY instead!
Deprecated.
DrawOrigin DrawOrigin 🔗 Source
Added in version 2.55.9.
Determines how coordinates given to Screen drawing functions are interpreted.
Each script has its own copy of this variable, meaning other scripts can’t change a script’s draw origin unexpectedly.
Defaults to DRAW_ORIGIN_DEFAULT.
sprite DrawOriginTarget 🔗 Source
Added in version 3.0.
When Screen->DrawOrigin is DRAW_ORIGIN_SPRITE, this sprite is used as the origin for Screen drawing functions.
Each script has its own copy of this variable.
Function descriptions#
Returns the number of the given object type that are present on the current screen.
Deprecated: Use NumItems instead!
itemsprite LoadItem(int n) 🔗 Source
Where ‘1 <= n <= NumItems’, returns a pointer to the nth object on the screen.
itemsprite CreateItem(int id) 🔗 Source
param ItemID (I_) id
Creates a new item sprite.
Returns the ffc for the given id, where 1 <= id <= MAX_FFC.
See ffc::ID.
ffc LoadFFC(int screen, int index) 🔗 Source
Returns the ffc from screen of the specified index, where 0 <= index < 128.
screen must be a valid screen within the current Region.
Returns the number of the given object type that are present on the current screen.
Deprecated: Use NumNPCs instead!
Where 1 <= n <= NumNPCs, returns a pointer to the nth npc on the
screen.
npc CreateNPC(int id) 🔗 Source
param NPCID (NPC_) id
Creates a new npc (enemy) sprite, with the given ID.
void ClearSprites(int spritelist) 🔗 Source
param SpriteList (SL_) spritelist
Kills all sprite objects of the specified type.
void Rectangle(int layer, int x, int y, int x2, int y2, int color, int scale = 1, int rx = 0, int ry = 0, int rot_degrees = 0, bool fill = true, int opacity = OP_OPAQUE) 🔗 Source
void Circle(int layer, int x, int y, int radius, int color, int scale = 1, int rx = 0, int ry = 0, int rot_degrees = 0, bool fill = true, int opacity = OP_OPAQUE) 🔗 Source
void Arc(int layer, int x, int y, int radius, int start_degrees, int end_degrees, int color, int scale = 1, int rx = 0, int ry = 0, int rot_degrees = 0, bool closed = true, bool fill = true, int opacity = OP_OPAQUE) 🔗 Source
void Ellipse(int layer, int x, int y, int xradius, int yradius, int color, int scale = 1, int rx = 0, int ry = 0, int rot_degrees = 0, bool fill = true, int opacity = OP_OPAQUE) 🔗 Source
void Line(int layer, int x, int y, int x2, int y2, int color, int scale = 1, int rx = 0, int ry = 0, int rot_degrees = 0, int opacity = OP_OPAQUE) 🔗 Source
void Spline(int layer, int x1, int y1, int x2, int y2, int x3, int y3, int x4, int y4, int color, int opacity = OP_OPAQUE) 🔗 Source
void PutPixel(int layer, int x, int y, int color, int rx = 0, int ry = 0, int rot_degrees = 0, int opacity = OP_OPAQUE) 🔗 Source
void PutPixels(int layer, int ptr, int rx, int ry, int rot_degrees) 🔗 Source
Puts multiple pixels to the screen in one function call.
PutPixels() expects an array as its arg, with the array in the format of
repeating blocks of { x, y, color, trans } Example:
PutPixels(1, { 25, 10, 5, OP_OPAQUE, 26, 10, 6, OP_OPAQUE }, 0, 0, 0 );This draws two pixels to the screen.
The first is at coordinates (25, 10), color 5, and it is opaque. The
second is at coordinates (26, 10), color 6, and opaque.
void DrawTiles(int layer, int ptr) 🔗 Source
Similar to FastTile(), but it draws multiple tiles in one call.
The arg *ptr[] should be an array with repeating sets of:
{x,y,tile,color,opacity}
…per tile that you want to draw.
void DrawCombos(int layer, int ptr) 🔗 Source
Similar to FastCombo, but draws multiple combos in one call.
The arg *ptr[] should be an array with repeating sets of:
{x,y,combo,cset,opacity}
…per combo that you want to draw.
void Lines(int layer, int ptr) 🔗 Source
Similar to Line(0, but draws multiple lines in one call.
The arg *ptr[] should be an array with repeating sets of: { x, y, x2,
y2, color, scale, rx, ry, angle, opacity }
…per line that you want to draw.
void DrawCharacter(int layer, int x, int y, int font, int color, int bg_color, int width, int height, char32 c, int opacity = OP_OPAQUE) 🔗 Source
void DrawInteger(int layer, int x, int y, int font, int color, int bg_color, int width, int height, int value, int num_decimal_places = 0, int opacity = OP_OPAQUE) 🔗 Source
void DrawTile(int layer, int x, int y, int tile, int block_w, int block_h, int cset, int xscale = -1, int yscale = -1, int rx = 0, int ry = 0, int rot_degrees = 0, int flip = 0, bool transparency = true, int opacity = OP_OPAQUE) 🔗 Source
void DrawTileCloaked(int layer, int x, int y, int tile, int blockw, int blockh, int flip = 0) 🔗 Source
As DrawTile(), but draws with a cloaked effect.
void DrawCombo(int layer, int x, int y, int combo, int w, int h, int cset, int xscale = -1, int yscale = -1, int rx = 0, int ry = 0, int rot_degrees = 0, int frame = 0, int flip = 0, bool transparency = true, int opacity = OP_OPAQUE) 🔗 Source
void DrawComboCloaked(int layer, int x, int y, int combo, int tilewidth, int tileheight, int flip = 0) 🔗 Source
As DrawCombo(), but draws with a cloaked effect.
void Quad(int layer, int x1, int y1, int x2, int y2, int x3, int y3, int x4, int y4, int w, int h, int cset, int flip, int texture, int render_mode) 🔗 Source
void Triangle(int layer, int x1, int y1, int x2, int y2, int x3, int y3, int w, int h, int cset, int flip, int texture, int render_mode) 🔗 Source
void Quad3D(int layer, int[] pos, int[] uv, int[] csets, int[] size, int flip, int texture, int render_mode) 🔗 Source
void Triangle3D(int layer, int[] pos, int[] uv, int[] csets, int[] size, int flip, int tile, int polytype) 🔗 Source
void FastTile(int layer, int x, int y, int tile, int cset, int opacity = OP_OPAQUE) 🔗 Source
void FastCombo(int layer, int x, int y, int combo, int cset, int opacity = OP_OPAQUE) 🔗 Source
void DrawString(int layer, int x, int y, int font, int color, int background_color, int format, char32[] str, int opacity = OP_OPAQUE) 🔗 Source
void DrawString(int layer, int x, int y, int font, int color, int background_color, int format, char32[] str, int opacity, int shadow_type, int shadow_color) 🔗 Source
As DrawString(), but includes a shadow on the text.
Valid values for shadow_type: ShadowType (SHD_).
void DrawLayer(int layer, int source_map, int source_screen, int source_layer, int x, int y, int rotation = 0, int opacity = OP_OPAQUE) 🔗 Source
void DrawScreen(int layer, int map, int screen, int x, int y, int rotation = 0) 🔗 Source
void DrawBitmap(int layer, int bitmap_id, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation, bool mask) 🔗 Source
void DrawBitmapEx(int layer, int bitmap_id, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation = 0, int cx = 0, int cy = 0, int mode = 0, int lit = 0, bool mask = true) 🔗 Source
void TileBlit(int layer, int tile, int cset, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation = 0, int cx = 0, int cy = 0, int mode = 0, int lit = 0, bool mask = true) 🔗 Source
As ‘bitmap->BlitTo’, but draws from a tile instead of a bitmap
Blit supports multiple MODES, OR’d together as a bitmask:
const int BITDX_NORMAL = 0;
const int BITDX_TRANS = 0x01; //Translucent
const int BITDX_PIVOT = 0x02; //THe sprite will rotate at a specific
point, instead of its center. const int BITDX_HFLIP = 0x04; //Horizontal
Flip const int BITDX_VFLIP = 0x08; //Vertical Flip.You can also set a pivot point for the rotation, using ‘int cx’ and ‘int cy’
If these are non-zero, the rotation anchor point will center on these coordinates.
You may specify a color to ‘int lit’ to use a lit mode. This tints the entire bitmap using that color index of the main palette.
void ComboBlit(int layer, int combo, int cset, int source_x, int source_y, int source_w, int source_h, int dest_x, int dest_y, int dest_w, int dest_h, int rotation = 0, int cx = 0, int cy = 0, int mode = 0, int lit = 0, bool mask = true) 🔗 Source
As ‘TileBlit’, but uses the current tile of a specified combo.
Blit supports multiple MODES, OR’d together as a bitmask:
const int BITDX_NORMAL = 0;
const int BITDX_TRANS = 0x01; //Translucent
const int BITDX_PIVOT = 0x02; //THe sprite will rotate at a specific
point, instead of its center. const int BITDX_HFLIP = 0x04; //Horizontal
Flip const int BITDX_VFLIP = 0x08; //Vertical Flip.You can also set a pivot point for the rotation, using ‘int cx’ and ‘int cy’
If these are non-zero, the rotation anchor point will center on these coordinates.
You may specify a color to ‘int lit’ to use a lit mode. This tints the entire bitmap using that color index of the main palette.
void SetRenderTarget(int rt) 🔗 Source
param RenderTarget (RT_) rt
Gets/sets the current “Render Target”. Most times this should be ‘RT_SCREEN’, though versions older than 2.55 required using this for bitmap drawing. 2.55’s bitmap effectively obsolete the render target system, and should be used instead of this.
void Message(int message_id) 🔗 Source
Triggers the message number message_id from the Strings table to be
displayed on the screen.
If message_id is 0, any message being displayed will be removed.
Returns the number of the given object type that are present on the current screen.
Deprecated: Use NumLWeapons instead!
lweapon LoadLWeapon(int n) 🔗 Source
param int n - Between 1 and NumLWeapons (inclusive).
Returns a pointer to the nth lweapon on the screen.
lweapon CreateLWeapon(int type) 🔗 Source
param LWeaponType (LW_) type
Creates a new lweapon sprite, with the given type.
Returns the number of the given object type that are present on the current screen.
Deprecated: Use NumEWeapons instead!
eweapon LoadEWeapon(int n) 🔗 Source
param int n - Between 1 and NumEWeapons (inclusive).
Returns a pointer to the nth eweapon on the screen.
eweapon CreateEWeapon(int type) 🔗 Source
param EWeaponType (EW_) type
Creates a new eweapon sprite, with the given type.
bool isSolid(int x, int y) 🔗 Source
bool isSolidLayer(int x, int y, int layer) 🔗 Source
As Screen->isSolid(), but instead of returning true if there is solidity on layers 0, 1, or 2 - returns the solidity only for the specified layer.
void TriggerSecrets() 🔗 Source
Triggers secrets on this screen (Screen->Index).
Temporary only, for permanent use Screen->State[].
void TriggerSecrets(int screen) 🔗 Source
Triggers secrets on the provided screen, which must be within the current Region.
Temporary only, for permanent use Game->LoadTempScreen() and mapdata::State[].
Plays the warping screen ‘zap’ effect.
Plays the warping screen ‘zap’ effect.
Plays the warping screen ‘wave’ effect.
Plays the warping screen ‘wave’ effect.
Plays the warping screen ‘wipe’ effect, respecting the wipe-related QRs.
Plays the warping screen ‘wipe’ effect, respecting the wipe-related QRs.
void OpeningWipe(int effect) 🔗 Source
Plays the warping screen ‘wipe’ effect.
Valid values for effect: WipeEffect (WIPE_).
void ClosingWipe(int effect) 🔗 Source
Plays the warping screen ‘wipe’ effect.
Valid values for effect: WipeEffect (WIPE_).
void Polygon(int layer, int num_points, int vertices, int color, int opacity = OP_OPAQUE) 🔗 Source
void DrawFrame(int layer, int x, int y, int tile, int cset, int width, int height, bool overlay = true, int opacity = OP_OPAQUE) 🔗 Source
Draws a frame using a 2x2 block of tiles, where the upper-left corner of which is the ‘tile’ value
This works based on how the engine subscreen frame object works, stretching the frame from those tiles to whatever size you specify.
Width/height are in 8-pixel increments; ex. 4,4 would give a 2x2 tile block; 8,8 would give a 4x4.
bool SecretsTriggered() 🔗 Source
Returns true if secrets have been triggered on this screen (including temp).
Deprecated: Use SecretsTriggered instead!
bool SpawnScreenEnemies() 🔗 Source
Immediately attempts to spawn all the screen enemies (Enemy[]), using the Pattern.
bool TriggerCombo(int layer, int pos) 🔗 Source
Attempts to trigger the combo at ‘layer,pos’. Returns true on success, false on failure.
Returns the number of the given object type that are present on the current screen.
Deprecated: Use NumPortals instead!
portal LoadPortal(int n) 🔗 Source
param int n - Between 1 and NumPortals (inclusive).
Returns a pointer to the nth portal on the screen.
portal CreatePortal() 🔗 Source
Creates a new portal object.
void DrawLightSquare(int cx, int cy, int radius = -1, int transp_rad = -1, int dith_rad = -1, int dith_type = -1, int dith_arg = -1) 🔗 Source
Draws a square light to the engine darkroom bitmap, centered on ‘cx,cy’.
Any of the args that defaults to -1, if passed as -1, will use the default
value from Game->Generic[] associated.
void DrawLightCircle(int cx, int cy, int radius = -1, int transp_rad = -1, int dith_rad = -1, int dith_type = -1, int dith_arg = -1) 🔗 Source
Draws a circular light to the engine darkroom bitmap, centered on ‘cx,cy’.
Any of the args that defaults to -1, if passed as -1, will use the default
value from Game->Generic[] associated.
void DrawLightCone(int cx, int cy, int dir, int length = -1, int transp_rad = -1, int dith_rad = -1, int dith_type = -1, int dith_arg = -1) 🔗 Source
Draws a cone of light to the engine darkroom bitmap, emanating in the
8-dir ‘dir’ from the point ‘cx,cy’.
Any of the args that defaults to -1, if passed as -1, will use the default
value from Game->Generic[] associated.
bool GetExDoor(int dir, int index) 🔗 Source
Returns a door state for the screen.
Each direction (DIR_UP,DIR_DOWN,DIR_LEFT,DIR_RIGHT) has 8 indexes (0-7)
void SetExDoor(int dir, int index, bool state) 🔗 Source
Sets a door state for the screen.
Each direction (DIR_UP,DIR_DOWN,DIR_LEFT,DIR_RIGHT) has 8 indexes (0-7)
void SetSideWarp(int warp_id, int screen, int dmap, int type) 🔗 Source
Valid values for type: WarpType (WT_).
void SetTileWarp(int warp_id, int screen, int dmap, int type) 🔗 Source
lweapon CreateLWeaponDx(int type, int baseitem) 🔗 Source
Create an lweapon with sprites, sounds, and other values set as if it was generated by a specific item.
npc LoadNPCByUID(int uid) 🔗 Source
Deprecated.
lweapon LoadLWeaponByUID(int uid) 🔗 Source
Deprecated.
eweapon LoadEWeaponByUID(int uid) 🔗 Source
Deprecated.
int LayerMap(int layer) 🔗 Source
Deprecated: Use LayerMap[] instead!
int LayerScreen(int layer) 🔗 Source
Deprecated: Use LayerScreen[] instead!
int GetSideWarpDMap(int warp_id) 🔗 Source
Deprecated: Use SideWarpDMap[] instead!
int GetSideWarpScreen(int warp_id) 🔗 Source
Deprecated: Use SideWarpScreen[] instead!
int GetSideWarpType(int warp_id) 🔗 Source
Deprecated: Use SideWarpType[] instead!
int GetTileWarpDMap(int warp_id) 🔗 Source
Deprecated: Use TileWarpDMap[] instead!
int GetTileWarpScreen(int warp_id) 🔗 Source
Deprecated: Use TileWarpScreen[] instead!
int GetTileWarpType(int warp_id) 🔗 Source
Deprecated: Use TileWarpType[] instead!
Added in version 3.0.