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

Documentation Area

Document Path: /doc/player/make_msg_name

Name: make_msg_name - create a good name of an object for messages

Syntax:
	string *make_msg_name(object obj, string given_id, status alive,
	    status possessive, status use_short, status report_missing)

Description:
	This function is a way to get nice names for all kinds of objects that
	can be used for messages.

Arguments:
	- obj: A pointer to the object that should be named.
	- given_id: The name the user gave to access the object. This should
	            usually be the first element of the find_id() return value.
	- alive: A status value specifying whether the object is alive. Usually
	         stringp(living(obj)). If this is true, the return value will
	         be ({ "", "", obj->query_name(1) }).
	- possessive: A boolean value specifying whether possessive pronouns
	              should be used. Usually true if the object is carried
	              around by the player, i.e. if the third return value of
	              find_id() equals 1.
	- use_short: A boolean value indicating whether the short description
	             should be used if the object doesn't have a query_name().
	- report_missing: If this is nonzero, a message will be issued into the
	                  IMPROVEME log file if the object does not have a
	                  query_name().

Return value:
	({ string player_prefix, string other_prefix, string suffix })
	player_prefix + suffix should be used in messages to the player.
	other_prefix + suffix should be used for messages to spectators.

See also:
living/find_id
living/query_name
object/short
efun/living
efun/stringp