Difference between revisions of "Script Classes for Adventure Games/StatusLine Class"

From SCI Wiki
Jump to navigationJump to search
 
Line 39: Line 39:
 
 
 
 
  
xxxxxxx body xxxxxxxx
+
==<br /> The StatusLine Class ==
 +
 
 +
The StatusLine class provides a status line at the top of the screen which is programmer-definable. When enabled, it overlays the menu bar. The user may still access the menu by pressing Esc or positioning the mouse pointer in the status line end pressing the mouse button. The status line usually shows the player's score. To use a status line in a game, create an instance of class Code which has the interface described in code below and set the code property of StatusLine to it. To display the status line, execute (StatusLine enable:).
 +
 
 +
{|
 +
|width= "125"|In file:||game.sc
 +
|-
 +
|Inherits from:||Object
 +
|-
 +
|Inherited by:||none
 +
|}
 +
 
 +
===<br /> Properties ===
 +
 
 +
<blockquote>
 +
==== state ====
 +
<blockquote>Whether or not the status line is being displayed. Do not manipulate this directly.</blockquote>
 +
 
 +
==== code ====
 +
<blockquote>An instance of Code which formats the status line. It will be called from StatusLine's doit: method with a pointer to string storage as a parameter:
 +
 
 +
<blockquote>(code doit: @theLine)</blockquote>
 +
 
 +
The code should format the status line into the provided string.</blockquote>
 +
</blockquote>
 +
 
 +
===<br /> Methods ===
 +
 
 +
<blockquote>
 +
==== doit: ====
 +
<blockquote>Format the status line and display it if it has been turned on.</blockquote>
 +
 
 +
==== enable: ====
 +
<blockquote>Turns the status line on. Invokes the doit: method.</blockquote>
 +
 
 +
==== disable: ====
 +
<blockquote>Turns the status line off. Invokes the doit: method.</blockquote>
 +
</blockquote>
  
 
&nbsp;
 
&nbsp;

Latest revision as of 02:06, 11 December 2015

Official SCI Documentation

Chapter: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14
15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | Index


The StatusLine Class

Author: Jeff Stephenson

Date: 5 April 1988

 


The StatusLine Class

The StatusLine class provides a status line at the top of the screen which is programmer-definable. When enabled, it overlays the menu bar. The user may still access the menu by pressing Esc or positioning the mouse pointer in the status line end pressing the mouse button. The status line usually shows the player's score. To use a status line in a game, create an instance of class Code which has the interface described in code below and set the code property of StatusLine to it. To display the status line, execute (StatusLine enable:).

In file: game.sc
Inherits from: Object
Inherited by: none


Properties

state

Whether or not the status line is being displayed. Do not manipulate this directly.

code

An instance of Code which formats the status line. It will be called from StatusLine's doit: method with a pointer to string storage as a parameter:

(code doit: @theLine)

The code should format the status line into the provided string.


Methods

doit:

Format the status line and display it if it has been turned on.

enable:

Turns the status line on. Invokes the doit: method.

disable:

Turns the status line off. Invokes the doit: method.

 

Notes


 

Table of Contents

 

< Previous: The Sound Class Next: The File Class >