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

From SCI Wiki
Jump to navigationJump to search
 
(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">User</span><br />
+
<div align="center"><span style="font-size: 22pt">The User 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 User Class ==
 +
 
 +
A User is an object which corresponds to the person playing the game and acts as the intermediary between the person and the other objects in the game. In the current games there is only one User, and thus we use the class User rather than an instance of the class.
 +
 
 +
{|
 +
|width= "125"|In file:||user.sc
 +
|-
 +
|Inherits from:||Object
 +
|-
 +
|Inherited by:||none
 +
|}
 +
 
 +
===<br /> Properties ===
 +
 
 +
<blockquote>
 +
==== alterEgo ====
 +
<blockquote>The ID of the Ego which is controlled by the User.</blockquote>
 +
 
 +
==== canInput ====
 +
<blockquote>TRUE if the User should accept input lines from its player, FALSE otherwise. Any time you don't want the player to be able to type an input line, just set canInput to FALSE. Default at startup is FALSE.</blockquote>
 +
 
 +
==== canControl ====
 +
<blockquote>Set to TRUE to let the User control the alterEgo with direction keys, mouse, etc. Anytime you want to set the alterEgo on a pre- programmed motion, set canControl to FALSE to prevent the player from interrupting the motion and taking control. Default at startup is FALSE.</blockquote>
 +
</blockquote>
 +
 
 +
===<br /> Methods ===
 +
 
 +
<blockquote>
 +
==== doit: ====
 +
<blockquote>The doit: method for User checks for an event. If one is present, User sends the handleEvent: event message in succession to TheMenuBar (the game's menu bar), alterEgo, and regions (the list of regions, beginning with the current room). If any of these objects respond to the event, they should set the claimed property of the event to TRUE to let the other objects receiving the event know that it has been dealt with.
 +
 
 +
If, after everyone has had a look at it, the event is still unclaimed, User puts up an input line and waits for the player to type a line of input. If a line is entered and the kernel is able to parse the line, the User turns the event into a saidEvent, indicating that valid input has been entered, and again sends the handleEvent: event message to the above objects. Once it has done so, it disposes of the event and returns.</blockquote>
 +
</blockquote>
  
 
&nbsp;
 
&nbsp;
Line 75: Line 84:
 
&nbsp;
 
&nbsp;
  
−
<span style="float: left">[[Script Classes for Adventure Games/Event|&lt; Previous: Event]]</span>
+
<span style="float: left">[[Script Classes for Adventure Games/Event Class|&lt; Previous: The Event Class]]</span>
−
<span style="float: right">[[Script Classes for Adventure Games/Game|Next: Game &gt;]]</span>
+
<span style="float: right">[[Script Classes for Adventure Games/Game Class|Next: The Game Class &gt;]]</span>
  
 
&nbsp;
 
&nbsp;

Latest revision as of 01:04, 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 User Class

Author: Jeff Stephenson

Date: 5 April 1988

 


The User Class

A User is an object which corresponds to the person playing the game and acts as the intermediary between the person and the other objects in the game. In the current games there is only one User, and thus we use the class User rather than an instance of the class.

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


Properties

alterEgo

The ID of the Ego which is controlled by the User.

canInput

TRUE if the User should accept input lines from its player, FALSE otherwise. Any time you don't want the player to be able to type an input line, just set canInput to FALSE. Default at startup is FALSE.

canControl

Set to TRUE to let the User control the alterEgo with direction keys, mouse, etc. Anytime you want to set the alterEgo on a pre- programmed motion, set canControl to FALSE to prevent the player from interrupting the motion and taking control. Default at startup is FALSE.


Methods

doit:

The doit: method for User checks for an event. If one is present, User sends the handleEvent: event message in succession to TheMenuBar (the game's menu bar), alterEgo, and regions (the list of regions, beginning with the current room). If any of these objects respond to the event, they should set the claimed property of the event to TRUE to let the other objects receiving the event know that it has been dealt with. If, after everyone has had a look at it, the event is still unclaimed, User puts up an input line and waits for the player to type a line of input. If a line is entered and the kernel is able to parse the line, the User turns the event into a saidEvent, indicating that valid input has been entered, and again sends the handleEvent: event message to the above objects. Once it has done so, it disposes of the event and returns.

 

Notes


 

Table of Contents

 

< Previous: The Event Class Next: The Game Class >

 

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