subscreenpage

Variables

const int	Index
const int	NumWidgets
const subscreenwidget[]	Widgets
const subscreendata	SubData
int	CursorPos

Functions

subscreenwidget	GetWidget(char32[] label)
subscreenwidget	CreateWidget(int type)
void	SwapWidgets(int index1, int index2)
subscreenwidget	FindWidget(int cursor_pos)
int	SelectorMove(int cursor_pos, int dir, int flags)
void	Delete()

Variable descriptions

const int Index 🔗 Source

The index of this page within the subscreen.

---

const int NumWidgets 🔗 Source

The number of widgets on the page.

---

const subscreenwidget[] Widgets 🔗 Source

The widgets on the page, ordered by their index.

---

const subscreendata SubData 🔗 Source

The subscreendata that owns this page.

---

int CursorPos 🔗 Source

The position value of the selector.

---

Function descriptions

subscreenwidget GetWidget(char32[] label) 🔗 Source

Returns the first widget with a matching label, or NULL if none exists.

---

subscreenwidget CreateWidget(int type) 🔗 Source

Adds a new widget of the specified type to the end of the page.

Returns that widget, or NULL if fails.

---

void SwapWidgets(int index1, int index2) 🔗 Source

Swaps the widgets at the two indexes.

---

subscreenwidget FindWidget(int cursor_pos) 🔗 Source

Returns the widget designated by the specified cursor position, or NULL if it fails.

---

int SelectorMove(int cursor_pos, int dir, int flags) 🔗 Source

Returns the new cursor position found by moving in ‘dir’ from ‘cursor_pos’.

‘flags’ determines:

• SUBSEL_FLAG_NO_NONEQUIP: Skip widgets that are “Non-equippable”

• SUBSEL_FLAG_NEED_ITEM: Skip widgets that currently have no equippable item

---

void Delete() 🔗 Source

Deletes the page.

If it is the last page, an empty page will be created in its’ place.