Script Classes for Adventure Games/User Class - Revision history

Andrew Branscom at 23:29, 17 January 2026

2026-01-17T23:29:57Z

← Older revision		Revision as of 19:29, 17 January 2026
Line 1:		Line 1:
			[[Category:SCI Pages]]
	[[Official SCI Documentation]]<br />		[[Official SCI Documentation]]<br />
	[[Script Classes for Adventure Games \| Table of Contents]]		[[Script Classes for Adventure Games \| Table of Contents]]

	<div align="center">		<div align="center">
	Chapter:		Chapter:
Line 32:		Line 32:
	[[Script Classes for Adventure Games/Global Variables\|27]] \|		[[Script Classes for Adventure Games/Global Variables\|27]] \|
	[[Script Classes for Adventure Games/Index\|Index]]		[[Script Classes for Adventure Games/Index\|Index]]
	</div>~~<br />~~		</div>
			<div align="center"><span style="font-size: 22pt">The User Class</span><br />''Author: [[Jeff Stephenson]]''<br />''1988-04-05''</div></div>
	<div align="center"><span style="font-size: 22pt">The User Class</span><br />
	''Author: [[Jeff Stephenson]]''<br />
	''~~Date: 5 April~~ 1988''</div>

	~~ ~~

			<br />
	==<br /> The User Class ==		==<br /> The User Class ==

Line 76:		Line 72:
	==<br /> References ==		==<br /> References ==

	<references />		<references /><!-- Do not edit this section. It is autopopulated by <ref></ref> tags -->

	==<br /> See ~~Also:~~ ==		==<br /> Also See ==

			* [[:Category:SCI Documentation\|SCI Documentation]]
			* [[:Category:Official SCI Documentation\|Official SCI Documentation]]
			* [[:Category:SCI Scripting\|SCI Scripting]]
			* [[:Category:SCI Classes\|SCI Classes]]
			* [[:Category:Animation\|Animation Articles]]
			* [[:Category:SCI Animation\|SCI Animation Articles]]
			* [[:Category:SCI User Class \| The SCI User Class]]
	* [[SCI Specifications]]		* [[SCI Specifications]]



			[[Official SCI Documentation]]<br />
	[[Script Classes for Adventure Games \| Table of Contents]]		[[Script Classes for Adventure Games \| Table of Contents]]

	<span style="float: left">[[Script Classes for Adventure Games/Event Class\|< Previous: The Event Class]]</span>		<span style="float: left">[[Script Classes for Adventure Games/Event Class\|< Previous: The Event Class]]</span>
	<span style="float: right">[[Script Classes for Adventure Games/Game Class\|Next: The Game Class >]]</span>		<span style="float: right">[[Script Classes for Adventure Games/Game Class\|Next: The Game Class >]]</span>



	[[Category:References]]		[[Category:References]]
	[[Category:SCI References]]		[[Category:SCI References]]
			[[Category:Historical Pages]]
			[[Category:SCI Historical Pages]]
			[[Category:Development]]
			[[Category:SCI Development]]
	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:SCI Documentation]]		[[Category:SCI Documentation]]
			[[Category:Official Documentation]]
			[[Category:Official SCI Documentation]]
	[[Category:Scripting]]		[[Category:Scripting]]
	[[Category:SCI Scripting]]		[[Category:SCI Scripting]]
	[[Category:Classes]]		[[Category:Classes]]
	[[Category:SCI Classes]]		[[Category:SCI Classes]]
			[[Category:Animation]]
			[[Category:SCI User Class]]
			[[Category:SCI User Class alterEgo Property]]
			[[Category:SCI User Class canInput Property]]
			[[Category:SCI User Class canControl Property]]
			[[Category:SCI User Class doit Method]]

Andrew Branscom: 2 revisions imported

2025-02-16T21:05:25Z

2 revisions imported

← Older revision	Revision as of 17:05, 16 February 2025
(No difference)

Andrew Branscom: 1 revision imported

2024-06-03T05:14:28Z

1 revision imported

← Older revision	Revision as of 01:14, 3 June 2024
(No difference)

Andrew Branscom at 00:05, 12 April 2018

2018-04-12T00:05:10Z

New page

[[Official SCI Documentation]]<br />
[[Script Classes for Adventure Games | Table of Contents]]

<div align="center">
Chapter:
[[Script Classes for Adventure Games/Introduction|1]] |
[[Script Classes for Adventure Games/RootObj Class|2]] |
[[Script Classes for Adventure Games/Object Class|3]] |
[[Script Classes for Adventure Games/Collection Class|4]] |
[[Script Classes for Adventure Games/Script Class|5]] |
[[Script Classes for Adventure Games/Timer Class|6]] |
[[Script Classes for Adventure Games/Feature Class|7]] |
[[Script Classes for Adventure Games/View Class|8]] |
[[Script Classes for Adventure Games/PicView Class|9]] |
[[Script Classes for Adventure Games/Cycling Classes|10]] |
[[Script Classes for Adventure Games/Motion Classes|11]] |
[[Script Classes for Adventure Games/Avoider Class|12]] |
[[Script Classes for Adventure Games/Event Class|13]] |
[[Script Classes for Adventure Games/User Class|14]]<br />
[[Script Classes for Adventure Games/Game Class|15]] |
[[Script Classes for Adventure Games/Locale Class|16]] |
[[Script Classes for Adventure Games/Region Class|17]] |
[[Script Classes for Adventure Games/Room Class|18]] |
[[Script Classes for Adventure Games/Timer2 Class|19]] |
[[Script Classes for Adventure Games/InvItem Class|20]] |
[[Script Classes for Adventure Games/Block Class|21]] |
[[Script Classes for Adventure Games/Cage Class|22]] |
[[Script Classes for Adventure Games/Sound Class|23]] |
[[Script Classes for Adventure Games/StatusLine Class|24]] |
[[Script Classes for Adventure Games/File Class|25]] |
[[Script Classes for Adventure Games/Code Class|26]] |
[[Script Classes for Adventure Games/Global Variables|27]] |
[[Script Classes for Adventure Games/Index|Index]]
</div><br />

<div align="center"><span style="font-size: 22pt">The User Class</span><br />
''Author: [[Jeff Stephenson]]''<br />
''Date: 5 April 1988''</div>

 

==<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>

==<br /> References ==

<references />

==<br /> See Also: ==

* [[SCI Specifications]]

 

[[Script Classes for Adventure Games | Table of Contents]]

<span style="float: left">[[Script Classes for Adventure Games/Event Class|< Previous: The Event Class]]</span>
<span style="float: right">[[Script Classes for Adventure Games/Game Class|Next: The Game Class >]]</span>

 

[[Category:References]]
[[Category:SCI References]]
[[Category:Documentation]]
[[Category:SCI Documentation]]
[[Category:Scripting]]
[[Category:SCI Scripting]]
[[Category:Classes]]
[[Category:SCI Classes]]