TopicGroupclass | actor.t[2846]

A TopicGroup is an object that can be used to group ActorTopicEntries that share common features such as convKeys or isActive conditions. A TopicGroup can be used anywhere an ActorTopicEntry can be used, and any ActorTopicEntries should behave just as they would if they were in the TopicGroup's container, apart from the modifications imposed by the TopicGroup.

`class TopicGroup : object`

Superclass Tree (in declaration order)

`TopicGroup`
`object`

Subclass Tree

`TopicGroup`
`ConvNode`

Global Objects

(none)

Summary of Properties

`active convKeys getActor isActive scoreBoost`

Summary of Methods

`addTopic nodeActive scoreBooster`

Properties

`active` | `actor.t[2884]`

This TopicGroup is active if both its own isActive property is true and its location is active (this allows us to locate TopicGroups within other TopicGroups, for instance)

`convKeys` | `actor.t[2890]`

A list of convKeys that should be added to the convKeys of each of our TopicEntries.

`getActor` | `actor.t[2924]`

Our associated actor is our location's associated actor.

`isActive` | `actor.t[2877]`

A TopicGroup's isActive property can be used to make all the TopicEntries enclosed within in inactive by being set to nil; if it is true then the enclosed TopicEntries are active if their own isActive property is true.

`scoreBoost` | `actor.t[2896]`

A scoreBoost that should be added to the scoreBoost of each of our TopicEntries.

Methods

`addTopic (obj)` | `actor.t[2855]`

Add a topic entry to our database; since a TopicGroup isn't a TopicDatabase we simply ask our location to add it to its database. We also modify the convKeys and scoreBoost properties of any items contained in us according to our own convKeys and scoreBoost properties.

`nodeActive ( )` | `actor.t[2918]`

If we're being used as a conversation node, our node is active when our own convKeys matches (i.e. overlaps with) that of our actor's activeKeys.

`scoreBooster ( )` | `actor.t[2902]`

By how much do we boost the score of any TopicEntries we contain? We need to add our own score boost to that our own location.

Adv3Lite Library Reference Manual
Generated on 28/03/2016 from adv3Lite version 1.5