The Rgn class is the base class for rooms.

Properties

• scripts
• number
• timer
• keep
• initialized

Methods

• void init()
  Sets up the region object.

  If it's initialized property is FALSE, it sets it to TRUE and if it's not part of the regions list, it adds it. Finally, it call's it's super's init() method.

• void doit()
  If the script property is set, it calls the script's doit() method.
 
• void dispose()
  Performs a complete disposal of the region and all it's elements.It removes it from the regions list, disposes of it's script object, timer object, and all it's sounds. Finally, it unloads the script resource from memory.
 
• bool handleEvent(heapPtr pEvent)
  If the script property is set, it calls the script's handleEvent() method. It then returns whether pEvent has been claimed or not.
 
• void setScript(heapPtr newScript[, heapPtr theCaller, number theRegister])
  Disposes the current script pointed to by the script property. If newScript is not NULL, it initializes it with theCaller and theRegister is specified.
 
• void cue()
  If the script property is set, it call's it's cue() method.
 
• void newRoom()
  In Rgn, this is just an empty place holder.
 
• void notify()
  In Rgn, this is just an empty place holder.