Actor¶

Class · class Actor: Thing · Source

A character that participates in travel, conversation and actor states.

Audience: author

Superclass: Thing

Declared members¶

• canAccompanyTravel — method; Decide whether this actor may accompany a leader along this journey.
• canStartJourney — method; A companion's own background agenda can still speak or do other work. Its travel waits for its leader, independent of declaration order.
• curState — property; Current ActorState, selected by the library or setCurState.
• desc — property; internal
• idleTurn — method; Run background behaviour when the actor has no state turn hook.
• isActor — property; internal
• isFixed — property; internal
• moveIntoForTravel — method; internal
• obeyCommand — method; Whether this actor will do as it is told. The state decides.
• posture — property; internal
• presentation — property; internal
• sayArriving — method; internal
• sayDeparting — method; What the player sees when this actor leaves, and when one arrives.
• scriptedTravelTo — method; internal
• setCurState — method; Change actor state, invoking deactivation and activation hooks.
• talkedThisTurn — property; Whether this actor has spoken this turn, for a ConvAgendaItem.
• travelAlone — method; Internal: the party has already been gathered and admitted.
• travelCycle — property; internal
• travelParty — method; Internal: eligibility has been checked exactly once for this journey.
• travelTo — method; internal

Inherited members¶

• afterTravel from Thing
• allowedPostures from Thing
• allowPourIntoMe from Thing
• beforeTravel from Thing
• bulk from Thing
• bulkCapacity from Thing
• bulkLimit from Thing
• cannotOpenMsg from Thing
• cannotTakeMsg from Thing
• canObjReachSelf from Thing
• contentsListed from Thing
• defaultPosture from Thing
• fluidName from Thing
• forget from Thing
• hasSpecialDesc from Thing
• informedOf from Thing
• initiallyKnowsAbout from Thing
• isAttachable from Thing
• isConsultable from Thing
• isContainer from Thing
• isDecoration from Thing
• isDistant from Thing
• isDrinkable from Thing
• isEdible from Thing
• isFamiliar from Thing
• isGenderNeutral from Thing
• isHer from Thing
• isHidden from Thing
• isHim from Thing
• isIntangible from Thing
• isIt from Thing
• isLightSource from Thing
• isLit from Thing
• isLockable from Thing
• isLocked from Thing
• isMassNoun from Thing
• isOpen from Thing
• isOpenable from Thing
• isOutOfReach from Thing
• isPlural from Thing
• isProper from Thing
• isTransparent from Thing
• isWorn from Thing
• keyItem from Thing
• known from Thing
• knowsAbout from Thing
• maxSingleBulk from Thing
• name from Thing
• notifyInsert from Thing
• objPos from Thing
• pcReferralPerson from Thing
• preCond from Thing
• rank from Thing
• refuses from Thing
• remapBehind from Thing
• remapIn from Thing
• remapOn from Thing
• remapUnder from Thing
• roomBeforeAction from Thing
• seen from Thing
• setKnowsAbout from Thing
• specialDesc from Thing

Member details¶

canAccompanyTravel¶

canAccompanyTravel(leader, conn, dest) · Source

Decide whether this actor may accompany a leader along this journey.

canStartJourney¶

canStartJourney() · Source

A companion's own background agenda can still speak or do other work. Its travel waits for its leader, independent of declaration order.

curState¶

curState = nil · Source

Current ActorState, selected by the library or setCurState.

desc¶

desc = nil · Source

Said instead of desc while in a state that has its own.

desc ="<<name>> is here. " · Source

Internal implementation detail; no supported authoring contract is documented.

idleTurn¶

idleTurn() · Source

Run background behaviour when the actor has no state turn hook.

isActor¶

isActor = true · Source

Internal implementation detail; no supported authoring contract is documented.

isFixed¶

isFixed = true · Source

Internal implementation detail; no supported authoring contract is documented.

moveIntoForTravel¶

moveIntoForTravel(room) · Source

Internal implementation detail; no supported authoring contract is documented.

obeyCommand¶

obeyCommand(issuer, a) · Source

Whether this actor will do as it is told. The state decides.

posture¶

posture = standing · Source

Internal implementation detail; no supported authoring contract is documented.

presentation¶

presentation = [&name, &isOpen, &isOpenable, &isContainer, &isLit, &isLightSource, &isFixed, &isDecoration, &isTransparent, &isHidden, &bulk, &bulkCapacity, &objPos, &curState] · Source

Internal implementation detail; no supported authoring contract is documented.

sayArriving¶

sayArriving(fromWay, conn) · Source

Internal implementation detail; no supported authoring contract is documented.

sayDeparting¶

sayDeparting(way, conn) · Source

What the player sees when this actor leaves, and when one arrives.

scriptedTravelTo¶

scriptedTravelTo(dest) · Source

Internal implementation detail; no supported authoring contract is documented.

setCurState¶

setCurState(state) · Source

Change actor state, invoking deactivation and activation hooks.

talkedThisTurn¶

talkedThisTurn = nil · Source

Whether this actor has spoken this turn, for a ConvAgendaItem.

travelAlone¶

travelAlone(dest, conn) · Source

Internal: the party has already been gathered and admitted.

travelCycle¶

travelCycle = -1 · Source

Internal implementation detail; no supported authoring contract is documented.

travelParty¶

travelParty(dest, conn, escort) · Source

Internal: eligibility has been checked exactly once for this journey.

travelTo¶

travelTo(dest, conn) · Source

Internal implementation detail; no supported authoring contract is documented.