subscreenwidget

Variables

const int	Type
const int	Index
const subscreenpage	Page
const int	DisplayItem
const int	EquipItem
int	Pos
int[]	PosDirs
bool[]	VisibleFlags
int	X
int	Y
int	W
int	H
const int	DispX
const int	DispY
const int	DispW
const int	DispH
bool[]	GenFlags
bool[]	Flags
bool[]	RequiredOwnedItems
bool[]	RequiredUnownedItems
int	RequiredCounter
int	RequiredCounterCond
int	RequiredCounterValue
int	RequiredLItems
int	RequiredLItemLevel
bool	ScriptDisabled
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	PressScript
untyped[]	PressInitD
bool[]	BtnPressScript
bool[]	BtnPageChange
int	PageMode
int	TargetPage
int	PageTransType
int	PageTransSFX
bool[]	PageTransFlags
int[]	PageTransArgs
int[]	CSet
int[]	Tile
int	Font
int	Align
int	ShadowType
int	ColorText
int	ColorFullText
int	ColorShadow
int	ColorFullShadow
int	ColorBG
int	ColorFullBG
int	ColorOutline
int	ColorFill
int	Button
int[]	Counter
int	MinDigits
int	MaxDigits
int	InfiniteItem
char32	InfiniteChar
int	CostIndex
int	ColorPlayer
int	ColorCompassBlink
int	ColorCompassOff
int	ColorRoom
int	ItemType
int	ItemID
int	FrameTile
int	FrameCSet
int	PieceTile
int	PieceCSet
int	Flip
int	Number
int[]	Corner
int	Frames
int	Speed
int	Delay
int	Container
int	GaugeWid
int	GaugeHei
int	Units
int	HSpace
int	VSpace
int	GridX
int	GridY
int	AnimVal
int	ShowDrain
int	PerContainer
int	TabSize
int	LItems

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)
bool	CheckConditions()
bool	CheckVisible()

Enumerations

enum SubscreenItemButton: 🔗 Source

SubscreenItemButton ITMBTN_A = 0

SubscreenItemButton ITMBTN_B = 1

SubscreenItemButton ITMBTN_X = 2

SubscreenItemButton ITMBTN_Y = 3

SubscreenItemButton NUM_ITMBTN = 4

---

enum ConditionType: 🔗 Source

ConditionType CONDTY_NONE = 0

ConditionType CONDTY_EQ = 1

==

ConditionType CONDTY_NEQ = 2

!=

ConditionType CONDTY_GREATER = 3

>

ConditionType CONDTY_GREATEREQ = 4

>=

ConditionType CONDTY_LESS = 5

<

ConditionType CONDTY_LESSEQ = 6

<=

ConditionType NUM_CONDTY = 7

---

Variable descriptions

const int Type 🔗 Source

value SubscreenWidgetType (SUBWIDG_)

The widget’s type.

---

const int Index 🔗 Source

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

---

const int EquipItem 🔗 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

---

int Pos 🔗 Source

The selector position of this flag.

Only used if the widget is selectable (see GenFlags[]).

---

int[] PosDirs 🔗 Source

index Direction (DIR_)

The 4 directional positions for the selector.

Only used if the widget is selectable (see GenFlags[]).

---

bool[] VisibleFlags 🔗 Source

Flags related to the visibility of the widget.

Use the ‘SUBVISIB_’ constants to access.

---

int X 🔗 Source

The X position of the widget within the subscreen.

Some widget types do not use this.

---

int Y 🔗 Source

The Y position of the widget within the subscreen.

Some widget types do not use this.

---

int W 🔗 Source

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.

---

int H 🔗 Source

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.

---

const int DispX 🔗 Source

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.

---

const int DispY 🔗 Source

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.

---

const int DispW 🔗 Source

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.

---

const int DispH 🔗 Source

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.

---

bool[] GenFlags 🔗 Source

index SubscreenWidgetGenFlag (SUBW_GENFL_)

The general flags for subscreen widgets. These are usually applicable regardless of widget type.

---

bool[] Flags 🔗 Source

The type-specific flags for subscreen widgets.

There is a different set of constants for this for each widget type.

---

bool[] RequiredOwnedItems 🔗 Source

index ItemID (I_)

Any items set true here must be owned for the widget to be active/visible.

---

bool[] RequiredUnownedItems 🔗 Source

index ItemID (I_)

Any items set true here must NOT be owned for the widget to be active/visible.

---

int RequiredCounter 🔗 Source

value CounterIndex (CR_)

The counter this widget requires to be active/visible. Must relate to the RequiredCounterValue based on the RequiredCounterCond.

• If CR_NONE, no requirement will be checked.

• If SUBW_GENFL_REQ_COUNTER_PERC is set, then the percentage this counter is full will be compared

• Otherwise, if SUBW_GENFL_REQ_COUNTER_MAX is set, then the max value of this counter will be compared

• Otherwise, this counter’s value will be compared

---

int RequiredCounterCond 🔗 Source

value ConditionType (CONDTY_)

The counter operation this widget requires to be active/visible. The RequiredCounter must relate to the RequiredCounterValue by this operation. If CONDTY_NONE, no requirement will be checked.

---

int RequiredCounterValue 🔗 Source

The counter value this widget requires to be active/visible. The RequiredCounter must relate to this value based on the RequiredCounterCond.

---

int RequiredLItems 🔗 Source

value LevelItemBitflags (LI_)

The Level Items that are required to be owned (or unowned, if SUBW_GENFL_REQ_INVERT_LITEM is set)

---

int RequiredLItemLevel 🔗 Source

The Level that RequiredLItems are checked for. If set to ‘-1’, uses the current level.

---

bool ScriptDisabled 🔗 Source

If set to ‘true’, the widget will not be active/visible.

---

int SelectorDestX 🔗 Source

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.

---

int SelectorDestY 🔗 Source

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.

---

int SelectorDestW 🔗 Source

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.

---

int SelectorDestH 🔗 Source

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.

---

int[] SelectorWid 🔗 Source

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[]).

---

int[] SelectorHei 🔗 Source

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[]).

---

int[] SelectorTile 🔗 Source

The tile for the two selector overrides.

Will be used by the selector on this widget, if the selector is overridden (see GenFlags[]).

---

int[] SelectorCSet 🔗 Source

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[]).

---

int[] SelectorFrames 🔗 Source

The animation frames for the two selector overrides.

Will be used by the selector on this widget, if the selector is overridden (see GenFlags[]).

---

int[] SelectorASpeed 🔗 Source

The animation speed for the two selector overrides.

Will be used by the selector on this widget, if the selector is overridden (see GenFlags[]).

---

int[] SelectorDelay 🔗 Source

The animation delay for the two selector overrides.

Will be used by the selector on this widget, if the selector is overridden (see GenFlags[]).

---

int PressScript 🔗 Source

The generic script that will run when a specified button is pressed while this widget is selected.

---

untyped[] PressInitD 🔗 Source

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.

---

bool[] BtnPageChange 🔗 Source

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.

---

int PageMode 🔗 Source

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.

---

int TargetPage 🔗 Source

The page to change to when using PageMode of ‘SUB_PGMODE_TARG’

---

int PageTransType 🔗 Source

The transition type for PageMode transition.

Compare with the ‘TRANS_TY_’ constants.

---

int PageTransSFX 🔗 Source

The transition sfx for PageMode transition.

---

bool[] PageTransFlags 🔗 Source

The flags for PageMode transition.

Use the ‘TRANSFLAG_’ constants to access these.

---

int[] PageTransArgs 🔗 Source

The arguments used for PageMode transition.

Use the ‘TRANS_*_ARG_’ constants to access these

---

int[] CSet 🔗 Source

The widget’s cset(s).

For SUBWIDG_FRAME,SUBWIDG_MCGUFF,SUBWIDG_TILEBLOCK,SUBWIDG_MINITILE: can use the ‘SUB_CS_’ constants.

• SUBWIDG_FRAME - 1 values

• SUBWIDG_MCGUFF - 1 values

• SUBWIDG_TILEBLOCK - 1 values

• SUBWIDG_MINITILE - 1 values

• SUBWIDG_MISCGAUGE - 4 values

• SUBWIDG_LGAUGE - 4 values

• SUBWIDG_MGAUGE - 4 values

---

int[] Tile 🔗 Source

The widget’s tile(s).

For SUBWIDG_MINITILE, can use the ‘SUB_SPTILE_’ constant values.

• SUBWIDG_FRAME - 1 values

• SUBWIDG_MCGUFF - 1 values

• SUBWIDG_TILEBLOCK - 1 values

• SUBWIDG_MINITILE - 1 values

• SUBWIDG_MISCGAUGE - 4 values

• SUBWIDG_LGAUGE - 4 values

• SUBWIDG_MGAUGE - 4 values

---

int Font 🔗 Source

value Font

The widget’s font.

• SUBWIDG_TEXT

• SUBWIDG_TEXTBOX

• SUBWIDG_TIME

• SUBWIDG_COUNTER

• SUBWIDG_OLDCTR

• SUBWIDG_BTNCOUNTER

• SUBWIDG_MMAPTITLE

• SUBWIDG_SELECTEDTEXT

---

int Align 🔗 Source

value TextAlignment (TF_)

The widget’s text alignment.

• SUBWIDG_TEXT

• SUBWIDG_TEXTBOX

• SUBWIDG_TIME

• SUBWIDG_COUNTER

• SUBWIDG_BTNCOUNTER

• SUBWIDG_MMAPTITLE

• SUBWIDG_SELECTEDTEXT

---

int ShadowType 🔗 Source

value ShadowType (SHD_)

The widget’s Shadow Type.

• SUBWIDG_TEXT

• SUBWIDG_TEXTBOX

• SUBWIDG_TIME

• SUBWIDG_COUNTER

• SUBWIDG_OLDCTR

• SUBWIDG_BTNCOUNTER

• SUBWIDG_MMAPTITLE

• SUBWIDG_SELECTEDTEXT

---

int ColorText 🔗 Source

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

---

int ColorFullText 🔗 Source

The widget’s color index used for Text when the counter is full

• SUBWIDG_COUNTER

• SUBWIDG_BTNCOUNTER

---

int ColorShadow 🔗 Source

The widget’s color index used for Shadows

• SUBWIDG_TEXT

• SUBWIDG_TEXTBOX

• SUBWIDG_TIME

• SUBWIDG_COUNTER

• SUBWIDG_OLDCTR

• SUBWIDG_BTNCOUNTER

• SUBWIDG_MMAPTITLE

• SUBWIDG_SELECTEDTEXT

---

int ColorFullShadow 🔗 Source

The widget’s color index used for Shadows when the counter is full

• SUBWIDG_COUNTER

• SUBWIDG_BTNCOUNTER

---

int ColorBG 🔗 Source

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

• SUBWIDG_COUNTERPERCBAR

---

int ColorFullBG 🔗 Source

The widget’s color index used for background when the counter is full

• SUBWIDG_COUNTER

• SUBWIDG_BTNCOUNTER

---

int ColorOutline 🔗 Source

The widget’s color index used for outline

• SUBWIDG_LINE

• SUBWIDG_RECT

• SUBWIDG_MCGUFF_FRAME

---

int ColorFill 🔗 Source

The widget’s color index used for fill

• SUBWIDG_RECT

• SUBWIDG_COUNTERPERCBAR

---

int Button 🔗 Source

value SubscreenItemButton (ITMBTN_)

The item button associated with the widget.

• SUBWIDG_BTNITM

• SUBWIDG_BTNCOUNTER

---

int[] Counter 🔗 Source

length SUBWIDG_COUNTER - 3 values, SUBWIDG_MISCGAUGE - 1 value, SUBWIDG_COUNTERPERCBAR - 1 value

value CounterIndex (CR_)

The counter(s) associated with the widget.

---

int MinDigits 🔗 Source

The minimum digits of the widget.

• SUBWIDG_COUNTER

• SUBWIDG_OLDCTR

• SUBWIDG_BTNCOUNTER

---

int MaxDigits 🔗 Source

The maximum digits of the widget.

• SUBWIDG_COUNTER

• SUBWIDG_BTNCOUNTER

---

int InfiniteItem 🔗 Source

The infinite item of the widget.

• SUBWIDG_COUNTER

• SUBWIDG_OLDCTR

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

char32 InfiniteChar 🔗 Source

The infinite character of the widget.

• SUBWIDG_COUNTER

• SUBWIDG_OLDCTR

• SUBWIDG_BTNCOUNTER

---

int CostIndex 🔗 Source

The index of cost to use for this widget

• SUBWIDG_BTNCOUNTER

---

int ColorPlayer 🔗 Source

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

---

int ColorCompassOff 🔗 Source

The widget’s color index used to indicate the off compass

• SUBWIDG_MMAP

---

int ColorRoom 🔗 Source

The widget’s color index used to indicate rooms

• SUBWIDG_LMAP

---

int ItemType 🔗 Source

The itemclass used by the widget (0 <= ItemType < IC_MAXUSABLE)

• SUBWIDG_ITEMSLOT

---

int ItemID 🔗 Source

The item ID used by the widget (-1 <= ItemID < NUM_ITEMDATA)

• SUBWIDG_ITEMSLOT

---

int FrameTile 🔗 Source

The frame/piece tile/cset used by the widget.

• SUBWIDG_MCGUFF_FRAME

---

int FrameCSet 🔗 Source

The frame/piece tile/cset used by the widget.

• SUBWIDG_MCGUFF_FRAME

---

int PieceTile 🔗 Source

The frame/piece tile/cset used by the widget.

• SUBWIDG_MCGUFF_FRAME

---

int PieceCSet 🔗 Source

The frame/piece tile/cset used by the widget.

• SUBWIDG_MCGUFF_FRAME

---

int Flip 🔗 Source

The widget’s flip value.

• SUBWIDG_MCGUFF

• SUBWIDG_TILEBLOCK

• SUBWIDG_MINITILE

---

int Number 🔗 Source

The number associated with the widget.

• SUBWIDG_MCGUFF

---

int[] Corner 🔗 Source

The corner(s) associated with the widget.

• SUBWIDG_MINITILE - 1 values

• SUBWIDG_LGAUGE - 4 values

• SUBWIDG_MGAUGE - 4 values

• SUBWIDG_MISCGAUGE - 4 values

---

int Frames 🔗 Source

The widget’s frames

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int Speed 🔗 Source

The widget’s speed

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int Delay 🔗 Source

The widget’s delay

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int Container 🔗 Source

The widget’s container number

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int GaugeWid 🔗 Source

The widget’s gauge width

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int GaugeHei 🔗 Source

The widget’s gauge height

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int Units 🔗 Source

The widgets unit value

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int HSpace 🔗 Source

The widget’s horizontal spacing

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int VSpace 🔗 Source

The widget’s vertical spacing

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int GridX 🔗 Source

The widget’s grid x

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int GridY 🔗 Source

The widget’s grid y

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int AnimVal 🔗 Source

The widget’s animation value

• SUBWIDG_LGAUGE

• SUBWIDG_MGAUGE

• SUBWIDG_MISCGAUGE

---

int ShowDrain 🔗 Source

The magic drain rate this widget will be visible at (-1 for any)

• SUBWIDG_MGAUGE

---

int PerContainer 🔗 Source

The counter amount per “container” for the widget

• SUBWIDG_MISCGAUGE

---

int TabSize 🔗 Source

The widget’s tabsize value

• SUBWIDG_TEXT

• SUBWIDG_TEXTBOX

---

int LItems 🔗 Source

The level items that cause the compass marker to stop blinking

• SUBWIDG_MMAP

---

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

---

bool CheckConditions() 🔗 Source

Checks the requirements / conditions of this widget. See RequiredOwnedItems[], RequiredUnownedItems[], RequiredCounter, RequiredLItems, ScriptDisabled

---

bool CheckVisible() 🔗 Source

Checks that the widget is visible- meaning, it both passes CheckConditions() and VisibleFlags[].