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

Documentation Area

Document Path: /doc/object/short


Lfun:	short - the short description of an object

Synopsis:
	string short()

Description:
	All visible items must have a short function. This function returns
	the short description of the item. If the function is missing or it
	returns 0 the item will be invisible to players. 

Return value:
	A string containing the short description of the object.

	There are some guidelines concerning style in short descriptions,
	provided to produce correct-looking english sentences when used by
	players. MOST IMPORTANT: shorts have to be in lower case in most
	cases! Please read build/shorts.

Examples:
	short() { return "a knife"; }

	A wizard tool might want to have a short() like this:

	short() {
		if (wizardp()) return "a wizard tool invisible to players";
	}

Note:
	PLEASE have a look at 'man build/shorts'!

See also:


This page was generated in LPC

Imprint / Impressum