subscreendata#

Variables#

int	CurPage
int	NumPages
const subscreenpage[]	Pages
const int	Type
bool[]	Flags
int	CursorPos
int	Script
untyped[]	InitD
bool[]	BtnPageLeft
bool[]	BtnPageRight
int	TransLeftType
int	TransLeftSFX
bool[]	TransLeftFlags
int[]	TransLeftArgs
int	TransRightType
int	TransRightSFX
bool[]	TransRightFlags
int[]	TransRightArgs
int	SelectorDestX
int	SelectorDestY
int	SelectorDestW
int	SelectorDestH
int[]	SelectorWid
int[]	SelectorHei
int[]	SelectorTile
int[]	SelectorCSet
int[]	SelectorFlashCSet
int[]	SelectorFrames
int[]	SelectorASpeed
int[]	SelectorDelay
int	TransClock
int	TransType
bool[]	TransFlags
int[]	TransArgs
int	TransFromPage
int	TransToPage

Functions#

void	GetName(char32[] buf)
void	SetName(char32[] buf)
void	SwapPages(int index1, int index2)

Enumerations#

enum TransitionFlag: 🔗 Source

TransitionFlag TRANSFLAG_NO_HIDE_SELECTOR = 0

TransitionFlag TRANSFLAG_MAX = 1

enum SubscreenWidgetType: 🔗 Source

SubscreenWidgetType SUBWIDG_NULL = 0

SubscreenWidgetType SUBWIDG_FRAME = 1

SubscreenWidgetType SUBWIDG_TEXT = 2

SubscreenWidgetType SUBWIDG_LINE = 3

SubscreenWidgetType SUBWIDG_RECT = 4

SubscreenWidgetType SUBWIDG_TIME = 5

SubscreenWidgetType SUBWIDG_MMETER = 6

SubscreenWidgetType SUBWIDG_LMETER = 7

SubscreenWidgetType SUBWIDG_BTNITM = 8

SubscreenWidgetType SUBWIDG_COUNTER = 9

SubscreenWidgetType SUBWIDG_OLDCTR = 10

SubscreenWidgetType SUBWIDG_MMAPTITLE = 11

SubscreenWidgetType SUBWIDG_MMAP = 12

SubscreenWidgetType SUBWIDG_LMAP = 13

SubscreenWidgetType SUBWIDG_BGCOLOR = 14

SubscreenWidgetType SUBWIDG_ITEMSLOT = 15

SubscreenWidgetType SUBWIDG_MCGUFF_FRAME = 16

SubscreenWidgetType SUBWIDG_MCGUFF = 17

SubscreenWidgetType SUBWIDG_TILEBLOCK = 18

SubscreenWidgetType SUBWIDG_MINITILE = 19

SubscreenWidgetType SUBWIDG_SELECTOR = 20

SubscreenWidgetType SUBWIDG_LGAUGE = 21

SubscreenWidgetType SUBWIDG_MGAUGE = 22

SubscreenWidgetType SUBWIDG_TEXTBOX = 23

SubscreenWidgetType SUBWIDG_SELECTEDTEXT = 24

SubscreenWidgetType SUBWIDG_MISCGAUGE = 25

SubscreenWidgetType SUBWIDG_BTNCOUNTER = 26

SubscreenWidgetType SUBWIDG_MAX = 27

enum SubscreenPageMode: 🔗 Source

SubscreenPageMode SUB_PGMODE_NONE = 0

no page change

SubscreenPageMode SUB_PGMODE_NEXT = 1

specified page

SubscreenPageMode SUB_PGMODE_MAX = 4

enum SSTYPE: 🔗 Source

SSTYPE SSTYPE_ACTIVE = 0

Subscreen Types

SSTYPE SSTYPE_PASSIVE = 1

SSTYPE SSTYPE_OVERLAY = 2

SSTYPE SSTYPE_MAX = 3

enum SSFL_ACTIVE: 🔗 Source

SSFL_ACTIVE SSFL_ACTIVE_NOPAGEWRAP = 0

Subscreen Flags

SSFL_ACTIVE SSFL_ACTIVE_OVERRIDE_SELECTOR = 1

SSFL_ACTIVE SSFL_ACTIVE_MAX = 2

enum SSFL_PASSIVE_MAX: 🔗 Source

SSFL_PASSIVE_MAX SSFL_PASSIVE_MAX = 0

enum SSFL_OVERLAY_MAX: 🔗 Source

SSFL_OVERLAY_MAX SSFL_OVERLAY_MAX = 0

enum TRANS_TY: 🔗 Source

TRANS_TY TRANS_TY_INSTANT = 0

Transition Types

TRANS_TY TRANS_TY_SLIDE = 1

TRANS_TY TRANS_TY_PIXEL = 2

TRANS_TY TRANS_TY_MAX = 3

enum TRANS_INSTANT_ARG_MAX: 🔗 Source

TRANS_INSTANT_ARG_MAX TRANS_INSTANT_ARG_MAX = 0

Transition arguments

enum TRANS_SLIDE_ARG: 🔗 Source

TRANS_SLIDE_ARG TRANS_SLIDE_ARG_DIR = 0

TRANS_SLIDE_ARG TRANS_SLIDE_ARG_SPEED = 1

TRANS_SLIDE_ARG TRANS_SLIDE_ARG_MAX = 2

enum TRANS_PIXEL_ARG: 🔗 Source

TRANS_PIXEL_ARG TRANS_PIXEL_ARG_INVERT = 0

TRANS_PIXEL_ARG TRANS_PIXEL_ARG_DURATION = 1

TRANS_PIXEL_ARG TRANS_PIXEL_ARG_XOFF = 2

TRANS_PIXEL_ARG TRANS_PIXEL_ARG_YOFF = 3

TRANS_PIXEL_ARG TRANS_PIXEL_ARG_MAX = 4

enum SUBVISIB: 🔗 Source

SUBVISIB SUBVISIB_CLOSED = 0

Visible while the active subscreen is closed

SUBVISIB SUBVISIB_OPEN = 1

Visible while the active subscreen is open

SUBVISIB SUBVISIB_SCROLLING = 2

Visible while the active subscreen is opening/closing

SUBVISIB SUBVISIB_NO_MSGSTR = 3

Hide while a message string is displaying

SUBVISIB SUBVISIB_MAX = 4

enum SUBW_GENFL: 🔗 Source

SUBW_GENFL SUBW_GENFL_SELECTABLE = 0

Widget genflags

SUBW_GENFL SUBW_GENFL_PGMODE_NOWRAP = 1

SUBW_GENFL SUBW_GENFL_SELECTOR_OVERRIDE = 2

SUBW_GENFL SUBW_GENFL_MAX = 3

enum SUB_CS: 🔗 Source

SUB_CS SUB_CS_MCGUFF = -1

Special Subscreen CSet Values

SUB_CS SUB_CS_MCGUFF_FRAME = -2

SUB_CS SUB_CS_OW_MAP = -3

SUB_CS SUB_CS_DUNG_MAP = -4

SUB_CS SUB_CS_BLUEFRAME = -5

SUB_CS SUB_CS_HCPIECES = -6

SUB_CS SUB_CS_SSVINE = -7

SUB_CS SUB_CS_MIN = -8

enum SUB_COLOR_SYS: 🔗 Source

SUB_COLOR_SYS SUB_COLOR_SYS_0 = -1

Special Subscreen Color Values

SUB_COLOR_SYS SUB_COLOR_SYS_1 = -2

SUB_COLOR_SYS SUB_COLOR_SYS_2 = -3

SUB_COLOR_SYS SUB_COLOR_SYS_3 = -4

SUB_COLOR_SYS SUB_COLOR_SYS_4 = -5

SUB_COLOR_SYS SUB_COLOR_SYS_5 = -6

SUB_COLOR_SYS SUB_COLOR_SYS_6 = -7

SUB_COLOR_SYS SUB_COLOR_SYS_7 = -8

SUB_COLOR_SYS SUB_COLOR_SYS_8 = -9

SUB_COLOR_SYS SUB_COLOR_SYS_9 = -10

SUB_COLOR_SYS SUB_COLOR_SYS_10 = -11

SUB_COLOR_SYS SUB_COLOR_SYS_11 = -12

SUB_COLOR_SYS SUB_COLOR_SYS_12 = -13

SUB_COLOR_SYS SUB_COLOR_SYS_13 = -14

SUB_COLOR_SYS SUB_COLOR_SYS_14 = -15

SUB_COLOR_SYS SUB_COLOR_SYS_15 = -16

SUB_COLOR_SYS SUB_COLOR_TEXT = -17

SUB_COLOR_SYS SUB_COLOR_CAPTION = -18

SUB_COLOR_SYS SUB_COLOR_OVERW_BG = -19

SUB_COLOR_SYS SUB_COLOR_DUNG_BG = -20

SUB_COLOR_SYS SUB_COLOR_DUNG_FG = -21

SUB_COLOR_SYS SUB_COLOR_CAVE_FG = -22

SUB_COLOR_SYS SUB_COLOR_BS_DARK = -23

SUB_COLOR_SYS SUB_COLOR_BS_GOAL = -24

SUB_COLOR_SYS SUB_COLOR_COMPASS_L = -25

SUB_COLOR_SYS SUB_COLOR_COMPASS_D = -26

SUB_COLOR_SYS SUB_COLOR_SUBSCR_BG = -27

SUB_COLOR_SYS SUB_COLOR_SUBSCR_SHD = -28

SUB_COLOR_SYS SUB_COLOR_MCGUFF_FRM = -29

SUB_COLOR_SYS SUB_COLOR_LMAP_BG = -30

SUB_COLOR_SYS SUB_COLOR_LMAP_FG = -31

SUB_COLOR_SYS SUB_COLOR_HERODOT = -32

SUB_COLOR_SYS SUB_COLOR_MSGTXT = -33

SUB_COLOR_SYS SUB_COLOR_TRANSPARENT = -34

SUB_COLOR_SYS SUB_COLOR_MIN = -35

enum SUB_SPTILE: 🔗 Source

SUB_SPTILE SUB_SPTILE_SSVINE = -1

Special Subscreen Tile Values

SUB_SPTILE SUB_SPTILE_MAGICMETER = -2

SUB_SPTILE SUB_SPTILE_MIN = -3

enum SUBW_FRAME_FLAG: 🔗 Source

SUBW_FRAME_FLAG SUBW_FRAME_FLAG_TRANSP = 0

Flags for SUBWIDG_FRAME

SUBW_FRAME_FLAG SUBW_FRAME_FLAG_OVERLAY = 1

SUBW_FRAME_FLAG SUBW_FRAME_NUMFLAGS = 2

enum SUBW_TEXT_NUMFLAGS: 🔗 Source

SUBW_TEXT_NUMFLAGS SUBW_TEXT_NUMFLAGS = 0

Flags for SUBWIDG_TEXT

enum SUBW_LINE: 🔗 Source

SUBW_LINE SUBW_LINE_FLAG_TRANSP = 0

Flags for SUBWIDG_LINE

SUBW_LINE SUBW_LINE_NUMFLAGS = 1

enum SUBW_RECT_FLAG: 🔗 Source

SUBW_RECT_FLAG SUBW_RECT_FLAG_TRANSP = 0

Flags for SUBWIDG_RECT

SUBW_RECT_FLAG SUBW_RECT_FLAG_FILLED = 1

SUBW_RECT_FLAG SUBW_RECT_NUMFLAGS = 2

enum SUBW_TIME: 🔗 Source

SUBW_TIME SUBW_TIME_FLAG_ALTSTR = 0

Flags for SUBWIDG_TIME

SUBW_TIME SUBW_TIME_NUMFLAGS = 1

enum SUBW_MMETER_NUMFLAGS: 🔗 Source

SUBW_MMETER_NUMFLAGS SUBW_MMETER_NUMFLAGS = 0

Flags for SUBWIDG_MMETER

enum SUBW_LMETER: 🔗 Source

SUBW_LMETER SUBW_LMETER_FLAG_BOTTOM = 0

Flags for SUBWIDG_LMETER

SUBW_LMETER SUBW_LMETER_NUMFLAGS = 1

enum SUBW_BTNITM: 🔗 Source

SUBW_BTNITM SUBW_BTNITM_FLAG_TRANSP = 0

Flags for SUBWIDG_BTNITM

SUBW_BTNITM SUBW_BTNITM_NUMFLAGS = 1

enum SUBW_COUNTER_FLAG: 🔗 Source

SUBW_COUNTER_FLAG SUBW_COUNTER_FLAG_SHOW0 = 0

Flags for SUBWIDG_COUNTER

SUBW_COUNTER_FLAG SUBW_COUNTER_FLAG_ONLYSEL = 1

SUBW_COUNTER_FLAG SUBW_COUNTER_NUMFLAGS = 2

enum SUBW_OLDCTR: 🔗 Source

SUBW_OLDCTR SUBW_OLDCTR_FLAG_USEX = 0

Flags for SUBWIDG_OLDCTR

SUBW_OLDCTR SUBW_OLDCTR_NUMFLAGS = 1

enum SUBW_MMAPTITLE_FLAG: 🔗 Source

SUBW_MMAPTITLE_FLAG SUBW_MMAPTITLE_FLAG_REQMAP = 0

Flags for SUBWIDG_MMAPTITLE

SUBW_MMAPTITLE_FLAG SUBW_MMAPTITLE_FLAG_ONELINE = 1

SUBW_MMAPTITLE_FLAG SUBW_MMAPTITLE_NUMFLAGS = 2

enum SUBW_MMAP_FLAG: 🔗 Source

SUBW_MMAP_FLAG SUBW_MMAP_FLAG_SHOWMAP = 0

Flags for SUBWIDG_MMAP

SUBW_MMAP_FLAG SUBW_MMAP_FLAG_SHOWPLAYER = 1

SUBW_MMAP_FLAG SUBW_MMAP_FLAG_SHOWCOMPASS = 2

SUBW_MMAP_FLAG SUBW_MMAP_NUMFLAGS = 3

enum SUBW_LMAP_FLAG: 🔗 Source

SUBW_LMAP_FLAG SUBW_LMAP_FLAG_SHOWMAP = 0

Flags for SUBWIDG_LMAP

SUBW_LMAP_FLAG SUBW_LMAP_FLAG_SHOWROOM = 1

SUBW_LMAP_FLAG SUBW_LMAP_FLAG_SHOWPLAYER = 2

SUBW_LMAP_FLAG SUBW_LMAP_FLAG_LARGE = 3

SUBW_LMAP_FLAG SUBW_LMAP_NUMFLAGS = 4

enum SUBW_BGCOLOR_NUMFLAGS: 🔗 Source

SUBW_BGCOLOR_NUMFLAGS SUBW_BGCOLOR_NUMFLAGS = 0

Flags for SUBWIDG_BGCOLOR

enum SUBW_ITEMSLOT_FLAG: 🔗 Source

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_FLAG_INVIS = 0

Flags for SUBWIDG_ITEMSLOT

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_FLAG_NON_EQUIPPABLE = 1

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_MOVE_IGNORE_SPEC_SELTEXT = 2

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_MOVE_IGNORE_SPEC_DISPLAY = 3

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_FLAG_NO_INTERACT_WO_ITEM = 4

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_FLAG_NO_INTERACT_WO_EQUIP = 5

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_FLAG_NO_UNEQUIP = 6

SUBW_ITEMSLOT_FLAG SUBW_ITEMSLOT_NUMFLAGS = 7

enum SUBW_MCGUFF_FRAME_FLAG: 🔗 Source

SUBW_MCGUFF_FRAME_FLAG SUBW_MCGUFF_FRAME_FLAG_SHOWFRAME = 0

Flags for SUBWIDG_MCGUFF_FRAME

SUBW_MCGUFF_FRAME_FLAG SUBW_MCGUFF_FRAME_FLAG_SHOWPIECES = 1

SUBW_MCGUFF_FRAME_FLAG SUBW_MCGUFF_FRAME_FLAG_LARGEPIECES = 2

SUBW_MCGUFF_FRAME_FLAG SUBW_MCGUFF_FRAME_NUMFLAGS = 3

enum SUBW_MCGUFF_FLAG: 🔗 Source

SUBW_MCGUFF_FLAG SUBW_MCGUFF_FLAG_OVERLAY = 0

Flags for SUBWIDG_MCGUFF

SUBW_MCGUFF_FLAG SUBW_MCGUFF_FLAG_TRANSP = 1

SUBW_MCGUFF_FLAG SUBW_MCGUFF_NUMFLAGS = 2

enum SUBW_TILEBLOCK_FLAG: 🔗 Source

SUBW_TILEBLOCK_FLAG SUBW_TILEBLOCK_FLAG_OVERLAY = 0

Flags for SUBWIDG_TILEBLOCK

SUBW_TILEBLOCK_FLAG SUBW_TILEBLOCK_FLAG_TRANSP = 1

SUBW_TILEBLOCK_FLAG SUBW_TILEBLOCK_NUMFLAGS = 2

enum SUBW_MINITILE_FLAG: 🔗 Source

SUBW_MINITILE_FLAG SUBW_MINITILE_FLAG_OVERLAY = 0

Flags for SUBWIDG_MINITILE

SUBW_MINITILE_FLAG SUBW_MINITILE_FLAG_TRANSP = 1

SUBW_MINITILE_FLAG SUBW_MINITILE_NUMFLAGS = 2

enum SUBW_SELECTOR_FLAG: 🔗 Source

SUBW_SELECTOR_FLAG SUBW_SELECTOR_FLAG_TRANSP = 0

Flags for SUBWIDG_SELECTOR

SUBW_SELECTOR_FLAG SUBW_SELECTOR_FLAG_LARGE = 1

SUBW_SELECTOR_FLAG SUBW_SELECTOR_FLAG_USEB = 2

SUBW_SELECTOR_FLAG SUBW_SELECTOR_NUMFLAGS = 3

enum SUBW_GAUGE_FLAG: 🔗 Source

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_MOD1 = 0

Flags for SUBWIDG_LGAUGE,SUBWIDG_MGAUGE,SUBWIDG_MISCGAUGE

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_MOD2 = 1

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_MOD3 = 2

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_MOD4 = 3

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_UNIQUE_LAST = 4

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_FULL_TILE = 5

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_ANIMATE_UNDER = 6

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_ANIMATE_OVER = 7

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_ANIMATE_PERCENT = 8

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_ANIMATE_SKIP_FIRST = 9

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_INFITEM_REQUIRE = 10

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_INFITEM_DISALLOW = 11

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_GRID_RTOL = 12

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_GRID_TTOPB = 13

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_GRID_COLUMN_FIRST = 14

SUBW_GAUGE_FLAG SUBW_GAUGE_FLAG_GRID_SNAKE_PATTERN = 15

SUBW_GAUGE_FLAG SUBW_GAUGE_NUMFLAGS = 16

enum SUBW_TEXTBOX: 🔗 Source

SUBW_TEXTBOX SUBW_TEXTBOX_FLAG_WORDWRAP = 0

Flags for SUBWIDG_TEXTBOX

SUBW_TEXTBOX SUBW_TEXTBOX_NUMFLAGS = 1

enum SUBW_SELECTEDTEXT: 🔗 Source

SUBW_SELECTEDTEXT SUBW_SELECTEDTEXT_FLAG_WORDWRAP = 0

Flags for SUBWIDG_SELECTEDTEXT

SUBW_SELECTEDTEXT SUBW_SELECTEDTEXT_NUMFLAGS = 1

enum SUBW_BTNCOUNTER_FLAG: 🔗 Source

SUBW_BTNCOUNTER_FLAG SUBW_BTNCOUNTER_FLAG_SHOW0 = 0

Flags for SUBWIDG_BTNCOUNTER

SUBW_BTNCOUNTER_FLAG SUBW_BTNCOUNTER_FLAG_NOCOLLAPSE = 1

SUBW_BTNCOUNTER_FLAG SUBW_BTNCOUNTER_NUMFLAGS = 2

Variable descriptions#

int CurPage 🔗 Source

The currently selected page.

int NumPages 🔗 Source

The total number of pages

const subscreenpage[] Pages 🔗 Source

The array containing the pages

const int Type 🔗 Source

Compare with the SSTYPE_ constants.

The type of the subscreen.

bool[] Flags 🔗 Source

The flags of the subscreen. Use the SSFL_*_ constants to access.

int CursorPos 🔗 Source

The position value of the selector.

int Script 🔗 Source

The subscreen’s script.

untyped[] InitD 🔗 Source

The subscreen’s InitD[] parameters

bool[] BtnPageLeft 🔗 Source

Use InteractButton (INTBTN_) to index this array.

The ‘true’ buttons here, when pressed, change pages leftwards.

bool[] BtnPageRight 🔗 Source

Use InteractButton (INTBTN_) to index this array.

The ‘true’ buttons here, when pressed, change pages rightwards.

int TransLeftType 🔗 Source

The transition type for left/right transitions.

Compare with the TRANS_TY_ constants.

int TransLeftSFX 🔗 Source

The transition sfx for left/right transitions.

bool[] TransLeftFlags 🔗 Source

The flags for left/right transitions.

Use the TRANSFLAG_ constants to access these.

int[] TransLeftArgs 🔗 Source

The arguments used for left/right transitions.

Use the ‘TRANS__ARG_ constants to access these

int TransRightType 🔗 Source

The transition type for left/right transitions.

Compare with the TRANS_TY_ constants.

int TransRightSFX 🔗 Source

The transition sfx for left/right transitions.

bool[] TransRightFlags 🔗 Source

The flags for left/right transitions.

Use the TRANSFLAG_ constants to access these.

int[] TransRightArgs 🔗 Source

The arguments used for left/right transitions.

Use the ‘TRANS__ARG_ constants to access these

int SelectorDestX 🔗 Source

The X/Y/W/H offsets for the selector on this subscreen, if the selector is overridden (see Flags).

These values will be ADDED to the x/y/w/h that the selector would normally draw to.

int SelectorDestY 🔗 Source

The X/Y/W/H offsets for the selector on this subscreen, if the selector is overridden (see Flags).

These values will be ADDED to the x/y/w/h that the selector would normally draw to.

int SelectorDestW 🔗 Source

The X/Y/W/H offsets for the selector on this subscreen, if the selector is overridden (see Flags).

These values will be ADDED to the x/y/w/h that the selector would normally draw to.

int SelectorDestH 🔗 Source

The X/Y/W/H offsets for the selector on this subscreen, if the selector is overridden (see Flags).

These values will be ADDED to the x/y/w/h that the selector would normally draw to.

int[] SelectorWid 🔗 Source