Difference between revisions of "Art screens"

From ECWolf Wiki
(Created page with "Art screens are used to provide an in game manual as well as provide story elements between clusters. They are simply specifically formatted text and do not have any specific ...")
 
(Add note about starting art screens with a ^P)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
Art screens are used to provide an in game manual as well as provide story elements between clusters. They are simply specifically formatted text and do not have any specific naming convention, although the Read This screen is HELPART.
 
Art screens are used to provide an in game manual as well as provide story elements between clusters. They are simply specifically formatted text and do not have any specific naming convention, although the Read This screen is HELPART.
 +
 +
'''Important:''' every art screen should start with a '''^P''' command to start the first page. If you don’t include a '''^P''' for the first page, then flipping back to previous pages might cause crashes or corrupted art screens to appear.
  
 
== Commands ==
 
== Commands ==
Line 20: Line 22:
 
* '''^L'''<y> <x> ''EOL'' - Set Position
 
* '''^L'''<y> <x> ''EOL'' - Set Position
 
:Sets the font drawing position in lines.
 
:Sets the font drawing position in lines.
* '''^P''' - End of Page
+
* '''^P''' - Start of Page
:Ends the current page and starts the next.
+
:Ends the current page (if there is one) and starts the next.
 
* '''^T'''<y> <x> <index> <time> ''EOL''- Timed Image Draw by Index
 
* '''^T'''<y> <x> <index> <time> ''EOL''- Timed Image Draw by Index
 
:Waits ''time'' and then draws an image by index.
 
:Waits ''time'' and then draws an image by index.
 
* '''^T'''<y> <x> '''['''<texture>''']''' <time> ''EOL'' - Timed Image Draw by Name
 
* '''^T'''<y> <x> '''['''<texture>''']''' <time> ''EOL'' - Timed Image Draw by Name
 
:Waits ''time'' and then draws an image by texture name.
 
:Waits ''time'' and then draws an image by texture name.

Latest revision as of 17:50, 19 November 2022

Art screens are used to provide an in game manual as well as provide story elements between clusters. They are simply specifically formatted text and do not have any specific naming convention, although the Read This screen is HELPART.

Important: every art screen should start with a ^P command to start the first page. If you don’t include a ^P for the first page, then flipping back to previous pages might cause crashes or corrupted art screens to appear.

Commands

A command is a letter prefixed with the caret character ('^') possibly followed by some specific formatting. The following commands are recognized. Commands with EOL indicate they must be on a separate line.

  • ^;<anything> EOL - Comment
  • ^> - Indent
Indents the text 160 pixels.
  • ^B<x> <y> <w> <h> EOL - Black-out
Create a black rectangle with the specified dimensions.
  • ^C<index> - Stencil Color
Sets the font to a stencil mode with the color specified by palette index. Not recommended for use.
  • ^C[<textcolor>] - Font Color
Sets the font to a color specified in TEXTCOLO. This will retain font shading.
  • ^E - End of File
Ends page and the art script.
  • ^G<y> <x> <index> - Draw Image by Index
Draws an image by an art index specified in TEXTURES. Not recommended for use.
  • ^G<y> <x> [<texture>] - Draw Image by Name
Draws an image in the specified location by texture name.
  • ^L<y> <x> EOL - Set Position
Sets the font drawing position in lines.
  • ^P - Start of Page
Ends the current page (if there is one) and starts the next.
  • ^T<y> <x> <index>
Waits time and then draws an image by index.
  • ^T<y> <x> [<texture>]
Waits time and then draws an image by texture name.