Phantasmal Site > Phantasmal API > API Listing > get_short_for_dir

API Function: get_short_for_dir

Summary:

get a short name (as a Phrase) for a numerical direction

Defined In LPC Object:

/usr/common/sys/exitd.c

Prototype:

object get_short_for_dir(int direction)

Can Be Called By:

Anybody

Description:

Take a numerical direction and return a Phantasmal Phrase object containing a short description of that direction. For instance, the "north" direction, in English, would usually render as "N". Direction numbers are defined in <exit.h>.

Return Value:

A Phrase appropriate to the supplied direction, or nil if the direction isn't recognized.

Errors:

Normally none.

See Also:

get_name_for_dir , direction_by_string