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

From SCI Wiki
Jump to navigationJump to search
m (Collector moved page Script Classes for Adventure Games/Cage to Script Classes for Adventure Games/Cage Class without leaving a redirect)
 
(3 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 />
Line 62: Line 39:
 
&nbsp;
 
&nbsp;
  
−
xxxxxxx body xxxxxxxx
+
==<br /> The Cage Class ==
 +
 
 +
The Cage class implements ability to keep Actors in a rectangular region.
 +
 
 +
{|
 +
|width= "125"|In file:||actor.sc
 +
|-
 +
|Inherits from:||Block
 +
|-
 +
|Inherited by:||none
 +
|}
 +
 
 +
===<br /> Properties ===
 +
 
 +
<blockquote>
 +
==== top <br /> bottom <br /> left <br /> right ====
 +
<blockquote>The bounding coordinates of the enclosing Cage.</blockquote>
 +
</blockquote>
 +
 
 +
===<br /> Methods ===
 +
 
 +
<blockquote>
 +
==== init: ====
 +
<blockquote>Add the Cage to the set of blocks for the current room and enable the Cage.</blockquote>
 +
 
 +
==== doit: actor ====
 +
<blockquote>Return TRUE if actor is inside of the Block (and is thus in a legal position) or FALSE if it is outside the Cage (and thus must be moved back in). This is called in each Actor's canBeHere: method.</blockquote>
 +
 
 +
==== dispose: ====
 +
<blockquote>Delete the Cage from the set of blocks for the current room and dispose of it if it is a dynamic instance.</blockquote>
 +
 
 +
==== enable: ====
 +
<blockquote>Set the active property of the Cage to TRUE, so that Actors cannot leave it.</blockquote>
 +
 
 +
==== disable: ====
 +
<blockquote>Set the active property of the Cage to FALSE, so that Actors can leave it.</blockquote>
 +
</blockquote>
  
 
&nbsp;
 
&nbsp;
Line 75: Line 88:
 
&nbsp;
 
&nbsp;
  
−
<span style="float: left">[[Script Classes for Adventure Games/Block|&lt; Previous: Block]]</span>
+
<span style="float: left">[[Script Classes for Adventure Games/Block Class|&lt; Previous: The Block Class]]</span>
−
<span style="float: right">[[Script Classes for Adventure Games/Sound|Next: Sound &gt;]]</span>
+
<span style="float: right">[[Script Classes for Adventure Games/Sound Class|Next: The Sound Class &gt;]]</span>
  
 
&nbsp;
 
&nbsp;

Latest revision as of 02:00, 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 Cage Class

Author: Jeff Stephenson

Date: 5 April 1988

 


The Cage Class

The Cage class implements ability to keep Actors in a rectangular region.

In file: actor.sc
Inherits from: Block
Inherited by: none


Properties

top
bottom
left
right

The bounding coordinates of the enclosing Cage.


Methods

init:

Add the Cage to the set of blocks for the current room and enable the Cage.

doit: actor

Return TRUE if actor is inside of the Block (and is thus in a legal position) or FALSE if it is outside the Cage (and thus must be moved back in). This is called in each Actor's canBeHere: method.

dispose:

Delete the Cage from the set of blocks for the current room and dispose of it if it is a dynamic instance.

enable:

Set the active property of the Cage to TRUE, so that Actors cannot leave it.

disable:

Set the active property of the Cage to FALSE, so that Actors can leave it.

 

Notes


 

Table of Contents

 

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

 

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