NodeEndCheckclass
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](../object/InitiateTopic.html)
[
ActorTopicEntry](../object/ActorTopicEntry.html)
[
ReplaceRedirector](../object/ReplaceRedirector.html)
[
Redirector](../object/Redirector.html)
object
[
TopicEntry](../object/TopicEntry.html)
object`
Subclass Tree
(none)
Global Objects
(none)
Summary of Properties
Inherited from InitiateTopic
:
includeInList
Inherited from ActorTopicEntry
:
activated
autoName
curiosityAroused
getActor
impliesGreeting
isConversational
keyTopics
listOrder
name
suggestAs
timesInvoked
Inherited from TopicEntry
:
isActive
matchExactCase
matchPattern
matchScore
scoreBoost
topicMatched
Summary of Methods
canEndConversation
handleTopic
Inherited from EndConvBlocker
:
blockEndConv
Inherited from ActorTopicEntry
:
activate
addToConvKeyTable
buildName
curiositySatisfied
deactivate
getKeyTopics
initializeTopicEntry
isReachable
nodeActive
showKeyTopics
timesToSuggest
Inherited from ReplaceRedirector
:
redirect
Inherited from Redirector
:
doInstead
doNested
doOtherAction
Inherited from TopicEntry
:
addTopic
matchTopic
scoreBooster
topicResponse
Properties
active
OVERRIDDEN
We’re only active when one or more of our keys is active (having been activated through an <.convnode> tag).
convKeys
OVERRIDDEN
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.
matchObj
OVERRIDDEN
no description available
Methods
canEndConversation (reason)
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 ( )
OVERRIDDEN
Do nothing here; this class only exists for the sake of its canEndConversation() method.
Adv3Lite Library Reference Manual
Generated on 15/03/2023 from adv3Lite version 1.6.1