Script Classes for Adventure Games/Script Class - Revision history

Andrew Branscom at 02:06, 7 January 2026

2026-01-07T02:06:35Z

← Older revision		Revision as of 22:06, 6 January 2026
Line 144:		Line 144:
	[[Category:Classes]]		[[Category:Classes]]
	[[Category:SCI Classes]]		[[Category:SCI Classes]]
	~~[[Category:Script Classes]]~~
	~~[[Category:SCI Script Classes]]~~

Andrew Branscom: /* Also See */

2026-01-07T02:04:03Z

Also See

← Older revision		Revision as of 22:04, 6 January 2026
Line 146:		Line 146:
	[[Category:Script Classes]]		[[Category:Script Classes]]
	[[Category:SCI Script Classes]]		[[Category:SCI Script Classes]]
	~~[[Category:Timer Class]]~~
	~~[[Category:SCI Inventory Class]]~~
	~~[[Category:Timer]]~~

Andrew Branscom: /* Also See */

2026-01-07T02:03:27Z

Also See

← Older revision		Revision as of 22:03, 6 January 2026
Line 120:		Line 120:
	* [[:Category:SCI Scripting\|SCI Scripting]]		* [[:Category:SCI Scripting\|SCI Scripting]]
	* [[:Category:SCI Classes\|SCI]]		* [[:Category:SCI Classes\|SCI]]
	* [[:Category:SCI Script ~~Class~~ \| The SCI Script ~~Class~~]]		* [[:Category:SCI Script Classes \| The SCI Script Classes]]
	* [[SCI Specifications]]		* [[SCI Specifications]]

Andrew Branscom: /* Also See */

2026-01-07T01:45:49Z

Also See

← Older revision		Revision as of 21:45, 6 January 2026
Line 116:		Line 116:
	==<br /> Also See ==		==<br /> Also See ==

	* [[:Category:SCI Script Class \| The SCI Script Class]]
	* [[:Category:SCI Documentation\|SCI Documentation]]		* [[:Category:SCI Documentation\|SCI Documentation]]
	* [[:Category:Official SCI Documentation\|Official SCI Documentation]]		* [[:Category:Official SCI Documentation\|Official SCI Documentation]]

Andrew Branscom: /* Also See */

2026-01-07T01:45:15Z

Also See

← Older revision		Revision as of 21:45, 6 January 2026
Line 116:		Line 116:
	==<br /> Also See ==		==<br /> Also See ==

	* [[:Category:SCI Script Class \| The SCI Script Class		* [[:Category:SCI Script Class \| The SCI Script Class]]
	~~SCI Specifications~~]]
	* [[:Category:SCI Documentation\|SCI Documentation]]		* [[:Category:SCI Documentation\|SCI Documentation]]
	* [[:Category:Official SCI Documentation\|Official SCI Documentation]]		* [[:Category:Official SCI Documentation\|Official SCI Documentation]]

Andrew Branscom at 01:44, 7 January 2026

2026-01-07T01:44:46Z

← Older revision		Revision as of 21:44, 6 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:
	[[Script Classes for Adventure Games/Introduction\|1]] \|		[[Script Classes for Adventure Games/Introduction\|1]] \|
	[[Script Classes for Adventure Games/RootObj Class\|2]] \|		[[Script Classes for Adventure Games/RootObj Class\|2]] \|
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 Script Class</span><br />''Author: [[Jeff Stephenson]]''<br />''1988-04-05''</div></div>
	<div align="center"><span style="font-size: 22pt">The Script Class</span><br />
	''Author: [[Jeff Stephenson]]''<br />
	''~~Date: 5 April~~ 1988''</div>

	~~ ~~

			<br />
	==<br /> The Script Class ==		==<br /> The Script Class ==

Line 116:		Line 112:
	==<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 Script Class \| The SCI Script Class
			SCI Specifications]]
			* [[:Category:SCI Documentation\|SCI Documentation]]
			* [[:Category:Official SCI Documentation\|Official SCI Documentation]]
			* [[:Category:SCI Scripting\|SCI Scripting]]
			* [[:Category:SCI Classes\|SCI]]
			* [[:Category:SCI Script Class \| The SCI Script 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/Inventory Class\|< Previous: The Inventory Class]]</span>		<span style="float: left">[[Script Classes for Adventure Games/Inventory Class\|< Previous: The Inventory Class]]</span>
	<span style="float: right">[[Script Classes for Adventure Games/Timer Class\|Next: The Timer Class >]]</span>		<span style="float: right">[[Script Classes for Adventure Games/Timer Class\|Next: The Timer 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:Script Classes]]
			[[Category:SCI Script Classes]]
			[[Category:Timer Class]]
			[[Category:SCI Inventory Class]]
			[[Category:Timer]]

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 23:57, 11 April 2018

2018-04-11T23:57:40Z

New page

[[Official SCI Documentation]] 
[[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]] 
[[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> 

<div align="center">The Script Class 
''Author: [[Jeff Stephenson]]'' 
''Date: 5 April 1988''</div>

 

== The Script Class ==

A Script is a kind of Object which has a state, methods to change that state, and code to execute when the state changes. It is used to model a sequence of actions which should be executed by an object, such as an Actor walking to the base of some stairs, walking up the stairs, and opening a door.

{|
|width+ "125"|In file:||system.sc
|-
|Inherits from:||Object
|-
|Inherited by:||none
|}

=== Properties ===

<blockquote>
==== client ====
<blockquote>The object (a Prop, Actor, Ego, Room, etc.) whose Script this is. Used to communicate with the Script's client.</blockquote>

==== state ====
<blockquote>The state of the Script.</blockquote>

==== start ====
<blockquote>The desired initial state of the Script.</blockquote>

==== timer ====
<blockquote>The ID of a timer which has been set to cue: the Script after a certain interval.</blockquote>

==== register ====
<blockquote>A property that allows you to store what ever you want. This is very useful in a Script since a temporary variable will not hold its value longer that the life of one method, thus without this property the only way to keep a value fro. state to state through a Script would have been a local o. global variable. If more than one value needs to be stored the register property could be used as a pointer to a Collection, List or Set.</blockquote>

==== caller ====
<blockquote>The is where the Script keeps the ID of the object to cue: upon completion.</blockquote>

==== seconds ====
<blockquote>This contains the number of seconds until a state change wil. occur. This is generally set in one of the scripts states to signal the number of seconds until a state change should occur.</blockquote>

==== cycles ====
<blockquote>This contains the number of animation cycles until a stat. change will occur. This is generally set in one of the script. states to signal the number of animation cycles until a stat. change should occur.</blockquote>

==== script ====
<blockquote>The ID of this script's script if it has one. This property is filled by the setScript method and should not be set directly.</blockquote>
</blockquote>

=== Methods ===

<blockquote>
==== init: [client] ====
<blockquote>Initialize the Script entering the initial state by doing a (self changeState:start). Set the Script's client to client if present.</blockquote>

==== changeState: newState ====
<blockquote>Change the Script's state to newState. This method is where to put the code to be executed on state transitions. It should store the new state in the state property, then switch to the appropriate code based on the new state:

<blockquote>
<div class="CodeBlockHeader">Code:</div>
<syntaxhighlight lang="sci">
(method (changeState newState)
(switch (= state newState)
transition code...
)
)
</syntaxhighlight>
</blockquote>
</blockquote>

==== cue: ====
<blockquote>Do a changeState: to the next state. Default is to invoke (self changeState:(+ state 1))</blockquote>

==== handleEvent: event ====
<blockquote>This method of an active script is called whenever there is an input event (see class Event). If (event claimed:) is TRUE, someone else has already responded to the event. Whether or not someone else has responded, if the Script responds to the event it should claim it by doing an (event claimed:TRUE). This method ca. be used to add additional responses to an Actor ,Prop etc.</blockquote>

==== setScript: newScript whoCares register ====
<blockquote>A Script can also have a script. This adds subroutine style capability to scripts. If the optional parameter whoCares is present the newScript will cue: whoCares and pass on the content. its register when it is disposed (i.e. (client cue:register)). In this case, the last state of the newScript should dispose o. itself i.e. (self dispose:) or (client setScript:0). The third parameter (if present) sets the newScript's register property. If a Script has a newScript the newScript will receive all the events the the parenet script receives.</blockquote>
</blockquote>

== References ==

<references />

== See Also: ==

* [[SCI Specifications]]

 

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

[[Script Classes for Adventure Games/Inventory Class|< Previous: The Inventory Class]]
[[Script Classes for Adventure Games/Timer Class|Next: The Timer Class >]]

 

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