DSBase class | travel.t[1091]

Base mix-in class for defining various types of double-sided (two-way) travel connectors

`class DSBase : object`

Superclass Tree (in declaration order)

`DSBase`
`object`

Subclass Tree

`DSBase`
`DSCon`
`DSDoor`
`SymDoor`
`DSPassage`
`SymPassage`
`DSPathPassage`
`SymPathPassage`
`DSStairway`
`SymStairway`
`DSTravelConnector`
`SymConnector`

Global Objects

(none)

Summary of Properties

`dirName inRoom1 inRoom2 isDestinationKnown room1 room2`

Summary of Methods

`attachedDir byRoom connDir doorDir getDestination room1Dir room2Dir`

Properties

`dirName` | `travel.t[1195]`

The name of our direction of travel from the point of view of the player character depending on whether the pc is in room1 or room2.

`inRoom1` | `travel.t[1098]`

Test whether the player character is in our room1

`inRoom2` | `travel.t[1101]`

Test whether the player character is in our room2

`isDestinationKnown` | `travel.t[1198]`

Our destination is known if each of the rooms we connect is either visited or familiar.

`room1` | `travel.t[1093]`

The two rooms we connnect.

`room2` | `travel.t[1094]`

no description available

Methods

`attachedDir ( )` | `travel.t[1131]`

Returns the direction property to which this connector object is connected in the player character's current location, e.g. &west. This is used on by DirState to add the appropriate adjective (e.g. 'west') to our vocab, so that the player can refer to us by the direction in which we lead. If you don't want this direction to be included in the vocab of this object, override attachedDir to nil.

`byRoom (args)` | `travel.t[1104]`

return a or b depending on which room the player char is in

`connDir (origin)` | `travel.t[1163]`

Return the direction that points to us from the player character's current location.

`doorDir ( )` | `travel.t[1150]`

Returns the direction in which this connector object leads from the player character's current location (or nil, if the player character isn't in one of the rooms this door is located it).

`getDestination (origin)` | `travel.t[1109]`

Our destination depends on our origin.

`room1Dir ( )` | `travel.t[1183]`

The direction an actor needs to travel in to travel via us from room1. This is set up in Room initObj();

`room2Dir ( )` | `travel.t[1189]`

The direction an actor needs to travel in to travel via us from room2. This is set up in Room initObj();

Adv3Lite Library Reference Manual
Generated on 25/04/2024 from adv3Lite version 2.0