Alchemy
Loading...
Searching...
No Matches

UiChannelSlot Struct Reference

A text channel, one of three, which types decoded text into a window a few characters a frame and runs its control codes. More...

#include <graphics/uiwindow.h>

Data Fields

struct UiWindow * work
 the window typed into; NULL when free
u16 x
 pen, 8.8 fixed-point pixels
u16 y
 pen, 8.8 fixed-point pixels
u16 spacing [4]
 Extra advance per line, in 1/256 pixels: after every character in Japanese, after a space in the other editions.
u16 line
 line of the page, indexes spacing; at most 3
u16 entry
 next code in UiRenderWork.entries
u16 countdown
 frames left of a pause, a page wait or a swell
u16 colour
 text colour; 15 by default
u16 outline
 outline colour; 0 for none
u16 lineSpacing
 10 by default
u16 transition
 frames left of the canvas scrolling up a line
u16 startX
 pen x each new line returns to, 8.8 fixed-point pixels
u16 ended
 1 once a TEXT_END code is reached
u16 glyphDelay
 frames to wait after a glyph while no button is held
u16 flags
 nonzero keeps the window's size from page to page
u16 unk26
 not named by TBS code

Detailed Description

A text channel, one of three, which types decoded text into a window a few characters a frame and runs its control codes.

Definition at line 43 of file uiwindow.h.

Field Documentation

◆ work

◆ x

u16 UiChannelSlot::x

◆ y

u16 UiChannelSlot::y

◆ spacing

u16 UiChannelSlot::spacing[4]

Extra advance per line, in 1/256 pixels: after every character in Japanese, after a space in the other editions.

Definition at line 49 of file uiwindow.h.

Referenced by UiText_QueueRenderEntries(), UiText_StartBattleMessage(), and UiWork_StepChannelScript().

◆ line

u16 UiChannelSlot::line

line of the page, indexes spacing; at most 3

Definition at line 50 of file uiwindow.h.

Referenced by UiText_QueueRenderEntries(), UiText_StartBattleMessage(), and UiWork_StepChannelScript().

◆ entry

◆ countdown

◆ colour

◆ outline

◆ lineSpacing

◆ transition

u16 UiChannelSlot::transition

frames left of the canvas scrolling up a line

Definition at line 56 of file uiwindow.h.

Referenced by UiText_StartCanvasScroll(), and UiWork_StepChannelScript().

◆ startX

u16 UiChannelSlot::startX

pen x each new line returns to, 8.8 fixed-point pixels

Definition at line 57 of file uiwindow.h.

Referenced by UiText_QueueRenderEntries(), UiText_StartBattleMessage(), and UiWork_StepChannelScript().

◆ ended

u16 UiChannelSlot::ended

1 once a TEXT_END code is reached

Definition at line 58 of file uiwindow.h.

Referenced by UiText_QueueRenderEntries(), UiText_StartBattleMessage(), and UiWork_StepChannelScript().

◆ glyphDelay

u16 UiChannelSlot::glyphDelay

frames to wait after a glyph while no button is held

Definition at line 59 of file uiwindow.h.

Referenced by UiWork_StepChannelScript().

◆ flags

u16 UiChannelSlot::flags

nonzero keeps the window's size from page to page

Definition at line 60 of file uiwindow.h.

Referenced by UiText_QueueRenderEntries(), and UiWork_StepChannelScript().

◆ unk26

u16 UiChannelSlot::unk26

not named by TBS code

Definition at line 61 of file uiwindow.h.