Actorclassactor.t[26]

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

An Actor is an object representing a living being (or something that behaves like a living being, such as an intelligent robot), with which the player character can potentially converse, and which can move around and pursue his/her/its own agenda. This class is intended for the implementation of NPCs (non-player characters).

class Actor :   EndConvBlocker   AgendaManager   ActorTopicDatabase   Thing

Superclass Tree   (in declaration order)

Actor
        EndConvBlocker
                object
        AgendaManager
                object
        ActorTopicDatabase
                TopicDatabase
                        object
        Thing
                ReplaceRedirector
                        Redirector
                                object
                Mentionable
                        LMentionable
                                object

Subclass Tree  

(none)

Global Objects  

(none)

Summary of Properties  

active  activeKeys  actorInformOverheard  actorStaysPutMsg  allNodes  allStates  alreadyTalkingMsg  attackResponseMsg  attentionSpan  boredomAgendaItem  boredomCount  cannotAttackMsg  cannotKissMsg  cannotTakeMsg  canTalkToMe  cantFollowFromHereMsg  canThrowToMe  cantStartFromHereMsg  contentsListed  contType  conversedLastTurn  conversedThisTurn  convKeyTab  curState  dontKnowWhereGoneMsg  fDaemon  followActorMsg  followAgendaItem  followFuseID  informedNameTab  informOverheard  isAttackable  isFixed  keepPendingKeys  keysManaged  kissRank  kissResponseMsg  lastConvTime  lastTravelInfo  noGoodbyeResponseMsg  noHelloResponseMsg  noResponseMsg  notificationOrder  ownsContents  pcArrivalTurn  pcConnector  pcJustArrived  pendingAgendaList  pendingKeys  refuseCommandMsg  specialDescBeforeContents  stateDesc  suggestionKey  touchResponseMsg  waitToSeeMsg 

Inherited from AgendaManager :
agendaList 

Inherited from ActorTopicDatabase :
askForTopics  askTopics  commandTopics  defaultAgendaTopic  giveTopics  initiateTopics  miscTopics  queryTopics  sayTopics  showTopics  talkTopics  tellTopics 

Inherited from Thing :
actorAlreadyInMsg  actorAlreadyOnMsg  actorNotInMsg  actorNotOnMsg  allowPourIntoMe  allowPourOntoMe  alreadyCleanMsg  alreadyClosedMsg  alreadyFastenedMsg  alreadyHasMsg  alreadyHeldMsg  alreadyInMsg  alreadyLitMsg  alreadyLockedMsg  alreadyMovedToMsg  alreadyOnMsg  alreadyOpenMsg  alreadyPresentMsg  alreadyThereMsg  alreadyWornMsg  autoGetOutToReach  autoTakeOnFindHidden  autoUnlock  bulk  bulkCapacity  canAttachToMe  canAttackWithMe  canBurnWithMe  canCleanWithMe  canClimbDownMe  canClimbUpMe  canCutWithMe  canDetachFromMe  canDigWithMe  canEnterOnMe  canFastenToMe  canGoThrougMe  canHearIn  canHearOut  canJumpOffMe  canJumpOverMe  canLieOnMe  canLockWithMe  canLookBehindMe  canLookThroughMe  canLookUnderMe  canMoveToMe  canMoveWithMe  cannotAttachMsg  cannotAttachToMsg  cannotAttachToSelfMsg  cannotAttackWithMsg  cannotAttackWithSelfMsg  cannotBoardMsg  cannotBreakMsg  cannotBurnMsg  cannotBurnWithMsg  cannotCleanMsg  cannotCleanWithMsg  cannotClimbDownMsg  cannotClimbMsg  cannotCloseMsg  cannotConsultMsg  cannotCutMsg  cannotCutWithMsg  cannotCutWithSelfMsg  cannotDetachFromMsg  cannotDetachFromSelfMsg  cannotDetachMsg  cannotDigMsg  cannotDigWithMsg  cannotDigWithSelfMsg  cannotDoffMsg  cannotDrinkMsg  cannotDropMsg  cannotEatMsg  cannotEnterMsg  cannotEnterOnMsg  cannotExtinguishMsg  cannotFastenMsg  cannotFastenToMsg  cannotFastenToSelfMsg  cannotFeelMsg  cannotFlipMsg  cannotFollowMsg  cannotFollowSelfMsg  cannotGetInCarriedMsg  cannotGetOnCarriedMsg  cannotGiveToMsg  cannotGiveToSelfMsg  cannotGoNearThereMsg  cannotGoThroughMsg  cannotJumpOffMsg  cannotJumpOverMsg  cannotLieOnMsg  cannotLightMsg  cannotLockWithMsg  cannotLockWithSelfMsg  cannotLookBehindMsg  cannotLookThroughMsg  cannotLookUnderMsg  cannotMoveMsg  cannotMoveToMsg  cannotMoveToSelfMsg  cannotMoveWithMsg  cannotMoveWithSelfMsg  cannotOpenMsg  cannotPlugIntoMsg  cannotPlugIntoSelfMsg  cannotPlugMsg  cannotPourIntoMsg  cannotPourIntoSelfMsg  cannotPourMsg  cannotPourOntoMsg  cannotPourOntoSelfMsg  cannotPullMsg  cannotPurloinContainerMsg  cannotPurloinRoomMsg  cannotPurloinSelfMsg  cannotPushDownMsg  cannotPushIntoMsg  cannotPushMsg  cannotPushOwnContainerMsg  cannotPushThroughMsg  cannotPushUpMsg  cannotPushViaSelfMsg  cannotPutBehindMsg  cannotPutInMsg  cannotPutInSelfMsg  cannotPutMsg  cannotPutOnMsg  cannotPutUnderMsg  cannotReadMsg  cannotRemoveMsg  cannotScrewMsg  cannotScrewWithMsg  cannotScrewWithSelfMsg  cannotSetMsg  cannotSetToMsg  cannotShowToMsg  cannotShowToSelfMsg  cannotSitOnMsg  cannotSmellMsg  cannotStandOnMsg  cannotTakeFromSelfMsg  cannotTakeMyContainerMsg  cannotTakeSelfMsg  cannotTalkToMsg  cannotTalkToSelfMsg  cannotTasteMsg  cannotThrowAtMsg  cannotThrowAtSelfMsg  cannotThrowMsg  cannotThrowToMsg  cannotThrowToSelfMsg  cannotTurnMsg  cannotTurnToMsg  cannotTurnWithMsg  cannotTurnWithSelfMsg  cannotTypeOnMsg  cannotUnfastenFromMsg  cannotUnfastenFromSelfMsg  cannotUnfastenMsg  cannotUnlockWithMsg  cannotUnlockWithSelfMsg  cannotUnplugFromMsg  cannotUnplugFromSelfMsg  cannotUnplugMsg  cannotUnscrewMsg  cannotUnscrewWithMsg  cannotUnscrewWithSelfMsg  cannotWearMsg  cannotWriteOnMsg  canPlugIntoMe  canPourIntoMe  canPourOntoMe  canPullTravel  canPushTravel  canPutBehindMe  canPutInMe  canPutUnderMe  canReachIn  canReachOut  canScrewWithMe  canSeeIn  canSeeOut  canSetMeTo  canSitOnMe  canSmellIn  canSmellOut  canStandOnMe  canSupply  canThrowAtMe  canTurnMeTo  canTurnWithMe  canTypeOnMe  canUnfastenFromMe  canUnlockWithMe  canUnplugFromMe  canUnscrewWithMe  canWriteOnMe  checkAttackMsg  checkFeelMsg  checkKissMsg  circularlyInMsg  collectiveGroups  contents  contentsListedInExamine  contentsListedInLook  contentsListedInSearch  currentInterlocutor  curSetting  darkName  decorationActions  decorationActions  desc  directlyHeld  directlyIn  directlyWorn  distinguishByContents  dontNeedCleaningObjMsg  dropItemsBehind  dropItemsUnder  dropLocation  enclosing  examined  examineListed  examineLister  exitLocation  extContents  familiar  feelDesc  findHiddenDest  fluidName  futileToAttackMsg  futileToKissMsg  getBulkHiddenBehind  getBulkHiddenIn  getBulkHiddenUnder  getFacets  getOutermostRoom  getOutToJump  globalParamName  groupOrder  hearNothingMsg  hiddenBehind  hiddenIn  hiddenUnder  inDarkDesc  indirectLockableMsg  initSpecialDesc  intContents  interiorDesc  inventoryListed  isAttachable  isBoardable  isBreakable  isBurnable  isClean  isCleanable  isClimbable  isCloseable  isConsultable  isCuttable  isDecoration  isDetachable  isDiggable  isDoffable  isDrinkable  isDroppable  isEdible  isEnterable  isExtinguishable  isFastenable  isFastened  isFeelable  isFlippable  isFollowable  isHidden  isKissable  isLightable  isListed  isLit  isLocked  isMoveable  isOn  isOpen  isOpenable  isPlayerChar  isPlugable  isPourable  isProminentNoise  isProminentSmell  isPullable  isPushable  isReadable  isRemoveable  isScrewable  isSettable  isSmellable  isSwitchable  isTakeable  isTasteable  isThrowable  isTransparent  isTurnable  isUnfastenable  isUnplugable  isUnscrewable  isVehicle  isWearable  keyDoesntWorkMsg  keyList  keyNotNeededMsg  known  knownKeyList  knownProp  lastSeenAt  lieOnScore  listableContents  listenDesc  listOrder  listWith  location  lockability  lockedMsg  lookBehindMsg  lookInMsg  lookListed  lookThroughMsg  lookUnderMsg  markInventoryAsSeen  matchPullOnly  matchPushOnly  maxBulkHiddenBehind  maxBulkHiddenIn  maxBulkHiddenUnder  maxSingleBulk  mentioned  moved  movedTo  moveNoEffectMsg  mustBeCleanedWith  myInventoryLister  myLookBehindLister  myLookInLister  myLookUnderLister  myOpeningContentsLister  myWornLister  needsCleaning  noLongerTalkingToAnyoneMsg  nominalContents  noNeedToCleanMsg  notFastenedMsg  notHoldingMsg  notImportantMsg  notInMsg  notLitMsg  notLockableMsg  notLockedMsg  notSwitchableMsg  notTalkingToAnyoneMsg  notWornMsg  objInPrep  objIntoPrep  okayCleanMsg  okayGetOutOfMsg  okayLockMsg  okayOpenMsg  okayPushIntoMsg  okayPushOutOfMsg  okayUnlockMsg  opened  openStatusReportable  owner  paraBrksBtwnSubcontents  partOfYouMsg  preCondActor  pullNoEffectMsg  pushNoEffectMsg  readDesc  recognizableInDark  remapActor  remapBehind  remapIn  remapOn  remapProps  remapUnder  roomContentsLister  roomSubContentsLister  roomTitle  searchListed  seen  seenProp  shouldBeBroken  shouldNotBreakMsg  shouldNotPourIntoMsg  shouldNotPourOntoMsg  sightSize  sitOnScore  smellDesc  smellNothingMsg  smellSize  soundSize  specialDesc  specialDescListWith  specialDescOrder  stagingLocation  standOnScore  tasteDesc  throwFallsShortMsg  tooDarkToSeeMsg  tooFarAwayToHearMsg  tooFarAwayToReadMsg  tooFarAwayToSeeDetailMsg  tooFarAwayToSmellMsg  turnNoEffectMsg  useInitSpecialDesc  useKey_  useSpecialDesc  viaMode  visibleInDark  vocabLikelihood  withKeyMsg  wornBy 

Inherited from Mentionable :
ambiguouslyPlural  disambigGroup  disambigMatchPhrases  disambigName  disambigOrder  isHer  isHim  isIt  massNoun  matchPhrases  matchPhrasesExclude  name  person  plural  proper  qualified  states  vocab  vocabWords 

Inherited from LMentionable :
acronymPluralPat  alphaCharPat  aName  apostPluralPat  apostSPat  deannotatePat  dictComp  dummyName  elevenEighteenPat  emptyVocabWords  esPluralPat  firstWordPat  heName  herName  hersName  himName  iesPluralPat  irregularPlurals  lastWordPat  leadingTagOrQuotePat  menPluralPat  objInName  objIntoName  objName  objOutOfName  oneLetterAnWordPat  oneLetterWordPat  ownerNamed  pluralPat  posPat  possAdj  possNoun  prepList  prepPhrasePat  prepWordPat  pronounMap  properNamePat  properPat  reflexiveName  specialAOrAn  tagOrQuotePat  thatName  thatObjName  theName  theObjName  trimPat  truncationLength  weakWordPat 

Summary of Methods  

activatePendingAgenda  actorAfterAction  actorAfterTravel  actorArrivingTurn  actorBeforeAction  actorBeforeTravel  actorCanEndConversation  actorRemoteSpecialDesc  actorSay  actorSayHello  actorSpecialDesc  addPendingKey  addToAllAgendas  addToBothAgendas  addToCurAgendas  addToPendingAgenda  afterAction  afterTravel  allowOtherActorToTake  arouse  arrivingTurn  beforeAction  beforeTravel  canCatchThrown  canEndConversation  cannotTakeFromActorMsg  condSay  convAgendaReady  curNodeIdx  curNodeKey  curNodeObj  dobjFor(AskAbout)  dobjFor(AskFor)  dobjFor(Attack)  dobjFor(AttackWith)  dobjFor(Feel)  dobjFor(Follow)  dobjFor(Kiss)  dobjFor(QueryAbout)  dobjFor(SayTo)  dobjFor(TalkAbout)  dobjFor(TalkTo)  dobjFor(TellAbout)  endConversation  findBestResponse  followDaemon  followFuse  getActor  getBestMatch  handleCommand  handleTopic  informedAbout  initiateTopic  iobjFor(GiveTo)  iobjFor(ShowTo)  iobjFor(ThrowTo)  makeActivated  makeDeactivated  manageKeys  nilResponse  noteConversed  notifyRemove  remoteSpecialDesc  removeFromAllAgendas  removeFromBothAgendas  removeFromCurAgendas  removeFromPendingAgenda  sayActorArriving  sayActorCatches  sayActorDeparting  sayActorDropsCatch  sayActorFollowing  sayActorFollowingMe  sayArriving  sayDeparting  sayFollowing  sayGoodbye  sayHeadAfterActor  sayHello  setFollowMeFuse  setInformed  setState  showSuggestions  specialDesc  startFollowing  stopFollowing  takeTurn  travelVia 

Inherited from EndConvBlocker :
blockEndConv 

Inherited from AgendaManager :
addToAgenda  executeAgenda  removeFromAgenda 

Inherited from ActorTopicDatabase :
listableTopics 

Inherited from TopicDatabase :
addTopic 

Inherited from Thing :
abcName  actionMoveInto  actorAction  addToAllContents  addToContents  allContents  allowReachOut  beforeMovePushable  canHear  cannotPushTravelMsg  cannotReachOutMsg  canReach  canSee  canSmell  canTalkTo  checkDisplay  checkInsert  checkPushTravel  checkReach  checkReachIn  checkRoomToHold  checkSetting  childLocType  commonContainingParent  commonInteriorParent  containerPath  containerPathBlock  darkDesc  describeMovePushable  describePushTravel  directChildParent  discover  display  displayAlt  dobjFor(Attach)  dobjFor(AttachTo)  dobjFor(Board)  dobjFor(Break)  dobjFor(Burn)  dobjFor(BurnWith)  dobjFor(Clean)  dobjFor(CleanWith)  dobjFor(Climb)  dobjFor(ClimbDown)  dobjFor(ClimbUp)  dobjFor(Close)  dobjFor(ConsultAbout)  dobjFor(Cut)  dobjFor(CutWith)  dobjFor(Default)  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(Flip)  dobjFor(GetOff)  dobjFor(GetOutOf)  dobjFor(GiveTo)  dobjFor(GiveToImplicit)  dobjFor(GoNear)  dobjFor(GoThrough)  dobjFor(GoTo)  dobjFor(JumpOff)  dobjFor(JumpOver)  dobjFor(LieIn)  dobjFor(LieOn)  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(Purloin)  dobjFor(Push)  dobjFor(PushTravelClimbDown)  dobjFor(PushTravelClimbUp)  dobjFor(PushTravelDir)  dobjFor(PushTravelEnter)  dobjFor(PushTravelGetOutOf)  dobjFor(PushTravelThrough)  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(ShowToImplicit)  dobjFor(SitIn)  dobjFor(SitOn)  dobjFor(SitOn)  dobjFor(SmellSomething)  dobjFor(StandIn)  dobjFor(StandOn)  dobjFor(StandOn)  dobjFor(Strike)  dobjFor(SwitchOff)  dobjFor(SwitchOn)  dobjFor(SwitchVague)  dobjFor(Take)  dobjFor(TakeFrom)  dobjFor(TakeFrom)  dobjFor(Taste)  dobjFor(Throw)  dobjFor(ThrowAt)  dobjFor(ThrowDir)  dobjFor(ThrowTo)  dobjFor(Turn)  dobjFor(TurnTo)  dobjFor(TurnWith)  dobjFor(TypeOn)  dobjFor(TypeOnVague)  dobjFor(Unfasten)  dobjFor(UnfastenFrom)  dobjFor(Unlock)  dobjFor(UnlockWith)  dobjFor(Unplug)  dobjFor(UnplugFrom)  dobjFor(Unscrew)  dobjFor(UnscrewWith)  dobjFor(Wear)  dobjFor(WriteOn)  doPushTravel  examineStatus  filterResolveList  findHidden  findPlausibleKey  firstContainerPathBlock  getBulkWithin  getCarriedBulk  getStatuslineExitsHeight  hasSeen  hideFromAll  interiorParent  iobjFor(AttachTo)  iobjFor(AttackWith)  iobjFor(BurnWith)  iobjFor(CleanWith)  iobjFor(CutWith)  iobjFor(Default)  iobjFor(DetachFrom)  iobjFor(DigWith)  iobjFor(FastenTo)  iobjFor(LockWith)  iobjFor(MoveTo)  iobjFor(MoveWith)  iobjFor(PlugInto)  iobjFor(PourInto)  iobjFor(PourOnto)  iobjFor(PushTravelClimbDown)  iobjFor(PushTravelClimbUp)  iobjFor(PushTravelEnter)  iobjFor(PushTravelGetOutOf)  iobjFor(PushTravelThrough)  iobjFor(PutBehind)  iobjFor(PutIn)  iobjFor(PutOn)  iobjFor(PutUnder)  iobjFor(ScrewWith)  iobjFor(TakeFrom)  iobjFor(ThrowAt)  iobjFor(TurnWith)  iobjFor(UnfastenFrom)  iobjFor(UnlockWith)  iobjFor(UnplugFrom)  iobjFor(UnscrewWith)  isAudibleFrom  isChild  isDirectChild  isDirectlyHeldBy  isDirectlyIn  isDirectlyWornBy  isHeldBy  isIlluminated  isIn  isInterior  isOrIsIn  isOutside  isReadableFrom  isSmellableFrom  isThereALightSourceIn  isVisibleFrom  isWornBy  knowsAbout  listableContentsOf  listContents  listRemoteContents  listSubcontentsOf  litWithin  locationWhich  locType  lookAroundWithin  makeCleaned  makeFastened  makeLit  makeLocked  makeMovedTo  makeOn  makeOpen  makeSetting  makeWorn  moveHidden  moveInto  moveMLIntoAdd  moveMLOutOf  nominalOwner  noteSeen  notifyInsert  notionalContents  outermostParent  outermostVisibleParent  ownedBy  preinitThing  pushTravelRevealItems  reachBlockedMsg  remoteInitSpecialDesc  remoteObjInName  removeFromContents  revealOnMove  roomHeadline  roomSubhead  sayDontKnowHowToGetThere  sayDontKnowHowToReach  sayFindHidden  scoreObject  setHasSeen  setKnown  setKnowsAbout  setSeen  shinesOut  showConnectedMiscContents  showFirstConnectedSpecials  showRemoteSpecialDesc  showSecondConnectedSpecials  showSpecialDesc  showStatuslineExits  statusName  totalBulkIn  traceContainerPath  tryCheck  unmention  unmentionRemoteContents  verifyActor  verifyPushTravel  wouldBeLitFor 

Inherited from ReplaceRedirector :
redirect 

Inherited from Redirector :
doInstead  doNested  doOtherAction 

Inherited from Mentionable :
construct  matchName  matchNameCommon  matchNameDisambig  phraseMatchName  simpleMatchName 

Inherited from LMentionable :
addDictWord  addVocab  addVocabWord  aNameFrom  aNameFromPoss  classInit  contify  distinguishedName  ifPronoun  inheritVocab  initVocab  initVocabWord  locify  matchPronoun  pluralNameFrom  pluralWordFrom  possessify  pronoun  removeVocabWord  replaceVocab  theNameFrom  theNameIs 

Properties  

activeactor.t[2079]

This definition is needed for the TopicGroup implementation, and should not normally be overridden in user game code. It allows TopicEntries and TopicGroups to determine their own active status by reference to that of their immediate location.

activeKeysactor.t[723]
If this list is not empty then the choice of topic entries to match will be restricted to those whose convKeys property includes at least one of the key values in this list.

actorInformOverheardactor.t[1759]
Should other actors who can notionally hear the PC talking to us overhear when information is imparted to us when our current ActorState is nil? By default they should.

actorStaysPutMsgactor.t[1245]
The message to display when this actor doesn't go anywhere when the player character tries to follow this actor.

allNodesactor.t[1632]
A list of all ConvNodes associated with this actor. This is a list of two element lists of the form [node-name, node-obj] where node-name is the convKeys property of the node and node is the associated object.

allStatesactor.t[1880]
A list of all the ActorStates associated with this Actor; this is populated by the preinitialization of the individual ActorStates.

alreadyTalkingMsgactor.t[1867]
no description available

attackResponseMsgactor.t[2209]
The message to display if attacking goes ahead but no HitTopics have been defined.

attentionSpanactor.t[1717]
The maximum value that our boredomCount can reach before we terminate a conversation through 'boredom', because we've given up waiting for the player character to say anything. A value of nil (the default) meanns that we never terminate a conversation for this reason.

boredomAgendaItemactor.t[1463]
our special "boredom" agenda item - this makes us initiate an end to an active conversation when the PC has ignored us for a given number of consecutive turns

boredomCountactor.t[1708]
The count of how many turns have passed during which no conversation has actually taken place when we're the player charater's current interlocutor. This can be used to terminate the conversation through 'boredom' if the boredomCount exceeds our attention span.

cannotAttackMsgOVERRIDDENactor.t[2203]
The message to display if isAttackable is nil

cannotKissMsgOVERRIDDENactor.t[2156]
The message to display if isKissable is nil

cannotTakeMsgOVERRIDDENactor.t[171]
The message to display when someone tries to take this actor.

canTalkToMeOVERRIDDENactor.t[2093]
In general we can talk to actors

cantFollowFromHereMsgactor.t[2406]
no description available

canThrowToMeOVERRIDDENactor.t[2257]
Unlike inaminate objects, actors can be the logical target of a ThrowTo action

cantStartFromHereMsgactor.t[2404]
no description available

contentsListedOVERRIDDENactor.t[180]
We don't normally list the contents of an Actor when Looking or Examining.

contTypeOVERRIDDENactor.t[174]
The (portable) contents of an actor are regarded as being carried.

conversedLastTurnactor.t[715]
Did this actor converse with the player character on the previous turn? He/she/it did so if our last conversation time is one less than the game's current turn count.

conversedThisTurnactor.t[708]
Has this actor conversed with the player character on the current turn? He/she/it has done so if our last conversation time is the same as the game's turn count.

convKeyTabactor.t[1553]
A Lookup Table holding conversation keys. Entries in this list take the form tag -> list of TopicEntries that match this tag (e.g. the key is a convKey tag, expressed as a single-quoted string, and the value is a list containing TopicEntries whose convKeys property contains that tag).

curStateactor.t[33]
Our current ActorState. This should normally be treated as a read-only property; to change the current ActorState of an actor call the setState() method.

dontKnowWhereGoneMsgactor.t[2402]
no description available

fDaemonactor.t[1087]
Store the id of the daemon being used to make us follow the player char. We can check whether this actor is currently following or not by testing whether or not this is nil.

followActorMsgactor.t[1238]
Otherwise, let the connector handle it.

followAgendaItemactor.t[1249]
Our currently executing FollowAgendaItem, if we have one.

followFuseIDactor.t[1169]
A note of our current following fuse, if we have one; this is used by FollowAgendaItem to check whether the player character is ready to follow us.

informedNameTabactor.t[1720]
Our look up table for things we've been informed about

informOverheardactor.t[1751]
Should other actors who can notionally hear the PC talking to us overhear when information is imparted to us? I.e. should their setInform() methods be called too? If we have a curState we use its setting, otherwise we use the value of actorInformOverheard.

isAttackableOVERRIDDENactor.t[2186]
By default it's normally possible to attack an actor, even if we don't want to allow it. Game code might want to override this to nil for actors it's obviously futile to try attacking, such as ghosts, gods and giants.

isFixedOVERRIDDENactor.t[167]
By default actors can't be picked up and carried around by other actors (though game authors can override this if they need to create a portable actor).

keepPendingKeysactor.t[737]
If keepPendingKeys is set to true (normally by a <.convstay> tag) then retain the pending conversation keys (and hence the active ones) for the next conversational turn.

keysManagedactor.t[616]
Flag; has the active/pending key management already been carried out on this turn?

kissRankOVERRIDDENactor.t[2169]
An Actor is a more likely target of a KISS action than is an animate object.

kissResponseMsgactor.t[2163]
The default response of the actor to an attempt to kiss him/her/it where this is not handled anywhere else, but allowKiss is true.

lastConvTimeactor.t[701]
The last turn on which this actor conversed with the player character. We start out with a value of -1 to mean that we haven't conversed at all.

lastTravelInfoactor.t[879]
If the player character has seen this actor travel then lastTravelInfo contains a two-element list comprising the room the actor was seen travelling from and the connector by which the actor was seen travelling.

Note that if you move an actor by authorial fiat using moveInto() (say) when the player character can see the actor, you might want to update lastTravelInfo manually to ensure that any subsequent FOLLOW command still works properly, e.g.: *.
"Bob storms out through the front door, slamming it behind him. ";
bob.moveInto(nil);
bob.lastTravelInfo = [hall, frontDoor]; *. (If instead of or before bob.moveInto(nil) you had written frontDoor.travelVia(bob), this wouldn't be necessary, since it would be handled for you by frontDoor.travelVia()).

noGoodbyeResponseMsgactor.t[1870]
no description available

noHelloResponseMsgactor.t[1864]
The message to display when someone says hello to this actor but there's no accessible HelloTopic defined.

noResponseMsgactor.t[186]
The default response of the actor to a conversational command that is not handled anywhere else.

notificationOrderactor.t[2085]
This property can be used by extensions or game code that wants to notify actors in some order of priority.

ownsContentsOVERRIDDENactor.t[2071]
An actor generally owns its contents

pcArrivalTurnactor.t[905]
The turn on which the player character last arrived in our location

pcConnectoractor.t[858]
The Travel Connector just traversed by the player character

pcJustArrivedactor.t[908]
Flag -- has the player character just arrived?

pendingAgendaListactor.t[1977]
A list of agenda items to be added to our agenda at some later point. The main purpose is to allow game code to set up a list of AgendaItems (typically ConvAgendaItems) that become part of the actor's current agenda when conversation is initiated via a HelloTopic.

pendingKeysactor.t[730]
a list of the keys to be copied into the activeKeys property for use in the next conversational turn. These are normally added by game code via <.convnode> tags and the like in conversational output.

refuseCommandMsgactor.t[313]
The default message to use in response to a command directed to this actor that is not handled in any other way.

specialDescBeforeContentsOVERRIDDENactor.t[131]
We normally list any actors after the miscellaneous contents of a room

stateDescOVERRIDDENactor.t[72]
Our state-specific description, which is appended to our desc to give our full description. By default we simply take this from our current ActorState.

suggestionKeyactor.t[1472]
If this is non-nil then a TOPICS command will use it to restrict the topics suggested to those with this key in their convKeys property. This could be used, for example, to provide a top-level 'menu' of topics when the full list would otherwise be overwhelming.

touchResponseMsgactor.t[2224]
no description available

waitToSeeMsgactor.t[2398]
no description available

Methods  

activatePendingAgenda ( )actor.t[1991]

Make our pending agenda items acting by moving them all from our pendingAgendaList to all our actual agenda lists (on the actor and on all our DefaultAgendaItems).

actorAfterAction ( )actor.t[792]
Give this actor a chance to respond just after an action prior to any response from its current actor state. By default we do nothing, but game code can easily override this without any risk of breaking the state-dependent afterAction mechanism.

actorAfterTravel (traveler, connector)actor.t[916]
Give this actor a chance to react just after another actor travels in addition to any reaction from its current actor state. By default we do nothing, but game code can easily override this without any risk of breaking the state-dependent afterTravel mechanism.

actorArrivingTurn ( )actor.t[1312]
This method is executed when this actor has just followed the player character to a new location and there is no current ActorState. By default we do nothing.

actorBeforeAction ( )actor.t[769]
Give this actor a chance to respond just before an action prior to any response from its current actor state. By default we do nothing, but game code can easily override this without any risk of breaking the state-dependent beforeAction mechanism.

actorBeforeTravel (traveler, connector)actor.t[887]
Give this actor a chance to react just before another actor travels in addition to any reaction from its current actor state. By default we do nothing, but game code can easily override this without any risk of breaking the state-dependent beforeTravel mechanism.

actorCanEndConversation (reason)actor.t[990]
A state-independent check on whether this actor will allow the current conversation to end on account of reason. By default we simply return true to allow the conversation to end, but game code can override this to return nil to disallow the ending of the conversation (presumably under specific conditions).

actorRemoteSpecialDesc (pov)actor.t[155]
The remoteSpecialDesc to use if we don't have a current ActorState (i.e. if curState is nil). By default we say the actor is in the remote location.

actorSay (str)actor.t[640]
This method can be called on the actor when we want to display the text of one or both sides of a conversational exchange with the actor without going through the TopicEntry mechanism to do so.

actorSayHello ( )actor.t[1798]
Have the actor greet the player character on the actor's initiative

actorSpecialDesc ( )actor.t[113]
The specialDesc to use if we don't have a current ActorState By default we just display a message saying the actor is here or that the actor is in a nested room.

addPendingKey (val)actor.t[743]
Add a convkey value to our pending keys list (for use as an active key

addToAllAgendas ([lst])actor.t[1913]
Add an agenda item both to myself and to any DefaultAgendaTopics either directly in me or in any of my Actor States

addToBothAgendas ([lst])actor.t[1902]
Add an agenda item to both myself and any DefaultAgendaTopic directly within me.

addToCurAgendas ([lst])actor.t[1927]
Add an agenda item to myself and to any DefaultAgendaTopios directly in me or in my current ActorState.

addToPendingAgenda ([lst])actor.t[1980]
Add an item to our pending agenda list

afterAction ( )OVERRIDDENactor.t[772]
Notification that an action has just been carried out in our presence

afterTravel (traveler, connector)OVERRIDDENactor.t[893]
Notification that travel has just taken place in our presence (usually because an actor has just arrived in our location)

allowOtherActorToTake (obj)actor.t[2068]
Is another actor allowed to take obj from our inventory? By default we return nil to disallow it for all objects.

arouse (key)actor.t[1561]
Set the curiosityAroused flag to true for all topic entries with this convKey. This allows topics to be suggested when and only when the player character has some reason to be curious about them, even though they were actually available before.

arrivingTurn ( )actor.t[1296]
This method is executed when this actor has just followed the player character to a new location.

beforeAction ( )OVERRIDDENactor.t[750]
Notification that an action is about to be carried out in our presence

beforeTravel (traveler, connector)OVERRIDDENactor.t[800]
Notification that something else is about to travel. By default we defer to out actor state, if we have one, but we also give the actor object a chance to respond.

canCatchThrown (obj)actor.t[2263]
We'll assume that actors can catch anything thrown at them by default, but game code may wish to override this assumption.

canEndConversation (reason)actor.t[951]
Is the actor willing for this conversation to be ended? We first check the current actor state (if any) and then the actor object. If either raises an object it should display a message saying what the objection is (and then return nil). By default we simply return true, allowing the conversation to end.

cannotTakeFromActorMsg (obj)actor.t[2050]
Return a message saying that the actor cannot take obj from our inventory.

condSay (str)actor.t[670]
Conditionally use actorSay() or say() to output str depending on whether str appears to be something the actor says or simply a non-verbal response (or lack of response). If str contains quote marks or the sequence @@ we'll assume it's something the actor says (and strip out the @@ that would simply be there to mark str as something the actor says, perhaps reported in indirect speech.

convAgendaReady (other)actor.t[1890]
Is this actor ready to invoke a ConvAgendaItem? We're ready if we haven't conversed this term and we can speak to the other actor and we're not at a conversation node. This method is used by the isReady property of ConvAgendaItem (to save it having to make three separate calls to getActor).

curNodeIdx ( )actor.t[1639]
Service method used by curNodeKey() and curNodeObj() to identify the current ConvNode object, if there is one.

curNodeKey ( )actor.t[1660]
The string name of our current convNode, if we have one.

curNodeObj ( )actor.t[1676]
The object representing our current convNode, if we have one.

dobjFor(AskAbout)OVERRIDDENactor.t[2103]
no description available

dobjFor(AskFor)OVERRIDDENactor.t[2111]
no description available

dobjFor(Attack)OVERRIDDENactor.t[2211]
no description available

dobjFor(AttackWith)OVERRIDDENactor.t[2220]
no description available

dobjFor(Feel)OVERRIDDENactor.t[2226]
no description available

dobjFor(Follow)OVERRIDDENactor.t[2324]
no description available

dobjFor(Kiss)OVERRIDDENactor.t[2171]
no description available

dobjFor(QueryAbout)OVERRIDDENactor.t[2145]
no description available

dobjFor(SayTo)OVERRIDDENactor.t[2137]
no description available

dobjFor(TalkAbout)OVERRIDDENactor.t[2127]
no description available

dobjFor(TalkTo)OVERRIDDENactor.t[2095]
no description available

dobjFor(TellAbout)OVERRIDDENactor.t[2119]
no description available

endConversation (reason)actor.t[927]
Terminate a conversation that's currently going on between this actor and the player character. The reason parameter is the reason for ending the conversation and can be one of endConvBye (the player character has just said goodbye), endConvTravel (the player character is leaving the location), endConvBoredom (this actor has become bored with waiting for the player character to say anything) or endConvActor (this actor wishes to terminate the conversation for some other reason of its own).

findBestResponse (prop, topic)actor.t[391]
Find the best response to use for a conversational command directed to this actor. prop would normally be a property pointer for the property containing the appropriate list or lists of Topic Entries to test, and topic is the Topic object we're trying to match.

followDaemon ( )actor.t[1002]
Mechanism to allow this actor to follow the player char. We do this rather simplistically by checking whether the player char is still in our location and moving us to the player char's location if s/he is not on the assumption that if the player char can get there in one turn, so can we. On arriving in the player char's new location we announce that we've just followed the player char and then run the arrivingTurn method on our current actor state (if we have one).

followFuse ( )actor.t[1176]
This method is executed right at the end of a turn on which the player has issued a command to follow this actor, and carries out the travel to follow this actor if the actor has traveled.

getActor ( )actor.t[1700]
We supply a getActor method that returns self so that objects such as TopicEntries that may be located either directly or indirectly in us can get at their associated actor by simply calling getActor on their immediate location; at some point such a chain of calls to location.getActor will end here.

getBestMatch (prop, requestedList)OVERRIDDENactor.t[325]
Find the best response to the topic produced by the player's command. prop is the xxxTopics list property we'll use to search for a matching TopicEntry. We first search the current ActorState for a match and then, only if we fail to find one, we search TopicEntries directly located in the actor. First priority, however, is given to TopicEntries whose convKeys match this actor's currentKeys (they match if the two lists have at least one element in common).

handleCommand (action)OVERRIDDENactor.t[190]
Handle a command (e.g. BOB, JUMP) directed at this actor.

handleTopic (prop, topic, defaultProp, =, &, noResponseMsg)actor.t[420]
Handle a conversational command where prop is a pointer to the property containing the appropriate list of TopicEntries to search (e.g. &askTopics), topic is the list of Topics to match, and defaultProp is pointer to the property to invoke if we can't find a match.

informedAbout (tag)actor.t[1740]
Determine whether this actor has been informed about tag. We return true if there is a corresponding non-nil entry in our informedNameTab

initiateTopic (top)OVERRIDDENactor.t[2011]
Respond to an InitiateTopic triggered on this actor with top as the matching object

iobjFor(GiveTo)OVERRIDDENactor.t[2236]
no description available

iobjFor(ShowTo)OVERRIDDENactor.t[2244]
no description available

iobjFor(ThrowTo)OVERRIDDENactor.t[2267]
no description available

makeActivated (key)actor.t[1584]
Set the activated flag to true for all topic entries with this convKey.

makeDeactivated (key)actor.t[1608]
Set the activated flag to nil for all topic entries with this convKey.

manageKeys ( )actor.t[592]
Move pending keys to active keys and clear pending keys if need be. We call this out as a separate method to allow it to be directly called from elsewhere.

nilResponse ( )actor.t[1874]
Do nothing if we can't fine a suitable Hello or Bye Topic/

noteConversed ( )actor.t[619]
Convenience method to note that conversation has occurred on this turn

notifyRemove (obj)OVERRIDDENactor.t[2030]
The notifyRemove() method is triggered when actionMoveInto() tries to move an object that's located within this actor. By default we don't allow it since it typically represents an attempt by the player character to take something from this actor's inventory.

remoteSpecialDesc (pov)OVERRIDDENactor.t[143]
The specialDesc of this actor when it is viewed from a remote location. If we have a current ActorState we use its remoteSpecialDesc, otherwise we use the actorRemoteSpecialDesc on the actor. Either way the pov parameter is the point of view object from which this actor is being viewed (normally the player char).

Note that this method is generally only relevant if the senseRegion module is used.

removeFromAllAgendas ([lst])actor.t[1950]
Remove an agenda Item both from this actor and from any associated DefaultAgendaTopics directly within this actor or in any of its ActorStates.

removeFromBothAgendas ([lst])actor.t[1938]
Remove an agenda Item both from this actor and from any associated DefaultAgendaTopics directly within this actor.

removeFromCurAgendas ([lst])actor.t[1964]
Remove an agenda item from myself and from any DefaultAgendaTopios directly in me or in my current ActorState.

removeFromPendingAgenda ([lst])actor.t[2000]
Remove one or more agenda items from our pending agenda

sayActorArriving (fromLoc)actor.t[1334]
Default message to display when the player character sees this actor arriving. We use a very plain-vanilla message here, since in practice game code will generally want to override this.

sayActorCatches (obj)actor.t[2310]
Display a message saying that this actor catches obj

sayActorDeparting (conn)actor.t[1283]
Method to display a message saying that this actor (normally an NPC visible to the player character) is departing via conn (a TravelConnector object, which may be a Room as well as a Door or other kind of connector). Note that the default behaviour of ActorState.sayDeparting is simply to call this method.

sayActorDropsCatch (obj)actor.t[2317]
Display a message saying that this actor failst to catch obj

sayActorFollowing (oldLoc, conn)actor.t[1113]
Display a message to say that we've just followed the player character to a new location from oldLoc. The library provides a default message but this can be overridded as desired.

sayActorFollowingMe (conn)actor.t[1224]
The message to display when another actor follows this one.

sayArriving (fromLoc)actor.t[1318]
The message to display when the player char sees this actor arriving after traveling from loc.

sayDeparting (conn)actor.t[1265]
Display a message describing this actor's departure via conn. This looks a bit circuitous in that this method calls the corresponding method on the current ActorState, which by default calls our own sayActorDeparting() method, which in turn calls sayDeparting on the connector; the idea is to allow customization at any point with the connector's sayDeparting() method simply providing a fallback to a colourless default. Note, however, that game code shouldn't normally override the actor's sayDeparting() method, but should instead intervene either on the ActorState or on the actor's sayActorDeparting() method. Note also that the purpose of this method is to describe an NPC's departure from the point of view of the player character, not to describe the player character's movements.

sayFollowing (oldLoc, conn)actor.t[1093]
Display a message to say that we've just followed the player character to a new location from oldLoc.

sayGoodbye (reason, =, endConvBye)actor.t[1829]
Say goodbye to this actor (farewell from the player character). The optional reason parameter is the reason we're saying goodbye, which defaults to endConvBye (i.e. the player character saying goodbye)

sayHeadAfterActor (conn)actor.t[2391]
reset the lastTravelInfo now that it's been used and is no longer relevant.

sayHello ( )actor.t[1766]
Say hello to the actor (when the greetin is initiated by the player character)

setFollowMeFuse ( )actor.t[1146]
Set the fuse to enable travel later on the same turn if this actor travels in the meantime. This method is called when a FOLLOW command is issed with this actor as its direct object.

setInformed (tag)actor.t[1728]
Note that we've been informed of something, by adding it to our informedNameTab. Tag is an arbitrary single-quoted string value used to represent the information in question.

setState (stat)actor.t[39]
Set our current ActorState to a new state (stat) or to no state at all (if the stat parameter is supplied as nil).

showSuggestions (explicit, =, true, tag, =, (, pendingKeys, =, =, ], suggestionKey, :, pendingKeys)actor.t[1483]
Show a list of topics the player character might want to discuss with this actor. The explicit flag is true if the player has explicitly requested the topic list via a TOPICS command. The tag parameter can be a single convKey tag or a list of convKey tags; if tag is nil or 'all' then we don't restrict the suggestions by tag, otherwise we restrict the suggestions to those that match the tag (or one of the tags in the list of tags).

specialDesc ( )actor.t[81]
Our specialDesc (used to describe us in room listing). By default we use our ActorState's specialDesc if we have a current ActorState or else our actorSpecialDesc if our current ActorState is nil. But if there's a current FollowAgendaItem we let it handle the specialDesc instead.

startFollowing ( )actor.t[1049]
Game code can call this method to instruct this actor to start following the player char round the map

stopFollowing ( )actor.t[1063]
Game code can call this method to instruct this actor to stop following the player char round the map.

takeTurn ( )actor.t[1383]
The takeTurn() method is called on every Actor every turn to carry out a number of housekeeping functions relating to the conversation and agenda item systems.

travelVia (conn, announceArrival, =, true)OVERRIDDENactor.t[1353]
Make this actor travel via the connector conn and report its departure. If announceArrival is true (the default) we also announce the actor's arrival (if it's visible to the player char).

To suppress the default arrival announcement altogether, supply the second optional parameter as nil. In some cases it may be easier to do this and supply your own custom arrival message after calling travelVia() than to juggle with the various sayArriving() methods.

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