DynamicRegionclass
no description available
class DynamicRegion : Region
Superclass Tree (in declaration order)
DynamicRegion
Region
` object`
Subclass Tree
(none)
Global Objects
(none)
Summary of Properties
Inherited from Region :
extraScopeItems familiar fastGoTo roomList rooms
Summary of Methods
addExtraScopeItems addToRoomList contractRegion expandRegion extraAdjustments isIn notifyAfter notifyBefore
Inherited from Region :
addToContents allRegions isCurrentlyWithin isOrIsIn makeRegionLists moveMLIntoAdd moveMLOutOf regionAfterAction regionAfterTravel regionBeforeAction regionBeforeTravel regionDaemon removeFromContents setFamiliarRooms travelerEntering travelerLeaving
Properties
allRegions
The list of regions a DynamicRegion is in is simply an empty list. [DYNAMICREGION EXTENSION]
regionsOVERRIDDEN
A DynamicRegion cannot be part of any other Region, so any value given to this property in game code will be ignored. [DYNAMICREGION EXTENSION]
Methods
addExtraScopeItems (action)OVERRIDDEN
Put extra items in scope when action is carried out in any room in this region. [DYNAMICREGION EXTENSION]
addToRoomList (rm)OVERRIDDEN
Add an additional room (passed as the rm parameter) to our list of rooms. This method is intended for internal library use at PreInit only. [DYNAMICREGION EXTENSION]
contractRegion (rm)
Remove rm from this Region. The rm parameter has the same meaning as for expandRegion(rm) [DYNAMICREGION EXTENSION].
expandRegion (rm)
Expand this region by adding rm to it. rm may be a single Room or a list of Rooms or a single Region or a list of Regions or a list of Rooms and Regions. Note, however, that the effect of specifying Regions as an argument to this method is only a shorthand way of specifying the rooms the Regions contain; no permanent relationship is created between a DynamicRegion and any other Regions added to it. [DYNAMICREGION EXTENSION]
extraAdjustments (rm, expanded)
Carry out any additional adjustments that need to be made as side-effects to adding or removing rooms. By default we do nothing here but game code can override as necessary. The rm parameter is the list of rooms/regions that have just been added (if expanding is true) or subtracted (if expanded is nil) from this region. [DYNAMICREGION EXTENSION]
isIn (region)OVERRIDDEN
A DynamicRegion cannot be in any other region, so we simply return nil [DYNAMICREGION EXTENSION]
notifyAfter ( )OVERRIDDEN
Carry out after notifications on the region [DYNAMICREGION EXTENSION]
notifyBefore ( )OVERRIDDEN
Carry out before notifications on the region [DYNAMICREGION EXTENSION]
Adv3Lite Library Reference Manual
Generated on 15/03/2023 from adv3Lite version 1.6.1