BasicLocationclass | travel.t[3468] |
Superclass Tree | Subclass Tree | Global Objects | Property Summary | Method Summary | Property Details | Method Details |
class
BasicLocation : Thing
BasicLocation
Thing
VocabObject
object
BasicLocation
NestedRoom
BasicChair
BasicBed
BasicPlatform
Booth
Platform
NominalPlatform
Bed
Chair
HighNestedRoom
Vehicle
Room
DarkRoom
FloorlessRoom
OutdoorRoom
ShipboardRoom
cannotGoThatWayMsg
defaultPosture
effectiveFollowLocation
listWithActorInTable
mustDefaultPostureProp
notTravelReadyMsg
roomLocation
roomNotifyList
roomTravelPreCond
Inherited from Thing
:
actorInAName
actorInName
actorInPrep
actorIntoName
actorOutOfName
actorOutOfPrep
aDisambigName
allStates
aName
brightness
bulk
canBeHeard
canBeSeen
canBeSmelled
canBeTouched
canMatchHer
canMatchHim
canMatchIt
canMatchThem
circularlyInMessage
collectiveGroup
collectiveGroups
contents
contentsListed
contentsListedInExamine
contentsListedSeparately
contentsLister
descContentsLister
described
disambigEquivName
disambigName
distantDesc
distantInitSpecialDesc
distantSpecialDesc
distinguishers
dummyName
equivalenceKey
equivalentGrouper
equivalentGrouperClass
equivalentGrouperTable
esEndingPat
explicitVisualSenseInfo
getState
globalParamName
holdingIndex
iesEndingPat
initDesc
initNominalRoomPartLocation
initSpecialDesc
inlineContentsLister
isEquivalent
isHer
isHim
isInInitState
isKnown
isLikelyCommandTarget
isListedAboardVehicle
isMassNoun
isPlural
isProperName
isQualifiedName
isThingConstructed
isTopLevel
listName
listWith
location
lookInLister
moved
name
nameDoes
nameSays
nameSees
objectNotifyList
objInPrep
obscuredInitSpecialDesc
obscuredSpecialDesc
owner
patElevenEighteen
patIsAlpha
patLeadingTagOrQuote
patOfPhrase
patOneLetterAnWord
patOneLetterWord
patSingleApostropheS
patTagOrQuoteChar
patUpperOrDigit
patVowelY
pluralDisambigName
pluralName
pronounSelector
roomDarkName
roomName
seen
sightPresence
sightSize
smellPresence
smellSize
soundPresence
soundSize
specialContentsLister
specialDesc
specialDescBeforeContents
specialDescListWith
specialDescOrder
specialNominalRoomPartLocation
suppressAutoSeen
takeFromNotInMessage
theDisambigName
theName
theNamePossNoun
tmpAmbient_
tmpAmbientFill_
tmpAmbientWithin_
tmpFillMedium_
tmpObstructor_
tmpObstructorWithin_
tmpPathIsIn_
tmpTrans_
tmpTransWithin_
touchPresence
touchSize
verbCan
verbCannot
verbCant
verbEndingSD
verbEndingSEd
verbEndingSMessageBuilder_
verbMust
verbToCome
verbToDo
verbToGo
verbToLeave
verbToSay
verbToSee
verbWill
verbWont
weight
Inherited from VocabObject
:
canResolvePossessive
disambigPromptOrder
pluralOrder
vocabLikelihood
vocabWords
weakTokens
actorInGroupPrefix
actorInGroupSuffix
actorIsFamiliar
actorKnowsDestination
actorTravelingWithin
addRoomNotifyItem
cannotGoShowExits
cannotGoThatWay
cannotGoThatWayInDark
cannotTravel
checkActorOutOfNested
checkActorReadyToEnterNestedRoom
checkMovingActorInto
checkStagingLocation
checkTravelerDirectlyInRoom
disembarkRoom
dispatchRoomDaemon
enteringRoom
getDropDestination
getExtraScopeItems
getNominalActorContainer
getNominalDropDestination
getRoomNotifyList
getStatuslineExitsHeight
isActorTravelReady
leavingRoom
listWithActorIn
makeStandingUp
removeRoomNotifyItem
roomActorHereDesc
roomActorPostureDesc
roomActorStatus
roomActorThereDesc
roomAfterAction
roomBeforeAction
roomDarkTravel
roomDesc
roomListActorPosture
roomOkayPostureChange
showStatuslineExits
travelerArriving
travelerLeaving
tryMakingDefaultPosture
tryMakingTravelReady
wouldBeLitFor
Inherited from Thing
:
acceptCommand
addAllContents
addDirectConnections
addObjectNotifyItem
addToContents
addToSenseInfoTable
adjustLookAroundTable
adjustThrowDestination
afterAction
afterTravel
allContents
aNameFrom
aNameObj
aNameOwnerLoc
announceDefaultObject
appendHeldContents
atmosphereList
baseMoveInto
basicExamine
basicExamineFeel
basicExamineListen
basicExamineSmell
basicExamineTaste
beforeAction
beforeTravel
buildContainmentPaths
cacheAmbientInfo
cacheSenseInfo
cacheSensePath
canBeHeardBy
canBeSeenBy
canBeSensed
canBeSmelledBy
canBeTouchedBy
canDetailsBeSensed
canHear
canMatchPronounType
canMoveViaPath
cannotReachObject
cannotSeeSmellSource
cannotSeeSoundSource
canOwn
canSee
canSmell
canThrowViaPath
canTouch
canTouchViaPath
checkBulkChange
checkBulkChangeWithin
checkMoveViaPath
checkThrowViaPath
checkTouchViaPath
childInName
childInNameGen
childInNameWithOwner
childInRemoteName
clearSenseInfo
cloneForMultiInstanceContents
cloneMultiInstanceContents
conjugateRegularVerb
connectionTable
construct
contentsInFixedIn
countDisambigName
countListName
countName
countNameFrom
countNameOwnerLoc
darkRoomContentsLister
defaultDistantDesc
defaultObscuredDesc
desc
directionForConnector
distantSmellDesc
distantSoundDesc
dobjFor(AskAbout)
dobjFor(AskFor)
dobjFor(AskVague)
dobjFor(AttachTo)
dobjFor(Attack)
dobjFor(AttackWith)
dobjFor(Board)
dobjFor(Break)
dobjFor(Burn)
dobjFor(BurnWith)
dobjFor(Clean)
dobjFor(CleanWith)
dobjFor(Climb)
dobjFor(ClimbDown)
dobjFor(ClimbUp)
dobjFor(Close)
dobjFor(Consult)
dobjFor(ConsultAbout)
dobjFor(CutWith)
dobjFor(Detach)
dobjFor(DetachFrom)
dobjFor(Dig)
dobjFor(DigWith)
dobjFor(Doff)
dobjFor(Drink)
dobjFor(Drop)
dobjFor(Eat)
dobjFor(Enter)
dobjFor(EnterOn)
dobjFor(Examine)
dobjFor(Extinguish)
dobjFor(Fasten)
dobjFor(FastenTo)
dobjFor(Feel)
dobjFor(Flip)
dobjFor(Follow)
dobjFor(GetOffOf)
dobjFor(GetOutOf)
dobjFor(GiveTo)
dobjFor(GoThrough)
dobjFor(JumpOff)
dobjFor(JumpOver)
dobjFor(Kiss)
dobjFor(LieOn)
dobjFor(Light)
dobjFor(ListenTo)
dobjFor(Lock)
dobjFor(LockWith)
dobjFor(LookBehind)
dobjFor(LookIn)
dobjFor(LookThrough)
dobjFor(LookUnder)
dobjFor(Move)
dobjFor(MoveTo)
dobjFor(MoveWith)
dobjFor(Open)
dobjFor(PlugIn)
dobjFor(PlugInto)
dobjFor(Pour)
dobjFor(PourInto)
dobjFor(PourOnto)
dobjFor(Pull)
dobjFor(Push)
dobjFor(PushTravel)
dobjFor(PutBehind)
dobjFor(PutIn)
dobjFor(PutOn)
dobjFor(PutUnder)
dobjFor(Read)
dobjFor(Remove)
dobjFor(Screw)
dobjFor(ScrewWith)
dobjFor(Search)
dobjFor(Set)
dobjFor(SetTo)
dobjFor(ShowTo)
dobjFor(SitOn)
dobjFor(Smell)
dobjFor(StandOn)
dobjFor(Strike)
dobjFor(Switch)
dobjFor(Take)
dobjFor(TakeFrom)
dobjFor(TalkTo)
dobjFor(Taste)
dobjFor(TellAbout)
dobjFor(TellVague)
dobjFor(Throw)
dobjFor(ThrowAt)
dobjFor(ThrowDir)
dobjFor(ThrowTo)
dobjFor(Turn)
dobjFor(TurnOff)
dobjFor(TurnOn)
dobjFor(TurnTo)
dobjFor(TurnWith)
dobjFor(TypeLiteralOn)
dobjFor(TypeOn)
dobjFor(Unfasten)
dobjFor(UnfastenFrom)
dobjFor(Unlock)
dobjFor(UnlockWith)
dobjFor(Unplug)
dobjFor(UnplugFrom)
dobjFor(Unscrew)
dobjFor(UnscrewWith)
dobjFor(Wear)
examineListContents
examineListContentsWith
examineSpecialContents
examineStatus
failCheck
feelDesc
fillMedium
findOpaqueObstructor
findTouchObstructor
forEachConnectedContainer
forEachContainer
fromPOV
getAllForTakeFrom
getAllPathsTo
getAnnouncementDistinguisher
getBagAffinities
getBagsOfHolding
getBestDistinguisher
getBulk
getBulkWithin
getCarryingActor
getCommonContainer
getCommonDirectContainer
getConnectedContainers
getConnectorTo
getContentsForExamine
getDestName
getEncumberingBulk
getEncumberingWeight
getHitFallDestination
getIdentityObject
getInScopeDistinguisher
getListedContents
getLocPushTraveler
getLocTraveler
getMovePathTo
getNoise
getNominalOwner
getObjectNotifyList
getOdor
getOutermostRoom
getOutermostVisibleRoom
getRoomPartLocation
getStateWithInfo
getThrowPathTo
getTouchPathTo
getTravelConnector
getVisualSenseInfo
getWeight
hasCollectiveGroup
hideFromAll
hideFromDefault
initializeEquivalent
initializeLocation
initializeThing
inRoomName
iobjFor(AttachTo)
iobjFor(AttackWith)
iobjFor(BurnWith)
iobjFor(CleanWith)
iobjFor(CutWith)
iobjFor(DetachFrom)
iobjFor(DigWith)
iobjFor(FastenTo)
iobjFor(GiveTo)
iobjFor(LockWith)
iobjFor(MoveWith)
iobjFor(PlugInto)
iobjFor(PourInto)
iobjFor(PourOnto)
iobjFor(PutBehind)
iobjFor(PutIn)
iobjFor(PutOn)
iobjFor(PutUnder)
iobjFor(ScrewWith)
iobjFor(ShowTo)
iobjFor(TakeFrom)
iobjFor(ThrowAt)
iobjFor(ThrowTo)
iobjFor(TurnWith)
iobjFor(UnfastenFrom)
iobjFor(UnlockWith)
iobjFor(UnplugFrom)
iobjFor(UnscrewWith)
isComponentOf
isDirectlyIn
isHeldBy
isIn
isInFixedIn
isListed
isListedInContents
isListedInInventory
isListedInRoomPart
isLookAroundCeiling
isNominallyIn
isNominallyInRoomPart
isOccludedBy
isOrIsIn
isOwnedBy
isShipboard
isVocabEquivalent
itIs
itNom
itObj
itPossAdj
itPossNoun
itVerb
listCardinality
localDirectionLinkForConnector
lookAround
lookAroundPov
lookAroundWithin
lookAroundWithinContents
lookAroundWithinDesc
lookAroundWithinName
lookAroundWithinSense
lookAroundWithinShowExits
lookInDesc
mainExamine
mainMoveInto
mapPushTravelHandlers
mapPushTravelHandlers
mapPushTravelHandlers
mapPushTravelHandlers
mapPushTravelHandlers
meetsObjHeld
mergeSenseInfo
mergeSenseInfoTable
moveInto
moveIntoForTravel
moveIntoNotifyPath
mustMoveObjInto
nameIs
nameIsnt
nameVerb
normalizePath
notePromptByOwnerLoc
notePromptByPossAdj
noteSeenBy
notifyInsert
notifyMoveInto
notifyMoveViaPath
notifyRemove
obscuredDesc
obscuredSmellDesc
obscuredSoundDesc
pluralNameFrom
processThrow
propHidesProp
propWithPresent
putInName
receiveDrop
remoteDesc
remoteInitSpecialDesc
remoteRoomContentsLister
remoteSpecialDesc
removeFromContents
removeObjectNotifyItem
restoreLocation
roomContentsLister
roomDaemon
roomDarkDesc
roomFirstDesc
roomRemoteDesc
roomTravelPreCond
saveLocation
selectPathTo
sendNotifyInsert
sendNotifyRemove
senseAmbientMax
senseInfoTable
senseObj
sensePathFromWithin
sensePathFromWithout
sensePathToContents
sensePathToLoc
sensePresenceList
setAllSeenBy
setContentsSeenBy
setGlobalParamName
setVisualSenseInfo
shineFromWithin
shineFromWithout
shineOnContents
shineOnLoc
showDistantSpecialDesc
showDistantSpecialDescInContents
showInventoryContents
showInventoryItem
showInventoryItemCounted
showListItem
showListItemCounted
showListItemCountedGen
showListItemGen
showObjectContents
showObscuredSpecialDesc
showObscuredSpecialDescInContents
showRemoteSpecialDesc
showRemoteSpecialDescInContents
showSpecialDesc
showSpecialDescInContents
showSpecialDescInContentsWithInfo
showSpecialDescWithInfo
showWornItem
showWornItemCounted
smellDesc
smellHereDesc
soundDesc
soundHereDesc
specialDescList
specialPathFrom
statusName
stopThrowViaPath
superHidesSuper
tasteDesc
thatNom
thatObj
theNameFrom
theNameObj
theNameOwnerLoc
theNameWithOwner
throwTargetCatch
throwTargetHitWith
throwViaPath
transmitAmbient
transSensingIn
transSensingOut
traversePath
tryHolding
tryImplicitRemoveObstructor
tryMovingObjInto
useInitDesc
useInitSpecialDesc
useSpecialDesc
useSpecialDescInContents
useSpecialDescInRoom
useSpecialDescInRoomPart
verbEndingEs
verbEndingIes
verbEndingS
verbToHave
verbWas
verifyFollowable
verifyInsert
verifyMoveTo
verifyRemove
whatIf
whatIfHeldBy
withVisualSenseInfo
Inherited from VocabObject
:
addToDictionary
expandPronounList
filterResolveList
getFacets
inheritVocab
initializeVocab
initializeVocabWith
matchName
matchNameCommon
matchNameDisambig
throwNoMatchForLocation
throwNoMatchForPossessive
throwNothingInLocation
cannotGoThatWayMsg | travel.t[4232] |
defaultPosture | travel.t[3695] |
effectiveFollowLocation OVERRIDDEN | travel.t[4268] |
For most rooms, this is simply the room itself.
listWithActorInTable | travel.t[3503] |
mustDefaultPostureProp | travel.t[3698] |
notTravelReadyMsg OVERRIDDEN | travel.t[3840] |
roomLocation OVERRIDDEN | travel.t[3988] |
roomNotifyList | travel.t[3982] |
roomTravelPreCond | travel.t[4258] |
actorInGroupPrefix (pov, posture, remote, lst) | travel.t[3621] |
actorInGroupSuffix (pov, posture, remote, lst) | travel.t[3629] |
actorIsFamiliar (actor) | travel.t[4154] |
This should return true if the actor is familiar with this location, nil if not. By default, we return nil, since actors are not by default familiar with any locations.
The purpose of this routine is to determine if the actor is meant to know the location well, within the context of the game, even before the game starts. For example, if an area in the game is an actor's own house, the actor would naturally be familiar, within the context of the game, with the locations making up the house.
Note that this routine doesn't need to "learn" based on the events of the game. The familiarity here is meant only to model the actor's knowledge as of the start of the game.
actorKnowsDestination (actor, conn) | travel.t[4122] |
There are two main reasons an actor would have intrinsic knowledge of a connector's destination:
1. The actor is supposed to be familiar with the location and its surroundings, within the context of the game. For example, if part of the game is the player character's own house, the PC would probably know where all of the connections among rooms go.
2. The destination location is plainly visible from this location or is clearly marked (such as with a sign). For example, if the current location is an open field, a nearby hilltop to the east might be visible from here, so we could see from here where we'll end up by going east. Alternatively, if we're in a lobby, and the passage to the west is marked with a sign reading "electrical room," an actor would have good reason to think an electrical room lies to the west.
We handle case (1) automatically through our actorIsFamiliar() method: if the actor is familiar with the location, we assume by default that the actor knows where all of the connectors from here go. We don't have any default handling for case (2), so individual rooms (or subclasses) must override this method if they want to specify intrinsic knowledge for any of their outgoing connectors.
actorTravelingWithin (origin, dest) | travel.t[4085] |
This routine is used any time an actor is moved with travelWithin(). This is not used when an actor travels between locations related by a TravelConnector object rather than by direct containment.
We do nothing by default. Locations can override this if they wish to perform any special handling during this type of travel.
addRoomNotifyItem (obj) | travel.t[3970] |
Items can be added here if they must be notified of actions performed by within the room even when the items aren't in the room at the time of the action. All items connected by containment with the actor performing an action are automatically notified of the action; only items that must receive notification even when not connected by containment need to be registered here.
cannotGoShowExits (actor) OVERRIDDEN | travel.t[3642] |
cannotGoThatWay ( ) | travel.t[4217] |
cannotGoThatWayInDark ( ) | travel.t[4246] |
This routine is essentially a replacement for the cannotGoThatWay() routine that we use when the actor is in the dark.
cannotTravel ( ) | travel.t[4170] |
The handling depends on whether or not it's dark. If it's dark, we don't want to reveal whether or not it's actually possible to perform the travel, since there's no light to see where the exits are.
checkActorOutOfNested (allowImplicit) OVERRIDDEN | travel.t[3812] |
checkActorReadyToEnterNestedRoom (allowImplicit) | travel.t[3785] |
checkMovingActorInto (allowImplicit) | travel.t[3718] |
checkStagingLocation (dest) OVERRIDDEN | travel.t[3710] |
checkTravelerDirectlyInRoom (traveler, allowImplicit) OVERRIDDEN | travel.t[3796] |
disembarkRoom ( ) | travel.t[3846] |
dispatchRoomDaemon ( ) | travel.t[4275] |
enteringRoom (traveler) | travel.t[3998] |
getDropDestination (objToDrop, path) OVERRIDDEN | travel.t[3862] |
getExtraScopeItems (actor) OVERRIDDEN | travel.t[3908] |
By default, this returns nothing. Subclasses can override as necessary to include additional items in scope. For example, a chair would probably want to include itself in scope, since the actor presumably knows he or she is sitting in a chair even if it's too dark to see the chair.
getNominalActorContainer (posture) | travel.t[3894] |
getNominalDropDestination ( ) OVERRIDDEN | travel.t[3883] |
The difference between the actual drop location and the nominal drop location is that the nominal drop location is used only for reporting messages, while the actual drop location is the location where objects are moved on 'drop' or equivalent actions. Rooms, for example, want to report that a dropped object lands on the floor (or the ground, or whatever), even though the room itself is the location where the object actually ends up. We distinguish between the nominal and actual drop location to allow these distinctions in reported messages.
getRoomNotifyList ( ) OVERRIDDEN | travel.t[3943] |
We'll also include any registered notification items for all of our containing rooms up to the outermost container.
The general notification mechanism always includes in the notification list all of the objects connected by containment to the actor, so objects that are in this room need not register for explicit notification.
getStatuslineExitsHeight ( ) OVERRIDDEN | travel.t[3664] |
isActorTravelReady (conn) OVERRIDDEN | travel.t[3826] |
leavingRoom (traveler) | travel.t[4006] |
listWithActorIn (posture) | travel.t[3484] |
By default, we maintain a lookup table, and store one nested actor grouper object for each posture. This makes it so that we show one group per posture in this room; for example, if we contain two sitting actors and three standing actors, we'll say something like "bill and bob are sitting on the stage, and jill, jane, and jack are standing on the stage." This can be overridden if a different arrangement of groups is desired; for example, an override could simply return a single grouper to list everyone in the room together, regardless of posture.
makeStandingUp ( ) | travel.t[3681] |
Subclasses might need to override this. For example, a chair will set the actor's location to the room containing the chair when the actor stands up from the chair.
removeRoomNotifyItem (obj) | travel.t[3976] |
roomActorHereDesc (actor) | travel.t[3557] |
roomActorPostureDesc (actor) | travel.t[3598] |
roomActorStatus (actor) | travel.t[3595] |
roomActorThereDesc (actor) OVERRIDDEN | travel.t[3566] |
roomAfterAction ( ) | travel.t[3926] |
roomBeforeAction ( ) | travel.t[3916] |
roomDarkTravel (actor) | travel.t[4199] |
By default, we'll simply display the same handler we do when the player attempts travel in a direction with no travel possible in the dark (cannotGoThatWayInDark), and then use 'exit' to cancel the command. This default behavior provides the player with no mapping information in the dark, since the same message is generated whether or not travel would be possible in a given direction were light present.
roomDesc ( ) OVERRIDDEN | travel.t[3554] |
roomListActorPosture (actor) | travel.t[3609] |
roomOkayPostureChange (actor) | travel.t[3602] |
showStatuslineExits ( ) OVERRIDDEN | travel.t[3650] |
travelerArriving (traveler, origin, connector, backConnector) | travel.t[4036] |
By default, we set each of the "motive" actors to its default posture, then describe the arrival.
travelerLeaving (traveler, dest, connector) | travel.t[4017] |
By default, we describe the traveler's departure if the traveler's destination is different from its present location.
tryMakingDefaultPosture ( ) | travel.t[3701] |
tryMakingTravelReady (conn) | travel.t[3837] |
wouldBeLitFor (actor) | travel.t[3518] |
Note that if the actor is already in this location, there's no need to run this test, since we could get the information from the actor directly. The point of this test is to determine the light level in this location without the actor having to be present.