A
          / \      _             Play Now                         Nemesis on 
          | |     | |  _______   _        _   _______    _______   _    _______
          | |\    | | |   ____| |  \    /  | |   ____|  /   ____| | |  /   ____|
 /-------/-------------------------------------------------------------------,
O= Home <=XX|  About  News  Pics  Adventurers  Wizards  Download  Connect     >
 \-------\-------------------------------------------------------------------'
          | |   \   | |  |____  | |      | | |  |____   ___ \  \  | |  ___ \  \
          | |     \_| |_______| |_|      |_| |_______| |_______/  |_| |_______/
          \ /
           V  

Documentation Area

Document Path: /doc/player/echo

Name: echo - write a message to a player

Syntax:
	echo(string echo)

Description:
	The echo function writes a string to the player. If you have commands
	in an item that return acknowledging messages like "Ok." or
	"You turn the faucet off", then better use
	this_player()->echo("the message string"); to correspond to the echo
	command.
	Calling echo() means, that your message will eventually not be
	displayed if the person prefers to have less verbose output.
	It's a brief/verbose-type mechanism, a special service to the user.  :)

Return value: 1
	echo always returns 1, so you can end an action-function with
	return ACTOR->echo(<message>); and not get the 'Huh?'.

Examples:
	return ACTOR->echo("You open "+short()+".");

See also:
player/query_echo
helpdir/set