Thing¶

Class · class Thing: object · Source

Base entity for physical and describable things in the adventure world.

Audience: author

Superclass: object

Subclasses: Actor, Attachable, Component, Consultable, Container, Fixture, Food, Gadget, Heavy, Immovable, Intangible, RearContainer, Room, SubComponent, Topic, TravelConnector, Unthing, Vehicle, Wearable

Declared members¶

• afterTravel — method; React after a traveller uses a connector.
• allowedPostures — property; internal
• allowPourIntoMe — property; Whether this will take something poured into it.
• beforeTravel — method; React before the traveller uses a connector.
• bulk — property; Space this thing occupies in a container.
• bulkCapacity — property; Total bulk this thing can hold when used as a container.
• bulkLimit — property; internal
• cannotOpenMsg — property; internal
• cannotTakeMsg — property; internal
• canObjReachSelf — method; internal
• contentsListed — property; Whether contents appear in a room description.
• defaultPosture — property; internal
• desc — property; internal
• fluidName — property; internal
• forget — method; Remove a fact tag from this knower; entity knowledge remains.
• hasSpecialDesc — property; internal
• informedOf — property; internal
• initiallyKnowsAbout — property; Subjects taught to this thing during vhylStart.
• isAttachable — property; internal
• isConsultable — property; Whether subjects may be looked up in it; see Consultable.
• isContainer — property; Whether the thing can hold contained entities.
• isDecoration — property; Mark scenery that is normally omitted from the room listing.
• isDistant — property; internal
• isDrinkable — property; internal
• isEdible — property; internal
• isFamiliar — property; internal
• isFixed — property; Prevent taking or moving this thing.
• isGenderNeutral — property; internal
• isHer — property; internal
• isHidden — property; Omit this thing from sight until revealed by an action.
• isHim — property; internal
• isIntangible — property; Seen and never touched; see Intangible.
• isIt — property; internal
• isLightSource — property; Whether this thing can provide light when lit.
• isLit — property; Current light state.
• isLockable — property; Whether locking actions apply to this thing.
• isLocked — property; Current locked state.
• isMassNoun — property; internal
• isOpen — property; Current open state; defaults to open for non-openable things.
• isOpenable — property; Whether open and close actions may change this thing's state.
• isOutOfReach — property; internal
• isPlural — property; internal
• isProper — property; Use a proper name without an article in English presentation.
• isTransparent — property; Allow sight into this thing while closed.
• isWorn — property; Current worn state used by clothing actions and preconditions.
• keyItem — property; Item that unlocks this thing, or nil when no key does.
• known — property; internal
• knowsAbout — method; Test whether this knower knows an entity or fact tag.
• maxSingleBulk — property; Maximum bulk of one item accepted by this container.
• name — property; Display name used by library messages and room descriptions.
• notifyInsert — method; Observe an item being inserted after placement changes.
• objPos — property; Position assigned to an item inserted here: in, on, under or behind.
• pcReferralPerson — property; internal
• preCond — method; Return preconditions for this object in the action and role.
• presentation — property; Properties exposed to structured hosts for entity presentation.
• rank — method; Return a candidate rank for this thing in the given action and role.
• refuses — method; Return nil to allow an action or text explaining a refusal.
• remapBehind — property; internal
• remapIn — property; internal
• remapOn — property; internal
• remapUnder — property; internal
• roomBeforeAction — method; internal
• seen — property; internal
• setKnowsAbout — method; Record knowledge of an entity or fact tag for this knower.
• specialDesc — property; internal

Member details¶

afterTravel¶

afterTravel(traveller, conn) · Source

React after a traveller uses a connector.

allowedPostures¶

allowedPostures = [standing] · Source

Internal implementation detail; no supported authoring contract is documented.

allowPourIntoMe¶

allowPourIntoMe = nil · Source

Whether this will take something poured into it.

beforeTravel¶

beforeTravel(traveller, conn) · Source

React before the traveller uses a connector.

bulk¶

bulk = 1 · Source

Space this thing occupies in a container.

bulkCapacity¶

bulkCapacity = 0 · Source

Total bulk this thing can hold when used as a container.

bulkLimit¶

bulkLimit = 0 · Source

Internal implementation detail; no supported authoring contract is documented.

cannotOpenMsg¶

cannotOpenMsg = nil · Source

Internal implementation detail; no supported authoring contract is documented.

cannotTakeMsg¶

cannotTakeMsg = nil · Source

Internal implementation detail; no supported authoring contract is documented.

canObjReachSelf¶

canObjReachSelf(who) · Source

Internal implementation detail; no supported authoring contract is documented.

contentsListed¶

contentsListed = true · Source

Whether contents appear in a room description.

defaultPosture¶

defaultPosture = standing · Source

Internal implementation detail; no supported authoring contract is documented.

desc¶

desc = nil · Source

Description emitted when the thing is examined.

desc ="There is nothing unusual about <<theName(self)>>. " · Source

Internal implementation detail; no supported authoring contract is documented.

fluidName¶

fluidName = nil · Source

Internal implementation detail; no supported authoring contract is documented.

forget¶

forget(tag) · Source

Remove a fact tag from this knower; entity knowledge remains.

hasSpecialDesc¶

hasSpecialDesc = nil · Source

Internal implementation detail; no supported authoring contract is documented.

informedOf¶

informedOf = [] · Source

Internal implementation detail; no supported authoring contract is documented.

initiallyKnowsAbout¶

initiallyKnowsAbout = nil · Source

Subjects taught to this thing during vhylStart.

isAttachable¶

isAttachable = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isConsultable¶

isConsultable = nil · Source

Whether subjects may be looked up in it; see Consultable.

isContainer¶

isContainer = nil · Source

Whether the thing can hold contained entities.

isDecoration¶

isDecoration = nil · Source

Mark scenery that is normally omitted from the room listing.

isDistant¶

isDistant = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isDrinkable¶

isDrinkable = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isEdible¶

isEdible = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isFamiliar¶

isFamiliar = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isFixed¶

isFixed = nil · Source

Prevent taking or moving this thing.

isGenderNeutral¶

isGenderNeutral = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isHer¶

isHer = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isHidden¶

isHidden = nil · Source

Omit this thing from sight until revealed by an action.

isHim¶

isHim = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isIntangible¶

isIntangible = nil · Source

Seen and never touched; see Intangible.

isIt¶

isIt = (!(isHim || isHer || isGenderNeutral)) · Source

Internal implementation detail; no supported authoring contract is documented.

isLightSource¶

isLightSource = nil · Source

Whether this thing can provide light when lit.

isLit¶

isLit = nil · Source

Current light state.

isLockable¶

isLockable = nil · Source

Whether locking actions apply to this thing.

isLocked¶

isLocked = nil · Source

Current locked state.

isMassNoun¶

isMassNoun = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isOpen¶

isOpen = true · Source

Current open state; defaults to open for non-openable things.

isOpenable¶

isOpenable = nil · Source

Whether open and close actions may change this thing's state.

isOutOfReach¶

isOutOfReach = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isPlural¶

isPlural = nil · Source

Internal implementation detail; no supported authoring contract is documented.

isProper¶

isProper = nil · Source

Use a proper name without an article in English presentation.

isTransparent¶

isTransparent = nil · Source

Allow sight into this thing while closed.

isWorn¶

isWorn = nil · Source

Current worn state used by clothing actions and preconditions.

keyItem¶

keyItem = nil · Source

Item that unlocks this thing, or nil when no key does.

known¶

known = (player.knowsAbout(self)) · Source

Internal implementation detail; no supported authoring contract is documented.

knowsAbout¶

knowsAbout(obj) · Source

Test whether this knower knows an entity or fact tag.

maxSingleBulk¶

maxSingleBulk = 0 · Source

Maximum bulk of one item accepted by this container.

name¶

name = nil · Source

Display name used by library messages and room descriptions.

notifyInsert¶

notifyInsert(item) · Source

Observe an item being inserted after placement changes.

objPos¶

objPos = posIn · Source

Position assigned to an item inserted here: in, on, under or behind.

pcReferralPerson¶

pcReferralPerson = SecondPerson · Source

Internal implementation detail; no supported authoring contract is documented.

preCond¶

preCond(a, role) · Source

Return preconditions for this object in the action and role.

presentation¶

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

Properties exposed to structured hosts for entity presentation.

rank¶

rank(a, role) · Source

Return a candidate rank for this thing in the given action and role.

refuses¶

refuses(action, c) · Source

Return nil to allow an action or text explaining a refusal.

remapBehind¶

remapBehind = nil · Source

Internal implementation detail; no supported authoring contract is documented.

remapIn¶

remapIn = nil · Source

Internal implementation detail; no supported authoring contract is documented.

remapOn¶

remapOn = nil · Source

Internal implementation detail; no supported authoring contract is documented.

remapUnder¶

remapUnder = nil · Source

Internal implementation detail; no supported authoring contract is documented.

roomBeforeAction¶

roomBeforeAction(c) · Source

Internal implementation detail; no supported authoring contract is documented.

seen¶

seen = nil · Source

Internal implementation detail; no supported authoring contract is documented.

setKnowsAbout¶

setKnowsAbout(obj) · Source

Record knowledge of an entity or fact tag for this knower.

specialDesc¶

specialDesc = nil · Source

Internal implementation detail; no supported authoring contract is documented.