AccompanyingStateclass

actor.t[5286]

Superclass
Tree

Subclass
Tree

Global
Objects

Property
Summary

Method
Summary

Property
Details

Method
Details

The basic “accompanying” state. In this state, whenever the actor we’re accompanying travels to a location we want to follow, we’ll travel at the same time with the other actor.

class AccompanyingState :   ActorState

Superclass Tree   (in declaration order)

AccompanyingState
ActorState
TravelMessageHandler
`                         object [ActorTopicDatabase](../object/ActorTopicDatabase.html) [TopicDatabase](../object/TopicDatabase.html)                                 object`

Subclass Tree  

AccompanyingState
GuidedTourState

Global Objects  

(none)

Summary of Properties  

Inherited from ActorState :
autoSuggest getImpliedConvState isInitState location stateDesc stateSuggestedTopics

Inherited from ActorTopicDatabase :
askForTopics askTopics commandTopics giveTopics initiateTopics miscTopics showTopics specialTopics tellTopics

Inherited from TopicDatabase :
limitSuggestions suggestedTopics topicGroupActive topicGroupScoreAdjustment

Summary of Methods  

accompanyTravel beforeTravel getAccompanyingTravelState

Inherited from ActorState :
activateState afterAction afterTravel arrivingTurn arrivingWithDesc beforeAction construct deactivateState distantSpecialDesc endConversation getActor getNominalTraveler getSuggestedTopicList getTopicOwner handleConversation initializeActorState justFollowed notifyTopicResponse obeyCommand remoteSpecialDesc showSpecialDescInContents specialDesc specialDescListWith suggestTopicsFor takeTurn

Inherited from TravelMessageHandler :
sayArriving sayArrivingDir sayArrivingDownStairs sayArrivingLocally sayArrivingThroughPassage sayArrivingUpStairs sayArrivingViaPath sayDeparting sayDepartingDir sayDepartingDownStairs sayDepartingLocally sayDepartingThroughPassage sayDepartingUpStairs sayDepartingViaPath sayTravelingRemotely

Inherited from ActorTopicDatabase :
initiateTopic showTopicResponse

Inherited from TopicDatabase :
addSuggestedTopic addTopic addTopicToList compareVocabMatch findTopicResponse handleTopic removeSuggestedTopic removeTopic removeTopicFromList showSuggestedTopicList

Properties  

(none)

Methods  

accompanyTravel (traveler, conn)

actor.t[5302]

Check to see if we are to accompany the given traveler on the given travel. ‘traveler’ is the Traveler performing the travel, and ‘conn’ is the connector that the traveler is about to take.

Note that ‘traveler’ is a Traveler object. This will simply be an Actor (which is a kind of Traveler) when the actor is performing the travel directly, but it could also be another kind of Traveler, such as a Vehicle. This routine must determine whether to accompany other kinds of actors.

By default, we’ll return true to indicate that we want to accompany any traveler anywhere they go. This should almost always be overridden in practice to be more specific.

beforeTravel (traveler, connector)OVERRIDDEN

actor.t[5326]

handle a before-travel notification for my actor

getAccompanyingTravelState (traveler, connector)

actor.t[5311]

Get our accompanying state object. We’ll create a basic accompanying in-travel state object, returning to the current state when we’re done. ‘traveler’ is the Traveler object that’s performing the travel; this might be an Actor, but could also be a Vehicle or other Traveler subclass.

TADS 3 Library Manual
Generated on 5/16/2013 from TADS version 3.1.3