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

Documentation Area

Document Path: /doc/room/set_read


Name: set_read - define a list of items that can be read in a room

Syntax:
	#define EXTD_ROOM
	#define READ_CMD

	set_read(string read_id, string read_mess)
	set_read(string *read_items)

Description:
	With the set_read function you are able to create items that can be
	read in rooms efficiently.

	If two arguments are provided (should be used, if there is only one
	readable item) the first argument is the item id and the second
	argument is the read description. Several id's can be separated with
	'#', just like in set_items.

	If there are more than one readable items, you can set them all at
	once, giving an array, containing item id's and read descriptions
	after each other.
		
	If the read message is not given, or if it is 0, the long description
	will be displayed if the player reads the item.

	If you omit the set_read completely and just #define READ_CMD together
	with EXTD_ROOM, 'read' displays the long description of any item that
	has 'sign' in its id.

Return value: none

Examples:
	set_read("sign", "You can't decipher it.\n");

	set_read( ({ "small sign", "Read the large sign.\n",
	             "large sign", "Read the small sign.\n" }) );

See also:


This page was generated in LPC

Imprint / Impressum