Scroll text

Syntax

Syntax: scroll_text T_DWORD1, T_DWORD2, T_DWORD3, T_DWORD4, T_DWORD5, T_FLOAT, T_BREG, T_STR

• T_DWORD1 = Left, right screen position where the top left corner of chat box will appear on screen. (00000000 is the top left corner of the screen.)

• T_DWORD2 = Up, down screen position where the top left corner of chat box will appear on screen. (00000000 is the top left corner of the screen.)

• T_DWORD3 = Chat box with. Ending margin of the chat box. (Word wrap will kick in if you run over your end margin just like in chat box.)

• T_DWORD4 = Chat box hight. Columns of the chat box. (Text will start scrolling from the last line of the box until it reaches the top of the chat box.)

box.

• T_DWORD5 = Windowed options.

Values of windowed options.

00000000 = Windowed white window message style.

00000001 = Windowed chat box style.

00000002 = Not windowed will scroll text with no underlay.

• T_FLOAT = Scrolling speed options.

Values of scrolling speed options.

00000000 = Won't scroll message.

00000001 = Normal scroll speed.

00000002 = Fast scroll speed.

• T_BREG = Register to set to 00000001 when the message has finished scrolling

• T_STR = Text string what you want your message to say goes here.

Use

Used to display a scrolling text message.

(Note: If you want to thread a scrolling message use thread _stg for the floors you want your message threaded on. The window message(s) will close upon changing floors.)

Example

100:     sync  //Waits 1 frame.
         scroll_text 000000C8, 000000C8, 0000000A, 00000006, 00000002, 1, R1, This is a<cr>scrolling text<cr>message. //Displays a scrolling text message.
101:     sync  //Waits 1 frame. (Yes 3 syncs are needed here!).
         sync  //Waits 1 frame. (Yes 3 syncs are needed here!).
         sync  //Waits 1 frame. (Yes 3 syncs are needed here!).
         jmpi_= R1, 00000000, 101 //If register 1 equals 00000000 jump to function 101. (If scrolling message has not finished keep waiting until it does.).
         winend  //Closes the window message.
         clear R1 //Makes register 1 equal 00000000.
         ret 

Also see

sync, jmpi_=, winend,

clear, ret