blob: bb732b2c1f466efd53480b945c86de083bcfd04a [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SYNOPSIS
2 int remove(void)
3
4DESCRIPTION
5 remove() does some housekeeping to ensure consistency and then
6 destructs the current object.
7
8 This lfun is not applied by the parser, but by other objects
9 to tell the current object to self-destruct. remove() should
10 be supplied by the base classes of the library. Return 1 if
11 actually self-destructed, 0 otherwise.
12
13 An alternative way to ensure the housekeeping on destruction
14 is through the use of the master apply prepare_destruct().
15
16NOTE
17 Your actual mudlib may name this lfun differently, "remove()" is
18 just the traditional name.
19
20SEE ALSO
21 destruct(E), prepare_destruct(M)