subscreenwidget#
Variables#
const int |
|
const int |
|
const subscreenpage |
|
const int |
|
const int |
|
int |
|
int[] |
|
bool[] |
|
int |
|
int |
|
int |
|
int |
|
const int |
|
const int |
|
const int |
|
const int |
|
bool[] |
|
bool[] |
|
int |
|
int |
|
int |
|
int |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int[] |
|
int |
|
untyped[] |
|
bool[] |
|
bool[] |
|
int |
|
int |
|
int |
|
int |
|
bool[] |
|
int[] |
|
int[] |
|
int[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int[] |
|
int |
|
int |
|
int |
|
char32 |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
Functions#
void |
GetSelTextOverride(char32[] buf) |
void |
SetSelTextOverride(char32[] str) |
void |
GetLabel(char32[] buf) |
void |
SetLabel(char32[] str) |
void |
GetText(char32[] buf) |
void |
SetText(char32[] str) |
Enumerations#
SubscreenItemButton ITMBTN_A = 0
SubscreenItemButton ITMBTN_B = 1
SubscreenItemButton ITMBTN_X = 2
SubscreenItemButton ITMBTN_Y = 3
SubscreenItemButton NUM_ITMBTN = 4
Variable descriptions#
value
SubscreenWidgetType (SUBWIDG_)
The widget’s type.
The index of this widget within the page.
const subscreenpage Page 🔗 Source
The page this widget is within.
const int DisplayItem 🔗 Source
The display/equip item ID for the widget.
Reads as -1 if no item exists, the widget is of a type that has no item, etc
The display/equip item ID for the widget.
Reads as -1 if no item exists, the widget is of a type that has no item, etc
The selector position of this flag.
Only used if the widget is selectable (see GenFlags
).
index
Direction (DIR_)
The 4 directional positions for the selector.
Only used if the widget is selectable (see GenFlags
).
Flags related to the visibility of the widget.
Use the ‘SUBVISIB_’ constants to access.
The X position of the widget within the subscreen.
Some widget types do not use this.
The Y position of the widget within the subscreen.
Some widget types do not use this.
The width/height of the widget within the subscreen.
This is USUALLY in pixels, but some types use different values! ex. for 2x2 frame, this is in minitiles, so 8 times less than pixels.
Some widget types do not use this.
The width/height of the widget within the subscreen.
This is USUALLY in pixels, but some types use different values! ex. for 2x2 frame, this is in minitiles, so 8 times less than pixels.
Some widget types do not use this.
Gets the display x, in pixels.
The rectangle represented by this is the same as the bounding box shown in the subscreen editor in ZQ.
Gets the display y, in pixels.
The rectangle represented by this is the same as the bounding box shown in the subscreen editor in ZQ.
Gets the display width, in pixels.
The rectangle represented by this is the same as the bounding box shown in the subscreen editor in ZQ.
Gets the display height, in pixels.
The rectangle represented by this is the same as the bounding box shown in the subscreen editor in ZQ.
The general flags for subscreen widgets. These are usually applicable regardless of widget type. Use the ‘SUBW_GENFL_’ constants to access.
The type-specific flags for subscreen widgets.
There is a different set of constants for this for each widget type.
The X/Y/W/H offsets for the selector on this widget, if the selector is
overridden (see GenFlags
).
These values will REPLACE the x/y/w/h that the selector would normally draw to.
The X/Y/W/H offsets for the selector on this widget, if the selector is
overridden (see GenFlags
).
These values will REPLACE the x/y/w/h that the selector would normally draw to.
The X/Y/W/H offsets for the selector on this widget, if the selector is
overridden (see GenFlags
).
These values will REPLACE the x/y/w/h that the selector would normally draw to.
The X/Y/W/H offsets for the selector on this widget, if the selector is
overridden (see GenFlags
).
These values will REPLACE the x/y/w/h that the selector would normally draw to.
The width (in pixels) for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
The height (in pixels) for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
The tile for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
The cset for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
int[] SelectorFlashCSet 🔗 Source
The flashcset for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
The animation frames for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
The animation speed for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
The animation delay for the two selector overrides.
Will be used by the selector on this widget, if the selector is
overridden (see GenFlags
).
The generic script that will run when a specified button is pressed while this widget is selected.
The 8 InitD[] args for the PressScript
bool[] BtnPressScript 🔗 Source
Use InteractButton (INTBTN_) to index this array.
The ‘true’ buttons here, when pressed while this widget is selected, run the press script.
Use InteractButton (INTBTN_) to index this array.
The ‘true’ buttons here, when pressed while this widget is selected,
change the current page based on PageMode
.
The type of page change that will occur when a specified button is pressed while this widget is selected.
Use the SubscreenPageMode (SUB_PGMODE_) (SUB_PGMODE_
) constants for this value.
The page to change to when using PageMode of ‘SUB_PGMODE_TARG’
The transition type for PageMode
transition.
Compare with the ‘TRANS_TY_’ constants.
The transition sfx for PageMode
transition.
bool[] PageTransFlags 🔗 Source
The flags for PageMode
transition.
Use the ‘TRANSFLAG_’ constants to access these.
The arguments used for PageMode
transition.
Use the ‘TRANS_*_ARG_’ constants to access these
The widget’s cset(s).
For SUBWIDG_FRAME,SUBWIDG_MCGUFF,SUBWIDG_TILEBLOCK,SUBWIDG_MINITILE: can use the ‘SUB_CS_’ constants.
SUBWIDG_FRAME
- 1 valuesSUBWIDG_MCGUFF
- 1 valuesSUBWIDG_TILEBLOCK
- 1 valuesSUBWIDG_MINITILE
- 1 valuesSUBWIDG_MISCGAUGE
- 4 valuesSUBWIDG_LGAUGE
- 4 valuesSUBWIDG_MGAUGE
- 4 values
The widget’s tile(s).
For SUBWIDG_MINITILE, can use the ‘SUB_SPTILE_’ constant values.
SUBWIDG_FRAME
- 1 valuesSUBWIDG_MCGUFF
- 1 valuesSUBWIDG_TILEBLOCK
- 1 valuesSUBWIDG_MINITILE
- 1 valuesSUBWIDG_MISCGAUGE
- 4 valuesSUBWIDG_LGAUGE
- 4 valuesSUBWIDG_MGAUGE
- 4 values
value
Font
The widget’s font.
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
SUBWIDG_TIME
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_BTNCOUNTER
SUBWIDG_MMAPTITLE
SUBWIDG_SELECTEDTEXT
value
TextAlignment (TF_)
The widget’s text alignment.
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
SUBWIDG_TIME
SUBWIDG_COUNTER
SUBWIDG_BTNCOUNTER
SUBWIDG_MMAPTITLE
SUBWIDG_SELECTEDTEXT
value
ShadowType (SHD_)
The widget’s Shadow Type.
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
SUBWIDG_TIME
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_BTNCOUNTER
SUBWIDG_MMAPTITLE
SUBWIDG_SELECTEDTEXT
The widget’s color index used for Text
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
SUBWIDG_TIME
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_BTNCOUNTER
SUBWIDG_MMAPTITLE
SUBWIDG_SELECTEDTEXT
SUBWIDG_MCGUFF_FRAME
The widget’s color index used for Text when the counter is full
SUBWIDG_COUNTER
SUBWIDG_BTNCOUNTER
The widget’s color index used for Shadows
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
SUBWIDG_TIME
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_BTNCOUNTER
SUBWIDG_MMAPTITLE
SUBWIDG_SELECTEDTEXT
The widget’s color index used for Shadows when the counter is full
SUBWIDG_COUNTER
SUBWIDG_BTNCOUNTER
The widget’s color index used for background
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
SUBWIDG_TIME
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_BTNCOUNTER
SUBWIDG_MMAPTITLE
SUBWIDG_SELECTEDTEXT
SUBWIDG_BGCOLOR
The widget’s color index used for background when the counter is full
SUBWIDG_COUNTER
SUBWIDG_BTNCOUNTER
The widget’s color index used for outline
SUBWIDG_LINE
SUBWIDG_RECT
SUBWIDG_MCGUFF_FRAME
The widget’s color index used for fill
SUBWIDG_RECT
value
SubscreenItemButton (ITMBTN_)
The item button associated with the widget.
SUBWIDG_BTNITM
SUBWIDG_BTNCOUNTER
length
SUBWIDG_COUNTER
- 3 values, SUBWIDG_MISCGAUGE
- 1 value
value
CounterIndex (CR_)
The counter(s) associated with the widget.
The minimum digits of the widget.
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_BTNCOUNTER
The maximum digits of the widget.
SUBWIDG_COUNTER
SUBWIDG_BTNCOUNTER
The infinite item of the widget.
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The infinite character of the widget.
SUBWIDG_COUNTER
SUBWIDG_OLDCTR
SUBWIDG_BTNCOUNTER
The index of cost to use for this widget
SUBWIDG_BTNCOUNTER
The widget’s color index used to indicate the Hero
SUBWIDG_MMAP
SUBWIDG_LMAP
int ColorCompassBlink 🔗 Source
The widget’s color index used to indicate the blinking compass
SUBWIDG_MMAP
The widget’s color index used to indicate the off compass
SUBWIDG_MMAP
The widget’s color index used to indicate rooms
SUBWIDG_LMAP
The itemclass used by the widget (0 <= ItemType < IC_MAXUSABLE)
SUBWIDG_ITEMSLOT
The item ID used by the widget (-1 <= ItemID < NUM_ITEMDATA)
SUBWIDG_ITEMSLOT
The frame/piece tile/cset used by the widget.
SUBWIDG_MCGUFF_FRAME
The frame/piece tile/cset used by the widget.
SUBWIDG_MCGUFF_FRAME
The frame/piece tile/cset used by the widget.
SUBWIDG_MCGUFF_FRAME
The frame/piece tile/cset used by the widget.
SUBWIDG_MCGUFF_FRAME
The widget’s flip value.
SUBWIDG_MCGUFF
SUBWIDG_TILEBLOCK
SUBWIDG_MINITILE
The number associated with the widget.
SUBWIDG_MCGUFF
The corner(s) associated with the widget.
SUBWIDG_MINITILE
- 1 valuesSUBWIDG_LGAUGE
- 4 valuesSUBWIDG_MGAUGE
- 4 valuesSUBWIDG_MISCGAUGE
- 4 values
The widget’s frames
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s speed
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s delay
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s container number
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s gauge width
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s gauge height
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widgets unit value
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s horizontal spacing
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s vertical spacing
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s grid x
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s grid y
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The widget’s animation value
SUBWIDG_LGAUGE
SUBWIDG_MGAUGE
SUBWIDG_MISCGAUGE
The magic drain rate this widget will be visible at (-1 for any)
SUBWIDG_MGAUGE
The counter amount per “container” for the widget
SUBWIDG_MISCGAUGE
The widget’s tabsize value
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
Function descriptions#
void GetSelTextOverride(char32[] buf) 🔗 Source
Gets the selected text override for this widget.
If the buffer provided is too small, it will *automatically be resized to fit*.
void SetSelTextOverride(char32[] str) 🔗 Source
Sets the selected text override for this widget.
A blank string represents no override.
void GetLabel(char32[] buf) 🔗 Source
Gets the label for this widget.
If the buffer provided is too small, it will *automatically be resized to fit*.
void SetLabel(char32[] str) 🔗 Source
Sets the label for this widget.
void GetText(char32[] buf) 🔗 Source
Gets/Sets the text for this widget.
If the buffer provided for GetText() is too small, it will *automatically be resized to fit*.
SUBWIDG_TEXT
SUBWIDG_TEXTBOX
void SetText(char32[] str) 🔗 Source
Gets/Sets the text for this widget.
If the buffer provided for GetText() is too small, it will *automatically be resized to fit*.
SUBWIDG_TEXT
SUBWIDG_TEXTBOX