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

Documentation Area

Document Path: /doc/object/drop


Lfun:	drop - this object is being dropped

Synopsis:
	int drop(int silent, string id)

Description:
	With this function you can control dropping independently from getting
	things. When something can't be taken, it also can't be dropped. But
	if something can be taken and should never be dropped this can be
	controlled with the drop function.

	If the silent flag is 1 you are supposed not to produce messages
	within drop, this happens when a player gives something away for
	instance. Also when the player quits.

	The second argument is the id-string a player used to reference the
	object.

Return value:
	Caution: drop works the opposite way of get. If you don't want an
	item to be dropped return 1, else return 0.

	If the object self-destructs in the drop function, be sure to return 1
	immediately after the destruct() call, as the destructed item surely 
	can't be dropped. Similarly, if drop is called in another object,
	always test if the object did self-destruct (the object pointer will
	turn to 0 then).

See also:


This page was generated in LPC

Imprint / Impressum