BasicContainer

A basic container is an object that can enclose its contents. This is the core of the Container type, but this class only has the bare-bones sense-related enclosing features, without any action implementation. This can be used for cases where an object isn't meant to have its contents be manipulable by the player (so we don't want to allow "put in" and so on), but where we do want the ability to conceal our contents when we're closed.

class BasicContainer : BulkLimiter

The message property we use when we can't move an object through the containment boundary. This is a playerActionMessages property.

Library message (in playerActionMessages) explaining why we can't touch an object through this container. This is used when an actor on the outside tries to reach something on the inside, or vice versa.

My current open/closed state. By default, this state never changes, but is fixed in the object's definition; for example, a box without a lid would always be open, while a hollow glass cube would always be closed. Our default state is open.

the material that we're made of

prepositional phrase for objects being put into me

message when an object is too large (all by itself) to fit in me

Determine if the given object fits through our opening. This is only called when we're open; this determines if the object can be moved in or out of this container. By default, we'll return true; some objects might want to override this to disallow objects over a certain size from being moved in or out of this container.

Note that this method doesn't care whether or not the object can actually fit inside the container once through the opening; we only care about whether or not the object can fit through the opening itself. This allows for things like narrow-mouthed bottles which have greater capacity within than in their openings.

Display a message explaining why we are obstructing a sense path to the given object.

explain why we can't see the source of an odor

explain why we can't see the source of a sound

Determine if the given object can "reach" through our opening, for the purposes of touching an object on the other side of the opening. This is used to determine if the object, which is usually an actor, can its "hand" (or whatever appendange 'obj' uses to reach things) through our opening. This is only called when we're open. By default, we'll simply return true.

This differs from canFitObjThruOpening() in that we don't care if all of 'obj' is able to fit through the opening; we only care whether obj's hand (or whatever it uses for reaching) can fit.

Determine if I can move an object via a path through this container.

Determine if an actor can touch an object via a path through this container.

Get my fill medium. If I'm open, inherit my parent's medium, assuming that the medium behaves like fog or smoke and naturally disperses to fill any nested open containers. If I'm closed, I am by default filled with no medium.

Determine how a sense passes to my contents. If I'm open, the sense passes through directly, since there's nothing in the way. If I'm closed, the sense must pass through my material.