NodeEndCheckclassactor.t[5219]

Superclass
Tree 		Subclass
Tree 		Global
Objects 		Property
Summary 		Method
Summary 		Property
Details 		Method
Details

A NodeEndCheck may optionally be assigned to a Conversation Node (as defined on the convKeys property, or through being located in a ConvNode object) to decide whether a conversation is allowed to end while it's at this node. There's no need to define one of these objects for a conversation node if you're happy for the conversation to be ended during it under all circumstances.

class NodeEndCheck :   EndConvBlocker   InitiateTopic

Superclass Tree   (in declaration order)

NodeEndCheck
        EndConvBlocker
                object
        InitiateTopic
                ActorTopicEntry
                        ReplaceRedirector
                                Redirector
                                        object
                        TopicEntry
                                object

Subclass Tree  

(none)

Global Objects  

(none)

Summary of Properties  

active  convKeys  matchObj 

Inherited from InitiateTopic :
agendaItem  defaultInvocation  includeInList  reasonInvoked  revealing 

Inherited from ActorTopicEntry :
activated  activateKeyTopics  agenda  agendaPath  arouseKeyTopics  aTag  autoName  autoSuppress  autoSuppressSubTopics  autoUseAgenda  curiosityAroused  getActor  impliesGreeting  keyTopics  lastConvResponse  lcrScriptClass  listOrder  name  nextStep  suggestAs  timesInvoked  tTag  wasConversational 

Inherited from TopicEntry :
isActive  matchExactCase  matchPattern  matchScore  narrator  scoreBoost  topicMatched 

Summary of Methods  

canEndConversation  handleTopic 

Inherited from EndConvBlocker :
blockEndConv 

Inherited from InitiateTopic :
matchTopic 

Inherited from ActorTopicEntry :
activate  addToConvKeyTable  baseHandleTopic  buildName  curiositySatisfied  deactivate  filterTopicSuggestions  fText  getKeyTopics  infTag  initializeTopicEntry  isConversational  isReachable  nodeActive  qualifiedDesc  revTag  showKeyTopics  timesToSuggest  tryAgenda  tryNextStep  useAgenda 

Inherited from ReplaceRedirector :
redirect 

Inherited from Redirector :
doInstead  doNested  doOtherAction 

Inherited from TopicEntry :
addTopic  factText  informFact  revealFact  scoreBooster  topicResponse 

Properties  

activeOVERRIDDENactor.t[5226]

We're only active when one or more of our keys is active (having been activated through an <.convnode> tag).

convKeysOVERRIDDENactor.t[5237]
Particular instances must override this property to stipulate which keys we're active for, unless this NodeEndCheck is located within a ConvNode object which will take care of this for us. Note that instead of locating a NodeEndCheck in a particular ConvNode, you can specify the convKeys for a number of ConvNodes here, and this NodeEndCheck will then apply to them all.

matchObjOVERRIDDENactor.t[5220]
no description available

Methods  

canEndConversation (reason)actor.t[5246]

Decide whether the conversation can be ended for reason while the conversation is at this node. By default we simply return true but instances should override to return nil when the conversation should not be permitted to end. When the method returns nil it should also display a message saying why the conversation may not be ended.

handleTopic ( )OVERRIDDENactor.t[5255]
Do nothing here; this class only exists for the sake of its canEndConversation() method.

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