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)

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 the INTBTN_ constants to index this array.

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

---

bool[] BtnPageRight 🔗 Source

Use the INTBTN_ constants 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

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int[] SelectorHei 🔗 Source

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int[] SelectorTile 🔗 Source

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int[] SelectorCSet 🔗 Source

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int[] SelectorFlashCSet 🔗 Source

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int[] SelectorFrames 🔗 Source

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int[] SelectorASpeed 🔗 Source

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int[] SelectorDelay 🔗 Source

The pixel-size, tile, cset/flashcset, and animation information for the two selector overrides.

These will be used by the selector on this subscreen, if the selector is overridden (see Flags[]).

---

int TransClock 🔗 Source

The timer clock used by the currently active transition.

-1 indicates no transition. Writing to -1 clears the current transition.

Writing a positive value starts a transition if none is currently active.

---

int TransType 🔗 Source

The transition type currently active.

Compare with the TRANS_TY_ constants.

---

bool[] TransFlags 🔗 Source

The flags for the current transition.

Use the TRANSFLAG_ constants to access these.

---

int[] TransArgs 🔗 Source

The arguments used for the current transition.

Use the ‘TRANS_``_ARG_`` constants to access these

---

int TransFromPage 🔗 Source

The page the currently active transition is going from/to.

---

int TransToPage 🔗 Source

The page the currently active transition is going from/to.

---

Function descriptions

void GetName(char32[] buf) 🔗 Source

Puts the subscreen’s name in the buffer.

If the buffer is too small, resizes it for you!

---

void SetName(char32[] buf) 🔗 Source

Sets the subscreen’s name from the buffer.

---

void SwapPages(int index1, int index2) 🔗 Source

Swaps the pages at the two indexes.