OutOfReach class | objects.t[2271]

Out Of Reach - this is a special mix-in that can be used to create an object that places its *contents* out of reach under customizable conditions, and can optionally place itself out of reach as well.

`class OutOfReach : object`

Superclass Tree (in declaration order)

`OutOfReach`
`object`

Subclass Tree

(none)

Global Objects

(none)

Summary of Properties

``

(none)

Summary of Methods

`cannotReachFromInsideMsg cannotReachFromOutsideMsg canObjReachContents canObjReachSelf canReachFromInside canReachSelfFromInside checkTouchViaPath tryImplicitRemoveObstructor`

Properties

(none)

Methods

`cannotReachFromInsideMsg (dest)` | `objects.t[2328]`

no description available

`cannotReachFromOutsideMsg (dest)` | `objects.t[2327]`

The message to use to indicate that we can't reach an object, because the actor is outside me and the target is inside, or vice versa. Each of these can return a property ID giving an actor action message property, or can simply return a string with the message text.

`canObjReachContents (obj)` | `objects.t[2341]`

Determine if the given object can reach my contents. 'obj' is the object (usually an actor) attempting to reach my contents from outside of me.

By default, we'll return nil, so that nothing within me can be reached from anyone outside. This can be overridden to allow my contents to become reachable from some external locations but not others; for example, a high shelf could allow an actor standing on a chair to reach my contents.

`canObjReachSelf (obj)` | `objects.t[2350]`

Determine if the given object can reach me. 'obj' is the object (usually an actor) attempting to reach this object.

By default, make this object subject to the same rules as its contents.

`canReachFromInside (obj, dest)` | `objects.t[2361]`

Determine if the given object outside of me is reachable from within me. 'obj' (usually an actor) is attempting to reach 'dest'.

By default, we return nil, so nothing outside of me is reachable from within me. This can be overridden as needed. This should usually behave symmetrically with canObjReachContents().

`canReachSelfFromInside (obj)` | `objects.t[2371]`

Determine if we can reach this object itself from within. This is used when 'obj' tries to touch this object when 'obj' is located within this object.

By default, we we use the same rules as we use to reach an external object from within.

`checkTouchViaPath (obj, dest, op)` | `objects.t[2272]`

no description available

`tryImplicitRemoveObstructor (sense, obj)` | `objects.t[2377]`

We cannot implicitly remove this obstruction, so simply return nil when asked.

TADS 3 Library Manual
Generated on 8/21/2012 from TADS version 3.1.2