| Prev | Next | Basic Verbs > direction |
direction
| Syntax |
direction (value)
|
| Params |
value is the object whose datatype you wish to coerce to be a direction.
|
| Action |
Coerces the datatype of value to be directionType if possible.
|
| Returns |
A valid Frontier direction if coercion is successful; an error condition otherwise.
|
| Examples |
direction (1) » up
Frontier defines seven valid directions, numbered 0-6. See the discussion of datatypes in Chapter 1 of the UserTalk Reference Guide for details.
direction (0)
The example above uses a special Frontier direction value that can be used to remove a previous setting for a direction, for example.
|
| Errors |
Supplying any value other than the integers 0-6, or the string representation of a valid Frontier direction, results in an error message.
|
| Notes |
The direction verb may prove useful in interacting with users who are being guided through navigating an outline. If the user supplies a string to indicate a direction he wants to travel, for example, coercing the string with direction would enable you to use any of the outline navigating verbs with the user's input as a parameter.
|
| See Also |
"Outline verbs"
|
| Prev | Next | Basic Verbs > direction |
