Difference between revisions of "AGIWiki/Display text on screen"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Fix syntax highlighting)
m (Text replacement - "<source lang=" to "<syntaxhighlight lang=")
Line 17: Line 17:
 
A typical messagebox, displayed in the middle of the screen.
 
A typical messagebox, displayed in the middle of the screen.
  
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
print("Hello world");
 
print("Hello world");
 
</source>
 
</source>
Line 23: Line 23:
 
Same but using ability to use #message .
 
Same but using ability to use #message .
  
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
print(m1);
 
print(m1);
  
Line 32: Line 32:
 
This time in the #message-part has been put a [[AGIWiki/String|string]]. Note that string s1 has been defined '''before''' using print-command and #message can be also elsewhere within the logic than beneath return-command.
 
This time in the #message-part has been put a [[AGIWiki/String|string]]. Note that string s1 has been defined '''before''' using print-command and #message can be also elsewhere within the logic than beneath return-command.
  
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
set.string(s1,"Hello world");
 
set.string(s1,"Hello world");
 
print(m1);
 
print(m1);
Line 44: Line 44:
 
Print.v provides a way for one print.v to display various messages. Once again it is important to define all modifiers before printing.
 
Print.v provides a way for one print.v to display various messages. Once again it is important to define all modifiers before printing.
  
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
v40 = 2; /* Oh hai just sounds better than Hello */
 
v40 = 2; /* Oh hai just sounds better than Hello */
 
set.string(s1,"Hello world");
 
set.string(s1,"Hello world");
Line 58: Line 58:
 
Should a need for displaying messagebox elsewhere than middle arise, print.at is the solution.
 
Should a need for displaying messagebox elsewhere than middle arise, print.at is the solution.
  
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
print.at(m2,1,20,10);
 
print.at(m2,1,20,10);
 
   
 
   
Line 73: Line 73:
 
With this command WinAGI is the IDE. The correct syntax being <code>print.at.v(vA,byte ROW,byte COLUMN,byte MAXWIDTH);</code>
 
With this command WinAGI is the IDE. The correct syntax being <code>print.at.v(vA,byte ROW,byte COLUMN,byte MAXWIDTH);</code>
  
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
#message 2 "Hallo world"
 
#message 2 "Hallo world"
 
#message 1 "%s1"
 
#message 1 "%s1"
Line 95: Line 95:
 
AGI Studio's helpfile claims that command should be like this: <code>print.at.v(vA,vX,vY,vW);</code> but it only accepts <code>print.at.v(mA,vX,vY,vW);</code>. It is better to avoid using this command under AGI Studio altogether and compile it with WinAGI and with correct syntax.
 
AGI Studio's helpfile claims that command should be like this: <code>print.at.v(vA,vX,vY,vW);</code> but it only accepts <code>print.at.v(mA,vX,vY,vW);</code>. It is better to avoid using this command under AGI Studio altogether and compile it with WinAGI and with correct syntax.
  
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
#message 2 "Hello world"
 
#message 2 "Hello world"
 
   
 
   

Revision as of 15:11, 25 October 2018

AGIWiki


Tutorials and Guides

Basics

Displaying text in AGI basically happens with commands print and display their variants. Print produces a message box and display a textline. The major difference between these two command-types are that while the print-command functions better within and while playing the game with animated objects, the display is better for uses like status-bar, intros, outros and credits for example where there is no interference from animated objects.

The reason why print works better with animated.objects is that usually it covers everything behind it when the messagebox appears and when it disappears almost everything behind is still like they were when the messagebox appeared. The display on the other hand simply displays line of text that can be easily wiped by animated object or message box. Worth remembering is that messageboxes are also used by system commands like quit.

Both print and display-variants can be affected by other commands, not forgetting certain flag and variable when it comes to print.

Examples

Print

A typical messagebox, displayed in the middle of the screen.

<syntaxhighlight lang="cpp"> print("Hello world"); </source>

Same but using ability to use #message .

<syntaxhighlight lang="cpp"> print(m1);

return();

  1. message 1 "Hello world"

</source>

This time in the #message-part has been put a string. Note that string s1 has been defined before using print-command and #message can be also elsewhere within the logic than beneath return-command.

<syntaxhighlight lang="cpp"> set.string(s1,"Hello world"); print(m1);

return();

  1. message 1 "%s1"

</source>

Print.v

Print.v provides a way for one print.v to display various messages. Once again it is important to define all modifiers before printing.

<syntaxhighlight lang="cpp"> v40 = 2; /* Oh hai just sounds better than Hello */ set.string(s1,"Hello world"); print.v(v40);

return();

  1. message 1 "%s1"
  2. message 2 "Oh hai world"

</source>

Print.at

Should a need for displaying messagebox elsewhere than middle arise, print.at is the solution.

<syntaxhighlight lang="cpp"> print.at(m2,1,20,10);

return();

  1. message 2 "Oh hai world"

</source>

Print.at.v

And the variant print.at.v is bit tricky because it's syntax varies which software one uses. AGI Studio uses wrong arguments. However, examples for both WinAGI and AGI Studio are presented. It is unknown how QT AGI Studio handles this command though it is based on AGI Studio.

WinAGI

With this command WinAGI is the IDE. The correct syntax being print.at.v(vA,byte ROW,byte COLUMN,byte MAXWIDTH);

<syntaxhighlight lang="cpp">

  1. message 2 "Hallo world"
  2. message 1 "%s1"

if(f5){

 set.string(s1,"Hello world");
 
 v40 = 1;
 v41 = 1;
 v42 = 20;
 v43 = 10;
 
 print.at.v(v40,1,20,10);

}

return(); </source>

AGI Studio

AGI Studio's helpfile claims that command should be like this: print.at.v(vA,vX,vY,vW); but it only accepts print.at.v(mA,vX,vY,vW);. It is better to avoid using this command under AGI Studio altogether and compile it with WinAGI and with correct syntax.

<syntaxhighlight lang="cpp">

  1. message 2 "Hello world"
 if(f5){
 
   v41 = 1;
   v42 = 20;
   v43 = 10;
  
   print.at.v(m2,v41,v42,v43);
 
 }
 return();

</source>

However, it will only print empty, yet right size messagebox. Weird, huh.

Flag 15 & variable 21

As default, messagebox halts progress of logic until user presses key. Yet that kind of behaviour can be altered with means like flag 15 and variable 21. Variable 21 defines the time in half-seconds how long the messagebox will remain until it's closed. Flag 15 causes messageboxes to remain on screen until close.window-command is issued or variable 21 value is met. The intriguing part when flag 15 is issued with messagebox is that messagebox won't no longer halt the logic nor cover possible action, such as display-command, happening behind it.

Display

Display.v

Set.text.attribute

Advanced