Andrew Branscom: 2 revisions imported

2025-02-16T21:05:23Z

2 revisions imported

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

Andrew Branscom: 1 revision imported

2024-06-03T05:14:27Z

1 revision imported

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

Andrew Branscom at 00:12, 12 April 2018

2018-04-12T00:12:09Z

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 Cage Class</span><br />
''Author: [[Jeff Stephenson]]''<br />
''Date: 5 April 1988''</div>

 

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

==<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/Block Class|< Previous: The Block Class]]</span>
<span style="float: right">[[Script Classes for Adventure Games/Sound Class|Next: The Sound Class >]]</span>

 

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

Script Classes for Adventure Games/Cage Class - Revision history

Andrew Branscom: 2 revisions imported

Andrew Branscom: 1 revision imported

Andrew Branscom at 00:12, 12 April 2018