DropType class | thing.t[270]

Drop Descriptor. This is passed to the receiveDrop() method of a "drop destination" when an object is discarded via commands such as DROP or THROW. The purpose of the descriptor is to identify the type of command being performed, so that the receiveDrop() method can generate an appropriate report message.

`class DropType : object`

Superclass Tree (in declaration order)

`DropType`
`object`

Subclass Tree

`DropType`
`DropTypeThrow`
`DropTypeShortThrow`

Global Objects

`dropTypeDrop`

Summary of Properties

``

(none)

Summary of Methods

`getReportPrefix standardReport`

Properties

(none)

Methods

`// getReportPrefix (obj, dest)`Interface description only | `thing.t[299]`

Get a short report describing the action without saying where the object ended up. This is roughly the same as the standard report, but omits any information on where the object lands, so that the caller can show a separate message explaining that part.

The report must be worded such that the object being dropped is the logical antecedent for any subsequent text. This means that callers can use a pronoun to refer back to the object dropped, allowing for more natural sequences to be constructed. (It usually sounds stilted to repeat the full name: "You drop the box. The box falls into the chasm." It's better if we can use a pronoun in the second sentence: "You drop the box. It falls into the chasm.")

'obj' is the object being dropped, and 'dest' is the drop destination.

`// standardReport (obj, dest)`Interface description only | `thing.t[279]`

Generate the standard report message for the action. The drop destination's receiveDrop() method can call this if the standard message is adequate to describe the result of the action.

'obj' is the object being dropped, and 'dest' is the drop destination.

TADS 3 Library Manual
Generated on 5/16/2013 from TADS version 3.1.3