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

From SCI Wiki
Jump to navigationJump to search
(Created page with "Official SCI Documentation<br /> <div align="center"> Chapter: 1 | 2...")
 
 
(5 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
Chapter:  
 
Chapter:  
 
[[Script Classes for Adventure Games/Introduction|1]] |  
 
[[Script Classes for Adventure Games/Introduction|1]] |  
−
[[Script Classes for Adventure Games/RootObj|2]] |  
+
[[Script Classes for Adventure Games/RootObj Class|2]] |  
−
[[Script Classes for Adventure Games/Object|3]] |  
+
[[Script Classes for Adventure Games/Object Class|3]] |  
−
[[Script Classes for Adventure Games/Collection|4]] |  
+
[[Script Classes for Adventure Games/Collection Class|4]] |  
−
[[Script Classes for Adventure Games/List|5]] |  
+
[[Script Classes for Adventure Games/Script Class|5]] |  
−
[[Script Classes for Adventure Games/Set|6]] |  
+
[[Script Classes for Adventure Games/Timer Class|6]] |  
−
[[Script Classes for Adventure Games/EventHandler|7]] |  
+
[[Script Classes for Adventure Games/Feature Class|7]] |  
−
[[Script Classes for Adventure Games/Inventory|8]] |  
+
[[Script Classes for Adventure Games/View Class|8]] |  
−
[[Script Classes for Adventure Games/Script|9]] |  
+
[[Script Classes for Adventure Games/PicView Class|9]] |  
−
[[Script Classes for Adventure Games/Timer|10]] |  
+
[[Script Classes for Adventure Games/Cycling Classes|10]] |  
−
[[Script Classes for Adventure Games/Feature|11]] |  
+
[[Script Classes for Adventure Games/Motion Classes|11]] |  
−
[[Script Classes for Adventure Games/View|12]] |  
+
[[Script Classes for Adventure Games/Avoider Class|12]] |  
−
[[Script Classes for Adventure Games/Prop|13]] |  
+
[[Script Classes for Adventure Games/Event Class|13]] |  
−
[[Script Classes for Adventure Games/Actor|14]] |
+
[[Script Classes for Adventure Games/User Class|14]]<br />
−
[[Script Classes for Adventure Games/Ego|15]] |
+
[[Script Classes for Adventure Games/Game Class|15]] |  
−
[[Script Classes for Adventure Games/PicView|16]] |
+
[[Script Classes for Adventure Games/Locale Class|16]] |  
−
[[Script Classes for Adventure Games/Cycle|17]] |
+
[[Script Classes for Adventure Games/Region Class|17]] |  
−
[[Script Classes for Adventure Games/Forward|18]] |
+
[[Script Classes for Adventure Games/Room Class|18]] |  
−
[[Script Classes for Adventure Games/Walk|19]] |
+
[[Script Classes for Adventure Games/Timer2 Class|19]] |  
−
[[Script Classes for Adventure Games/Reverse|20]] |
+
[[Script Classes for Adventure Games/InvItem Class|20]] |  
−
[[Script Classes for Adventure Games/CycleTo|21]] |
+
[[Script Classes for Adventure Games/Block Class|21]] |  
−
[[Script Classes for Adventure Games/EndLoop|22]] |
+
[[Script Classes for Adventure Games/Cage Class|22]] |  
−
[[Script Classes for Adventure Games/BegLoop|23]] |
+
[[Script Classes for Adventure Games/Sound Class|23]] |  
−
[[Script Classes for Adventure Games/Motion|24]] |
+
[[Script Classes for Adventure Games/StatusLine Class|24]] |  
−
[[Script Classes for Adventure Games/MoveTo|25]] |
+
[[Script Classes for Adventure Games/File Class|25]] |  
−
[[Script Classes for Adventure Games/Wander|26]]<br />
+
[[Script Classes for Adventure Games/Code Class|26]] |  
−
[[Script Classes for Adventure Games/Follow|27]] |
+
[[Script Classes for Adventure Games/Global Variables|27]] |  
−
[[Script Classes for Adventure Games/Chase|28]] |
 
−
[[Script Classes for Adventure Games/Jump|29]] |
 
−
[[Script Classes for Adventure Games/JumpTo|30]] |
 
−
[[Script Classes for Adventure Games/Orbit|31]] |
 
−
[[Script Classes for Adventure Games/Path|32]] |
 
−
[[Script Classes for Adventure Games/RelPath|33]] |
 
−
[[Script Classes for Adventure Games/Avoider|34]] |
 
−
[[Script Classes for Adventure Games/Event|35]] |
 
−
[[Script Classes for Adventure Games/User|36]] |
 
−
[[Script Classes for Adventure Games/Game|37]] |  
 
−
[[Script Classes for Adventure Games/Locale|38]] |  
 
−
[[Script Classes for Adventure Games/Region|39]] |  
 
−
[[Script Classes for Adventure Games/Room|40]] |  
 
−
[[Script Classes for Adventure Games/Timer2|41]] |
 
−
[[Script Classes for Adventure Games/TimeOut|42]] |  
 
−
[[Script Classes for Adventure Games/InvItem|43]] |  
 
−
[[Script Classes for Adventure Games/Block|44]] |  
 
−
[[Script Classes for Adventure Games/Cage|45]] |  
 
−
[[Script Classes for Adventure Games/Sound|46]] |  
 
−
[[Script Classes for Adventure Games/StatusLine|47]] |  
 
−
[[Script Classes for Adventure Games/File|48]] |  
 
−
[[Script Classes for Adventure Games/Code|49]] |  
 
−
[[Script Classes for Adventure Games/Global Variables|50]] |  
 
 
[[Script Classes for Adventure Games/Index|Index]]
 
[[Script Classes for Adventure Games/Index|Index]]
 
</div><br />
 
</div><br />
  
−
<div align="center"><span style="font-size: 22pt"></span><br />
+
<div align="center"><span style="font-size: 22pt">The StatusLine Class</span><br />
 
''Author: [[Jeff Stephenson]]''<br />
 
''Author: [[Jeff Stephenson]]''<br />
 
''Date: 5 April 1988''</div>
 
''Date: 5 April 1988''</div>
Line 62: Line 39:
 
&nbsp;
 
&nbsp;
  
−
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;
Line 75: Line 89:
 
&nbsp;
 
&nbsp;
  
−
<span style="float: left">[[Script Classes for Adventure Games/|&lt; Previous: ]]</span>
+
<span style="float: left">[[Script Classes for Adventure Games/Sound Class|&lt; Previous: The Sound Class]]</span>
−
<span style="float: right">[[Script Classes for Adventure Games/|Next: &gt;]]</span>
+
<span style="float: right">[[Script Classes for Adventure Games/File Class|Next: The File Class &gt;]]</span>
  
 
&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 >

 

Retrieved from "http://sciwiki.sierrahelp.com/index.php?title=Script_Classes_for_Adventure_Games/StatusLine_Class&oldid=9005"